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": "0fba6312-e787-4bf6-8ae8-6769ec9932ea",
"jobs_id": "ba229d49-cbea-4e4b-ba15-569b6fe57262",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f6cfa3e4-84ee-43e8-b157-43f944eb36fa",
"_parent_id": "a2adf9ff-85c1-4cdc-8229-987fc21216d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "74e76184-76ea-4208-95b6-0bc4261b9a74",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6296e7fe-fe57-49dc-b1c2-b344e057f0ca",
"_parent_id": "449d035a-d208-4303-909c-527d84bdb56a",
"root_parent_id": "45fe612a-a10d-4765-ae5a-d19de4b995a0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dd0bf574-558f-42e0-9452-b317ffaae7c7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0aef0145-87de-43fa-b491-e59d0156c57e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b9ce8a52-6186-4f24-8c3c-db1475c0e14a",
"_parent_code": "sample string 6",
"sales_organization_id": "9b32b063-3b5a-4b00-9847-0692af78dc01",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+00:00"
},
"modified_dateutc": "2026-10-01T01:01:17.9609079+00:00"
},
"equipment_model_id": "e99bb346-06eb-4e67-a139-226b4a9f97ed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "05c44c30-60e8-4341-89ca-0da75e3a7188",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b68d9164-ff0c-47f7-a28f-8d551094ab24",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3597824c-4ef5-4d32-a46d-f1a0ada44ce9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "589bb8ac-7b8a-4a45-a4c2-19b06c14b80c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+00:00"
},
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00"
},
"equipment_family_id": "b2a29c84-15f8-4799-8aad-b62b2a6f42e1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0aef0145-87de-43fa-b491-e59d0156c57e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b9ce8a52-6186-4f24-8c3c-db1475c0e14a",
"_parent_code": "sample string 6",
"sales_organization_id": "9b32b063-3b5a-4b00-9847-0692af78dc01",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+00:00"
},
"modified_dateutc": "2026-10-01T01:01:17.9609079+00:00"
},
"date_in_production_since": "2026-10-01T01:01:17.975288+00:00",
"date_out_of_production_since": "2026-10-01T01:01:17.975288+00:00",
"date_end_support": "2026-10-01T01:01:17.975288+00:00",
"sales_organization_id": "d2913368-4745-4507-9f11-f03f904cad8e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+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-01T01:01:17.975288+00:00"
},
"project_status_id": "991094c0-2d04-43af-acd6-5caacca34f3d",
"project_status_code": "sample string 10",
"project_status": {
"id": "fec213b5-3bf6-4c5c-8175-530fc325d2f8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "86c370ed-e44a-40b7-a166-e800ed66c110",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00"
},
"company_id": "e7aacf4c-6827-4359-a1e7-228d5c1601a8",
"company_code": "sample string 12",
"db_address_id": "4da9c8fc-07e0-4ce3-8384-19f0b08c4d70",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cb3cb1af-82f3-4970-a0cc-a2f0e81b7339",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fd79e8dc-d054-4a81-969b-1cbd00b62fde",
"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-01T01:01:17.975288+00:00",
"date_create": "2026-10-01T01:01:17.975288+00:00",
"date_update": "2026-10-01T01:01:17.975288+00:00",
"updated_by_user_id": "c1243ab3-dc53-4491-9c45-e33dcde861ec",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-01T01:01:17.975288+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-01T01:01:17.975288+00:00",
"date_last_job": "2026-10-01T01:01:17.975288+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-01T01:01:17.975288+00:00",
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00",
"is_mobile_installation": true
},
"job_type_id": "70516e12-1d9d-4955-9185-602cdea6e4f8",
"job_type_code": "sample string 7",
"job_type": {
"id": "e39f5b32-3689-4cfb-b23b-5d3452950b81",
"name": "sample string 2",
"sales_organization_id": "0f190cdb-7c4c-4437-9a48-cc85456898f8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00",
"code": "sample string 7"
},
"job_priority_id": "f806f2f9-12a8-4fa8-918e-92a991a87339",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e436cb4d-55be-4a11-bfaa-e38dbb8c8201",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "efd6c3e8-e990-4fa4-9e44-06991b79f65a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00"
},
"job_status_id": "96e435c8-5e65-4edd-b59d-41c470fd58e0",
"job_status_code": "sample string 11",
"db_address_id": "4096913f-ac9a-4fa1-8930-df5d65a2932c",
"contact_id": "89d2f71d-f082-407d-93b7-9319c3c5a277",
"requested_by_company_id": "da18eaa6-84f3-49c8-a971-258d5c6c170e",
"requested_by_contact_id": "2bf204c9-24c5-4df8-bd6f-c6fa633cd817",
"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-01T01:01:17.975288+00:00",
"due_date": "2026-10-01T01:01:17.975288+00:00",
"date_create": "2026-10-01T01:01:17.975288+00:00",
"date_update": "2026-10-01T01:01:17.975288+00:00",
"date_closed": "2026-10-01T01:01:17.975288+00:00",
"suggested_user_id": "23a246a1-663e-4804-8fd0-cfb2d11e8590",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "af8cda77-52c6-4324-80db-635f17f5810f",
"db_language_id": "7a6aeb55-47b1-43b9-95b3-9982c467ec5e",
"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-01T01:01:17.975288+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2bdd344e-4153-4ed1-803a-dde20c911097",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6b712dc6-7d90-4aa1-bd2e-4c9ef87a7b33",
"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": "27793dca-ca50-43ed-bc78-e974f39496af",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8bd91484-2eb3-43ea-b0a1-fedd39ffda87"
},
"suggested_date_start": "2026-10-01T01:01:17.975288+00:00",
"skill_id": "612c7ff3-acf2-4f7a-b245-67818d98f7c8",
"skill_code": "sample string 32",
"skill": {
"id": "ca30217e-f205-4dab-b543-e3394522df5a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b009a8f6-bac6-477d-8e89-47975d3bdeea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e2044b0-6da1-4665-8587-9787de477d55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb90b0b7-ebf6-4673-9038-15eebececc6d",
"db_currency_id": "589d6eab-b10e-43ef-aeb2-00c3d4707d65",
"db_language_id": "d4958166-cf81-48d5-b2b1-919a02bd8120",
"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-01T01:01:17.9609079+00:00"
},
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dd653ba4-44e2-4743-b9c5-c4aff1ab1157",
"date_reported_by_company": "2026-10-01T01:01:17.975288+00:00",
"id2": 36,
"company_id": "0e6c9126-5882-46af-8c47-392b4b77e5a9",
"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": "53cadb2c-b5f3-4872-928f-f9a641180b2e",
"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-01T01:01:17.975288+00:00"
},
"work_instruction_details_id": "c98b03d2-74cf-469c-b41c-06b1d28e9a8a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "952c0690-5350-4179-952f-597e92a35349",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8caa5664-5cbc-429f-8ae2-89d76c451e81",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-01T01:01:17.975288+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": "d7ef1c08-5702-4877-81de-12110bb183d5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-01T01:01:17.975288+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.