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": "30ddc3b8-44c8-4025-93b8-e63ab820f182",
"jobs_id": "9a990133-ae57-4088-99a2-dc4d0a8a151f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d4af2dc0-783e-43d3-bb2b-18bfd724989a",
"_parent_id": "3b734e88-37b3-40be-be6c-cb1657676866",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d2bc3c06-3afd-4bdb-8049-6f462acb4f51",
"project_reference_back_office": "sample string 5",
"project": {
"id": "66870806-ff01-4dcf-be27-c73fed5ea354",
"_parent_id": "b8cb538a-fe44-4187-9f2c-c759960df0fc",
"root_parent_id": "c64140e7-9ee4-44af-a227-babb6407b647",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b35bae37-fee7-4d21-b869-dd242823c53c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "30bcc9bc-b41a-4a2c-bce4-9e8624b69736",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bdde1e35-9bda-4078-9cdf-f8f4b7bba193",
"_parent_code": "sample string 6",
"sales_organization_id": "9933ed67-d4f5-4c1c-a718-bb8e59bcba66",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+00:00"
},
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00"
},
"equipment_model_id": "5ea87a61-b59e-4dda-8cc3-c9eb6ac96601",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64b9d34e-7b45-4096-bb28-f4f1f9960783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "57a98cee-b160-422a-a011-6382370aac7c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cece72c9-e074-4032-b052-39d348aedc2a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "463714b0-e65e-4611-be8b-22b63ee6d174",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+00:00"
},
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00"
},
"equipment_family_id": "f5db86e6-2169-4a15-a4cf-74db8073b34b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "30bcc9bc-b41a-4a2c-bce4-9e8624b69736",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bdde1e35-9bda-4078-9cdf-f8f4b7bba193",
"_parent_code": "sample string 6",
"sales_organization_id": "9933ed67-d4f5-4c1c-a718-bb8e59bcba66",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+00:00"
},
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00"
},
"date_in_production_since": "2026-09-05T08:01:11.4496475+00:00",
"date_out_of_production_since": "2026-09-05T08:01:11.4496475+00:00",
"date_end_support": "2026-09-05T08:01:11.4496475+00:00",
"sales_organization_id": "7a223e85-87c0-4d8c-abc8-cbc001d1bdfb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+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-05T08:01:11.4496475+00:00"
},
"project_status_id": "29e1b199-4a5c-4c3b-b775-0d568ffae764",
"project_status_code": "sample string 10",
"project_status": {
"id": "b536e22d-06ec-409f-8d22-5c1ba9b9f387",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a5366ccc-34f4-49ab-aa5d-f6d1a423f06d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00"
},
"company_id": "af5b792b-4484-4fd3-be59-f7379832e38c",
"company_code": "sample string 12",
"db_address_id": "e60cf730-948b-4021-9ccd-88c20053a98f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d7ddc317-f38d-442e-8cba-4e2cf210a434",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ac6c9cb3-93e7-4d62-b484-fbb20220f4b9",
"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-05T08:01:11.4496475+00:00",
"date_create": "2026-09-05T08:01:11.4496475+00:00",
"date_update": "2026-09-05T08:01:11.4496475+00:00",
"updated_by_user_id": "b89cf02c-3bcf-4e48-8fac-f9041bc9381a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-05T08:01:11.4496475+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-05T08:01:11.4496475+00:00",
"date_last_job": "2026-09-05T08:01:11.4496475+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-05T08:01:11.4496475+00:00",
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00",
"is_mobile_installation": true
},
"job_type_id": "529cb6ea-e4af-43e1-b287-2823fef3c297",
"job_type_code": "sample string 7",
"job_type": {
"id": "e5371146-15bc-4f03-ba74-75f9c7d548fb",
"name": "sample string 2",
"sales_organization_id": "cf1dc9c8-b4ca-4fe1-8270-0766bb1341dc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00",
"code": "sample string 7"
},
"job_priority_id": "b2bee463-7b6e-4e73-9382-39ab06090a27",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ee414ace-678d-4b0d-ba47-c08d27148742",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a5154a3b-b040-451b-8052-10a23a4b33bc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00"
},
"job_status_id": "80429ffc-d629-49dc-bc1c-bef5fa5251e8",
"job_status_code": "sample string 11",
"db_address_id": "f4e8970c-ce30-416d-9af1-65625b840027",
"contact_id": "16f1f99f-c279-43a6-8b96-0cfd83562eb0",
"requested_by_company_id": "6747a6f4-ed64-423e-a4c3-e26391e5de7c",
"requested_by_contact_id": "2c787d3a-d2b4-4598-b494-1a894764f3f6",
"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-05T08:01:11.4496475+00:00",
"due_date": "2026-09-05T08:01:11.4496475+00:00",
"date_create": "2026-09-05T08:01:11.4496475+00:00",
"date_update": "2026-09-05T08:01:11.4496475+00:00",
"date_closed": "2026-09-05T08:01:11.4496475+00:00",
"suggested_user_id": "9ab31d32-3ae2-47e2-8122-d838c253514b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4cf55bbb-bba3-402e-b0dd-1d6d42caad57",
"db_language_id": "ee685a5b-0ac5-43b2-ae83-2601dce741bd",
"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-05T08:01:11.4496475+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "53c4e951-4ffa-489a-ba4a-6a5b643e06c5",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "08fd529a-8160-455b-b4a3-9e9f7d6fe4c1",
"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": "fa779e32-52ee-47b4-9a21-44b89f1cd699",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f736135e-65ae-4f1d-85c9-98f56c366a9b"
},
"suggested_date_start": "2026-09-05T08:01:11.4496475+00:00",
"skill_id": "9eb03b17-ada5-4546-82e6-64de57e1385c",
"skill_code": "sample string 32",
"skill": {
"id": "30443e85-adfc-401a-8a58-a10bd9c22d02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f6df37ee-720e-4cc5-a9ef-32d89412d8c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f403210-4143-4328-8857-cb90cc96ebd6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50d0d2a1-63e8-4127-92a2-ca09c7fbf4f7",
"db_currency_id": "65ef1a95-fefb-49e6-973a-78cb7bcb80aa",
"db_language_id": "935ae9bb-fc89-47fd-b91a-4f99a67ec996",
"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-05T08:01:11.4496475+00:00"
},
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2f16bd0c-6514-4cd8-bb7c-3684281d7905",
"date_reported_by_company": "2026-09-05T08:01:11.4496475+00:00",
"id2": 36,
"company_id": "4842d4b8-4592-464c-bc02-120a0282f6da",
"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": "7d5c03cd-09c9-4462-99bc-0478889e6f49",
"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-05T08:01:11.4496475+00:00"
},
"work_instruction_details_id": "f714ba9c-85fb-4217-880d-9b22e611d934",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7193b442-ca35-43aa-84d3-f8f38de2869e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cbb67482-ccf3-4842-9994-eb9f2ec2d506",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-05T08:01:11.4496475+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": "cbe02b75-bfa5-4405-aac4-65b0f559d2ca",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-05T08:01:11.4496475+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.