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": "5c5d04ca-c869-4c22-a6e4-ddeb4982b4d1",
"jobs_id": "21a3c15a-53ba-488e-8fc4-df0035c71a45",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5e648dd6-c1de-4afc-bd91-6e9a39f21044",
"_parent_id": "b068f664-0494-426b-b1a1-134771441761",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f05d3df4-83de-4289-8158-b09e3fbe09e3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b7b03f26-779c-4e71-bddc-224e2e39ce73",
"_parent_id": "1bfd724f-cbe2-46ba-958e-244eedf26818",
"root_parent_id": "e89a750e-c216-4cd7-9f3f-a676791597cc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ce6528ee-9f78-40b1-b9ff-1389574d3b0d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "01662c55-e070-46cc-94b1-813b1b5b3e4d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5b44a10-07c9-4f7f-835a-829133d1ec85",
"_parent_code": "sample string 6",
"sales_organization_id": "edb1a8bd-fb97-4b6c-9a95-f19059b2bc23",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+00:00"
},
"modified_dateutc": "2025-11-20T09:32:46.7174863+00:00"
},
"equipment_model_id": "91bce56e-5c2a-4046-8c14-854bff7a1fb9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "694ba85d-ec70-4a6b-ae64-0ea2df175be6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5a8b0217-f4d2-4b09-bdc0-f3cbf504de61",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8a241b57-3825-401b-92b3-0e73787003ff",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "76b10e46-565d-437e-a0ec-a1912ed47b84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+00:00"
},
"modified_dateutc": "2025-11-20T09:32:46.7174863+00:00"
},
"equipment_family_id": "9f89306a-376d-4be2-9cff-74bae124b868",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "01662c55-e070-46cc-94b1-813b1b5b3e4d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f5b44a10-07c9-4f7f-835a-829133d1ec85",
"_parent_code": "sample string 6",
"sales_organization_id": "edb1a8bd-fb97-4b6c-9a95-f19059b2bc23",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+00:00"
},
"modified_dateutc": "2025-11-20T09:32:46.7174863+00:00"
},
"date_in_production_since": "2025-11-20T09:32:46.7174863+00:00",
"date_out_of_production_since": "2025-11-20T09:32:46.7174863+00:00",
"date_end_support": "2025-11-20T09:32:46.7174863+00:00",
"sales_organization_id": "2911f196-5f9a-437b-88f5-d035d9602ed7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+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": "2025-11-20T09:32:46.7174863+00:00"
},
"project_status_id": "e3bfeb8c-8cb2-4d9f-98dd-d8fcbd1b11d3",
"project_status_code": "sample string 10",
"project_status": {
"id": "1c721022-46ca-4165-ba69-8aa15657a87f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ad2f3ee5-d4e2-4fe0-a3fa-f4055cea4a47",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-20T09:32:46.7174863+00:00"
},
"company_id": "8f64cb62-9463-4355-9bc4-bcf9a00751a1",
"company_code": "sample string 12",
"db_address_id": "e061dd46-a611-4c35-89e4-79dccb905979",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b1ab6a12-2441-491c-a751-900ae51c7b0f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2329e1c3-ecc0-4f53-9c1e-a3332a6e1e79",
"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": "2025-11-20T09:32:46.7174863+00:00",
"date_create": "2025-11-20T09:32:46.7174863+00:00",
"date_update": "2025-11-20T09:32:46.7174863+00:00",
"updated_by_user_id": "fb206151-1499-4df6-84e2-7e6bd90852ed",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-20T09:32:46.7174863+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": "2025-11-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-20T09:32:46.7174863+00:00",
"date_last_job": "2025-11-20T09:32:46.7174863+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-20T09:32:46.7174863+00:00",
"modified_dateutc": "2025-11-20T09:32:46.7174863+00:00",
"is_mobile_installation": true
},
"job_type_id": "26970f8c-e2dd-4cae-97a7-97ecd452244d",
"job_type_code": "sample string 7",
"job_type": {
"id": "afb8da85-7639-43e3-85b6-7ea350c9d292",
"name": "sample string 2",
"sales_organization_id": "40847210-839a-4281-b865-88622f0f80bd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-20T09:32:46.7174863+00:00",
"code": "sample string 7"
},
"job_priority_id": "6368e990-f282-4a87-a80c-53bced53184b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2e23f265-90be-493a-8868-fae5ecb0f43d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "428d40df-2b00-4d83-8b64-29ae4dc81198",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-20T09:32:46.7174863+00:00"
},
"job_status_id": "5745667e-6825-4bc8-be0e-cbdbabc337f8",
"job_status_code": "sample string 11",
"db_address_id": "8b764c05-1743-43c1-b68d-78b10e72e25b",
"contact_id": "b0156bcc-d368-40ea-a7ff-bf00418c9eef",
"requested_by_company_id": "9cf08557-ae20-478d-b3cf-a935998a98f8",
"requested_by_contact_id": "36318e14-98c0-4f87-a7ff-f8711b3819b0",
"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": "2025-11-20T09:32:46.7174863+00:00",
"due_date": "2025-11-20T09:32:46.7174863+00:00",
"date_create": "2025-11-20T09:32:46.7174863+00:00",
"date_update": "2025-11-20T09:32:46.7174863+00:00",
"date_closed": "2025-11-20T09:32:46.7174863+00:00",
"suggested_user_id": "d42a17fc-6395-4226-85f4-f41abaa70a57",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a8743d60-dce2-4810-aa7f-caba23a3b0e1",
"db_language_id": "ccb3a371-d831-43a5-939b-8ad828951d7a",
"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": "2025-11-20T09:32:46.7174863+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e22ed1cb-48e1-4bd4-a894-79dad316e120",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e0c69643-66ce-40eb-90c8-145fcc17e578",
"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": "fb203cde-ce53-4219-975e-f0fe9f591a07",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-20T09:32:46.7330925+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4faa726c-1ad3-43d1-8280-a31893c59183"
},
"suggested_date_start": "2025-11-20T09:32:46.7330925+00:00",
"skill_id": "2043e1a0-851e-45a1-a508-b62ec95c67ef",
"skill_code": "sample string 32",
"skill": {
"id": "f5f4d06b-3828-4a05-bcc0-6637a1278460",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dad6b075-6727-41d5-a328-68b121e77891",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a15b6493-061e-47aa-be10-e6fea09f34cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac5c61d3-b6a3-4684-98aa-59d8758564eb",
"db_currency_id": "aad1ac9b-c0d3-4a73-8be1-c0689ed7b861",
"db_language_id": "da6e812c-6cf1-4d3f-b963-65557ce9d761",
"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": "2025-11-20T09:32:46.7174863+00:00"
},
"modified_dateutc": "2025-11-20T09:32:46.7330925+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ceb28b6b-abfa-450d-99da-843239e561c2",
"date_reported_by_company": "2025-11-20T09:32:46.7330925+00:00",
"id2": 36,
"company_id": "c1d7d745-67cf-4a3e-892c-de26ba5c3586",
"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": "84fdec3f-028b-40e3-b01a-f1c6ec92ba3b",
"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": "2025-11-20T09:32:46.7330925+00:00"
},
"work_instruction_details_id": "b10e40e4-031b-438d-812f-7527de099f27",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f7f48d6d-1723-4a0d-99b3-409ce24f3b6e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "af929f62-2a41-4235-b9e1-43f435c9b5cb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-20T09:32:46.7330925+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": "597aaeb0-1d7a-47c2-b8e3-5dcd9f591e57",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-20T09:32:46.7330925+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.