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": "960ce5c8-47dc-47fb-a1bc-ef7a18efdeca",
"jobs_id": "39646a67-6635-4c9c-bd6c-8ea914be54fa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1c4c5bbc-96c8-44ab-9b99-a2016a608195",
"_parent_id": "1e885507-81f3-4cb1-9053-8dd9b318efa3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3388dade-3841-49ed-b67c-a542ef9d6b51",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ad6e3b35-eb15-4c4b-a819-734511816b09",
"_parent_id": "aacf4cc1-b9a7-4752-ad13-3c533aa74afa",
"root_parent_id": "b3e5c14e-769c-454c-a1ba-1585beb9379b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "27a50b1e-581d-4bec-8539-460efa4f8848",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "40f108e1-b43b-45d0-ac59-4239fad5a34c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "36d7c7d7-4730-4e8a-bdb8-58595fd3ca8c",
"_parent_code": "sample string 6",
"sales_organization_id": "203e1626-45d9-4932-8cd7-1e08e69e5713",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+00:00"
},
"modified_dateutc": "2026-10-05T17:27:08.8458124+00:00"
},
"equipment_model_id": "fbe26e91-1025-4346-b6dd-f797abafc4eb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "50074517-2de5-419e-b12f-417de471e2a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ecf61b63-7591-4ee7-99f4-2ce8ff3a302b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f54013c5-65d1-4f84-9e9f-b1a002ebd169",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9a0e40e-1682-4e80-a870-9b6f6e3f403b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+00:00"
},
"modified_dateutc": "2026-10-05T17:27:08.8458124+00:00"
},
"equipment_family_id": "b0934a1a-c591-4f9d-b457-dbcce16906be",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "40f108e1-b43b-45d0-ac59-4239fad5a34c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "36d7c7d7-4730-4e8a-bdb8-58595fd3ca8c",
"_parent_code": "sample string 6",
"sales_organization_id": "203e1626-45d9-4932-8cd7-1e08e69e5713",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+00:00"
},
"modified_dateutc": "2026-10-05T17:27:08.8458124+00:00"
},
"date_in_production_since": "2026-10-05T17:27:08.8458124+00:00",
"date_out_of_production_since": "2026-10-05T17:27:08.8458124+00:00",
"date_end_support": "2026-10-05T17:27:08.8458124+00:00",
"sales_organization_id": "9b0292f6-25cc-4378-9b70-24f9f5e365a6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+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": "2026-10-05T17:27:08.8613911+00:00"
},
"project_status_id": "728b3bff-8535-474c-8b7e-3705e01a66da",
"project_status_code": "sample string 10",
"project_status": {
"id": "27ffa0e2-5a76-4001-a437-e5d6ca712bfc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "433f95f3-36e0-4c46-acde-32884852481f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T17:27:08.8613911+00:00"
},
"company_id": "834a24c0-15b0-4f81-850a-ed12802bfba2",
"company_code": "sample string 12",
"db_address_id": "b71d1356-ba0e-41ce-846b-c2dcb833b15e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a91acc2f-3016-4329-bc06-4e04a9eba1b8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0626e3fc-6ca1-4655-84d0-3d598a0335f4",
"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": "2026-10-05T17:27:08.8613911+00:00",
"date_create": "2026-10-05T17:27:08.8613911+00:00",
"date_update": "2026-10-05T17:27:08.8613911+00:00",
"updated_by_user_id": "ee499258-c438-493f-a4e9-e709b76fcafa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T17:27:08.8613911+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": "2026-10-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T17:27:08.8613911+00:00",
"date_last_job": "2026-10-05T17:27:08.8613911+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T17:27:08.8613911+00:00",
"modified_dateutc": "2026-10-05T17:27:08.8613911+00:00",
"is_mobile_installation": true
},
"job_type_id": "8f662800-548c-4564-a54d-acb1320c1fa2",
"job_type_code": "sample string 7",
"job_type": {
"id": "5d655bb6-687a-47c3-9941-dfc7a946a7be",
"name": "sample string 2",
"sales_organization_id": "4bd4f974-e787-46ef-8a62-a8994e0b8563",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T17:27:08.8613911+00:00",
"code": "sample string 7"
},
"job_priority_id": "05cc8968-b1bd-4e6b-8a55-43c9525e3096",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ca218a28-867c-4261-9de1-c1185070f6f9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "000ed846-b74a-4dde-9d7d-1e7682a3727d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T17:27:08.8613911+00:00"
},
"job_status_id": "02ffd0ec-1fad-4c03-803f-1b4ad9d37382",
"job_status_code": "sample string 11",
"db_address_id": "8be78e97-ed8e-4c7b-9721-a3d3e88c27fc",
"contact_id": "6dbf63eb-ce5e-44bd-9d4c-6a591bc106d8",
"requested_by_company_id": "511af41c-81ff-4583-9de1-989290726f48",
"requested_by_contact_id": "95d1c807-f577-45d6-839d-4e013a75d653",
"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": "2026-10-05T17:27:08.8613911+00:00",
"due_date": "2026-10-05T17:27:08.8613911+00:00",
"date_create": "2026-10-05T17:27:08.8613911+00:00",
"date_update": "2026-10-05T17:27:08.8613911+00:00",
"date_closed": "2026-10-05T17:27:08.8613911+00:00",
"suggested_user_id": "c6438655-5feb-461d-9732-dfd3d0c292ac",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4876eac3-ac55-4396-a2c9-21288fbeee68",
"db_language_id": "ac70adf9-0ac5-4d76-80c5-274e0738109a",
"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": "2026-10-05T17:27:08.8613911+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eaf03e0c-e5ac-45f1-97be-6d63682251e1",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9150ab16-63eb-4482-921e-7004491b95cb",
"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": "7eb0a5e6-7b48-4aad-84b2-a72279bccd0a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T17:27:08.8613911+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cf023c11-90e3-4feb-867b-d1eb3fc4ef85"
},
"suggested_date_start": "2026-10-05T17:27:08.8613911+00:00",
"skill_id": "63203057-096b-492b-82e1-2470f6d61836",
"skill_code": "sample string 32",
"skill": {
"id": "4c29c5e5-196f-4f72-88c8-9c4e25da0e50",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d367b6e8-8466-4397-821d-b4d56f81cb36",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "746007cb-5b3e-4aeb-9d61-28928b465b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0ce3cee-9bde-4812-964b-36028363df10",
"db_currency_id": "de99fad5-e8ce-46db-b271-dff5df8fc600",
"db_language_id": "62104b35-ccd5-4f56-bc51-b163f3eaa6e9",
"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": "2026-10-05T17:27:08.8458124+00:00"
},
"modified_dateutc": "2026-10-05T17:27:08.8613911+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ceb7feb6-4120-485d-8a56-abecdb2e992d",
"date_reported_by_company": "2026-10-05T17:27:08.8613911+00:00",
"id2": 36,
"company_id": "2123bb8c-7572-4c6e-b88b-2998a82b13fb",
"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": "bd1538fd-8381-4940-bca2-d684bb90c5fe",
"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": "2026-10-05T17:27:08.8613911+00:00"
},
"work_instruction_details_id": "0b86ec30-2e73-4030-bdc9-103f78568e14",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bf6abe11-ca9b-4eae-a40a-7a2cb322628c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8744a353-9b74-463a-8784-971f8b73e711",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T17:27:08.8613911+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": "8448916c-1d79-49ba-9ef7-4ce00da6848b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T17:27:08.8613911+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.