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": "2ce6fbe0-6054-4750-8b6f-04c3de18e177",
"jobs_id": "d57290c4-4044-4cc2-a0d0-951a6d5e76de",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f27246f4-6143-4d23-bc24-2f4bea398d76",
"_parent_id": "41d7d19b-ee08-45f3-aeef-9e9149b96070",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0ea2f914-57a2-4c76-a780-becc93dcc247",
"project_reference_back_office": "sample string 5",
"project": {
"id": "76135459-6155-4d57-9909-9349385513d0",
"_parent_id": "fcabc2e3-7fff-4322-8c9b-b3a21f5a9bb6",
"root_parent_id": "5a2ef956-72dc-4cc1-9bbe-9a9f8d95d231",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "834d196a-5254-4281-a94f-0136dbd81994",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d3877e9b-ac7b-4a14-aeb5-913ef8c27eae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "61a7a07c-7312-4e23-b85c-eb9bb4763190",
"_parent_code": "sample string 6",
"sales_organization_id": "cc7ee5ed-94aa-4fa2-9ab1-e2c61f30ab58",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+00:00"
},
"modified_dateutc": "2026-10-11T11:49:26.8240358+00:00"
},
"equipment_model_id": "042c4517-416c-4af5-920b-14f19ff285eb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f33e4453-3763-4a8e-a51c-df4a324d6fc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4d02400f-778b-4434-a416-ea5a57e02640",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dc4910f2-2b52-49b7-9702-a8016fb98559",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "322c94ac-3d73-402e-b3f9-470a6bf3eec8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+00:00"
},
"modified_dateutc": "2026-10-11T11:49:26.8240358+00:00"
},
"equipment_family_id": "cdf8f204-d034-44a9-b8c7-097795d4d388",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d3877e9b-ac7b-4a14-aeb5-913ef8c27eae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "61a7a07c-7312-4e23-b85c-eb9bb4763190",
"_parent_code": "sample string 6",
"sales_organization_id": "cc7ee5ed-94aa-4fa2-9ab1-e2c61f30ab58",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+00:00"
},
"modified_dateutc": "2026-10-11T11:49:26.8240358+00:00"
},
"date_in_production_since": "2026-10-11T11:49:26.8240358+00:00",
"date_out_of_production_since": "2026-10-11T11:49:26.8240358+00:00",
"date_end_support": "2026-10-11T11:49:26.8240358+00:00",
"sales_organization_id": "8a3882e7-62ce-4f22-b878-6e12148fdaa7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+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-11T11:49:26.8405869+00:00"
},
"project_status_id": "5f43f4f7-7126-4da9-8f19-b1e81fc4ea0a",
"project_status_code": "sample string 10",
"project_status": {
"id": "d54e128b-6f4f-4e74-b7e2-3a4529f3ee1c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dd6d2836-6403-4fc8-bb0f-fb628a7ccf26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-11T11:49:26.8405869+00:00"
},
"company_id": "443b6f8a-3e9a-427f-8fa6-eb8a79a6dcf1",
"company_code": "sample string 12",
"db_address_id": "1c1e75b9-cb12-43be-b907-b614dd697189",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bab04c71-b048-43bd-ac92-9e309b76dc3d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e600e1b8-9ad7-4b02-9128-a82a37e33f18",
"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-11T11:49:26.8405869+00:00",
"date_create": "2026-10-11T11:49:26.8405869+00:00",
"date_update": "2026-10-11T11:49:26.8405869+00:00",
"updated_by_user_id": "36ccbcfc-bee4-4c7a-ba91-e4113993bd19",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-11T11:49:26.8405869+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-11T11:49:26.8405869+00:00",
"date_last_job": "2026-10-11T11:49:26.8405869+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-11T11:49:26.8405869+00:00",
"modified_dateutc": "2026-10-11T11:49:26.8405869+00:00",
"is_mobile_installation": true
},
"job_type_id": "4ce72f36-eff7-47da-a3f6-2d5ff754ada6",
"job_type_code": "sample string 7",
"job_type": {
"id": "4b374f71-c05a-4445-a915-63eaa738b996",
"name": "sample string 2",
"sales_organization_id": "dad10af0-c3bf-4f03-a460-7453e9533a7d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-11T11:49:26.8405869+00:00",
"code": "sample string 7"
},
"job_priority_id": "7d2ae9c9-ec7d-4661-a26a-5415a27680c6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "13f8163c-e9a2-4acf-9048-4e212587fb56",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4c90f037-d3a6-4f32-aeaa-76edbfdc6fe7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-11T11:49:26.8405869+00:00"
},
"job_status_id": "28b790b2-ae23-41d1-b0c1-36cec39c2d25",
"job_status_code": "sample string 11",
"db_address_id": "44c96914-63dc-41a4-8cff-0bb847a19ab8",
"contact_id": "2895ddcf-7045-4747-ae75-57035b8724b9",
"requested_by_company_id": "d7b54ab5-d203-4379-9784-c30b3ee36de9",
"requested_by_contact_id": "62f22ca6-849c-40dc-b1a0-49476abb9980",
"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-11T11:49:26.8405869+00:00",
"due_date": "2026-10-11T11:49:26.8405869+00:00",
"date_create": "2026-10-11T11:49:26.8405869+00:00",
"date_update": "2026-10-11T11:49:26.8405869+00:00",
"date_closed": "2026-10-11T11:49:26.8405869+00:00",
"suggested_user_id": "7e287b5b-07b5-4c32-a347-31b76c0ba87d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3b314b59-a0ba-4415-a08d-e1cb7f012c8c",
"db_language_id": "59b8eb72-5242-4d14-ab40-48f52d6e1f63",
"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-11T11:49:26.8405869+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "59c4c95b-380d-46ce-9f01-93f29ff88339",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0e795f1a-cebf-41f6-b73a-43ae2b0ce4e9",
"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": "92789e4f-dfcd-4c1a-9390-194d1a8769ca",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-11T11:49:26.8405869+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "114156a1-fab5-49a9-91de-ae50b12f59a3"
},
"suggested_date_start": "2026-10-11T11:49:26.8405869+00:00",
"skill_id": "9bd1984c-6852-46ee-ad2d-86b530af282a",
"skill_code": "sample string 32",
"skill": {
"id": "33ba6ba7-848b-4287-97b6-11ead44a712a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d26b5222-08e1-43c4-821f-a841044c5eba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f69eda15-b809-4027-95a7-34b3e8a21ca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "925daf11-8de4-4a31-b615-9b1546401c67",
"db_currency_id": "38f40f5e-c0cf-4b10-abd7-6e76f1640fd5",
"db_language_id": "ada9334c-10f4-4236-9f27-84526781778b",
"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-11T11:49:26.8240358+00:00"
},
"modified_dateutc": "2026-10-11T11:49:26.8405869+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "33c33a25-60d0-4ca1-a573-17ad55cfeca7",
"date_reported_by_company": "2026-10-11T11:49:26.8405869+00:00",
"id2": 36,
"company_id": "154afa40-6b66-48cb-85cc-3b055951bb26",
"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": "6e01a5ac-f5d4-4718-8108-3f8cc078d3ef",
"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-11T11:49:26.8405869+00:00"
},
"work_instruction_details_id": "4a42b11e-6154-4824-a8ef-e69945fc1b0c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c9a93608-78f2-472d-be20-ba5ad4c37dc0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "01f20031-3f72-400a-86bd-c6e6c3c83877",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-11T11:49:26.8405869+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": "660c8d80-ea55-41b8-8d3c-2a8868357177",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-11T11:49:26.8606386+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.