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": "ff60af6d-dcc8-4ee7-9f80-19df8d468062",
"jobs_id": "6ef83c35-9cb6-4fc3-af9f-3dabf29f1224",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cb681488-75e6-4690-a89f-5526993dd401",
"_parent_id": "41d2c305-0b5d-44de-b8b4-c38064c9facc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e4cee421-a89f-4d46-bd59-8daeec4c480a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "955242f7-3203-4b7b-9d32-870062821915",
"_parent_id": "a9f1b689-7ebe-4cbc-80be-a5d119bb107d",
"root_parent_id": "69e81022-3470-4a40-965f-c41c3fa65b0f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "da32b431-d002-4bc5-ae0d-b218f92a37a5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "61c86c3d-cbea-44fc-b975-13c0ec8d6823",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7933ee1-db42-4715-bc8f-9a7f1aef7e5e",
"_parent_code": "sample string 6",
"sales_organization_id": "615c6b86-c994-4105-9333-2efcc10d58a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+00:00"
},
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00"
},
"equipment_model_id": "12b8e3cb-e300-439d-be4f-5166da825bad",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fbfc6568-9616-4bee-98f3-fea49cb19147",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "50d2a98f-4b5e-4249-8e63-e87d93d1d772",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2a1c82dd-27f7-442e-a031-0f63152f1580",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4cd6c8b4-adc3-49e0-8e19-416381a4d3ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+00:00"
},
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00"
},
"equipment_family_id": "bd4edde8-cb8f-45fc-ac2c-513430fdbed8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "61c86c3d-cbea-44fc-b975-13c0ec8d6823",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7933ee1-db42-4715-bc8f-9a7f1aef7e5e",
"_parent_code": "sample string 6",
"sales_organization_id": "615c6b86-c994-4105-9333-2efcc10d58a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+00:00"
},
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00"
},
"date_in_production_since": "2026-10-30T20:11:19.5805759+00:00",
"date_out_of_production_since": "2026-10-30T20:11:19.5805759+00:00",
"date_end_support": "2026-10-30T20:11:19.5805759+00:00",
"sales_organization_id": "3f719a98-a41a-4684-b6ab-52fbd1f916eb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+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-30T20:11:19.5805759+00:00"
},
"project_status_id": "c0e54da7-a071-4892-8d87-e52075ab8f66",
"project_status_code": "sample string 10",
"project_status": {
"id": "57969d57-4e2b-4544-a32d-64b6cdaef23b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b825d4f5-c688-473e-a0e6-9312592da5f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00"
},
"company_id": "b668c2db-3b3d-46cb-9af9-b0481f49d3f9",
"company_code": "sample string 12",
"db_address_id": "d2cb537b-6352-47dc-9889-4a3527e3b11f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6f7bd125-968a-43c1-afc3-4f98579a6c3f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3a13ae9b-daf9-4872-945a-880c4161a9af",
"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-30T20:11:19.5805759+00:00",
"date_create": "2026-10-30T20:11:19.5805759+00:00",
"date_update": "2026-10-30T20:11:19.5805759+00:00",
"updated_by_user_id": "80b4a275-fb3e-4e65-83d2-246919600705",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-30T20:11:19.5805759+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-30T20:11:19.5805759+00:00",
"date_last_job": "2026-10-30T20:11:19.5805759+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-30T20:11:19.5805759+00:00",
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00",
"is_mobile_installation": true
},
"job_type_id": "8ad509bd-0c0f-4020-8ed5-b5a14bde5569",
"job_type_code": "sample string 7",
"job_type": {
"id": "5c2b6969-3c0b-45ec-9463-e3281fd279f9",
"name": "sample string 2",
"sales_organization_id": "94d5c841-a5f8-4dfe-b8ec-5990f8c3ae32",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00",
"code": "sample string 7"
},
"job_priority_id": "58109ff2-5eb6-4490-abd5-e7ec4f64bbb6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ccb600fb-67b2-43fd-a3e0-61df6e9c3dcd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "39fd8b69-6853-41db-a81c-4799d6397076",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00"
},
"job_status_id": "a65616b3-fd16-4910-b828-bbf0ea44173b",
"job_status_code": "sample string 11",
"db_address_id": "862b6b2a-61d8-4f39-b9d0-a27403770edb",
"contact_id": "1ff09b1b-619c-42e5-9ea0-dce3e2fd1194",
"requested_by_company_id": "e4a5fc42-a77b-42f3-bd45-5b5a985b0278",
"requested_by_contact_id": "ab0c6fcb-46c3-4bc1-a806-29d13322e228",
"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-30T20:11:19.5805759+00:00",
"due_date": "2026-10-30T20:11:19.5805759+00:00",
"date_create": "2026-10-30T20:11:19.5805759+00:00",
"date_update": "2026-10-30T20:11:19.5805759+00:00",
"date_closed": "2026-10-30T20:11:19.5805759+00:00",
"suggested_user_id": "54b9d82b-5a21-4abb-a15f-1eb5aa3c7e45",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3fdf7c56-e7f6-4557-8d5f-9d19f8d92cfa",
"db_language_id": "0d3dbfe3-bc92-4692-b8f9-7943da1239e1",
"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-30T20:11:19.5805759+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f1ba805b-4e06-46e7-a0fb-ddfe40ce512a",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2e79407b-2a49-4742-9785-15eec8397cef",
"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": "e25f46ec-3620-48f0-8f3e-8742459a1ac4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "df41db1f-e679-4fcd-b6d1-49057be32679"
},
"suggested_date_start": "2026-10-30T20:11:19.5805759+00:00",
"skill_id": "3f066068-f860-49b9-b576-ed8224cfede3",
"skill_code": "sample string 32",
"skill": {
"id": "af024d4a-d76a-48ad-8012-9dce1ba373bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b44deaee-6498-46c2-941f-917db3d134d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb2a65ad-8bc3-4ba2-b72b-897636c11fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d2540e-a1f2-4d2e-8138-b5f00ab288cf",
"db_currency_id": "0c9bb3f5-5c83-45fd-b570-fe93fe3e4461",
"db_language_id": "82fefe73-2371-4705-93d8-7158c7e12a87",
"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-30T20:11:19.5805759+00:00"
},
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "80139638-9511-4ab1-90c9-47561e1816c0",
"date_reported_by_company": "2026-10-30T20:11:19.5805759+00:00",
"id2": 36,
"company_id": "209eba55-973e-4923-90be-ea44a2d776f9",
"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": "0d1a2ffe-e970-451b-9fd9-68c00ddbe43e",
"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-30T20:11:19.5805759+00:00"
},
"work_instruction_details_id": "5fd2828b-5acc-47dc-9084-bef2d5a690b6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "22d04b3f-08e8-4cfd-864c-3f67a43f0891",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "99820ba0-6c18-4fb3-b23d-81077344b3fc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-30T20:11:19.5805759+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": "0a74e874-6e00-4bf3-89a9-84c0e92c2ddd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-30T20:11:19.5805759+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.