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": "8338233e-a60e-44b5-887e-109f499d9176",
"jobs_id": "a7986847-4f4a-49f8-993a-befd28129bec",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5706f3b0-02b3-45d4-841d-3c7350ba4602",
"_parent_id": "c30d0c97-b829-40f4-8a7a-c751eefe0e08",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b10e2845-d28a-4e79-974b-56dd172a7b80",
"project_reference_back_office": "sample string 5",
"project": {
"id": "63c26766-ac99-4a57-bc87-e95d19330afc",
"_parent_id": "8396ad92-376a-4eb8-a676-7fb19f7fdb9f",
"root_parent_id": "661537d2-cc1f-42af-bfc4-8344c2323cfb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4ebd542a-bc44-4df7-b9f1-ea7ecaf08daa",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6c82857f-a6da-4b90-81e2-ee504a353986",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4fc1409d-1f7d-4190-91cd-2f6054c46ba5",
"_parent_code": "sample string 6",
"sales_organization_id": "b4b0d8ff-2f4e-4537-9624-c75141f185d2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+00:00"
},
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00"
},
"equipment_model_id": "056cd38a-4e6f-440d-9b6e-62e0cf27a6b1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "27038f14-253e-4863-a932-ca0aa4dc9e66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0a9b8bae-b114-4205-b516-cd23bd5a06a4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "323f5f00-752d-44ee-b81b-6c3bc953437e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "82e15a46-ff6b-4853-ba97-dc2ba0d63ee9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+00:00"
},
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00"
},
"equipment_family_id": "2c6fad8b-eac2-4b0b-8c74-4e8ee68bdc56",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6c82857f-a6da-4b90-81e2-ee504a353986",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4fc1409d-1f7d-4190-91cd-2f6054c46ba5",
"_parent_code": "sample string 6",
"sales_organization_id": "b4b0d8ff-2f4e-4537-9624-c75141f185d2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+00:00"
},
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00"
},
"date_in_production_since": "2026-07-22T03:09:42.8153589+00:00",
"date_out_of_production_since": "2026-07-22T03:09:42.8153589+00:00",
"date_end_support": "2026-07-22T03:09:42.8153589+00:00",
"sales_organization_id": "263444fd-c1ea-4aa4-8395-62e11d17f879",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+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-07-22T03:09:42.8153589+00:00"
},
"project_status_id": "c96edd24-b9c4-4f27-b031-5fc99c19785d",
"project_status_code": "sample string 10",
"project_status": {
"id": "d7f5cd43-5f48-4a90-b1da-a088e3ae50e4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3b0e7db9-5071-4c86-aab2-73d5152a4eb6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00"
},
"company_id": "1038a35e-85e8-42a2-9307-7873bb118303",
"company_code": "sample string 12",
"db_address_id": "6da0b11d-5b54-4d5e-9dd9-8c35f1f6eb89",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "91bbe065-b6d1-4e02-94bd-2fbd4e054f4e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "aa320938-e6e4-4d77-98a9-4de3d9b55188",
"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-07-22T03:09:42.8153589+00:00",
"date_create": "2026-07-22T03:09:42.8153589+00:00",
"date_update": "2026-07-22T03:09:42.8153589+00:00",
"updated_by_user_id": "8e3d41fc-f6b6-4a23-a968-cf350782c3a5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-22T03:09:42.8153589+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-07-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-22T03:09:42.8153589+00:00",
"date_last_job": "2026-07-22T03:09:42.8153589+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-22T03:09:42.8153589+00:00",
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00",
"is_mobile_installation": true
},
"job_type_id": "e99afa3f-25d7-4753-b66d-a3e8e9025bc1",
"job_type_code": "sample string 7",
"job_type": {
"id": "f230aaa0-87ba-4b41-8768-3caef454d0cc",
"name": "sample string 2",
"sales_organization_id": "e0d68cf4-6e7a-48fc-84d1-e47e4c946418",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00",
"code": "sample string 7"
},
"job_priority_id": "20a8f8e2-4527-4dc9-ac08-6b48ab69d221",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "55975198-1bd5-4602-8951-fc2e44348127",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "81435cc5-885a-4dbd-86ff-89211b97fa4d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00"
},
"job_status_id": "90c67468-c27e-44eb-8707-46cafd546f94",
"job_status_code": "sample string 11",
"db_address_id": "3e2f3141-0e0a-4f90-88d7-92f0d563f57e",
"contact_id": "174a4ee6-6a94-4716-96fc-b85e0390d573",
"requested_by_company_id": "00090d6d-6dd1-46ac-b449-6dee2342fa3b",
"requested_by_contact_id": "5e398703-154a-4d72-abb3-d4add042c9ba",
"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-07-22T03:09:42.8153589+00:00",
"due_date": "2026-07-22T03:09:42.8153589+00:00",
"date_create": "2026-07-22T03:09:42.8153589+00:00",
"date_update": "2026-07-22T03:09:42.8153589+00:00",
"date_closed": "2026-07-22T03:09:42.8153589+00:00",
"suggested_user_id": "aab54d50-333f-4d52-ae43-4aabd2dabea0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "43957c49-43bb-4fc6-9f7a-79b7fcc0548c",
"db_language_id": "15185089-4f6e-40bb-8ce3-c40b28c2e939",
"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-07-22T03:09:42.8153589+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "44118cc7-9a66-4f4d-a6c2-cdaf10f4af44",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "898ab2c9-6f54-4dcb-b086-16eeaa7ecec6",
"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": "6b96abf3-edbb-4f5b-a53d-6bbbe8ca370a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a2934aef-88eb-40b8-8855-bdd15370223f"
},
"suggested_date_start": "2026-07-22T03:09:42.8153589+00:00",
"skill_id": "6c79a001-c5db-4be3-8681-23c95c959d9c",
"skill_code": "sample string 32",
"skill": {
"id": "d79061d6-a647-482b-b676-650dbbd18f26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "65c29f19-3a4c-490f-94ed-8f92e3f55662",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3da16a9f-e7fc-453f-ba0b-7ca2c7873d54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da5c8497-cccb-4082-9354-2c13cc780844",
"db_currency_id": "9dca2a6c-5a9e-4607-a3dc-508b65367585",
"db_language_id": "f506c62b-2f5f-4f96-a366-b18b06896ffc",
"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-07-22T03:09:42.8153589+00:00"
},
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "654413fb-7767-46a9-b8a4-283e46ef8572",
"date_reported_by_company": "2026-07-22T03:09:42.8153589+00:00",
"id2": 36,
"company_id": "46461f63-b9f4-435c-ab45-169e2adbe63f",
"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": "5c9e0529-f7ab-4e9e-ab28-01f05d0c0a8a",
"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-07-22T03:09:42.8153589+00:00"
},
"work_instruction_details_id": "4892413b-5e88-4941-a16c-28342e3e8165",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9097d216-4d23-42cc-b7c3-9daa672a125a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "14b72f1f-86ce-4647-9b81-b51e5cc19ea8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-22T03:09:42.8153589+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": "2b560b70-53d2-4e52-8d2d-b3fd3cb6b4e6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-22T03:09:42.8153589+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.