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": "3ce52160-a201-412c-82c8-c38020980774",
"jobs_id": "c0f3ad1d-7992-4e78-b6d0-b51f6d42a809",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2d600b1b-c875-47ff-b4aa-4887614bf0db",
"_parent_id": "2d0bc385-8111-4120-bcbd-8bf19fcb04f5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1229ab2e-a189-4a33-ad8f-c30734c6bf8c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e84cec03-2cd7-4090-a5f2-4734173ff25c",
"_parent_id": "ec514bec-5b23-4b98-a9a9-045b25997f29",
"root_parent_id": "bda1d874-5f94-4578-b35b-9494eeda264e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e0510eaf-bbc7-47b6-9bc3-e7a488cf4758",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "23a3f480-44b5-4ef4-bbe7-0e81af6c40b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29315d28-0d7d-4983-93c3-99377dd75f21",
"_parent_code": "sample string 6",
"sales_organization_id": "81ecadd3-89a6-44d4-a3c9-6882ea182cac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+00:00"
},
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00"
},
"equipment_model_id": "22325e01-042a-46e1-b9c7-59e7657fa914",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8fe17510-6fea-4ed0-b6c0-c33fcef85df0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "370365f3-a30e-4298-a868-c4cc1868322d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fd15c8ae-0e87-4f05-9cfb-b5f054f5e492",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "09a97273-6700-4050-b88e-5af3bb0c2dfe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+00:00"
},
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00"
},
"equipment_family_id": "bc56d024-5da1-4b3f-ab0f-59acecda9af8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "23a3f480-44b5-4ef4-bbe7-0e81af6c40b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29315d28-0d7d-4983-93c3-99377dd75f21",
"_parent_code": "sample string 6",
"sales_organization_id": "81ecadd3-89a6-44d4-a3c9-6882ea182cac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+00:00"
},
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00"
},
"date_in_production_since": "2026-05-02T08:04:12.375281+00:00",
"date_out_of_production_since": "2026-05-02T08:04:12.375281+00:00",
"date_end_support": "2026-05-02T08:04:12.375281+00:00",
"sales_organization_id": "5fc21bd1-033d-4a56-b23a-6f391568d178",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+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-05-02T08:04:12.375281+00:00"
},
"project_status_id": "7f23c886-5958-494b-a94e-1cf513aaaf18",
"project_status_code": "sample string 10",
"project_status": {
"id": "559ee460-ebef-4afd-8c24-61815b786ee7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "60c658bd-2598-4189-bdf3-b47dab08c169",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00"
},
"company_id": "2d70b231-757f-45fe-b4a5-941e488d6950",
"company_code": "sample string 12",
"db_address_id": "0f262843-135d-4c61-9177-400794abf58e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "555c5348-e95c-4e9e-b85c-5814e418839c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7e2390e2-db1f-4e38-806f-cd8201dbf358",
"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-05-02T08:04:12.375281+00:00",
"date_create": "2026-05-02T08:04:12.375281+00:00",
"date_update": "2026-05-02T08:04:12.375281+00:00",
"updated_by_user_id": "cf3ffff5-6e79-41b6-81ab-cc6bea8c2724",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-02T08:04:12.375281+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-05-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-02T08:04:12.375281+00:00",
"date_last_job": "2026-05-02T08:04:12.375281+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-02T08:04:12.375281+00:00",
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00",
"is_mobile_installation": true
},
"job_type_id": "7df99050-175c-47b2-875a-9203d0a726db",
"job_type_code": "sample string 7",
"job_type": {
"id": "7092d0f9-712c-46d1-922f-7d97b7f90e7b",
"name": "sample string 2",
"sales_organization_id": "7a9918eb-1de0-4030-a53e-64b31e697455",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00",
"code": "sample string 7"
},
"job_priority_id": "6ca5c63b-35a4-409b-8030-cd2c8bce3568",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "50d86d32-3eeb-4b2f-a1bc-cbd21e816884",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25c7dacf-2dd0-4fba-93fb-3094b8bd4bf1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00"
},
"job_status_id": "c670b116-8dfa-4b4f-9980-5c3d271eaecd",
"job_status_code": "sample string 11",
"db_address_id": "2652fccf-4c9d-49ff-ac9b-7a341ee0c4a9",
"contact_id": "025b65af-cdef-4ef7-86a2-4dcb68be66c4",
"requested_by_company_id": "71083021-d414-46bd-970f-dd4523b1ab2f",
"requested_by_contact_id": "24487a6d-bdd0-4618-bbb4-375674855070",
"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-05-02T08:04:12.375281+00:00",
"due_date": "2026-05-02T08:04:12.375281+00:00",
"date_create": "2026-05-02T08:04:12.375281+00:00",
"date_update": "2026-05-02T08:04:12.375281+00:00",
"date_closed": "2026-05-02T08:04:12.375281+00:00",
"suggested_user_id": "098596f8-15e8-4ddc-abbd-5b88a9808c44",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4c4f364a-7edd-4551-b08e-f079833e9a19",
"db_language_id": "488f000b-4b34-43a7-b761-2cce7a7b30c2",
"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-05-02T08:04:12.375281+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "49e1a340-f7e6-4d41-ae2d-809cd0c39a33",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "04c1660e-ae08-4ef3-85dc-92b9c04572b0",
"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": "899d348d-a52b-49d6-b668-438599239e2c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8f78bffb-ef22-4148-99dc-66c4928b62e3"
},
"suggested_date_start": "2026-05-02T08:04:12.375281+00:00",
"skill_id": "c5dfe403-d1b1-4e4a-add8-8a7e55231da1",
"skill_code": "sample string 32",
"skill": {
"id": "0223afc4-b5a6-41a0-a2a2-761911574cca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "496621e6-c1b2-40dd-afcd-e9de247ecc7c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5db131fa-9ced-4e68-a90a-0591c7292cc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "752ab70d-7910-49d5-8b6c-d12e6c870e72",
"db_currency_id": "84e02093-7ee9-4b83-aba9-07968a70e236",
"db_language_id": "0102343c-5552-4ea3-b421-b73c653e2d8a",
"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-05-02T08:04:12.375281+00:00"
},
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "92c4e8d8-4e4f-409a-a3f6-4a00b955ccfb",
"date_reported_by_company": "2026-05-02T08:04:12.375281+00:00",
"id2": 36,
"company_id": "aa83dbbb-0ca6-486c-97c5-f5f2b05ab25a",
"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": "2cf20b6a-b8e3-4686-a4df-2ea5a1c17238",
"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-05-02T08:04:12.375281+00:00"
},
"work_instruction_details_id": "cd385eae-6526-464b-8757-0ec24002f037",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b90c7f8e-62b8-4cab-99b5-0846969143cb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6e485392-aa4c-4488-ad15-66633dd8d490",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-02T08:04:12.375281+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": "7998dc3f-ea92-442b-af37-386c0aa5902f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-02T08:04:12.375281+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.