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": "25ecd775-a656-48bc-9093-3b3bda8169c0",
"jobs_id": "eef01ba8-02d6-4bc3-917b-3b4d65426956",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d410d6df-aae3-4472-9db3-bff07002f18b",
"_parent_id": "af37c3c2-2b94-48a6-8fea-f57989dea071",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "847db441-07df-456a-8bd2-c67fe7255947",
"project_reference_back_office": "sample string 5",
"project": {
"id": "daa9bbee-0176-4b69-98de-42e2287507e4",
"_parent_id": "765765e5-74cd-4a1b-a4a7-dea7beb6a722",
"root_parent_id": "71876599-2e1c-4546-b947-d90b1ee0acf8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6c832f07-d396-4f4c-bf82-36028576644e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5b73d456-3041-4b3f-b376-007f2a32617f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "77b9e4d5-4bcd-4ff7-8d23-4bb54ac8a58e",
"_parent_code": "sample string 6",
"sales_organization_id": "777624d4-711f-479e-ac1c-6c936f91f27b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+00:00"
},
"modified_dateutc": "2026-10-05T17:28:59.5872361+00:00"
},
"equipment_model_id": "3e507d05-26df-40af-9be7-eb2be5a262e9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "14ed2ce8-d987-4c74-a21e-cabc94a1bf79",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ff46eef5-d16f-46b4-ae18-290f9c0e0885",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7653e266-ccf5-4950-89dc-4cb593f43645",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9cc52623-eb68-472b-adbb-3e439d305fdb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+00:00"
},
"modified_dateutc": "2026-10-05T17:28:59.5872361+00:00"
},
"equipment_family_id": "a30a1eb9-718c-4690-8fa8-6ecc1b66eb9f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5b73d456-3041-4b3f-b376-007f2a32617f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "77b9e4d5-4bcd-4ff7-8d23-4bb54ac8a58e",
"_parent_code": "sample string 6",
"sales_organization_id": "777624d4-711f-479e-ac1c-6c936f91f27b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+00:00"
},
"modified_dateutc": "2026-10-05T17:28:59.5872361+00:00"
},
"date_in_production_since": "2026-10-05T17:28:59.5872361+00:00",
"date_out_of_production_since": "2026-10-05T17:28:59.5872361+00:00",
"date_end_support": "2026-10-05T17:28:59.5872361+00:00",
"sales_organization_id": "12730828-ab94-4450-848a-5615cae378b1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+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-05T17:28:59.5872361+00:00"
},
"project_status_id": "4102341b-173b-4bc2-9861-f97772d136aa",
"project_status_code": "sample string 10",
"project_status": {
"id": "4bee32e3-6a41-4e52-a760-0d351e02c0cb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a512a5af-c056-41c1-875b-9b15b21c2a20",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T17:28:59.5872361+00:00"
},
"company_id": "203dcf25-80f9-4fa5-af85-1eb0ca2bec34",
"company_code": "sample string 12",
"db_address_id": "e004d179-1ba0-46ed-a844-ff220f220a58",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "82ef1be8-b51b-48ff-9239-09fc18b5b86e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5d4f6257-346b-4e40-afd8-271d98ee06e1",
"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-05T17:28:59.5984847+00:00",
"date_create": "2026-10-05T17:28:59.5984847+00:00",
"date_update": "2026-10-05T17:28:59.5984847+00:00",
"updated_by_user_id": "4a35ba4b-fc62-4b42-86f5-e4f0336f3e06",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T17:28:59.5984847+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T17:28:59.5984847+00:00",
"date_last_job": "2026-10-05T17:28:59.5984847+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T17:28:59.5984847+00:00",
"modified_dateutc": "2026-10-05T17:28:59.5984847+00:00",
"is_mobile_installation": true
},
"job_type_id": "ecdbba6b-c08c-495c-a0bf-715f89254825",
"job_type_code": "sample string 7",
"job_type": {
"id": "8384d0ed-0601-4810-ad64-72986a0bd713",
"name": "sample string 2",
"sales_organization_id": "3cc19faa-29c8-485d-8ca1-f1bc828ea943",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T17:28:59.5984847+00:00",
"code": "sample string 7"
},
"job_priority_id": "4aa92cf4-12e4-4d0f-9584-696cd0dca6fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fd78fe58-0a0e-4ebb-84e6-c981deaacd8b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "20fec5df-6d2e-43b6-8545-4d669254666c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T17:28:59.5984847+00:00"
},
"job_status_id": "051514b5-f6b4-4fdc-b87e-fddeed22fa71",
"job_status_code": "sample string 11",
"db_address_id": "b4657384-7803-42e7-b420-5b41074818ed",
"contact_id": "4b432524-a00b-4222-8322-ecb38a91fe9c",
"requested_by_company_id": "20a44a2e-c4fb-44a7-a1a3-9f8e083acc28",
"requested_by_contact_id": "41c04377-1b9c-4268-a918-5d1b85f576c1",
"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-05T17:28:59.5984847+00:00",
"due_date": "2026-10-05T17:28:59.5984847+00:00",
"date_create": "2026-10-05T17:28:59.5984847+00:00",
"date_update": "2026-10-05T17:28:59.5984847+00:00",
"date_closed": "2026-10-05T17:28:59.5984847+00:00",
"suggested_user_id": "e0e7bb53-d66f-47be-8459-032bdc0fb193",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ab83e4d6-01ad-46bb-83a4-65287b757961",
"db_language_id": "c60b3be5-3033-4cda-89d3-19da4791578c",
"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-05T17:28:59.5984847+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0d82594e-0f94-4087-bea0-1d6c4d0c1f67",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5480dc84-d945-469e-8958-ecb4ab1b02bb",
"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": "b3f2cc6c-55e4-47db-a827-96b98d837726",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T17:28:59.5984847+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e78ffd41-2cc4-434b-b0b9-b6bd79497a33"
},
"suggested_date_start": "2026-10-05T17:28:59.5984847+00:00",
"skill_id": "84419d48-2d2d-4d18-9124-9d102b50d664",
"skill_code": "sample string 32",
"skill": {
"id": "3e5e3183-a071-4ab9-8937-54a95ff7bb1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "700f9001-cea4-4049-a921-7b7074938305",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6091b980-605d-4b6d-bd69-0f1f2a4e8e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17ad69de-8c98-4f90-8457-0806a121dfd3",
"db_currency_id": "d9700df8-a1bd-4610-9ced-2a7c571585f1",
"db_language_id": "1781a21e-cbe6-4576-9f77-20d07eff0d4b",
"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-05T17:28:59.5872361+00:00"
},
"modified_dateutc": "2026-10-05T17:28:59.5984847+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e40843ad-32c2-4d95-871c-27e3d5c86194",
"date_reported_by_company": "2026-10-05T17:28:59.5984847+00:00",
"id2": 36,
"company_id": "6f9e4bf8-cc5a-4554-85e0-d324a0739c5c",
"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": "5659e0ec-721a-4479-85e5-a7c5b22850f2",
"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-05T17:28:59.5984847+00:00"
},
"work_instruction_details_id": "0a75a06f-abf4-40f5-b71e-d7d98b01b2a2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "78a2c962-3459-4d64-b839-09008f3c6f5c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fa68fe80-e63d-4c37-bfe4-c9ab23c68c0a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T17:28:59.6165848+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": "bc4c48c2-9e03-4a02-ac14-57d86a255c60",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T17:28:59.6165848+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.