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": "be7abe6e-402f-40f5-bd96-91f5da5bbca0",
"jobs_id": "3088fa0b-0787-40c1-ac95-3300d26490b3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1d2ad1f9-b694-46d0-917a-6679bf0390fe",
"_parent_id": "b89ba5f9-7f42-4ef9-84dd-ee8c74d004f4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "97dda05c-ee06-422a-8d3b-5fb8ee0a3bfa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "863c1f02-d846-4441-84b3-22a6856a87cc",
"_parent_id": "53f18db4-c599-41d9-89e8-e4d29835c802",
"root_parent_id": "366e23c4-356c-4a44-8ff2-0c84b75f0009",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b51965e7-9959-405c-baca-8a86bfa1bb56",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "11b21555-6f8a-4407-b9e2-1f9ed6fd3553",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8840df73-f0dd-4b36-94bc-c7997ba4b912",
"_parent_code": "sample string 6",
"sales_organization_id": "69e0a704-d005-436f-a815-bd69b9a768ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+00:00"
},
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00"
},
"equipment_model_id": "92426e54-0f8d-45bb-80b1-4be43c007d54",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8fc3ec97-df04-40a6-acd9-9ee73db07706",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a8dea637-c244-4daf-97f0-16200a5cb10c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "944d223d-0a96-4b58-9da0-15078a855583",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fa734723-4b4b-4cad-a1a3-c397b7b11631",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+00:00"
},
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00"
},
"equipment_family_id": "013259cd-5084-4d45-8eb4-0a741cd870de",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "11b21555-6f8a-4407-b9e2-1f9ed6fd3553",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8840df73-f0dd-4b36-94bc-c7997ba4b912",
"_parent_code": "sample string 6",
"sales_organization_id": "69e0a704-d005-436f-a815-bd69b9a768ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+00:00"
},
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00"
},
"date_in_production_since": "2025-11-16T05:33:01.2302319+00:00",
"date_out_of_production_since": "2025-11-16T05:33:01.2302319+00:00",
"date_end_support": "2025-11-16T05:33:01.2302319+00:00",
"sales_organization_id": "a225daae-1f07-4537-bd0d-cf64e2786b3f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+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-11-16T05:33:01.2302319+00:00"
},
"project_status_id": "31facbfa-f36d-4e2f-879b-f8bd75ef71a8",
"project_status_code": "sample string 10",
"project_status": {
"id": "14b60c81-ab1c-4137-b5f0-d4cc10768c64",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "29ae0e5d-4bb8-4b92-ab8c-44f929f0bc80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00"
},
"company_id": "d13b807d-39a8-4097-928e-8a5191166e46",
"company_code": "sample string 12",
"db_address_id": "e6bfd488-ad8d-4840-bf32-63cf0087f50f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e1bff24d-b003-4a95-9f3e-ca5a4cb81693",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "aebab71b-1129-4b16-8062-5ff49dd996aa",
"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-11-16T05:33:01.2302319+00:00",
"date_create": "2025-11-16T05:33:01.2302319+00:00",
"date_update": "2025-11-16T05:33:01.2302319+00:00",
"updated_by_user_id": "f8e4f4fe-0eed-4b7c-b426-4c33be3528f0",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-16T05:33:01.2302319+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-11-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-16T05:33:01.2302319+00:00",
"date_last_job": "2025-11-16T05:33:01.2302319+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-16T05:33:01.2302319+00:00",
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00",
"is_mobile_installation": true
},
"job_type_id": "2ca0c494-302e-499d-9cbd-901b5368eb18",
"job_type_code": "sample string 7",
"job_type": {
"id": "0a45ee52-f04c-4402-bfcd-051fe2f1a76e",
"name": "sample string 2",
"sales_organization_id": "c1eb07f4-158f-4111-94f5-8ca12d4c213f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00",
"code": "sample string 7"
},
"job_priority_id": "575048c5-38ec-44ba-8ee1-8594b47a3da3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8296ed22-77ef-4e49-9b6c-87ad82ff2a17",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2a6b6f07-a49b-49f4-91d8-2dfb6b43055e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00"
},
"job_status_id": "888c0a3a-65c0-4dd1-aa05-120ca4d97993",
"job_status_code": "sample string 11",
"db_address_id": "66905564-b151-4a0d-b619-75e7f7f9cd67",
"contact_id": "6ed71d67-2f03-4d25-8d73-873f60fac8d6",
"requested_by_company_id": "1b30ee48-c1b1-4cbe-b297-73f34cee1e82",
"requested_by_contact_id": "d325d19a-bd5f-4ad3-aa98-7d6b40916521",
"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-11-16T05:33:01.2302319+00:00",
"due_date": "2025-11-16T05:33:01.2302319+00:00",
"date_create": "2025-11-16T05:33:01.2302319+00:00",
"date_update": "2025-11-16T05:33:01.2302319+00:00",
"date_closed": "2025-11-16T05:33:01.2302319+00:00",
"suggested_user_id": "472e21aa-ed02-46ae-be85-5e6cb6bac37b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5bfb8377-c860-46a9-9590-b0bba1f56dfa",
"db_language_id": "ef0d2a10-a39d-4232-8b6b-60914c9a3892",
"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-11-16T05:33:01.2302319+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e7b648b4-dbac-4567-a44b-252924f45066",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9d6e0e0d-ad13-46e7-b0f3-417d53e28f8d",
"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": "e924ecb2-2470-4c3b-b4a0-03c897ebac86",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7dd04e1f-e02f-46a5-bb89-f5fa909893e0"
},
"suggested_date_start": "2025-11-16T05:33:01.2302319+00:00",
"skill_id": "db10a30f-6c2d-420f-a5fd-70629c3c6b45",
"skill_code": "sample string 32",
"skill": {
"id": "b5e6c5a8-5761-44e0-b2b4-e6167d88d208",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0dfee6f7-4d92-4c8c-8f09-55bc6ac487ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c82bb9d8-0c34-4416-8a9e-bdf7ee2fe799",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d44a3793-98b4-499a-88c3-15dddfddac9d",
"db_currency_id": "54ebdf01-2ee5-4f89-8a07-03228bc2ef2c",
"db_language_id": "00177b5e-8df9-4bf3-9b7f-0e21ccfcd50f",
"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-11-16T05:33:01.2302319+00:00"
},
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f1de0166-e8c8-4385-ae78-1e9bf5aa8d6a",
"date_reported_by_company": "2025-11-16T05:33:01.2302319+00:00",
"id2": 36,
"company_id": "307144ba-c919-451b-88d9-17d55858f7d7",
"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": "f473eeef-0fc3-4382-96b6-cbc3ab0b0983",
"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-11-16T05:33:01.2302319+00:00"
},
"work_instruction_details_id": "217ac905-a6f8-4feb-929b-f3b7ade0ea50",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d71230b4-eb33-459d-a65c-1d8360ec2665",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "03c3a49c-c7f5-4d40-9a24-837da4d37b6a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-16T05:33:01.2302319+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": "93a7ec0c-4c38-4921-9f1c-355147528b80",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-16T05:33:01.2302319+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.