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": "7d10fd0b-874e-4ea8-aad7-c2e7b2c0508f",
"jobs_id": "8e2c07fe-a9c7-408c-979f-b75462e4c6fe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eb70c7d3-392e-46ea-bc3e-8b86be006310",
"_parent_id": "09eefcca-875e-4856-90a4-1cb60c99b0a2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9ab7eabc-5781-4223-9a05-8165d17b0439",
"project_reference_back_office": "sample string 5",
"project": {
"id": "eabbace8-c699-4b00-a20f-484a4dee1319",
"_parent_id": "f566bbbe-3bee-4444-8c3e-dd286cf68bee",
"root_parent_id": "9d968590-2096-4e11-af2a-f34ac6aae7b9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fc12c187-2a5e-4988-8e3f-8ec7c0437939",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f0f3c1a8-4713-41dd-9e79-286704afe5fa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41e69859-3fde-434b-9af0-1c0badb755a9",
"_parent_code": "sample string 6",
"sales_organization_id": "4e248a6a-bfd7-4529-93f7-039241d128de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+00:00"
},
"modified_dateutc": "2026-10-23T17:44:08.5016352+00:00"
},
"equipment_model_id": "44a98fab-80d1-40e0-a916-f43470f7b66b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a3306d11-4f2a-48ae-a9db-7165eda89aa3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d765b301-43ea-4b77-822c-bd7259f5246a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "86125afd-45f8-4828-afe1-0c74b81a8fb8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3c71f8e2-2970-4cf9-b0cb-679ffe1121ce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+00:00"
},
"modified_dateutc": "2026-10-23T17:44:08.5016352+00:00"
},
"equipment_family_id": "884ce50a-e215-4f5b-8536-193c6d6a666f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f0f3c1a8-4713-41dd-9e79-286704afe5fa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41e69859-3fde-434b-9af0-1c0badb755a9",
"_parent_code": "sample string 6",
"sales_organization_id": "4e248a6a-bfd7-4529-93f7-039241d128de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+00:00"
},
"modified_dateutc": "2026-10-23T17:44:08.5016352+00:00"
},
"date_in_production_since": "2026-10-23T17:44:08.5016352+00:00",
"date_out_of_production_since": "2026-10-23T17:44:08.5016352+00:00",
"date_end_support": "2026-10-23T17:44:08.5016352+00:00",
"sales_organization_id": "702f4db7-66c4-4068-8964-ddf92e8d8a24",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+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-23T17:44:08.5186919+00:00"
},
"project_status_id": "c2a66f41-12d9-4671-af43-9ffa0a938527",
"project_status_code": "sample string 10",
"project_status": {
"id": "a9a59d85-279d-4906-ac95-db0d966fd4dc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f639cd84-69a4-455b-981b-8cf152924921",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T17:44:08.5186919+00:00"
},
"company_id": "15d2762f-e6c9-41f4-9b6b-c2bc71167d60",
"company_code": "sample string 12",
"db_address_id": "8078f530-d4fe-4c96-b09f-9e06156980bf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "89e67a2e-ff8a-4167-9c88-715f857f79f6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dbf958e8-77f1-4106-b6f4-6d03debd6e21",
"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-23T17:44:08.5186919+00:00",
"date_create": "2026-10-23T17:44:08.5186919+00:00",
"date_update": "2026-10-23T17:44:08.5186919+00:00",
"updated_by_user_id": "3cb9725a-948d-45b3-a1ba-b302cc73d3d9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-23T17:44:08.5186919+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-23T17:44:08.5186919+00:00",
"date_last_job": "2026-10-23T17:44:08.5186919+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-23T17:44:08.5186919+00:00",
"modified_dateutc": "2026-10-23T17:44:08.5186919+00:00",
"is_mobile_installation": true
},
"job_type_id": "df70f027-c285-4226-8438-2ebc448b8864",
"job_type_code": "sample string 7",
"job_type": {
"id": "0c9ce023-09dd-479e-b05f-d7bb37a5b1fb",
"name": "sample string 2",
"sales_organization_id": "6ee02a60-48ed-48d4-b9c4-9b3688edeede",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-23T17:44:08.5186919+00:00",
"code": "sample string 7"
},
"job_priority_id": "5cd7d490-cd08-40af-96d5-a11b2a7cafeb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6601f5fa-cc7d-4a76-ae63-ad932749b887",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4de68668-aa6b-4e45-8ee5-9fff4fc6be9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-23T17:44:08.5186919+00:00"
},
"job_status_id": "0bd5a64a-e3c0-4524-9f62-394429f56c7a",
"job_status_code": "sample string 11",
"db_address_id": "edff87b2-c9db-4723-8ced-fce835a6d54a",
"contact_id": "cebf55df-20bb-43f7-a627-1686c882bc2f",
"requested_by_company_id": "d486d637-a6a5-46ab-adba-c41704bf926b",
"requested_by_contact_id": "50b8611c-bae7-4d54-9071-a8a3b04a726e",
"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-23T17:44:08.5186919+00:00",
"due_date": "2026-10-23T17:44:08.5186919+00:00",
"date_create": "2026-10-23T17:44:08.5186919+00:00",
"date_update": "2026-10-23T17:44:08.5186919+00:00",
"date_closed": "2026-10-23T17:44:08.5186919+00:00",
"suggested_user_id": "68ba6023-c882-4897-8a09-3c50f9addf49",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d8f33430-0af0-4fe8-a28b-0211a67251af",
"db_language_id": "8db46415-1211-41d5-98fc-002779aa7b42",
"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-23T17:44:08.5186919+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8e77fc9e-e31a-4991-8a5d-560f7501e6a2",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b4e23f7e-097d-498c-94c7-5a3b6c90d045",
"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": "7c32053d-fead-4c82-9e1b-c8789c7b4e96",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-23T17:44:08.5186919+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dd7ec264-6bab-4aec-a802-2c6ae3b7588d"
},
"suggested_date_start": "2026-10-23T17:44:08.5186919+00:00",
"skill_id": "ff83c5e4-4ae4-4281-99db-965dc4314f39",
"skill_code": "sample string 32",
"skill": {
"id": "66bc9861-d7ef-4220-a439-01621552b437",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d8b90d8a-82a4-4cb9-ac47-f683af25f4bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "73c4f831-30ff-4e46-9efe-0cac6a865893",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fe2552-1999-4fa2-836f-a0e94226a5d9",
"db_currency_id": "b8bd0a85-a7aa-4dbc-82f6-b5acc8f87284",
"db_language_id": "f4351396-9621-419e-b680-b0e1a4f74dff",
"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-23T17:44:08.5016352+00:00"
},
"modified_dateutc": "2026-10-23T17:44:08.5186919+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f4c4ff6d-f1cf-4b5e-b781-a13deec5037b",
"date_reported_by_company": "2026-10-23T17:44:08.5186919+00:00",
"id2": 36,
"company_id": "81e5cc90-9550-4dcc-943b-638730425323",
"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": "7944d599-0cf0-4ab9-837f-7aaeabf4f827",
"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-23T17:44:08.5186919+00:00"
},
"work_instruction_details_id": "b4a053ed-86f7-422a-8029-c8a70290e479",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ca474e51-9c2b-4785-b836-07274fa83332",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "94afefbc-2f78-4c66-9808-1a7f501ec000",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-23T17:44:08.5186919+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": "29275eca-04b8-4325-9c23-e724405ddec5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-23T17:44:08.5186919+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.