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": "8e00d97a-2816-4697-94d9-3472c689027b",
"jobs_id": "038236d9-1c5e-4069-b0f9-c166c0fa93d7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9094a91c-ba02-48e1-8e2b-7471f0eea2de",
"_parent_id": "b624fdbe-e7bc-4a5e-925d-3c2b8512bf37",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "239ca3c5-47d8-4536-984b-f23b6fcb9233",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bef20303-0cb1-4af5-a212-249a493be1be",
"_parent_id": "2d8ca309-a298-4e27-b6a4-d6bd1d44da1b",
"root_parent_id": "9dc67219-7d37-4084-95fc-a26a81ca93dd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b2e7a9a2-6e73-43c7-ad17-6ec4fe412492",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "78a21e63-d60e-4c0c-a8dc-816e0e5b2d63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67cd1d7e-b4aa-4ce4-b315-6d6b8f7db843",
"_parent_code": "sample string 6",
"sales_organization_id": "d572c752-2bf3-48d3-959a-19b0bb352677",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+00:00"
},
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00"
},
"equipment_model_id": "5fc249e2-03e5-4ab5-aa8c-aec059c648a8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e629a67c-08d6-4d85-9ff6-34c352d78e2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b36a65e1-8250-47d0-b818-fd1c30dd236b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c62201a9-3fd5-4794-acca-4d7d3abd1552",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "011283e3-839e-417c-b51a-dda20c54d565",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+00:00"
},
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00"
},
"equipment_family_id": "f2f4f2ef-9d4c-40ac-b813-66b9953aeb78",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "78a21e63-d60e-4c0c-a8dc-816e0e5b2d63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67cd1d7e-b4aa-4ce4-b315-6d6b8f7db843",
"_parent_code": "sample string 6",
"sales_organization_id": "d572c752-2bf3-48d3-959a-19b0bb352677",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+00:00"
},
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00"
},
"date_in_production_since": "2026-05-09T19:23:35.4483618+00:00",
"date_out_of_production_since": "2026-05-09T19:23:35.4483618+00:00",
"date_end_support": "2026-05-09T19:23:35.4483618+00:00",
"sales_organization_id": "69f2f79c-0b14-42b4-b141-827bd0b33b37",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+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-05-09T19:23:35.4483618+00:00"
},
"project_status_id": "ed46b401-cbfe-49e7-982a-5482f884ef12",
"project_status_code": "sample string 10",
"project_status": {
"id": "f4aaa30a-f874-4b68-82b2-67ad627af4a4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5fd2ab3c-24ed-4c4b-8b22-6ef9b273e98e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00"
},
"company_id": "8fa93876-ee70-4452-8e53-bfd67fc52204",
"company_code": "sample string 12",
"db_address_id": "beefe154-d43c-4166-b061-138f1700014b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8f4cd0d5-3a44-44ff-82a1-be1913a927a5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9f79fcf8-748a-4399-bb45-ba7d154dd1c1",
"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-05-09T19:23:35.4483618+00:00",
"date_create": "2026-05-09T19:23:35.4483618+00:00",
"date_update": "2026-05-09T19:23:35.4483618+00:00",
"updated_by_user_id": "547b20f7-0075-4e7f-8661-8a67715d9151",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-09T19:23:35.4483618+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-05-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-09T19:23:35.4483618+00:00",
"date_last_job": "2026-05-09T19:23:35.4483618+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-09T19:23:35.4483618+00:00",
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00",
"is_mobile_installation": true
},
"job_type_id": "123267db-64ca-4181-b53b-b53278d784d7",
"job_type_code": "sample string 7",
"job_type": {
"id": "772d02ae-aa9d-46ac-a935-89df3f8bdae6",
"name": "sample string 2",
"sales_organization_id": "dfe2644e-528a-4159-bf13-0ab7976b55b3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00",
"code": "sample string 7"
},
"job_priority_id": "3706cca9-b593-49a4-b3b5-627abfad3b0f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7a3cdca6-f3f0-4edb-97c2-cac9143804cf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f2b0d450-404a-4f67-89a4-419e19ec8373",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00"
},
"job_status_id": "ff9ba507-8e65-4afa-9dbb-1047d0651b8e",
"job_status_code": "sample string 11",
"db_address_id": "19991e90-2ace-4bd9-aee7-49263311800e",
"contact_id": "7ad40b6f-be37-494a-b328-45f8dee99f03",
"requested_by_company_id": "2d6c42dc-e330-4d89-8c89-0685ee797f1b",
"requested_by_contact_id": "6c17562d-7b0d-4b57-b53e-a9b397dcdbcf",
"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-05-09T19:23:35.4483618+00:00",
"due_date": "2026-05-09T19:23:35.4483618+00:00",
"date_create": "2026-05-09T19:23:35.4483618+00:00",
"date_update": "2026-05-09T19:23:35.4483618+00:00",
"date_closed": "2026-05-09T19:23:35.4483618+00:00",
"suggested_user_id": "c491dcb4-7958-49a4-b974-c5f135a6ab71",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b2e88e5b-e69b-42b9-8e09-8234d31ed8ba",
"db_language_id": "354ca559-30fe-4901-87ed-074e08a3f0ef",
"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-05-09T19:23:35.4483618+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "238de797-5285-4560-a4c2-ff7e418882ff",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2002d9fb-4256-4d94-8e26-7e46d7f96c0a",
"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": "5ec17c9b-d0b1-4692-8da7-117027ce27ee",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2d6972b3-5fe5-49c9-b5a2-6cd29dbc2719"
},
"suggested_date_start": "2026-05-09T19:23:35.4483618+00:00",
"skill_id": "30bd1cb2-fb25-431f-b305-0eca0b78cf51",
"skill_code": "sample string 32",
"skill": {
"id": "e8f5fc75-2d35-4450-8801-0e6e93674d19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "29e86646-9323-4ad2-bf4e-acac7af29c38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1b2686b6-911a-458e-9752-c230ddde07e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e0c22c7-ef9d-4de4-bc4e-4a792e82a275",
"db_currency_id": "08f99c41-7ff4-412b-938c-f002fc7f930e",
"db_language_id": "65b38c09-778a-4e8a-a1f1-0e160e5ba8da",
"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-05-09T19:23:35.4483618+00:00"
},
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "76faa543-ffde-4e30-9458-5accb0eb0528",
"date_reported_by_company": "2026-05-09T19:23:35.4483618+00:00",
"id2": 36,
"company_id": "07389f52-d099-4211-b8b1-d40305342edc",
"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": "4dc280a9-f763-4dc2-aea7-861deb1a727d",
"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-05-09T19:23:35.4483618+00:00"
},
"work_instruction_details_id": "ca3e7f03-abba-4fe1-8b00-58740b825356",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dfcd9385-745e-4537-8163-8d4277126187",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c96888f2-6e37-4d2c-9cd4-3cdb71210860",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-09T19:23:35.4483618+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": "c5c34303-e9c0-4018-b284-eae47f26e9af",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-09T19:23:35.4483618+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.