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": "68aa00eb-aeb2-48d6-93eb-d2a6af4c7215",
"jobs_id": "5f3a3fde-4ce5-4adb-8b80-34a39266138c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5917de01-a926-464b-aa41-8d925148ef9a",
"_parent_id": "63905fe5-9314-4a18-b03b-754be5e1ae4e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a0a0f7f0-d971-4185-8b1c-8dea2b532700",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6efb8af2-13c6-40d1-93bd-ccfaa1aebd2a",
"_parent_id": "aec4aaf7-246f-4cbd-a89a-7c589cc1b110",
"root_parent_id": "a6e5e434-2719-4990-bd4a-368627c9a6f9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "687e0cc4-748b-4a10-87d2-04aef74d9599",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab40c681-d002-4dbc-be73-cc71566e837a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "39d1d026-ac73-40b9-97b8-d2de99959202",
"_parent_code": "sample string 6",
"sales_organization_id": "18b93650-99dc-4b56-895b-a9e48b12bd04",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+00:00"
},
"modified_dateutc": "2026-11-08T18:41:18.4760654+00:00"
},
"equipment_model_id": "d11f4503-0770-45a3-9f7a-676ce6ddc735",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dead029c-d8d7-4897-8b98-951466f452a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "32ca4235-520e-4861-91f1-da1805b2aacb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c3b69b90-64e0-446e-921f-9b80b2283d00",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ffe3f602-9678-480e-9aaa-c52af377bd0b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+00:00"
},
"modified_dateutc": "2026-11-08T18:41:18.4760654+00:00"
},
"equipment_family_id": "67ea45b1-38e9-470e-8561-745664481e54",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab40c681-d002-4dbc-be73-cc71566e837a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "39d1d026-ac73-40b9-97b8-d2de99959202",
"_parent_code": "sample string 6",
"sales_organization_id": "18b93650-99dc-4b56-895b-a9e48b12bd04",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+00:00"
},
"modified_dateutc": "2026-11-08T18:41:18.4760654+00:00"
},
"date_in_production_since": "2026-11-08T18:41:18.4760654+00:00",
"date_out_of_production_since": "2026-11-08T18:41:18.4760654+00:00",
"date_end_support": "2026-11-08T18:41:18.4760654+00:00",
"sales_organization_id": "a31455d1-ba0c-4189-90a1-751bdcce88f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+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-11-08T18:41:18.4760654+00:00"
},
"project_status_id": "9c985c1a-55ea-49f2-8ad2-2fc2a320cad7",
"project_status_code": "sample string 10",
"project_status": {
"id": "43f22bf8-96a9-4e7e-9d51-9ab20a30afdb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6f240835-e060-47a8-bb00-449b2bc5ad1b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T18:41:18.4760654+00:00"
},
"company_id": "057ed6b4-4dea-4a11-8192-5e64ef6655f4",
"company_code": "sample string 12",
"db_address_id": "af59f579-3112-43b9-8b13-2e521bdf609a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "54fcdf67-f80f-418d-b5f2-1592892a70c4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e54b26b9-afac-4b11-91ea-3fe0230bfa6e",
"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-11-08T18:41:18.4760654+00:00",
"date_create": "2026-11-08T18:41:18.4760654+00:00",
"date_update": "2026-11-08T18:41:18.4760654+00:00",
"updated_by_user_id": "00a08a1a-b6af-4492-b786-c5d383a6d4f4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-08T18:41:18.4760654+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-11-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-08T18:41:18.4923217+00:00",
"date_last_job": "2026-11-08T18:41:18.4923217+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-08T18:41:18.4923217+00:00",
"modified_dateutc": "2026-11-08T18:41:18.4923217+00:00",
"is_mobile_installation": true
},
"job_type_id": "f303467d-d598-4c50-a62f-aba1cbb891dd",
"job_type_code": "sample string 7",
"job_type": {
"id": "78f6faa6-16ed-4161-98d6-6e5678b6996b",
"name": "sample string 2",
"sales_organization_id": "9e0f3867-6e1f-40c3-b82f-8a97eff5bb8d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-08T18:41:18.4923217+00:00",
"code": "sample string 7"
},
"job_priority_id": "7fc0958e-9702-476a-9b4b-520c62641e79",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fd6acfd3-8ea7-4227-8eaa-b117fa814f92",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8d827121-044f-44ee-8ccc-3128d79773e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T18:41:18.4923217+00:00"
},
"job_status_id": "fc7e76f4-f99d-40ce-b345-b2fed575e94d",
"job_status_code": "sample string 11",
"db_address_id": "51e31d06-5223-420b-9ada-23c2e8c1d9ba",
"contact_id": "f59d2e31-aa62-4c7b-9a08-40a54c339f08",
"requested_by_company_id": "9cdec0d6-d7a3-4ade-8500-7e419cfa6313",
"requested_by_contact_id": "8109d022-dd80-4a7b-b845-323deb75f1e0",
"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-11-08T18:41:18.4923217+00:00",
"due_date": "2026-11-08T18:41:18.4923217+00:00",
"date_create": "2026-11-08T18:41:18.4923217+00:00",
"date_update": "2026-11-08T18:41:18.4923217+00:00",
"date_closed": "2026-11-08T18:41:18.4923217+00:00",
"suggested_user_id": "d870ae17-7d91-4a88-b59f-e50630891cea",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b87a69f0-d697-4c2f-83c3-e66392b7bb9c",
"db_language_id": "12772ba0-eef6-4395-99cd-87c5c0702066",
"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-11-08T18:41:18.4923217+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "96aba6ed-bdb6-4d5d-b272-c07225f0c52d",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a4b6b483-73ca-4edd-bafc-6c7548641ba0",
"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": "f44b50bd-d6bc-4918-9a0f-bbd4e49dfb63",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-08T18:41:18.4923217+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ebfec0d8-b236-45a2-a32c-a56d04f2bccf"
},
"suggested_date_start": "2026-11-08T18:41:18.4923217+00:00",
"skill_id": "d4602d6e-b5d6-4955-b24a-ab8cdf8839cb",
"skill_code": "sample string 32",
"skill": {
"id": "d8280cb0-c802-405b-991d-9a623ea51e40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c419671e-e4b3-469c-b4d6-88380fa72f11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e441f790-8289-45a5-b3e2-79d336bb5fa4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64ddd57f-e56b-4ebb-b877-10d61c2ec127",
"db_currency_id": "8810bf3b-e1d6-4a76-a48b-4c1a6a17006b",
"db_language_id": "e4ad19f0-61a2-4b26-926e-0153c16db32d",
"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-11-08T18:41:18.4760654+00:00"
},
"modified_dateutc": "2026-11-08T18:41:18.4923217+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6d639488-39ab-47a0-a023-fe7e42dccc06",
"date_reported_by_company": "2026-11-08T18:41:18.4923217+00:00",
"id2": 36,
"company_id": "62f71183-cf44-48dd-8739-afa31e15a367",
"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": "e7adbea1-99f2-4d4a-bfe5-3bbb3af5bf6b",
"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-11-08T18:41:18.4923217+00:00"
},
"work_instruction_details_id": "5b11679e-9684-4c31-a2a3-1c3a751739ee",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c2e36b3d-540f-422f-8e12-4e41ddcf32bc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "15851d9c-be60-4497-8a32-42ad9831e28c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-08T18:41:18.4923217+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": "f421fb9d-0edf-47a9-9702-014c11b2af23",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-08T18:41:18.4923217+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.