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": "006712a8-6ef2-4ea0-b1e0-3fd12c7deff4",
"jobs_id": "c6829ed7-3ee3-40a0-8966-2b872b407209",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a07806b8-9d99-4b22-8aa1-23c3f8c655cb",
"_parent_id": "ba9bf574-3074-4fc3-adea-db293fff4b37",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e14b8360-37fb-442e-a01b-d2ab14dd2e59",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4c20be29-ee0f-46b9-bf87-cb46b88fff3e",
"_parent_id": "3de24b74-d32f-4379-ad63-5d4025d25ef4",
"root_parent_id": "8bd4897d-f0fd-43a5-9163-84d20db43dfd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dc9af3b4-84e1-4275-b272-06a1e3917acf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ce73326b-6681-484b-a42b-422ddb67ccd4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cbb11bb-65a9-4baf-aea2-b4d00cb066c2",
"_parent_code": "sample string 6",
"sales_organization_id": "677888aa-20ea-4f7e-acc0-db630272bad9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+00:00"
},
"modified_dateutc": "2026-04-18T03:39:42.3458468+00:00"
},
"equipment_model_id": "e8b10fd7-60e3-4f4d-832d-9f5c7ec404c2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "97c1b88f-138d-41db-8d44-38ffd213a290",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b805d0ad-146f-4131-904c-ab316bdef3bb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7006357c-764c-4d6c-99e1-6138be111021",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c92c9f25-8729-4dda-aa11-e01854f71f4b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+00:00"
},
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00"
},
"equipment_family_id": "897f7977-e932-44c1-a449-f1087f3d0d3f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ce73326b-6681-484b-a42b-422ddb67ccd4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cbb11bb-65a9-4baf-aea2-b4d00cb066c2",
"_parent_code": "sample string 6",
"sales_organization_id": "677888aa-20ea-4f7e-acc0-db630272bad9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+00:00"
},
"modified_dateutc": "2026-04-18T03:39:42.3458468+00:00"
},
"date_in_production_since": "2026-04-18T03:39:42.3614682+00:00",
"date_out_of_production_since": "2026-04-18T03:39:42.3614682+00:00",
"date_end_support": "2026-04-18T03:39:42.3614682+00:00",
"sales_organization_id": "f37a4956-90cc-446b-bfc9-2bf64d44e1f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+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-04-18T03:39:42.3614682+00:00"
},
"project_status_id": "47353794-36ae-4e8d-8659-4983c5a761f8",
"project_status_code": "sample string 10",
"project_status": {
"id": "4ccb4148-1f44-457d-8636-4a1bc13476ad",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a3f1587d-3b46-41a4-80de-f4460d3b9fea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00"
},
"company_id": "b7e11187-5a13-4438-83f6-8b2343e10a64",
"company_code": "sample string 12",
"db_address_id": "c55aee2c-6946-4631-a7cd-b44126a7dcfb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b18b4037-2596-46f8-bb6d-0f5201e31357",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4617e8f3-597d-42dd-824e-701d66b4bc58",
"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-04-18T03:39:42.3614682+00:00",
"date_create": "2026-04-18T03:39:42.3614682+00:00",
"date_update": "2026-04-18T03:39:42.3614682+00:00",
"updated_by_user_id": "20b2813a-dee3-4248-affd-624e32a63349",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-18T03:39:42.3614682+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-04-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-18T03:39:42.3614682+00:00",
"date_last_job": "2026-04-18T03:39:42.3614682+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-18T03:39:42.3614682+00:00",
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00",
"is_mobile_installation": true
},
"job_type_id": "d1bcaf1e-8780-4c6e-a210-1f281b916239",
"job_type_code": "sample string 7",
"job_type": {
"id": "702b1034-6c98-48bc-85d6-9ccfa3d5096b",
"name": "sample string 2",
"sales_organization_id": "62321564-09f9-4eef-b064-b3d8e102830c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00",
"code": "sample string 7"
},
"job_priority_id": "2d73bfad-ca0b-42b6-9e85-4be13cd8aed0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e8cbfc32-ea41-40cd-9b53-7879641c63ce",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f8ef3fc4-15c6-435c-9f9b-6032e968664c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00"
},
"job_status_id": "69313aa6-310a-4233-bb07-611ecb90c5e6",
"job_status_code": "sample string 11",
"db_address_id": "bfbb6bbf-685e-45de-86e5-dba50d408558",
"contact_id": "87e28847-3910-4b5a-96fe-211e09d76384",
"requested_by_company_id": "d49c7b45-7220-40a0-9a8d-63cf3a2fddd5",
"requested_by_contact_id": "cc56789c-f976-43f0-a23c-e59c18c1ff46",
"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-04-18T03:39:42.3614682+00:00",
"due_date": "2026-04-18T03:39:42.3614682+00:00",
"date_create": "2026-04-18T03:39:42.3614682+00:00",
"date_update": "2026-04-18T03:39:42.3614682+00:00",
"date_closed": "2026-04-18T03:39:42.3614682+00:00",
"suggested_user_id": "31050c19-c653-4bac-ae23-7b1d3d2e208c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dc00b174-0c23-4f3b-adf9-8a0bcc0ecbda",
"db_language_id": "63c3d549-6ed6-4efb-b15c-4b3c148c0b40",
"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-04-18T03:39:42.3614682+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a2e8b4b3-7002-4631-8028-8ea3fac4ba40",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3086e37f-7218-4290-90f3-e59ef292f9c2",
"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": "207d4464-fb8a-4ebf-9f8c-aa2404bf7b82",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "58bc3092-cc14-44ca-ab06-5af843c1fb6e"
},
"suggested_date_start": "2026-04-18T03:39:42.3614682+00:00",
"skill_id": "48984525-70d2-4270-bc01-7bae58443a53",
"skill_code": "sample string 32",
"skill": {
"id": "b52184f4-edde-4dd4-a120-816752b718bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c236d2bd-5de4-4d3f-b27f-e82b6fe16c9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05765d10-a435-40f7-8a8a-7f2b70fc0346",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86e96b04-9604-430d-bb31-1787ac913bc9",
"db_currency_id": "1c5e3532-217d-4c44-8508-723a25a53179",
"db_language_id": "c9dbe072-b31a-422f-8136-e88d9d89a88d",
"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-04-18T03:39:42.3458468+00:00"
},
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "13fec567-e799-43af-884b-f5436456f822",
"date_reported_by_company": "2026-04-18T03:39:42.3614682+00:00",
"id2": 36,
"company_id": "c5ff16c2-b24b-4246-96c8-baf5846b88e2",
"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": "a60eac20-b448-4bc1-a082-e9d842159501",
"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-04-18T03:39:42.3614682+00:00"
},
"work_instruction_details_id": "35ddf151-684a-4253-9242-46dc25774ca8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7c5871bc-bf29-49ee-9390-2a0b0a116604",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f5ee9f2c-3b30-420d-8883-6df18f934e8a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-18T03:39:42.3614682+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": "3a5fe45f-5866-4a4b-a8e4-dc67792b9381",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-18T03:39:42.3614682+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.