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": "34c01d64-b001-400d-945a-0d87479efce1",
"jobs_id": "b7d01aa1-51e3-4616-a3cc-95fe3e12a92e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4b781841-da27-4e87-b9e7-67d556421cfe",
"_parent_id": "2b53bf46-d9a9-4019-8763-723ea273aeca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eee3ec78-a11d-449a-b076-4e52ffaf8b97",
"project_reference_back_office": "sample string 5",
"project": {
"id": "27763919-20dd-4386-8325-c72a744883d6",
"_parent_id": "c17696c7-bdb5-4f3c-b7a2-52307ace1803",
"root_parent_id": "9b17076b-04e3-468f-9a57-9cc2a59b0a24",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "af2aa863-6ef0-41f3-b90a-2ff8109b9a99",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "74d79798-f515-46de-a3bf-f951011412eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc4a49ac-8898-4bcb-8e25-c0194f1f97de",
"_parent_code": "sample string 6",
"sales_organization_id": "17f34e4f-bc94-4281-b93e-8ec19628f4aa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+00:00"
},
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00"
},
"equipment_model_id": "278fe531-f307-4fa4-8c7f-5112278f1a38",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "324edc4f-8765-47e6-891d-c03aff6e4a22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8aece176-4385-4324-b7da-f4dae30284cd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a91a4ff6-eda3-498d-907a-ebd0c0bdbf15",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "41c93d7e-f19e-491a-b8e4-a923dfe39bda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+00:00"
},
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00"
},
"equipment_family_id": "4bd19e1b-81f5-4c19-a17f-74794b10e568",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "74d79798-f515-46de-a3bf-f951011412eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc4a49ac-8898-4bcb-8e25-c0194f1f97de",
"_parent_code": "sample string 6",
"sales_organization_id": "17f34e4f-bc94-4281-b93e-8ec19628f4aa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+00:00"
},
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00"
},
"date_in_production_since": "2026-03-25T13:46:25.2677666+00:00",
"date_out_of_production_since": "2026-03-25T13:46:25.2677666+00:00",
"date_end_support": "2026-03-25T13:46:25.2677666+00:00",
"sales_organization_id": "2e855457-5808-445e-bfc0-91659e0b4d2c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+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-03-25T13:46:25.2677666+00:00"
},
"project_status_id": "21e47cde-2ced-4c45-a32a-1e6ad8ff71dc",
"project_status_code": "sample string 10",
"project_status": {
"id": "226e4786-007c-40b0-abba-7b2ab969a02f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "927a47dd-7f74-47e3-aada-1948d682ae53",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00"
},
"company_id": "4e3c49f4-3484-40dc-97dc-e6b1c3cea9d0",
"company_code": "sample string 12",
"db_address_id": "7e8e053b-ff31-4ac2-960a-b6790f140bc3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8f972ec9-2209-4939-804c-f59d86f08c96",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dd115897-0e27-4f38-856d-4cd6080dad8a",
"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-03-25T13:46:25.2677666+00:00",
"date_create": "2026-03-25T13:46:25.2677666+00:00",
"date_update": "2026-03-25T13:46:25.2677666+00:00",
"updated_by_user_id": "4c497091-6a12-4189-9cd1-dbd647dd43c7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-25T13:46:25.2677666+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-03-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-25T13:46:25.2677666+00:00",
"date_last_job": "2026-03-25T13:46:25.2677666+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-25T13:46:25.2677666+00:00",
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00",
"is_mobile_installation": true
},
"job_type_id": "25b644b4-f5e7-444c-af3b-c2fbfc4460cf",
"job_type_code": "sample string 7",
"job_type": {
"id": "b173224c-9ae8-4c39-915d-634f9de77a7a",
"name": "sample string 2",
"sales_organization_id": "0a277ed1-3ff7-41e3-9ab7-02cf38f57ea0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00",
"code": "sample string 7"
},
"job_priority_id": "c0ff6e8b-a139-4159-affa-2fa0bdf0bccf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3d6ef9b9-20f3-47f3-8555-892f14bda6ff",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f880631d-88ef-4c3f-be3e-765b51f55b11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00"
},
"job_status_id": "92f15a88-04ea-47db-a005-01547987ed7e",
"job_status_code": "sample string 11",
"db_address_id": "12cb9ea5-747b-4d1c-8cf5-1ca27101cc35",
"contact_id": "79df16cb-47a4-49ea-9761-20fb087fc20b",
"requested_by_company_id": "be96d7a2-1ba6-4619-bbf5-a4c0cd9d11ab",
"requested_by_contact_id": "f96decfd-a4d3-4d4d-86b7-0e9c0ff74990",
"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-03-25T13:46:25.2677666+00:00",
"due_date": "2026-03-25T13:46:25.2677666+00:00",
"date_create": "2026-03-25T13:46:25.2677666+00:00",
"date_update": "2026-03-25T13:46:25.2677666+00:00",
"date_closed": "2026-03-25T13:46:25.2677666+00:00",
"suggested_user_id": "dd14bf29-3744-4d8e-840d-17ee7255024b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "41e2c05a-67c5-41df-9da3-d7d7b5845acd",
"db_language_id": "a60ac6dd-e2c4-46d0-9767-7d1665b0a57f",
"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-03-25T13:46:25.2677666+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89f8aa60-4a12-44ca-9001-1b50f504d991",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "60408faf-ef1c-4444-ac31-d827b4dbbe0b",
"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": "592fdd6b-cdb8-4d6a-9c8e-c4c7bfd06560",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0945a9c9-11c9-4750-abe6-29b6634b36c4"
},
"suggested_date_start": "2026-03-25T13:46:25.2677666+00:00",
"skill_id": "481136be-16df-48d7-b172-50dfefecca37",
"skill_code": "sample string 32",
"skill": {
"id": "27f69673-3d4c-47b7-86be-ada2920b6b30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cdec4b98-8afb-4570-ac0b-783c2048bcb8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd27e2f4-6c4a-4585-9697-83b7146734c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7c9b041-e685-4585-9167-cdc5d0b49b58",
"db_currency_id": "80585218-e137-4fe7-910d-a2986aefe759",
"db_language_id": "208c467f-677c-4718-a11c-6ee133ebd200",
"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-03-25T13:46:25.2677666+00:00"
},
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d1d69e05-d756-4eac-a075-c578bda1bf33",
"date_reported_by_company": "2026-03-25T13:46:25.2677666+00:00",
"id2": 36,
"company_id": "bc12dc04-df08-41c6-82e3-407dca7d6cbd",
"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": "ae0a0420-7f45-4260-a5cd-ebbda3469d7d",
"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-03-25T13:46:25.2677666+00:00"
},
"work_instruction_details_id": "ef8c1904-2a12-43e9-94de-b11bbd555726",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b27b67a1-b7d2-4055-910a-ff7a291f003b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "02cee62b-d842-4748-ac7a-a95569d1dd4b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-25T13:46:25.2677666+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": "ae9470e6-bbd0-4ba7-9725-f315ab005b50",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-25T13:46:25.2677666+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.