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": "e4b2f45f-ab49-4376-a0f9-c9943126461e",
"jobs_id": "b239e407-f791-4cc9-a8aa-2f113e7e9e11",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b32a3dea-787e-4d83-a86a-0240e475aebe",
"_parent_id": "9d84b51c-6cae-4578-b0b3-fd7cb74d168b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1fed8675-9938-4691-9695-82b40dd33790",
"project_reference_back_office": "sample string 5",
"project": {
"id": "96c2b947-8770-45e5-8e40-9accfaa21a4c",
"_parent_id": "7f335aa6-c084-4cf6-9249-ff7c3832fbe7",
"root_parent_id": "3c9bc690-4167-406c-b21e-7156d5f23b98",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c061cc56-b2b8-4ebe-8992-f93548c73d5c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4e7100a3-dfb6-4cbe-9a00-4f51eb79feb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c4629a2d-7e65-436f-b14f-08f98bbe6983",
"_parent_code": "sample string 6",
"sales_organization_id": "ac8f2cc2-f41c-4145-ac59-2625b9bc5aa5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+00:00"
},
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00"
},
"equipment_model_id": "6e73fc21-423b-4276-8254-730e08ed4e3d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "417d34f0-eb31-45c3-8736-0bb95b0b5363",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9f309e7e-2180-4f01-b10c-f979df29473a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6c01d46a-e551-423c-b4a2-b59241131aa4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "09f2cb16-c4d6-49b1-8b4e-de20679cbd8a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+00:00"
},
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00"
},
"equipment_family_id": "18ddfbd4-4f5a-4e2b-902c-d46b891443b3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4e7100a3-dfb6-4cbe-9a00-4f51eb79feb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c4629a2d-7e65-436f-b14f-08f98bbe6983",
"_parent_code": "sample string 6",
"sales_organization_id": "ac8f2cc2-f41c-4145-ac59-2625b9bc5aa5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+00:00"
},
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00"
},
"date_in_production_since": "2026-10-14T05:36:09.7484676+00:00",
"date_out_of_production_since": "2026-10-14T05:36:09.7484676+00:00",
"date_end_support": "2026-10-14T05:36:09.7484676+00:00",
"sales_organization_id": "29595f5f-994a-4201-b4ef-d3997c9adf0e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+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-14T05:36:09.7484676+00:00"
},
"project_status_id": "b5394a4c-7f79-4b13-b8bc-7dfd81a16cf9",
"project_status_code": "sample string 10",
"project_status": {
"id": "ad643d6c-197e-4139-bcbe-50f6cd261070",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3523a90f-36f9-4da0-9e0b-66a4bb848db5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00"
},
"company_id": "e5df8d7e-d56f-471b-9114-a5851d3949e7",
"company_code": "sample string 12",
"db_address_id": "97bc6385-12ec-46b3-bd06-b61d9ede5f3e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b25fe012-1e23-478f-98ab-cb42b2f0af6e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "287d1b43-53ac-449c-a5e8-d90958bb7a76",
"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-14T05:36:09.7484676+00:00",
"date_create": "2026-10-14T05:36:09.7484676+00:00",
"date_update": "2026-10-14T05:36:09.7484676+00:00",
"updated_by_user_id": "a72bed53-479f-41b1-9b8e-b49dedd5e51e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-14T05:36:09.7484676+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-14T05:36:09.7484676+00:00",
"date_last_job": "2026-10-14T05:36:09.7484676+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-14T05:36:09.7484676+00:00",
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00",
"is_mobile_installation": true
},
"job_type_id": "df7eb981-62af-40c8-9bcf-d28cad1853c3",
"job_type_code": "sample string 7",
"job_type": {
"id": "3a62ab4e-7e72-4bf6-8f90-cd25080271d7",
"name": "sample string 2",
"sales_organization_id": "5fd72c7b-b13f-4934-ab24-64cf3a4d5a1c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00",
"code": "sample string 7"
},
"job_priority_id": "117e97f9-12e6-45fa-a84e-171a4b5a8e71",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5dcc87ac-cfc4-48bf-a4ef-c87a993c1961",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "973190fe-9b61-4c6c-acb0-c52082494eab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00"
},
"job_status_id": "fbaf547c-fc7c-46a6-a2d2-58a5d3aa9f86",
"job_status_code": "sample string 11",
"db_address_id": "f45bde95-e315-4b75-bd72-e739701563a7",
"contact_id": "0ef532f7-3058-4430-ac28-a17e9d811e59",
"requested_by_company_id": "16826185-447d-4143-9ee7-9b6f0667cbaf",
"requested_by_contact_id": "adb53bd4-4ba2-400f-8b56-8eb22ea9c88a",
"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-14T05:36:09.7484676+00:00",
"due_date": "2026-10-14T05:36:09.7484676+00:00",
"date_create": "2026-10-14T05:36:09.7484676+00:00",
"date_update": "2026-10-14T05:36:09.7484676+00:00",
"date_closed": "2026-10-14T05:36:09.7484676+00:00",
"suggested_user_id": "8ef277cf-4040-4030-8807-a3c259965171",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a94ea5e0-f0af-4d47-af0e-3c8c55ef4ce1",
"db_language_id": "d7161d7a-bab4-448c-921e-627cfa2982c3",
"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-14T05:36:09.7484676+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0801f49a-a162-4257-affe-04002ddc2c00",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4bba8d41-9344-481a-b7d0-e4bbe179694a",
"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": "4bd715d8-49c3-4fae-a612-46d3342c6d8d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ca146535-428f-46ea-9dbe-6f9a1bc62f4a"
},
"suggested_date_start": "2026-10-14T05:36:09.7484676+00:00",
"skill_id": "932e41d9-433d-4604-b635-f870600f9f5d",
"skill_code": "sample string 32",
"skill": {
"id": "0ffdde27-22f1-4263-accc-2b2388404e6d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e3569ab8-f596-4b86-8bf2-6aad0bb48998",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "75f43c51-7a2b-4012-8764-e4081a36e1e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e166c8fd-8a13-4b39-b06b-42ac537e54ab",
"db_currency_id": "452d8ac3-0df9-4576-9b3b-0b06d83ac964",
"db_language_id": "2520e77a-b9d5-4aa8-aaec-b6cec8ed87c6",
"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-14T05:36:09.7484676+00:00"
},
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bc8c31f5-0677-4da5-a498-df390459b92b",
"date_reported_by_company": "2026-10-14T05:36:09.7484676+00:00",
"id2": 36,
"company_id": "3408d466-032a-48e4-8430-1f3be710d327",
"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": "f66021c9-e2da-4924-a543-504bfe3a9f68",
"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-14T05:36:09.7484676+00:00"
},
"work_instruction_details_id": "df9ee088-fdb0-4ee7-b4fc-3f70a85b5066",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1ffcf005-7c5d-4a6d-98ec-871f0042d977",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9ffc3e1b-fc31-4360-b8b9-df01dd753bdc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-14T05:36:09.7484676+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": "6098367e-511e-40d0-b031-7f16ad710c12",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-14T05:36:09.7484676+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.