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": "8ff068c8-667f-4115-9014-cbce1d5194d4",
"jobs_id": "d9457162-58a8-40c8-bc7e-87b8a143eb72",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "48093f8c-94ee-4680-92b1-019392dee9d9",
"_parent_id": "0e84a31b-99d3-4c50-a0f3-1a1709cb0620",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ff88f82d-7bb3-4c86-a6f4-086bf5a82e7f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "34e91efe-955a-401c-bc7d-f4ca6317b972",
"_parent_id": "39883b78-031c-49db-a5eb-290d819e5346",
"root_parent_id": "47725318-8b5a-4c0a-a457-0c894fcf369e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b097b5b9-5aca-46d5-b980-834f31ece977",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "31bd38ef-df5d-49c4-ad65-9f4192040c8c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e133fc5c-c2a1-4b30-974b-8d31e0fc53c9",
"_parent_code": "sample string 6",
"sales_organization_id": "158cddf6-5e00-4842-a400-25a930ac4063",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+00:00"
},
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00"
},
"equipment_model_id": "e6e838a1-4730-437a-bef0-8a3070635d74",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ad73bb23-1d29-4794-b1ad-dba490d00ea3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "89933901-d5ef-49c9-9654-5c895e1cf216",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "17f3007e-7ea0-4719-a929-b5df47f1de96",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b678bc4-2e06-45d5-b066-2bc40cdb2bde",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+00:00"
},
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00"
},
"equipment_family_id": "2074ba92-7f32-4963-a3a7-fd69fd08cba8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "31bd38ef-df5d-49c4-ad65-9f4192040c8c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e133fc5c-c2a1-4b30-974b-8d31e0fc53c9",
"_parent_code": "sample string 6",
"sales_organization_id": "158cddf6-5e00-4842-a400-25a930ac4063",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+00:00"
},
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00"
},
"date_in_production_since": "2026-09-27T08:50:59.6268764+00:00",
"date_out_of_production_since": "2026-09-27T08:50:59.6268764+00:00",
"date_end_support": "2026-09-27T08:50:59.6268764+00:00",
"sales_organization_id": "b94dec11-158d-435d-814c-55b7f0b4abf0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+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-27T08:50:59.6268764+00:00"
},
"project_status_id": "6f9a4870-bbce-45e4-8007-d84691d6c00d",
"project_status_code": "sample string 10",
"project_status": {
"id": "b61911ca-07ae-42f5-956a-f5bf91b8555e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fcd2a7be-ba5a-4b96-b6c6-ae737e41675c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00"
},
"company_id": "c024ba0e-866a-4ee0-bde0-6359a859f2f2",
"company_code": "sample string 12",
"db_address_id": "6b0e4ec8-40b8-472c-8051-55f4560cccd4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b4f5184d-4790-4020-b463-0f6750854d29",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eaf0fca3-e25c-40be-81aa-e85de25edb65",
"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-27T08:50:59.6268764+00:00",
"date_create": "2026-09-27T08:50:59.6268764+00:00",
"date_update": "2026-09-27T08:50:59.6268764+00:00",
"updated_by_user_id": "ce147390-1adb-47e2-967d-48b5e51e7bee",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-27T08:50:59.6268764+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-27T08:50:59.6268764+00:00",
"date_last_job": "2026-09-27T08:50:59.6268764+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-27T08:50:59.6268764+00:00",
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00",
"is_mobile_installation": true
},
"job_type_id": "8d2fca4b-655b-4fe4-ba2a-b0348bfa6e48",
"job_type_code": "sample string 7",
"job_type": {
"id": "7c03b49a-10e0-4fd5-bac8-799cb47478e4",
"name": "sample string 2",
"sales_organization_id": "926e1034-abb5-4438-aa0f-a254e1aa8934",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00",
"code": "sample string 7"
},
"job_priority_id": "65c178ba-2f10-475e-aa73-eede601097d6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "070caf8e-a240-4547-a7d8-01e832dc4de1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1e98acc0-0208-498f-aeba-d145537d235d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00"
},
"job_status_id": "c5d9ff38-91b4-42b5-8f32-7fa1772f9c1e",
"job_status_code": "sample string 11",
"db_address_id": "6ebca2f4-bc95-44a0-b0c8-f1e005ed2afe",
"contact_id": "40375599-0fe0-4283-8fa3-5c17086fd570",
"requested_by_company_id": "63022eb7-b018-4319-9657-08e482becf28",
"requested_by_contact_id": "7e9cd7f8-0b66-4afe-8b5a-59fcec59ab5a",
"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-27T08:50:59.6268764+00:00",
"due_date": "2026-09-27T08:50:59.6268764+00:00",
"date_create": "2026-09-27T08:50:59.6268764+00:00",
"date_update": "2026-09-27T08:50:59.6268764+00:00",
"date_closed": "2026-09-27T08:50:59.6268764+00:00",
"suggested_user_id": "784bbcb4-3985-4fc6-b000-5f5a8b02b4e3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "50ee4d28-71e9-40d3-9119-cd6146f1d306",
"db_language_id": "92fa0149-844c-423a-8285-4947236aedb2",
"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-27T08:50:59.6268764+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a6cc7363-9b89-431b-94ce-f7de6d35e0f6",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e80cc6ac-f7bb-4e26-b9d9-b2a5ed3ad331",
"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": "35a62024-affb-45a9-9378-04b6b3ecdfa5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a4a384d5-3674-448e-91ed-c3d5a81864b6"
},
"suggested_date_start": "2026-09-27T08:50:59.6268764+00:00",
"skill_id": "9a36c305-9d60-4d8d-acdf-02bc04ab3020",
"skill_code": "sample string 32",
"skill": {
"id": "b3f242da-51af-4b7a-92bc-632db6b58352",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "56651c79-161e-4234-bb79-b942ff612d60",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7d4f4c35-de92-410c-9168-ac8d3059eb18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94816e00-56b5-4fd8-921f-5c6eecd8041e",
"db_currency_id": "9e114e8e-accd-4756-ad47-fa6c37bb75c0",
"db_language_id": "1a3ff545-1ce3-4dd1-b6b2-d51351e642a9",
"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-27T08:50:59.6268764+00:00"
},
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a0384434-cd32-4563-a34e-733c5f135d2a",
"date_reported_by_company": "2026-09-27T08:50:59.6268764+00:00",
"id2": 36,
"company_id": "766c6c9b-b28d-4d4a-9bb9-f4b4587749d6",
"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": "5a9b025c-79d0-4199-aecf-9b18998a64c1",
"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-27T08:50:59.6268764+00:00"
},
"work_instruction_details_id": "b40bae33-1898-492b-9595-665c0296d6df",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b569f279-3ebe-417a-accd-b3c8be6ce4cc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "56c2d808-58d5-4b22-8e9d-008ffe25fd63",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-27T08:50:59.6268764+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": "c1106ca1-6b84-4cb6-a878-2cef4bbda568",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-27T08:50:59.6268764+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.