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": "ae4e01a4-79ce-483a-b802-8e41311d82d4",
"jobs_id": "05eb8c70-f4e5-443c-83ff-e5fa27f41694",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2b94defc-cdb2-484b-8463-dd72d65fba06",
"_parent_id": "86fbf388-ff6f-421e-899e-8b667209d1d9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cac90543-4df3-47b3-bf26-8f987ca48058",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bf6cfc47-3da3-4c44-96d2-4e1a8e9d6be9",
"_parent_id": "c60f87db-0f81-4746-8a1b-22c1c38f16f4",
"root_parent_id": "0fa75da4-a5b0-4fb9-9f14-14ed5c5d7d7c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "11f26588-217b-4346-858e-d5987722dde7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b5d8deea-7ac3-4118-8778-221c53cc6345",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a5ffbfad-3c89-4f16-aa64-527267ae44f9",
"_parent_code": "sample string 6",
"sales_organization_id": "33d8a718-68ae-40f6-b5e4-1006c2b8df3e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+00:00"
},
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00"
},
"equipment_model_id": "1d29b890-29ec-4d52-b140-f80cc58651fa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d54a2708-ec7b-4b9d-a101-0a0776e4fadd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "24c37483-5787-4a2c-a965-167db52bb2eb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "06d911d9-003f-4d0b-9c30-b9d7ccf5f98e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "66c1f56f-d20f-465a-8623-f8cf52ba36e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+00:00"
},
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00"
},
"equipment_family_id": "70f83161-5a31-4b38-9e65-8c603aab2812",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b5d8deea-7ac3-4118-8778-221c53cc6345",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a5ffbfad-3c89-4f16-aa64-527267ae44f9",
"_parent_code": "sample string 6",
"sales_organization_id": "33d8a718-68ae-40f6-b5e4-1006c2b8df3e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+00:00"
},
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00"
},
"date_in_production_since": "2026-08-31T01:27:28.9364365+00:00",
"date_out_of_production_since": "2026-08-31T01:27:28.9364365+00:00",
"date_end_support": "2026-08-31T01:27:28.9364365+00:00",
"sales_organization_id": "87ff9d46-95d1-40fe-b638-6191c3102c0c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+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-08-31T01:27:28.9364365+00:00"
},
"project_status_id": "4dab723a-ec4e-408d-bcec-c37e13c97fcc",
"project_status_code": "sample string 10",
"project_status": {
"id": "065ab185-5438-4eb3-85a9-2df1ce494297",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9a4fbc72-6c24-4bdb-8eaa-811e25e68f60",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00"
},
"company_id": "763d5455-5a60-487b-8c7e-8f3fe070b42c",
"company_code": "sample string 12",
"db_address_id": "19181ca0-d5d1-4b65-8eca-09f963b99d34",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8b74a7a2-447d-4829-9e1c-23d0a20f1867",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "077a8fc6-c6eb-4a23-8f77-190d07281d9d",
"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-08-31T01:27:28.9364365+00:00",
"date_create": "2026-08-31T01:27:28.9364365+00:00",
"date_update": "2026-08-31T01:27:28.9364365+00:00",
"updated_by_user_id": "ccd2cab4-27df-4288-b5eb-168a0e2b5a20",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-31T01:27:28.9364365+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-08-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-31T01:27:28.9364365+00:00",
"date_last_job": "2026-08-31T01:27:28.9364365+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-31T01:27:28.9364365+00:00",
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00",
"is_mobile_installation": true
},
"job_type_id": "521e518c-8f8f-4a36-b3a4-fa5f95bcc9d0",
"job_type_code": "sample string 7",
"job_type": {
"id": "b3655117-f094-4b6d-ac75-bac7f3d3eeb0",
"name": "sample string 2",
"sales_organization_id": "b153fdfe-5475-428f-8594-80a1aefd93a6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00",
"code": "sample string 7"
},
"job_priority_id": "06b9c5f7-414f-4e05-8af5-08c7562b0cfe",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "47b59f0f-5f50-48cc-8313-f0e9ccaa7e6d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "abb8f8f8-0d56-454f-8e98-45a195d9b932",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00"
},
"job_status_id": "9b0b19f2-fad3-4123-8800-954d480ad965",
"job_status_code": "sample string 11",
"db_address_id": "3c6e1183-f3f2-4afa-9919-ae752737c440",
"contact_id": "62de06d3-f3e6-407b-bb83-34c6cf359967",
"requested_by_company_id": "342d3c72-ae0f-4c73-9a09-a1f58a42ddd0",
"requested_by_contact_id": "743fe0a8-c12a-4b19-82b3-fcab73d332f8",
"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-08-31T01:27:28.9364365+00:00",
"due_date": "2026-08-31T01:27:28.9364365+00:00",
"date_create": "2026-08-31T01:27:28.9364365+00:00",
"date_update": "2026-08-31T01:27:28.9364365+00:00",
"date_closed": "2026-08-31T01:27:28.9364365+00:00",
"suggested_user_id": "33310b57-f617-410a-b152-fe0a70a132db",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bc3e1c4d-f552-467f-9f2c-413db0431bb9",
"db_language_id": "bc1087ca-bb44-43b9-86ec-ea086781f6ee",
"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-08-31T01:27:28.9364365+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bcea6d87-9084-4723-abbc-e8c7ab5ebdc0",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "632bf352-d64a-4a12-937a-0a38e941deaf",
"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": "c31ca763-6dce-43a3-8268-8f9c0de41854",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "94923b91-2162-40e2-9e97-4a0b3e1fb68a"
},
"suggested_date_start": "2026-08-31T01:27:28.9364365+00:00",
"skill_id": "a026979a-2706-4f5c-a04b-823d853b7b1c",
"skill_code": "sample string 32",
"skill": {
"id": "56f56246-7e52-426f-95e3-ed79a739147e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "70f18ab5-867f-4472-a4f9-7b9807e78ac3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd2dce10-ed22-4cb6-bd4e-055ff335e3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b5a177-5fa1-4849-8202-8b50be332dc0",
"db_currency_id": "d3d9b92e-c578-473e-9260-07b5d09211dc",
"db_language_id": "df7266e5-0b21-4c93-82a6-9189473cdaea",
"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-08-31T01:27:28.9364365+00:00"
},
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "55265e23-410d-426b-9124-8b18a7f969f1",
"date_reported_by_company": "2026-08-31T01:27:28.9364365+00:00",
"id2": 36,
"company_id": "8740a1e4-0334-4228-a5c3-17e87155befa",
"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": "5a0c3640-61c8-4df5-9d40-14bf6e6ce189",
"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-08-31T01:27:28.9364365+00:00"
},
"work_instruction_details_id": "56a87add-07a5-46a7-9abd-3e9f87233a2c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b9afb52b-cb6f-4ce7-be47-926da3d121fe",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3943548e-11fe-4741-bbb6-f31cc12e054d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-31T01:27:28.9364365+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": "afc394fd-1a90-4277-9cd0-3095e514e241",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-31T01:27:28.9364365+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.