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": "6dc0523c-4990-4adf-b40f-1738bc6f21ae",
"jobs_id": "bc62a4fb-15f5-4c0b-87e2-35c38485678b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e7cd7c48-4056-48a0-acad-a76c4252b6f3",
"_parent_id": "f7c0dc5c-f53e-451b-9b81-0b8526342702",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9f029089-1527-4059-ac48-a61890570dce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2c34d710-48ab-42ff-9ae0-6920cd2817e4",
"_parent_id": "76d07e5a-22d2-49c8-a611-e4f1d9bb3e1e",
"root_parent_id": "175c8049-4d4c-4202-95af-877f4a2c9f88",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "78ef3abb-c592-44c1-8cb1-e41a17038f8d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dd7f47c4-495a-4ed1-b527-033a14d14cf8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4d360d7-39d0-45cd-990a-44e1eaa9d610",
"_parent_code": "sample string 6",
"sales_organization_id": "46ed98ee-d47e-4512-a11b-9255d3daab48",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+00:00"
},
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00"
},
"equipment_model_id": "c62b389b-c5ee-4e5a-9fef-84a2eb7e7bed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ef981aca-8434-4a33-9718-02bfe6183022",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c2aaef75-352e-4283-a898-6f81c54fffa0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7d8983de-6777-4856-89c2-c8b4c3e68939",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b64174f0-a7ce-4fc2-8f48-f0bb0a8320f3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+00:00"
},
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00"
},
"equipment_family_id": "1a119a2b-1006-4b16-9a43-babb603ec764",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dd7f47c4-495a-4ed1-b527-033a14d14cf8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4d360d7-39d0-45cd-990a-44e1eaa9d610",
"_parent_code": "sample string 6",
"sales_organization_id": "46ed98ee-d47e-4512-a11b-9255d3daab48",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+00:00"
},
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00"
},
"date_in_production_since": "2026-06-23T07:27:34.889722+00:00",
"date_out_of_production_since": "2026-06-23T07:27:34.889722+00:00",
"date_end_support": "2026-06-23T07:27:34.889722+00:00",
"sales_organization_id": "f3b8b1aa-fc5a-47d9-bd6a-3d051596eba5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+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-23T07:27:34.889722+00:00"
},
"project_status_id": "d1f044df-887b-4825-9d46-af9973cda530",
"project_status_code": "sample string 10",
"project_status": {
"id": "d8cc57bf-fe48-4b5a-ada9-a631396a8e55",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "94b818f9-9baa-4ed9-9019-de4ed2453940",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00"
},
"company_id": "7e7a65e4-2215-4153-97f9-67a11565bd9c",
"company_code": "sample string 12",
"db_address_id": "fd13932c-dfac-410a-ad84-71957f3a49f0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "218e03f6-9d9b-4fe0-ad6c-c9ffd45d7789",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d68c97c8-9cbd-46eb-b383-03cf96598968",
"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-23T07:27:34.889722+00:00",
"date_create": "2026-06-23T07:27:34.889722+00:00",
"date_update": "2026-06-23T07:27:34.889722+00:00",
"updated_by_user_id": "54f38fb1-5248-4f3c-9d53-2b98f8b83830",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-23T07:27:34.889722+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-23T07:27:34.889722+00:00",
"date_last_job": "2026-06-23T07:27:34.889722+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-23T07:27:34.889722+00:00",
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00",
"is_mobile_installation": true
},
"job_type_id": "e83c2917-3157-42f3-839b-749fc1a04125",
"job_type_code": "sample string 7",
"job_type": {
"id": "2678af45-e8a8-49cb-b4ff-2f52b0f4d0af",
"name": "sample string 2",
"sales_organization_id": "18a839ae-b626-4051-b8ac-5b1d68561e36",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00",
"code": "sample string 7"
},
"job_priority_id": "0ad0bd20-fdfd-433e-9abd-9821e53a900f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ef6611fc-63bd-4d62-bf27-57d82b5227e4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "58592755-7c3e-4bf4-b7d3-ee321af1e493",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00"
},
"job_status_id": "282e1658-735a-4944-9e08-e01a0ff8824d",
"job_status_code": "sample string 11",
"db_address_id": "6cc771d8-49ed-4140-b227-af5db604e1e2",
"contact_id": "cfd8d904-c8bd-4530-805f-3768465f6958",
"requested_by_company_id": "9eb87bbb-e06f-4033-9349-2b1d9e79e462",
"requested_by_contact_id": "f6d1e6b4-8f13-4fbf-8918-4d28da4e7c0d",
"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-23T07:27:34.889722+00:00",
"due_date": "2026-06-23T07:27:34.889722+00:00",
"date_create": "2026-06-23T07:27:34.889722+00:00",
"date_update": "2026-06-23T07:27:34.889722+00:00",
"date_closed": "2026-06-23T07:27:34.889722+00:00",
"suggested_user_id": "174b7180-5ebd-4a0f-8a8c-161e5b33ab88",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ee970e05-f675-47fd-8949-4d67d0c947fe",
"db_language_id": "14f29aeb-4a67-40d6-9e34-7b1c617242be",
"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-23T07:27:34.889722+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "015a3e46-61d2-4314-be5f-59a5f1ae9a33",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5f8984b3-5cd2-44c7-8d04-7e25e72ac336",
"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": "db6325c5-c94f-430e-91e8-e2bd94093e91",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7455fee4-f504-4d48-a694-4fe9405984e7"
},
"suggested_date_start": "2026-06-23T07:27:34.889722+00:00",
"skill_id": "61cfe046-13c6-4a1d-9def-25dbc1dfa560",
"skill_code": "sample string 32",
"skill": {
"id": "c70f1cce-12d9-4c64-9797-d2a10fcd489a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a3b920f8-d7fc-4ab9-a1f4-e22a4544c196",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a9077e9-0c53-4806-be42-cdb2e12ae615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b41d989-42a7-4b4d-b852-46343bc554d0",
"db_currency_id": "ad55266c-e55c-4856-8427-b2476f5a1bfa",
"db_language_id": "e98eb818-efc8-4445-9a58-c374fdbe149e",
"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-23T07:27:34.889722+00:00"
},
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4de15c70-24bd-4db9-bfe6-d665f36fb325",
"date_reported_by_company": "2026-06-23T07:27:34.889722+00:00",
"id2": 36,
"company_id": "22dc8c61-6f13-4fb6-b855-8675bbf6d3dc",
"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": "0ef81799-21d5-403c-af9c-1f5db8012289",
"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-23T07:27:34.889722+00:00"
},
"work_instruction_details_id": "e3a8ab9d-baa2-48c7-8472-a0f01ce8f9e0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "52ab211c-ebf8-4158-aa50-218e9328d528",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cb19332f-66c2-4df5-a667-49983da252ce",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-23T07:27:34.889722+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": "8a0c6cfa-05bc-45ee-98b0-1a127b1ccda5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-23T07:27:34.889722+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.