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
{
"id": "71ed001c-3eed-426d-8ee1-9369f12d946f",
"jobs_id": "f8be2d8d-5d9a-4ebb-8ae7-2096f99847b2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6318491f-b8b6-4d42-8735-a09c0e645155",
"_parent_id": "e145f03b-8fb7-4f23-a5f7-04525a5a39b0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5dce2623-925e-4a8f-b67f-abc1a0f65613",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8f07f9ec-9ef8-4410-9193-f32976b05052",
"_parent_id": "903f6b4a-f931-4891-9612-6ef229d92522",
"root_parent_id": "8327ca80-9212-4f02-ad19-8e5e2ca7366b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f9c942eb-6a2e-4e4b-a8cb-e042f2e2f35b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "16de090c-aa49-48df-ad3a-6f866948fd9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "454dd912-18ee-4790-a588-7b022bac0134",
"_parent_code": "sample string 6",
"sales_organization_id": "cda7382f-68aa-4121-ac18-bfe4fa533115",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+00:00"
},
"modified_dateutc": "2026-11-16T07:45:16.4743404+00:00"
},
"equipment_model_id": "f01149d9-e2f4-4368-ab47-7171278eeaf0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c6da3cdc-434e-4ca5-ae99-ca6be78e5fe1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a2ae554a-c483-42a1-b286-b84b2343f9f0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "26988d56-e59d-4b7e-92de-0833d7c7b3f3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8cf338b4-ec56-4cdf-a529-c20ba9a7caed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+00:00"
},
"modified_dateutc": "2026-11-16T07:45:16.4743404+00:00"
},
"equipment_family_id": "90846e58-fc01-4905-b154-479c4fa11196",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "16de090c-aa49-48df-ad3a-6f866948fd9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "454dd912-18ee-4790-a588-7b022bac0134",
"_parent_code": "sample string 6",
"sales_organization_id": "cda7382f-68aa-4121-ac18-bfe4fa533115",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+00:00"
},
"modified_dateutc": "2026-11-16T07:45:16.4743404+00:00"
},
"date_in_production_since": "2026-11-16T07:45:16.4743404+00:00",
"date_out_of_production_since": "2026-11-16T07:45:16.4743404+00:00",
"date_end_support": "2026-11-16T07:45:16.4743404+00:00",
"sales_organization_id": "36bcb3a2-2a9d-4a47-8a95-c68c1de5f27f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+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-16T07:45:16.4910972+00:00"
},
"project_status_id": "c87791d4-812f-4127-8885-c5c477c8d8f6",
"project_status_code": "sample string 10",
"project_status": {
"id": "765e1ab6-0650-49e4-a1a2-9feb8c28b46c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d0443dba-0a99-422e-827d-81d56792b92a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-16T07:45:16.4910972+00:00"
},
"company_id": "b1f56af5-373e-46cb-beb6-e9d1bf279c7c",
"company_code": "sample string 12",
"db_address_id": "3754ad8a-4a9f-47e9-80a7-3c252ae65f83",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2504f62a-cb9b-41bd-93c1-e5b67d968b14",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "374f203b-0aa2-4628-9585-9d588ec0c314",
"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-16T07:45:16.4910972+00:00",
"date_create": "2026-11-16T07:45:16.4910972+00:00",
"date_update": "2026-11-16T07:45:16.4910972+00:00",
"updated_by_user_id": "e146a35a-1e83-414e-be57-97a8dd47bfea",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-16T07:45:16.4910972+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-16T07:45:16.4910972+00:00",
"date_last_job": "2026-11-16T07:45:16.4910972+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-16T07:45:16.4910972+00:00",
"modified_dateutc": "2026-11-16T07:45:16.4910972+00:00",
"is_mobile_installation": true
},
"job_type_id": "ae9b9e79-8433-4426-8cf8-644c450edfe0",
"job_type_code": "sample string 7",
"job_type": {
"id": "9840d34f-a102-4907-a054-c62f7e02e5ca",
"name": "sample string 2",
"sales_organization_id": "889dd460-ada5-4d4f-a552-b653272a9285",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-16T07:45:16.4910972+00:00",
"code": "sample string 7"
},
"job_priority_id": "66737278-4552-427a-b7fb-dd52382e66e0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "76a2ebc8-60b1-4ac3-b4b7-d669ce486c4c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c5b87dcc-ab46-4841-872c-8e7552f7f6ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-16T07:45:16.4910972+00:00"
},
"job_status_id": "97214349-9dcf-4cf4-88d0-7c14c011f8dd",
"job_status_code": "sample string 11",
"db_address_id": "7b1b84bc-9af3-4adb-a9c2-4d986616b06b",
"contact_id": "ad6378aa-01fd-4016-9801-4b1e22e6e5eb",
"requested_by_company_id": "9748101f-75b8-4d8d-b972-e0da325e0e64",
"requested_by_contact_id": "d01b796a-a2f0-4d19-acd8-8f7cf1049292",
"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-16T07:45:16.4910972+00:00",
"due_date": "2026-11-16T07:45:16.4910972+00:00",
"date_create": "2026-11-16T07:45:16.4910972+00:00",
"date_update": "2026-11-16T07:45:16.4910972+00:00",
"date_closed": "2026-11-16T07:45:16.4910972+00:00",
"suggested_user_id": "bfef2fa8-677c-4962-85a4-b595be789857",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "64953e32-80fa-4249-a764-820b70cc3a81",
"db_language_id": "b6753898-65a6-4582-817f-51a5cc3d8313",
"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-16T07:45:16.4910972+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ef4e32d6-3b60-4eed-afab-c99a14e6b0a9",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "18896bee-9926-49b3-9b2f-41377176efba",
"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": "674eeb62-cac8-4414-b8e7-2cea43861737",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-16T07:45:16.4910972+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "498aed23-bc1e-4191-8d2f-ad99440c0373"
},
"suggested_date_start": "2026-11-16T07:45:16.4910972+00:00",
"skill_id": "abd1f54f-157d-4e52-8e4d-ee6ab763f128",
"skill_code": "sample string 32",
"skill": {
"id": "6bdef08f-fc8f-43f3-a381-d755ddb9b3b2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9dde2b26-c8da-4634-afc6-0013b725c702",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70a77045-947c-4ed6-864f-3b0c82c788e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1186a6-183f-40c8-880e-8add9ca9498e",
"db_currency_id": "1f587806-e6da-4afd-9d62-dba222b1fadf",
"db_language_id": "e10f7b63-1da9-4c35-a891-a9910b8e36c8",
"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-16T07:45:16.4743404+00:00"
},
"modified_dateutc": "2026-11-16T07:45:16.4910972+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7334a3a7-2e37-464b-bf76-7d3b0e331249",
"date_reported_by_company": "2026-11-16T07:45:16.4910972+00:00",
"id2": 36,
"company_id": "79e04c33-7632-4d40-b1ee-9475a6062e01",
"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": "8208a8ea-334d-46f8-b569-22c0db804a3d",
"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-16T07:45:16.4910972+00:00"
},
"work_instruction_details_id": "6850dd29-f44f-428d-bc77-94d4a9cdbb32",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f3765a62-c476-4d96-8067-6815b4b1a62b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "892c0251-1570-46ed-b5e2-c759a064b896",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-16T07:45:16.4910972+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": "db6ffe19-1898-4c6d-8cc7-76caa5b665a6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-16T07:45:16.4910972+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.