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": "a1954ee9-5c6a-4031-b1e8-50f6c199181d",
"jobs_id": "11ce57da-0336-4592-91c1-0a281186345c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8fe3e9aa-976b-4b1c-adda-b89374155e72",
"_parent_id": "5d6948b3-94c0-42cd-897e-e229354f327c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f625b555-e2f5-40a9-89ba-8a02a8a3e205",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3fe0868e-ace9-4823-b4fd-ca9448c7ff86",
"_parent_id": "a1cb9dd9-a212-40f7-9709-9519faca36e5",
"root_parent_id": "37533c42-fee9-48ee-bfb8-af877a6c1c6c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "42157975-0bb8-4b93-9c93-fa09763c7a1b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ae60d826-602d-4b9d-8bde-0d6c3f149656",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1c3c57cf-c19a-45e1-ba35-1c1ebd0a0656",
"_parent_code": "sample string 6",
"sales_organization_id": "f76d8f47-0f31-4273-b0fd-fd990bd42ebf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+00:00"
},
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00"
},
"equipment_model_id": "99396bdf-3922-4a74-979f-40c09e09e701",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4d6012ad-5200-4e5e-8e05-0cc2dcd77118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a0c39026-f4ea-4d1f-992d-3d9217425114",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "54229e52-87aa-49ef-94d9-1ea9b4287171",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9e0aa7ea-c21e-4f14-951a-8ee9bbc7c745",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+00:00"
},
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00"
},
"equipment_family_id": "2b4a64c4-cd00-4c16-893a-7fab7af0472c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ae60d826-602d-4b9d-8bde-0d6c3f149656",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1c3c57cf-c19a-45e1-ba35-1c1ebd0a0656",
"_parent_code": "sample string 6",
"sales_organization_id": "f76d8f47-0f31-4273-b0fd-fd990bd42ebf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+00:00"
},
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00"
},
"date_in_production_since": "2026-06-01T00:23:18.9945067+00:00",
"date_out_of_production_since": "2026-06-01T00:23:18.9945067+00:00",
"date_end_support": "2026-06-01T00:23:18.9945067+00:00",
"sales_organization_id": "ff277e23-39ed-4a07-988a-350351f71e52",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+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-06-01T00:23:18.9945067+00:00"
},
"project_status_id": "b978115a-ea76-499a-9ca4-87db9ce5929a",
"project_status_code": "sample string 10",
"project_status": {
"id": "5c430a45-1af3-4470-8ca8-cee36c73ecc1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3a36da00-3a2a-45ec-af04-416f6daf2318",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00"
},
"company_id": "1d941743-7692-444e-93b3-2af60af88aaa",
"company_code": "sample string 12",
"db_address_id": "76d01ec8-f6a0-45e2-9d36-ee0c1646ac42",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "26fca218-ed14-4969-a856-8c5a73fe5ea5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "54a3f256-a835-4b69-be95-f906ab1bfd65",
"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-06-01T00:23:18.9945067+00:00",
"date_create": "2026-06-01T00:23:18.9945067+00:00",
"date_update": "2026-06-01T00:23:18.9945067+00:00",
"updated_by_user_id": "d2f1fd8a-dd99-4061-8c1a-67756b6f2395",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-01T00:23:18.9945067+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-06-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-01T00:23:18.9945067+00:00",
"date_last_job": "2026-06-01T00:23:18.9945067+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-01T00:23:18.9945067+00:00",
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00",
"is_mobile_installation": true
},
"job_type_id": "36073e81-1531-4bfe-9165-d30be8e74748",
"job_type_code": "sample string 7",
"job_type": {
"id": "3b287a94-8a19-47a6-8344-4b3cd78aaa90",
"name": "sample string 2",
"sales_organization_id": "d864a91b-f6f0-47a0-af61-e519d4683519",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00",
"code": "sample string 7"
},
"job_priority_id": "c8661b25-b14a-41d5-8706-a2044e822b69",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "13ad77ad-f612-4969-a737-0a0e9ac93c84",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "83fa9f6d-2de9-4257-831e-d5af0ecf4a56",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00"
},
"job_status_id": "6fd111d7-19bd-4d54-bf70-52b4a508c5d1",
"job_status_code": "sample string 11",
"db_address_id": "1412ee03-8ed5-4763-8726-a6da425061c3",
"contact_id": "1707854a-0b0a-4b11-ab03-c33c3b5d22bd",
"requested_by_company_id": "ea71257a-85de-4ccb-9c0d-ebfe7e5e1225",
"requested_by_contact_id": "358bea8b-2114-40b7-895c-a32580e8ac18",
"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-06-01T00:23:18.9945067+00:00",
"due_date": "2026-06-01T00:23:18.9945067+00:00",
"date_create": "2026-06-01T00:23:18.9945067+00:00",
"date_update": "2026-06-01T00:23:18.9945067+00:00",
"date_closed": "2026-06-01T00:23:18.9945067+00:00",
"suggested_user_id": "4da7e6d2-d26d-43ca-be7e-7eb70ad08d0f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2e43c102-e84f-4c51-a6b3-97f8b9c901b3",
"db_language_id": "5cbb37d8-b69a-4f2f-af87-8cd034b76581",
"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-06-01T00:23:18.9945067+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eb82773e-e90a-4dfd-91e7-a050bcbd4b2b",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "35af8c50-4a41-4e29-84c1-ba6badb97ae4",
"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": "7de4c519-6ac9-4b1d-87f9-e0f4c4e614a5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8e77c3ce-9955-4c3d-9c21-c96f2ee9da85"
},
"suggested_date_start": "2026-06-01T00:23:18.9945067+00:00",
"skill_id": "d9bfb04b-29e0-444e-950a-612662c41ce3",
"skill_code": "sample string 32",
"skill": {
"id": "a7ee554f-5a45-4ec4-979e-e83a9cd71571",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4e35fde0-6dc1-477d-b4de-3803242ae882",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ef955039-1ca7-49b2-bb71-b8ba5bbc9d84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5df0fa5e-09fd-4bcc-b67f-0a2503215ce9",
"db_currency_id": "6e16d881-18b7-4efb-85a5-6c40c669e1fa",
"db_language_id": "a8d17f16-f036-47c9-8146-4fe8555d8b77",
"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-06-01T00:23:18.9945067+00:00"
},
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ef66c84d-02a5-44c1-b220-f5f43b0a43f1",
"date_reported_by_company": "2026-06-01T00:23:18.9945067+00:00",
"id2": 36,
"company_id": "052b9004-a726-412a-9e82-73a291874f94",
"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": "6b8d9619-da02-42ad-8fff-1bcd3166a44b",
"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-06-01T00:23:18.9945067+00:00"
},
"work_instruction_details_id": "efa7ab43-3f17-4bb2-997c-86345c4adf3c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "34699da2-06b3-45b1-8293-60f81b6457f2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "628c5aaa-df25-4b50-b6d5-309e3db98350",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-01T00:23:18.9945067+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": "eca968ad-ccd7-4c33-868f-973dc03af62c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-01T00:23:18.9945067+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.