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": "eab36611-3992-490e-8935-f372af1f3e7e",
"jobs_id": "384176b9-9062-48a2-8d46-b30fd10b1211",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a2363518-d24b-46e9-af47-f25d3f9fdf40",
"_parent_id": "a2381621-77b4-42a6-9e6d-2782e9fd1f7d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "86b3b665-24b7-4735-9513-b49d6a7f4765",
"project_reference_back_office": "sample string 5",
"project": {
"id": "057a8f4c-df79-482d-8b3a-f6d249887e3f",
"_parent_id": "fc3da792-ef5c-481e-8065-7a8898613f3f",
"root_parent_id": "76b34f26-a237-44b7-8bc4-453f71ffdad7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d9d648ec-a8b1-4bcb-bc54-f88781a40200",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "20f4a795-5370-4179-9bac-afdc7820275b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c7b2ed26-34d3-46e4-aa9c-181b60a59308",
"_parent_code": "sample string 6",
"sales_organization_id": "7006f9e4-41e2-4288-be38-d93e40f27776",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+00:00"
},
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00"
},
"equipment_model_id": "efb60379-edad-47dc-84d8-98073b5e0a28",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2156c13b-9926-4c53-b2c5-f35690b62e7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6c11e8a2-25fb-4bf4-be5c-8d80b37c19cd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "333c20c6-8d30-4fd2-9372-d7e56f045141",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8ac4ff0c-9ce0-47ab-91f4-0ba8e63f3380",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+00:00"
},
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00"
},
"equipment_family_id": "6e4433a2-2a99-417e-9535-2b2b53e507da",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "20f4a795-5370-4179-9bac-afdc7820275b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c7b2ed26-34d3-46e4-aa9c-181b60a59308",
"_parent_code": "sample string 6",
"sales_organization_id": "7006f9e4-41e2-4288-be38-d93e40f27776",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+00:00"
},
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00"
},
"date_in_production_since": "2026-07-24T12:37:52.4603646+00:00",
"date_out_of_production_since": "2026-07-24T12:37:52.4603646+00:00",
"date_end_support": "2026-07-24T12:37:52.4603646+00:00",
"sales_organization_id": "a525b217-8117-4005-aec0-460624c29206",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+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-07-24T12:37:52.4603646+00:00"
},
"project_status_id": "ffa83ea6-f6e1-42ae-aa3e-4f74e7d4724b",
"project_status_code": "sample string 10",
"project_status": {
"id": "73413005-beec-43b0-8476-c041c34b564e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6bdcd6d2-e544-4de9-854c-7d00d95c5af3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00"
},
"company_id": "216d3a48-3860-419f-9d58-5d331ce140cc",
"company_code": "sample string 12",
"db_address_id": "0f9c2510-dc5e-42db-b730-b72851bf61ca",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ea3c716f-ed5d-4a25-91dd-3a1858a2e6a1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b81f10af-48b1-416c-ae9c-3fb60b2eaa98",
"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-07-24T12:37:52.4603646+00:00",
"date_create": "2026-07-24T12:37:52.4603646+00:00",
"date_update": "2026-07-24T12:37:52.4603646+00:00",
"updated_by_user_id": "c0105559-c1f2-4c59-bb7f-123d9a886329",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-24T12:37:52.4603646+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-07-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-24T12:37:52.4603646+00:00",
"date_last_job": "2026-07-24T12:37:52.4603646+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-24T12:37:52.4603646+00:00",
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00",
"is_mobile_installation": true
},
"job_type_id": "daacba45-757c-4636-ae55-2976ba2d146d",
"job_type_code": "sample string 7",
"job_type": {
"id": "94097ca8-ae48-43fd-8107-8d1834cf7666",
"name": "sample string 2",
"sales_organization_id": "6c876771-697d-4725-b0b4-25fcafd8edd3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00",
"code": "sample string 7"
},
"job_priority_id": "e211958d-85fa-436e-b31f-68eb5afce38a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "74f00aea-da0e-4637-bb02-4eb0a024f332",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "675a3e80-c916-480f-9757-4e5b41908d2d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00"
},
"job_status_id": "dd9254aa-4410-4b6f-8a31-c8b3861314fb",
"job_status_code": "sample string 11",
"db_address_id": "aa035900-f59c-4f79-aad1-fa73f200ea16",
"contact_id": "d0b9062c-d953-4191-b3bf-378cfcc46fc7",
"requested_by_company_id": "0990fd7f-0f43-4665-a6fa-81ea8dc96b66",
"requested_by_contact_id": "88b3ccfd-435d-4f96-bb92-f3d3414c592a",
"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-07-24T12:37:52.4603646+00:00",
"due_date": "2026-07-24T12:37:52.4603646+00:00",
"date_create": "2026-07-24T12:37:52.4603646+00:00",
"date_update": "2026-07-24T12:37:52.4603646+00:00",
"date_closed": "2026-07-24T12:37:52.4603646+00:00",
"suggested_user_id": "501ee3fc-fdda-4172-8136-0a3b62b91333",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8a3d721c-7aad-4293-84ec-536430786249",
"db_language_id": "519869eb-d876-4a20-9b36-5301494302dd",
"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-07-24T12:37:52.4603646+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "53d7a21c-d3e0-4706-a191-6f0a8ab447ba",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fa7967c9-3e21-4aef-856b-9c6baa3b795c",
"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": "5caaa035-23ac-4784-bf37-7b93d729084f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "acfd244d-fa6d-428b-a70d-5c7dc1c75534"
},
"suggested_date_start": "2026-07-24T12:37:52.4603646+00:00",
"skill_id": "642bee02-5077-43e7-bb7e-fee30fe9bb1d",
"skill_code": "sample string 32",
"skill": {
"id": "f67d520b-b5e8-4f40-8cf9-b976f7282787",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "beb54158-9722-48a2-aa9c-e11327fe2536",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48c6d59c-9109-451b-b3ff-68d2f7ed0a03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9454360d-42b1-4222-90d9-ccae2eb58d45",
"db_currency_id": "6b4f22d4-5e33-4e38-8cf5-fc2b40fbde6f",
"db_language_id": "45b236ef-075b-4d96-84ae-2a2b44ea4d19",
"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-07-24T12:37:52.4603646+00:00"
},
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78d469d7-e77d-4d22-bd65-05f89827a150",
"date_reported_by_company": "2026-07-24T12:37:52.4603646+00:00",
"id2": 36,
"company_id": "1ade67d6-1bf4-48cb-a087-8b3a81557031",
"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": "6afc82c1-8c4b-44d1-8b8c-380545bd4aad",
"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-07-24T12:37:52.4603646+00:00"
},
"work_instruction_details_id": "f2edb127-f431-4962-9baa-6f2f13933279",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "11173991-1040-42d4-bca2-cd9dbd6cbfe8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "484cabd5-a7ee-4c24-961c-bb57eb1ff26e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-24T12:37:52.4603646+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": "6221c7bd-4232-4fa9-9966-c31a32ddd4ce",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-24T12:37:52.4603646+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.