Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "b122058b-02a2-4db1-aaf8-3516252bedce",
"jobs_id": "124bb15d-fe6f-4857-8819-3d09c6facb46",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "af87076f-4428-4b4f-9f9a-b2f59dc1e732",
"_parent_id": "139b7949-17b2-4fa3-9020-df33104c9b0d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4975c345-7e94-4e09-bc47-aa244e474377",
"project_reference_back_office": "sample string 5",
"project": {
"id": "198bb781-1492-4760-8121-f9cf3e3c0edd",
"_parent_id": "249d8a0d-696a-4704-bce1-35742329e5b3",
"root_parent_id": "8a3b2643-d6c2-4fbf-bab1-89f5e386ec39",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4bb9cd8c-e376-487e-8827-34a57e437a2b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "43ea606a-a333-4baa-ae70-9330252ead11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "91943d77-688a-4e80-9857-7c8150f95f90",
"_parent_code": "sample string 6",
"sales_organization_id": "1ce190c6-344a-4e41-b241-7668d9f3ba49",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"equipment_model_id": "299f23bf-1f39-4f19-baa0-1d5779dfab18",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6b0630b0-59e2-454e-9287-e9e958c9c5ec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f4c1ae14-2ba9-4db0-9e57-a2a1f95f545b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d67c94ab-4d08-4a49-b6ff-8a7df83bd923",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f2b4ec99-0f33-48d9-9f3b-57565bc5d798",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"equipment_family_id": "857ebfaf-f75e-48ca-8b5f-107c77af8922",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "43ea606a-a333-4baa-ae70-9330252ead11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "91943d77-688a-4e80-9857-7c8150f95f90",
"_parent_code": "sample string 6",
"sales_organization_id": "1ce190c6-344a-4e41-b241-7668d9f3ba49",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"date_in_production_since": "2025-08-12T12:40:20.2340276+00:00",
"date_out_of_production_since": "2025-08-12T12:40:20.2340276+00:00",
"date_end_support": "2025-08-12T12:40:20.2340276+00:00",
"sales_organization_id": "def0d0aa-1482-4ee0-998d-1e45f5efc6ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"project_status_id": "524336e7-25b3-4ea9-ae9f-c808b4407286",
"project_status_code": "sample string 10",
"project_status": {
"id": "42ba774d-fc44-472f-9759-2fe41eb603a1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5311ffe8-53c2-4dac-9f36-0ab0785ad122",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"company_id": "325df90d-1e6b-4394-beb7-b496f9dd2728",
"company_code": "sample string 12",
"db_address_id": "22b7d935-108b-433a-96eb-5811bf33cc5b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f88e0a65-2cc2-4eaa-917d-43e86e54e5ed",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ba0a9143-f844-44d6-8a2b-301351c55733",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2025-08-12T12:40:20.2340276+00:00",
"date_create": "2025-08-12T12:40:20.2340276+00:00",
"date_update": "2025-08-12T12:40:20.2340276+00:00",
"updated_by_user_id": "a5c03623-d74e-41dd-897b-e7d2251c52e9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-12T12:40:20.2340276+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2025-08-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-12T12:40:20.2340276+00:00",
"date_last_job": "2025-08-12T12:40:20.2340276+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-12T12:40:20.2340276+00:00",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00",
"is_mobile_installation": true
},
"job_type_id": "b354d651-8a96-41fd-a38e-cfdd6b2c55bf",
"job_type_code": "sample string 7",
"job_type": {
"id": "4005e8cf-d4f0-46e0-b67d-75b643181f25",
"name": "sample string 2",
"sales_organization_id": "3b619e57-9f21-4996-9650-ebec1628ee98",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00",
"code": "sample string 7"
},
"job_priority_id": "ab4502a1-c0e0-4876-af5f-9344dcfaf3fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "487c666d-00ee-4739-ac2c-cf2a85214e1c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "38c62500-4c2b-45b3-a281-5ca09ca2e0db",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"job_status_id": "fe3d654d-b211-4fdc-8d58-3d55eb1308e3",
"job_status_code": "sample string 11",
"db_address_id": "41b9b985-2ca4-40f7-b425-962fdc3445d1",
"contact_id": "149469de-aae9-4893-8f4a-ffe69a7edb88",
"requested_by_company_id": "e19e9f71-5338-4778-b0ac-356d9ade3611",
"requested_by_contact_id": "8e412867-5966-4278-b05b-73e3b11bc722",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2025-08-12T12:40:20.2340276+00:00",
"due_date": "2025-08-12T12:40:20.2340276+00:00",
"date_create": "2025-08-12T12:40:20.2340276+00:00",
"date_update": "2025-08-12T12:40:20.2340276+00:00",
"date_closed": "2025-08-12T12:40:20.2340276+00:00",
"suggested_user_id": "522b42ab-fc21-47d5-b2e0-d98d3343e4be",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "29de557d-ab6a-41ef-9cee-e7bce72f71fb",
"db_language_id": "fedfcf9a-1c2f-4c7f-8f7d-c63b40c71731",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2025-08-12T12:40:20.2340276+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6aef435b-b6d5-4f37-b4e7-acba36239a73",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "81a79c9c-9574-41e5-b06e-2123bd2195dc",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "4910dad5-76f8-417a-9716-85cc64138137",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1a2aabe9-7619-4ed5-87cd-026da620a75a"
},
"suggested_date_start": "2025-08-12T12:40:20.2340276+00:00",
"skill_id": "78948dd3-c1b0-4862-8a56-a3c21baf4cc7",
"skill_code": "sample string 32",
"skill": {
"id": "ceb626bc-f102-4927-8390-6d7b73907895",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a88ecf31-3a08-4438-a44a-4f545f949f68",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa1bf53a-2dbc-4039-b74b-fe53b285507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d86f32e-9296-4e71-9214-9d27fcf0be41",
"db_currency_id": "24cc7998-e0ce-442b-9267-32bfcd6dcc9c",
"db_language_id": "64bd3b4a-c360-4fea-acbd-d65e24fdb1c1",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a61eb7c2-be0a-4d94-9a84-6cbd386fd7bf",
"date_reported_by_company": "2025-08-12T12:40:20.2340276+00:00",
"id2": 36,
"company_id": "018701ff-7141-4a70-b9fd-045747f57dc0",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "46e669d9-341f-424d-a5c1-b382be5917ce",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
},
"work_instruction_details_id": "a491bb30-258d-483e-83c3-2cfad98f2104",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "39678e19-165f-474c-908c-7035d310f354",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d0b42a1e-6772-45cc-a517-decd18cf0198",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-12T12:40:20.2340276+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "55cfbbf4-5c11-4b6c-a6cf-471ca4bf6f2e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-12T12:40:20.2340276+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.