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": "f53ef6d7-204d-45da-b8e3-e80f51f9bc6d",
"jobs_id": "983440b4-cf3d-4f68-ba6d-3fdc5fbbbe4d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d7b7f1a8-cb41-409e-b3cf-8cca7d9b2519",
"_parent_id": "5fbf118f-26a3-4d49-91cd-f51e92658eed",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "27e119ed-a325-43ee-bb3e-879bfe5968fb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dff05fbc-c4fc-4494-ba4a-611c009d9ec7",
"_parent_id": "9d7a3f13-b6c5-43bf-8196-8d1079404fe1",
"root_parent_id": "e29cfea0-35d1-499f-aed8-fb3a9d9cda26",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "95b28565-04a3-4718-bb7c-a0c926395e29",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "28097beb-634e-4914-be05-0f5107039e64",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fff26069-757e-4b89-8e98-ab7764cee3a9",
"_parent_code": "sample string 6",
"sales_organization_id": "b5387b3f-0ec5-4df3-8f00-1cc0f657e4bb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+00:00"
},
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00"
},
"equipment_model_id": "5710fb7e-dc3a-4745-96d0-2500ff1f21d8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e41231c5-4d86-4d4f-a690-4c9053347935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cd5e7bd5-3823-4aa6-85fd-d2fbeb5620da",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0835f75c-aa6d-45ac-8efc-0d429f6a329d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4c369f96-3cbc-4bd7-abf2-822bce16d323",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+00:00"
},
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00"
},
"equipment_family_id": "10ba0c4f-27d8-408f-b619-3581a76185ff",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "28097beb-634e-4914-be05-0f5107039e64",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fff26069-757e-4b89-8e98-ab7764cee3a9",
"_parent_code": "sample string 6",
"sales_organization_id": "b5387b3f-0ec5-4df3-8f00-1cc0f657e4bb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+00:00"
},
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00"
},
"date_in_production_since": "2026-09-26T07:13:42.7391331+00:00",
"date_out_of_production_since": "2026-09-26T07:13:42.7391331+00:00",
"date_end_support": "2026-09-26T07:13:42.7391331+00:00",
"sales_organization_id": "3f0dd5ef-3935-4101-ac9c-302c88680fb0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+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-09-26T07:13:42.7391331+00:00"
},
"project_status_id": "fad3ab42-2541-4ad1-ada9-d3d77efda60e",
"project_status_code": "sample string 10",
"project_status": {
"id": "50edece8-ff5f-47be-855d-80a73e992797",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a8f5fcce-e581-45c2-8dfe-ac31b338aed8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00"
},
"company_id": "7c6d55c3-7372-4412-8089-0c92366531c1",
"company_code": "sample string 12",
"db_address_id": "a36792f6-e8ce-4ec4-9a68-75ecaadd2818",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "748acf8a-be81-4b33-bcdc-c1620f56d343",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7b31f9fc-9763-4377-ac60-4d067ed3718e",
"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-09-26T07:13:42.7391331+00:00",
"date_create": "2026-09-26T07:13:42.7391331+00:00",
"date_update": "2026-09-26T07:13:42.7391331+00:00",
"updated_by_user_id": "07ff3746-d999-48e1-86dc-13a76510aab5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-26T07:13:42.7391331+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-09-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-26T07:13:42.7391331+00:00",
"date_last_job": "2026-09-26T07:13:42.7391331+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-26T07:13:42.7391331+00:00",
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00",
"is_mobile_installation": true
},
"job_type_id": "b203c716-47e2-4c43-b37b-cac54a2c6489",
"job_type_code": "sample string 7",
"job_type": {
"id": "2591917e-7e59-4041-8feb-415d3be78848",
"name": "sample string 2",
"sales_organization_id": "0f4c4e71-19e2-4433-b6b3-dc6fafdb9d51",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00",
"code": "sample string 7"
},
"job_priority_id": "73bc95c7-2e10-4c39-928e-fb7edef58d2d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "359afffb-274f-45f9-9952-f882123a4069",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "13b0dd1f-4de0-4b75-b0d4-f9f533bc3656",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00"
},
"job_status_id": "9b1845aa-f5a8-4586-a848-a5c7bbd052e9",
"job_status_code": "sample string 11",
"db_address_id": "25ee25b4-29ff-438a-a68a-4c830f59365f",
"contact_id": "8978690e-4c86-4517-8809-c9f6f8bd8a88",
"requested_by_company_id": "89fd9990-9116-42e3-a635-7d38cc1757a3",
"requested_by_contact_id": "40e5544a-ed22-4c71-b03d-38c77cff8ce8",
"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-09-26T07:13:42.7391331+00:00",
"due_date": "2026-09-26T07:13:42.7391331+00:00",
"date_create": "2026-09-26T07:13:42.7391331+00:00",
"date_update": "2026-09-26T07:13:42.7391331+00:00",
"date_closed": "2026-09-26T07:13:42.7391331+00:00",
"suggested_user_id": "dd332606-667f-4eaa-a2e4-c3a39831e1ae",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c5eae64e-ac54-4416-b581-523c3745830b",
"db_language_id": "2e99d921-28d1-48e4-9ddd-413a0e63d956",
"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-09-26T07:13:42.7391331+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "10dc2b53-7684-4096-8f2d-ce598d71c3e4",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a28a475-0bb1-4a13-874d-0fcc86e3f781",
"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": "828a182d-a88a-43fb-8893-126995945122",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5fdfe078-80b1-453a-b4c1-c939634090e9"
},
"suggested_date_start": "2026-09-26T07:13:42.7391331+00:00",
"skill_id": "3a817208-e2e6-48ff-bcf3-0581b8f44ec9",
"skill_code": "sample string 32",
"skill": {
"id": "b16898fb-8ca4-4214-8a68-0261792b8efe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1e432718-1c49-43ee-908b-8323ecdac3bd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40d1f9d8-b052-4b23-9907-6d7842c54b0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2611e1b0-150a-4425-b71e-2fbe084a49d5",
"db_currency_id": "052fcbb1-2a6a-45c5-a8f9-224a02d9cc3d",
"db_language_id": "7ebe6d77-6181-4782-b6e7-5f5ee9873d6c",
"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-09-26T07:13:42.7391331+00:00"
},
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f99b3e1d-c5bf-47a1-9639-3c2bab9d76fd",
"date_reported_by_company": "2026-09-26T07:13:42.7391331+00:00",
"id2": 36,
"company_id": "606be199-fc8d-4303-9f7a-2c9946905e04",
"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": "9a99b02a-2fc3-470b-8d01-6265b022337b",
"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-09-26T07:13:42.7391331+00:00"
},
"work_instruction_details_id": "f7b4a4a1-ea03-4cc9-afdc-3091e85c3fd4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4904d944-9eb1-49c7-8bd3-dc333b0812dc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "09108e65-d668-4a4d-9873-2ea93109a95a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-26T07:13:42.7391331+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": "8f23d996-6c38-4983-b6c0-3a68cc164cac",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-26T07:13:42.7391331+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.