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": "c31e1f30-0779-47c3-9600-c7c20531582e",
"jobs_id": "4aee73ba-f16d-49cc-9910-44b71efc047a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4c72c753-160b-451d-9600-31f61483c3ec",
"_parent_id": "11a6c2c0-c1ad-415d-9c61-0a75ee162bb7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7eea0907-08a9-45b2-9af6-40b776ea2daf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "afb5c2ab-61ae-47d9-a1db-0dfac63ec920",
"_parent_id": "70350c4f-ff33-44ef-ab11-4cae0de27325",
"root_parent_id": "bf148502-7221-46f4-a76f-94bb54344c6f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ba228072-9c46-4a12-8c38-d3e5fedc42c7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "20778824-a230-4874-9121-338d5562cc11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41e41372-a6a4-48d2-892c-10193552702e",
"_parent_code": "sample string 6",
"sales_organization_id": "5d9443d3-5255-478b-a660-f4c3fe56a82e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+00:00"
},
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00"
},
"equipment_model_id": "446950ef-c779-442c-b350-485fa9a00f74",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7648bd01-bcd3-4387-bc09-f696b0be4713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d3510306-513a-48fb-b64d-483955352fd4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6afd09d3-57e1-4a5b-80fa-f15b0a4164d9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b1cb7721-9932-495d-ba48-494311bf4c7f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+00:00"
},
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00"
},
"equipment_family_id": "db4d8d9b-ca97-427b-a4ca-5409c7718cd5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "20778824-a230-4874-9121-338d5562cc11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41e41372-a6a4-48d2-892c-10193552702e",
"_parent_code": "sample string 6",
"sales_organization_id": "5d9443d3-5255-478b-a660-f4c3fe56a82e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+00:00"
},
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00"
},
"date_in_production_since": "2026-05-07T01:42:51.7944087+00:00",
"date_out_of_production_since": "2026-05-07T01:42:51.7944087+00:00",
"date_end_support": "2026-05-07T01:42:51.7944087+00:00",
"sales_organization_id": "829ebbc0-01b2-4a7f-aa40-4ba0bb503aa2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+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-07T01:42:51.7944087+00:00"
},
"project_status_id": "ced9a71f-bfb3-4b39-935b-f44e7e7a516e",
"project_status_code": "sample string 10",
"project_status": {
"id": "67a37b0e-6695-4ccb-954e-62eb0cb83ed5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "28e4189c-2a63-436e-8ff8-d36ad329972f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00"
},
"company_id": "24dcda6b-66f2-43c1-903b-5722351bfe84",
"company_code": "sample string 12",
"db_address_id": "a8d1c9e2-3797-496b-8a9a-81b1346a9bbd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e2841da1-ca27-4c55-90a7-e7eacd953f0d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "726b127e-80f5-47e7-a4f1-d64f21f8ea2f",
"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-07T01:42:51.7944087+00:00",
"date_create": "2026-05-07T01:42:51.7944087+00:00",
"date_update": "2026-05-07T01:42:51.7944087+00:00",
"updated_by_user_id": "324618f3-2a94-404f-93b4-e08446079dfd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T01:42:51.7944087+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T01:42:51.7944087+00:00",
"date_last_job": "2026-05-07T01:42:51.7944087+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T01:42:51.7944087+00:00",
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00",
"is_mobile_installation": true
},
"job_type_id": "d3b858e1-77a1-41e5-8033-5fae9861d90b",
"job_type_code": "sample string 7",
"job_type": {
"id": "ac5379b4-5b44-47c2-aa00-df6d91960476",
"name": "sample string 2",
"sales_organization_id": "67f9a071-c78d-4b52-b8d0-969ab7ff984e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00",
"code": "sample string 7"
},
"job_priority_id": "36222f0e-6777-4851-a7ac-b2e0806e56e9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "999e4ff9-8022-47e7-98b0-d8dcaaf2f813",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "88942bb2-05da-4cb7-be6e-da3bd6e1c37f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00"
},
"job_status_id": "d627f81d-6ba6-4188-b0dc-cc6ec3487b8e",
"job_status_code": "sample string 11",
"db_address_id": "cd6f96e4-3d7c-4f8a-872a-512023d04707",
"contact_id": "5ad0e371-338a-49c9-a4d5-0fa058a9366c",
"requested_by_company_id": "f4498597-2a99-49fd-8b54-127b287e6d86",
"requested_by_contact_id": "7677cb9d-e2fd-49c2-abeb-35979a43ffde",
"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-07T01:42:51.7944087+00:00",
"due_date": "2026-05-07T01:42:51.7944087+00:00",
"date_create": "2026-05-07T01:42:51.7944087+00:00",
"date_update": "2026-05-07T01:42:51.7944087+00:00",
"date_closed": "2026-05-07T01:42:51.7944087+00:00",
"suggested_user_id": "fa62261a-cef4-4f46-a5ba-e7dfac429e01",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "16df528f-f915-4e60-a946-1d64654bc1e3",
"db_language_id": "9d2aef31-2b02-4086-b6e8-3892ec179044",
"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-07T01:42:51.7944087+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c9605816-3ba2-4807-a63f-6170fa61dab7",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ca6762d7-1ac5-4406-a250-da040cbf0b6c",
"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": "7b6011fb-c374-495d-b74a-26af5aaa55b2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c0506e6c-c9f8-4be7-a71f-b895331d33c6"
},
"suggested_date_start": "2026-05-07T01:42:51.7944087+00:00",
"skill_id": "2c918435-5eaa-45b2-96a2-7dd5f541be40",
"skill_code": "sample string 32",
"skill": {
"id": "8d335af2-c89d-4ab3-bff9-bc92cb3e20cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0278c513-7a65-4884-85c1-88f3cf2a29be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a80b719d-f0bf-4a85-8f4e-f23420d9bfaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0de6e9-a4b7-4b5c-9705-ce12045f3fc3",
"db_currency_id": "4a12e0a8-d3ac-42f0-bb9b-f2f4c5f44cbc",
"db_language_id": "77fb1926-2045-4f3e-bd5a-0feebf0eb413",
"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-07T01:42:51.7944087+00:00"
},
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "eedbe40f-b659-4322-aa0e-6eb46b986e69",
"date_reported_by_company": "2026-05-07T01:42:51.7944087+00:00",
"id2": 36,
"company_id": "7b4c055f-9749-47d3-b629-35da876eead4",
"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": "09a8c856-4eec-40eb-94b7-d41a3e59b7fc",
"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-07T01:42:51.7944087+00:00"
},
"work_instruction_details_id": "ecbd840d-d4a4-49d8-aae9-08399fba2fa7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e9cb0d84-fb8c-4fa4-b37c-79c549488158",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5dd06952-1ab1-4e77-a8a9-4536bb0f7f93",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T01:42:51.7944087+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": "f6b4e846-3247-4bdb-8bac-060acf02b0ff",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T01:42:51.7944087+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.