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": "5aecd71e-e0df-4f54-b99f-5a48dec4093f",
"jobs_id": "7f791ccd-aa04-4f30-bc53-c49c11e7f8df",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bd9bf6d8-12e6-4a82-9551-1fd365b7f3e9",
"_parent_id": "7645d48a-1648-4c0e-a7d2-07b85d71dbda",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eb606007-b69b-49fc-92d1-8c7593dea53a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1e98da49-c651-4f04-892a-a87459ea160c",
"_parent_id": "af32b21f-4741-41a0-aaab-c7646f947130",
"root_parent_id": "2da1f09c-0353-4034-83c4-fc8d1a60749b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "76142f53-61ad-4797-bd8a-a4d34725ee95",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e75696a5-2ba0-419e-a556-4afcf5fe4d73",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da1dadcc-91a5-4bf5-98ec-370c3557d033",
"_parent_code": "sample string 6",
"sales_organization_id": "8a8c389e-05ae-4b05-9143-8643b501eaaa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+00:00"
},
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00"
},
"equipment_model_id": "165e2f8d-1c9d-44c3-9ccf-4cc068f58e2b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ce67738f-268a-4c10-8a78-1370a7276693",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "831a2494-998d-49b4-ae22-32d41f0f134f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c4385b87-d008-4fb2-974c-d589d2a014fa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "866b4ff5-f254-4801-a2b4-c589c2d7112b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+00:00"
},
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00"
},
"equipment_family_id": "2304554a-cda3-4521-80e3-fe026ef0c112",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e75696a5-2ba0-419e-a556-4afcf5fe4d73",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da1dadcc-91a5-4bf5-98ec-370c3557d033",
"_parent_code": "sample string 6",
"sales_organization_id": "8a8c389e-05ae-4b05-9143-8643b501eaaa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+00:00"
},
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00"
},
"date_in_production_since": "2026-08-30T04:36:14.6770483+00:00",
"date_out_of_production_since": "2026-08-30T04:36:14.6770483+00:00",
"date_end_support": "2026-08-30T04:36:14.6770483+00:00",
"sales_organization_id": "5df8028b-d90a-49b3-bfbe-0fd1fc42ba9c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+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-08-30T04:36:14.6770483+00:00"
},
"project_status_id": "02d235b3-9dc1-4038-bfa1-b23dfe7befa5",
"project_status_code": "sample string 10",
"project_status": {
"id": "edc5e67c-affd-49d8-944f-378d65c9b324",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3e40d486-d567-461a-ace1-4180952f85a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00"
},
"company_id": "be693cfc-816a-43d0-a422-4852a8aacfcb",
"company_code": "sample string 12",
"db_address_id": "15d1fcd7-a2da-47d9-a879-b3e3ce6f8d2a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a8c0dedf-c753-42bd-8a0d-d9b053b02261",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "19437c68-5e1e-4ddd-a6b8-fe7209e02c0e",
"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-08-30T04:36:14.6770483+00:00",
"date_create": "2026-08-30T04:36:14.6770483+00:00",
"date_update": "2026-08-30T04:36:14.6770483+00:00",
"updated_by_user_id": "3418504b-ce2c-4b44-b936-33b69e5c10c2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-30T04:36:14.6770483+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-08-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-30T04:36:14.6770483+00:00",
"date_last_job": "2026-08-30T04:36:14.6770483+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-30T04:36:14.6770483+00:00",
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00",
"is_mobile_installation": true
},
"job_type_id": "647aab12-b6d5-4154-b0db-c9379b1e2bab",
"job_type_code": "sample string 7",
"job_type": {
"id": "25c43290-e9c4-43da-9d17-1cc31dee88c6",
"name": "sample string 2",
"sales_organization_id": "2b2d16cf-c214-4c61-9084-da2a5c9915c9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00",
"code": "sample string 7"
},
"job_priority_id": "a841f968-c047-44d9-8559-afb1599735d9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "68137d04-f37a-458e-88dd-c473a5f645fc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "da80fc90-d9d7-4289-93c2-e4c9310e9953",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00"
},
"job_status_id": "1e1e0381-e016-4933-8659-f879a0e8dd14",
"job_status_code": "sample string 11",
"db_address_id": "551eed08-2a5a-476d-bc73-95027e74c3d3",
"contact_id": "cf645b5a-0632-4746-bec4-fa3dd4c66fc1",
"requested_by_company_id": "e1ef9de3-76a3-44d7-a808-02f2b49998d7",
"requested_by_contact_id": "a81675cd-1df8-43c4-901c-a1cffe50023d",
"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-08-30T04:36:14.6770483+00:00",
"due_date": "2026-08-30T04:36:14.6770483+00:00",
"date_create": "2026-08-30T04:36:14.6770483+00:00",
"date_update": "2026-08-30T04:36:14.6770483+00:00",
"date_closed": "2026-08-30T04:36:14.6770483+00:00",
"suggested_user_id": "f8fc6574-81a9-4579-a56a-5045c3ddb618",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6b4a8a49-5cea-4d1e-983a-dfae9ad42b42",
"db_language_id": "bdd9db57-2f63-4ac4-8018-a34929301993",
"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-08-30T04:36:14.6770483+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ecce5471-b0fa-496d-8f32-be243ef7ad7c",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4dab63d0-761d-4ea0-aff8-32f827cdb12c",
"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": "8a28cbf7-493a-4bb2-8963-f46fdec28f2d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8de0d97a-9d83-44cb-8d39-352614bb56aa"
},
"suggested_date_start": "2026-08-30T04:36:14.6770483+00:00",
"skill_id": "a6020c78-cf96-4f2e-b02c-85d5bf8e122a",
"skill_code": "sample string 32",
"skill": {
"id": "06b26a59-648c-4924-bafe-4950d0ef64a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d2fdbf5e-1329-4b76-8952-c824879d3b98",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "38b95009-265d-4394-ad63-abff78b2aa44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de1ad79-3119-4dd8-b6e5-51f0e19ec765",
"db_currency_id": "67a6046c-b2b0-40b5-9ba8-1e5ffcdc4d8d",
"db_language_id": "ea2bd031-9967-44eb-8c57-20ae55631107",
"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-08-30T04:36:14.6770483+00:00"
},
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d19005aa-77b2-4d2d-9798-e56499316194",
"date_reported_by_company": "2026-08-30T04:36:14.6770483+00:00",
"id2": 36,
"company_id": "588ced48-a460-4c8b-8227-ca75e14e5a1c",
"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": "fbd724e9-52d1-43f5-a4f5-21833388d243",
"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-08-30T04:36:14.6770483+00:00"
},
"work_instruction_details_id": "23338d53-abd8-4ec9-b6aa-056b7c41b1c1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "24ffcc1f-6032-4552-bcbd-e0ce9bd0a393",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "259c1f4a-74c4-477b-b0a9-f301ae651eff",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-30T04:36:14.6770483+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": "82efffdb-c5b7-4729-b44a-e7e2728f12af",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-30T04:36:14.6770483+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.