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": "206b0f7b-cede-4231-987b-47f461678be0",
"jobs_id": "040bc883-4173-4281-bc15-eb94b7d9c8da",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "50ec7c24-66bf-43d7-89b8-106eec1efbaf",
"_parent_id": "90fc6bff-a037-4684-82e5-20a9af77e7d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ccd57c13-3e06-43b6-ad69-884ad09c5ade",
"project_reference_back_office": "sample string 5",
"project": {
"id": "42dd8970-7dd3-4e10-b41f-5964e3b67e5d",
"_parent_id": "2548be94-118e-4a72-841e-4d148e855634",
"root_parent_id": "98a1b10f-3298-4f43-a560-5df22be0c65f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b2c4420f-279c-497b-83d6-b81d4b5ae5c9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "36347d19-db5a-4a0b-ba88-524c6f32e16d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0528c481-dfe2-4ea7-9c49-6f2139cf13cd",
"_parent_code": "sample string 6",
"sales_organization_id": "28fd3706-f987-4e56-9476-f8505b3073f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+00:00"
},
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00"
},
"equipment_model_id": "8822d72d-f9c3-40af-a012-39c489dc1604",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e789053b-58bd-4d3c-bd96-a770af5b5823",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ae58dc3b-9596-4cc1-8a78-6a77c28dfe05",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "650e355f-785d-45ae-a6a2-0078a8f88b3f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d3dd988e-b7ad-41b9-b36c-456e3fcd6404",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+00:00"
},
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00"
},
"equipment_family_id": "226db441-63fc-4641-822f-a087e516d17c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "36347d19-db5a-4a0b-ba88-524c6f32e16d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0528c481-dfe2-4ea7-9c49-6f2139cf13cd",
"_parent_code": "sample string 6",
"sales_organization_id": "28fd3706-f987-4e56-9476-f8505b3073f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+00:00"
},
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00"
},
"date_in_production_since": "2026-09-07T10:43:18.8095919+00:00",
"date_out_of_production_since": "2026-09-07T10:43:18.8095919+00:00",
"date_end_support": "2026-09-07T10:43:18.8095919+00:00",
"sales_organization_id": "915a6cb2-55c3-4fa9-8e52-8a3b50df1313",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+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-09-07T10:43:18.8095919+00:00"
},
"project_status_id": "c48ff861-2cfb-42d0-a701-c2e177476e92",
"project_status_code": "sample string 10",
"project_status": {
"id": "f08cbded-21c7-4d35-9f33-3a3789e04c81",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f7a36eea-9fc1-446d-88a9-7a55031b27ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00"
},
"company_id": "0e2a2abd-6c78-4024-9186-e02d844d3712",
"company_code": "sample string 12",
"db_address_id": "1b8c3504-1464-4ac3-ba17-73f4d6444f5e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "928229f0-0cb9-4cbc-94ae-31e02eb896e6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "983ef904-e22d-48c7-be66-e25286c2be94",
"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-09-07T10:43:18.8095919+00:00",
"date_create": "2026-09-07T10:43:18.8095919+00:00",
"date_update": "2026-09-07T10:43:18.8095919+00:00",
"updated_by_user_id": "ab4c03ac-357e-478e-baea-d71836fc44dc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-07T10:43:18.8095919+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-09-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-07T10:43:18.8095919+00:00",
"date_last_job": "2026-09-07T10:43:18.8095919+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-07T10:43:18.8095919+00:00",
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00",
"is_mobile_installation": true
},
"job_type_id": "858d5d38-ea00-46fe-86c0-dca0e8347bb8",
"job_type_code": "sample string 7",
"job_type": {
"id": "2b93baff-7c3f-4b1a-a377-fbee56631ec3",
"name": "sample string 2",
"sales_organization_id": "126824cf-cb66-4a6a-b080-88dd1b2176e2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00",
"code": "sample string 7"
},
"job_priority_id": "fbaa9399-644b-472b-8ac6-b99cfdfb018b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0f517e9a-ae2f-4897-911f-5d24a83008f1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1a672c5a-d302-4157-966d-4ff492b810a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00"
},
"job_status_id": "4bdbe51f-fcc9-4152-b7d8-ae52eff7b0f6",
"job_status_code": "sample string 11",
"db_address_id": "d94654b7-098a-4454-b67b-3da2b672df2a",
"contact_id": "40c9cb20-91c8-438a-bfb2-5bdc017fc276",
"requested_by_company_id": "07bd9dab-28e7-4904-92fa-4903a6c32ee9",
"requested_by_contact_id": "58764e38-ca26-40db-a6ba-73430bce95f3",
"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-09-07T10:43:18.8095919+00:00",
"due_date": "2026-09-07T10:43:18.8095919+00:00",
"date_create": "2026-09-07T10:43:18.8095919+00:00",
"date_update": "2026-09-07T10:43:18.8095919+00:00",
"date_closed": "2026-09-07T10:43:18.8095919+00:00",
"suggested_user_id": "9099b4e8-28cb-4426-befc-8c57243696ad",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "31908f82-81d0-4f05-b33c-f3baf6cb417f",
"db_language_id": "1ffeb2d0-35a9-4ed4-82b3-c5d993c72c66",
"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-09-07T10:43:18.8095919+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a8082814-a422-40f2-99a1-88124e001225",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0e94643b-4283-4e7f-aa75-30cae87cc6af",
"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": "e96ce4bd-2368-4bbe-a9e1-53b826d82eef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bb97bb17-c1f0-49c6-a68d-3d6b39bd0c34"
},
"suggested_date_start": "2026-09-07T10:43:18.8095919+00:00",
"skill_id": "8e6b363f-8248-4838-9b8e-bfde4c43098d",
"skill_code": "sample string 32",
"skill": {
"id": "7232f19b-1b05-457b-b3dc-44913cff3052",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "09ea0cc7-948b-4488-b8b4-18f9412205b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c9cc869-cf8f-497e-8971-244b8056a224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "931aea26-4f14-4d81-9e1c-9dea1e40d500",
"db_currency_id": "23a9ca1b-8bcc-4c6a-aa75-a74f0c7cc890",
"db_language_id": "f4b1a4d0-2a74-4d37-a0dd-0e94138cc149",
"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-09-07T10:43:18.8095919+00:00"
},
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c454e941-ad82-4d36-9924-334ced6acde6",
"date_reported_by_company": "2026-09-07T10:43:18.8095919+00:00",
"id2": 36,
"company_id": "e4106510-b46d-48d1-ae67-89a3d790aa02",
"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": "95e77cbc-223e-48eb-84ce-ef551dca4ca8",
"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-09-07T10:43:18.8095919+00:00"
},
"work_instruction_details_id": "fd49c369-1b7a-4568-9561-1e7514b6d942",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "963721f4-de1c-4bf3-9e05-c26ae2068322",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b6722fee-0397-4c0b-9184-7f45064aa947",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-07T10:43:18.8095919+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": "26006986-4bb5-4b60-9de4-cee05afa1ed7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-07T10:43:18.8095919+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.