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": "be738228-3454-4e02-9d75-2b6a7aa1c97e",
"jobs_id": "1834e2d6-95fc-4828-aacd-761c521433f7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "288960eb-4dcb-40fb-acbd-1b044052233e",
"_parent_id": "d6006ccf-9cc2-420c-b9da-4f08c5009fad",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "458e725c-5585-4a28-a2e3-62d7b3b791a5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ecb2e85d-705d-43f9-a7a1-fb274d9fda0c",
"_parent_id": "53a19717-3f5b-4ee6-a2c9-6ae0fc7c967a",
"root_parent_id": "cd02968b-f610-404f-ba42-5db503d34e8d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "163dfe9d-8664-4581-a927-beb00261e737",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "45f384f3-70d8-4d60-b1c4-d5eb78db0b12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c65d2cc2-1dc0-4615-b72c-f446bbcc190c",
"_parent_code": "sample string 6",
"sales_organization_id": "185de495-27a1-465d-9d68-69ddbc95af45",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+00:00"
},
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00"
},
"equipment_model_id": "39765197-bc86-4221-ab0c-3bf9396c4b9d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1054103d-a358-4868-9373-2f8fd394a44b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e7a74862-5e44-403b-9e0a-bc96399f2da5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bc06930a-f632-4385-978e-05a7b45134a1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2bddd549-6aaa-4214-b02b-d61cfb705f0c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+00:00"
},
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00"
},
"equipment_family_id": "c07a8b96-8295-4e9f-aaf5-e4d7fe9da46d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "45f384f3-70d8-4d60-b1c4-d5eb78db0b12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c65d2cc2-1dc0-4615-b72c-f446bbcc190c",
"_parent_code": "sample string 6",
"sales_organization_id": "185de495-27a1-465d-9d68-69ddbc95af45",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+00:00"
},
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00"
},
"date_in_production_since": "2026-04-16T14:50:03.0274591+00:00",
"date_out_of_production_since": "2026-04-16T14:50:03.0274591+00:00",
"date_end_support": "2026-04-16T14:50:03.0274591+00:00",
"sales_organization_id": "abc1ad6b-a1de-4c6a-b9d2-1e81619c03a0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+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-04-16T14:50:03.0274591+00:00"
},
"project_status_id": "85c9cb2d-6e77-4d72-93bd-bec9391ec076",
"project_status_code": "sample string 10",
"project_status": {
"id": "ac78e214-daaf-4c39-9ddf-ef4db967a217",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9cf63e11-0638-4ba5-b47e-3331b390ab6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00"
},
"company_id": "88dc248a-f50b-41d8-b83a-af243e0d657f",
"company_code": "sample string 12",
"db_address_id": "eaf29a5d-7d20-428d-9ef6-dcb247c2e3c9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c6137363-9ec5-43b1-a6c7-a72be8d7938f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f79766e3-e66a-4041-bc4d-ccc39c27f8ea",
"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-04-16T14:50:03.0274591+00:00",
"date_create": "2026-04-16T14:50:03.0274591+00:00",
"date_update": "2026-04-16T14:50:03.0274591+00:00",
"updated_by_user_id": "2ebe9ad8-ad2a-44ea-99ea-411c487eedee",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-16T14:50:03.0274591+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-04-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-16T14:50:03.0274591+00:00",
"date_last_job": "2026-04-16T14:50:03.0274591+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-16T14:50:03.0274591+00:00",
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00",
"is_mobile_installation": true
},
"job_type_id": "39145f06-b4ed-48c5-915b-a397c5e0d6d9",
"job_type_code": "sample string 7",
"job_type": {
"id": "c8f3870d-2c3b-4ff7-83d3-8a24ce397c57",
"name": "sample string 2",
"sales_organization_id": "d150729a-854c-4593-9181-7afbaa35ddfc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00",
"code": "sample string 7"
},
"job_priority_id": "5b6c73c5-a6e3-4409-bfe0-501bd6eb6b40",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0261a197-e8eb-4c14-bce4-1acfa9892934",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a3fc8695-dff5-44be-ac73-bf129e667fc2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00"
},
"job_status_id": "f65e6341-2853-4829-ac30-63190901ebc2",
"job_status_code": "sample string 11",
"db_address_id": "fe70e705-a4bd-4a0f-980c-f837ff07390b",
"contact_id": "f17621a1-7453-4f1e-8a1c-a99cb74de387",
"requested_by_company_id": "2498a76d-696e-4c5c-be01-a006895f4f08",
"requested_by_contact_id": "643c1fb3-8dc8-4228-8d72-7cbef96908dc",
"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-04-16T14:50:03.0274591+00:00",
"due_date": "2026-04-16T14:50:03.0274591+00:00",
"date_create": "2026-04-16T14:50:03.0274591+00:00",
"date_update": "2026-04-16T14:50:03.0274591+00:00",
"date_closed": "2026-04-16T14:50:03.0274591+00:00",
"suggested_user_id": "a1a98ad7-c1b1-4fec-990e-de91a35fef08",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9c24b5c7-311c-42b4-b8cc-079e1aa2552d",
"db_language_id": "9f4dfc16-4936-48e5-8e4f-3841b59240ad",
"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-04-16T14:50:03.0274591+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4961a0f3-27e3-4e28-963b-3067fb0bcb6e",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c6a6c00c-63f5-47ef-9da0-37f0bea1c9db",
"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": "d4b451ea-cd9e-413e-8c6a-9c3d7a0540dd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "da5df15a-3093-4f90-b664-ed211257f4e6"
},
"suggested_date_start": "2026-04-16T14:50:03.0274591+00:00",
"skill_id": "c23417fb-7789-437b-a404-cf8355450132",
"skill_code": "sample string 32",
"skill": {
"id": "9a61914b-e360-44e4-97a0-664e721d1221",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "13d5a9d1-46c2-4665-a4f1-dd2919944657",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5276e99f-3167-41bc-9d2e-56939e062bd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35a345bb-0c31-4534-b4cf-4c3930c879ba",
"db_currency_id": "c6d466e1-5ffb-4e07-a72c-a7605ef74547",
"db_language_id": "516c757b-e867-4951-830b-3a3078b665c9",
"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-04-16T14:50:03.0274591+00:00"
},
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0ced5334-b854-4512-a977-d53f9399a4f2",
"date_reported_by_company": "2026-04-16T14:50:03.0274591+00:00",
"id2": 36,
"company_id": "90a84908-e13a-4902-b3de-462eccb7f46e",
"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": "c1c6f133-f21d-44ce-ab30-e499d9f4725c",
"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-04-16T14:50:03.0274591+00:00"
},
"work_instruction_details_id": "e84fec8b-4b01-47be-b404-1c568f9bd15a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8d927c5a-c927-42ec-928e-130cc0445ec5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bd6ae098-db18-43a2-92e2-51fceb64196c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-16T14:50:03.0274591+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": "9fc8c374-2d9d-4bd0-89c8-0de6d33c9906",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-16T14:50:03.0274591+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.