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": "5c72b5fd-f7e6-4d38-9acd-04b952f9f6b2",
"jobs_id": "5b90cf1e-ddcf-43bb-ace1-a0b553c18f82",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "02fcfd57-6e92-4f5d-9c48-3424559a5d93",
"_parent_id": "0d21bc9d-09f4-408d-84b6-afef509bd8b4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db2135a4-0a85-4a38-968d-d54ea5662270",
"project_reference_back_office": "sample string 5",
"project": {
"id": "295b03fb-32a4-43a2-8420-15b41f149083",
"_parent_id": "17aa8cf2-e3db-48b6-8784-2df2b9e2e585",
"root_parent_id": "0a672919-4e07-4ce6-8689-dbbb595f12bd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "da6d5d26-ed01-4136-a5e6-c7b269cc2ead",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ce52f8be-04ec-4738-b70d-df2d84036fe2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f4710f6-3309-463f-8f02-90ee3bb75aef",
"_parent_code": "sample string 6",
"sales_organization_id": "2c5cad01-00d4-42c5-82ca-d198d3af9a03",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+00:00"
},
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00"
},
"equipment_model_id": "5221a5c5-dba4-46d9-816a-d70a017f5ca0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "74160e05-bfa4-4471-b323-c17ce9378548",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f015cf55-5cf9-4f1d-8ca1-355e63dd4ad9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "01689c5a-150f-4574-8e15-397084a27e73",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "306d219b-4eff-4f06-8616-bdc626a58982",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+00:00"
},
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00"
},
"equipment_family_id": "197c9fae-7785-4d19-b1bc-7d6acca2d797",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ce52f8be-04ec-4738-b70d-df2d84036fe2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f4710f6-3309-463f-8f02-90ee3bb75aef",
"_parent_code": "sample string 6",
"sales_organization_id": "2c5cad01-00d4-42c5-82ca-d198d3af9a03",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+00:00"
},
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00"
},
"date_in_production_since": "2026-02-19T04:53:35.6785446+00:00",
"date_out_of_production_since": "2026-02-19T04:53:35.6785446+00:00",
"date_end_support": "2026-02-19T04:53:35.6785446+00:00",
"sales_organization_id": "c2cf03ef-0939-4c71-a252-cc842994cb7c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+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-02-19T04:53:35.6785446+00:00"
},
"project_status_id": "ff1b5cfc-fcef-4d45-b6b6-07497b9ad043",
"project_status_code": "sample string 10",
"project_status": {
"id": "e94002a0-13bb-4b9f-907e-9f92f27389ea",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0ed4e77a-91e5-4d89-868a-bdd74e28a126",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00"
},
"company_id": "cae8929d-32a6-4420-b6cf-86535a3fd28a",
"company_code": "sample string 12",
"db_address_id": "70b0646c-d8ad-4b96-9683-f225f295ce2b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "32145072-f044-4bfa-81e3-4f8c80a521ae",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "01bd6bb9-bb1a-4181-8c70-19db7ba895af",
"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-02-19T04:53:35.6785446+00:00",
"date_create": "2026-02-19T04:53:35.6785446+00:00",
"date_update": "2026-02-19T04:53:35.6785446+00:00",
"updated_by_user_id": "f403ecfe-50b8-44d4-8520-c1494f6d9ecd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-19T04:53:35.6785446+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-02-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-19T04:53:35.6785446+00:00",
"date_last_job": "2026-02-19T04:53:35.6785446+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-19T04:53:35.6785446+00:00",
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00",
"is_mobile_installation": true
},
"job_type_id": "089b6ee4-71ee-49be-912e-227ab9354393",
"job_type_code": "sample string 7",
"job_type": {
"id": "8a3833db-75ca-45da-815e-e176581832c8",
"name": "sample string 2",
"sales_organization_id": "6ecdc74a-4250-4144-8f9a-9eb88d7441d5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00",
"code": "sample string 7"
},
"job_priority_id": "c17ccb3c-6c03-4c6c-99a5-3230ec9580fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d9217dbb-61a5-4a6a-9b09-60d9f00225f8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6908e859-59ad-4beb-aaaf-5554e9dbc669",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00"
},
"job_status_id": "3bb2a3d4-2308-4f35-b2f3-516d361dc2fb",
"job_status_code": "sample string 11",
"db_address_id": "26d0d15b-da4c-4203-a532-0a5b7a6c81eb",
"contact_id": "7a3fb110-f67f-4677-902e-dd2eba61fb07",
"requested_by_company_id": "3f8f2fc7-dc7d-44a6-a0b9-cd346d148fc6",
"requested_by_contact_id": "fa3ca673-04a5-4131-b295-8449e9efa2ab",
"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-02-19T04:53:35.6785446+00:00",
"due_date": "2026-02-19T04:53:35.6785446+00:00",
"date_create": "2026-02-19T04:53:35.6785446+00:00",
"date_update": "2026-02-19T04:53:35.6785446+00:00",
"date_closed": "2026-02-19T04:53:35.6785446+00:00",
"suggested_user_id": "08989071-197e-4ce7-97c4-d9efda6328ad",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c92a3116-f38f-4f1c-94ea-a582b38b9055",
"db_language_id": "23fb0a89-c2d8-4def-9f96-e9426c1b7a31",
"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-02-19T04:53:35.6785446+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "50f80d7a-9f02-4328-8c37-d99a05800ceb",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a7bd98a2-1f5f-495e-aa17-53321f1e5bc2",
"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": "6430edeb-27c7-4433-80df-1c33eaffb0d4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e3a2b100-710f-4352-b006-7358b681e9bd"
},
"suggested_date_start": "2026-02-19T04:53:35.6785446+00:00",
"skill_id": "5a392549-abf3-4649-b6fd-99811eec011c",
"skill_code": "sample string 32",
"skill": {
"id": "350afea1-f3d9-4fef-92ae-0ad1bfb8dcff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "773887ac-2124-40f8-a5c7-e457b56ac864",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cd4688e2-c2dc-4700-bc48-b9b11355b858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ecaaff2-ff87-459f-95ea-ed6a1c1e8949",
"db_currency_id": "0642488c-ad6c-407b-a5e5-a22de12b7c6f",
"db_language_id": "9b32a875-7864-429b-bc71-7ccfadb12a20",
"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-02-19T04:53:35.6785446+00:00"
},
"modified_dateutc": "2026-02-19T04:53:35.6785446+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ee9c6bb0-efbd-4328-8abc-2a995d2ec526",
"date_reported_by_company": "2026-02-19T04:53:35.6785446+00:00",
"id2": 36,
"company_id": "cc034e86-55d7-4fd8-b3a3-cd4634d543f0",
"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": "c47db8e2-9ee7-47a9-8532-cb696d5f6412",
"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-02-19T04:53:35.6785446+00:00"
},
"work_instruction_details_id": "50a1c272-2d17-410e-94e0-e7cb197e4380",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4ce60f1e-8154-432c-b589-d675a20fe07e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6cc78048-3b83-4ed1-831c-0ffd81b11eb7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-19T04:53:35.6785446+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": "ac7100c4-c6b7-4b47-bf5a-9f0d863c64f0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-19T04:53:35.6941659+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.