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": "86b876dc-cc2f-48f6-b3fe-885923dfe14f",
"jobs_id": "2797829a-a68e-446e-8b48-09a1faf3287c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7dd3ff78-9804-47d8-b0ba-f8e25430e61d",
"_parent_id": "f8836b4a-a221-4221-81d0-afb6a3445638",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1a44865a-f8bd-4814-8600-1802e8cb54a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "585b6388-3366-45e0-8b9c-d6ba6587a74e",
"_parent_id": "ce48a632-4ae4-4b4e-88cc-ad387b4bdcd7",
"root_parent_id": "c9fff69f-d41b-4c97-901c-2716bf390c07",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5874fde4-9790-49b2-bb12-1a9b001d7de7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e89b0d91-2391-4ce5-9dff-e43450907026",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "991003fd-f887-4f19-a14b-614fe1f555c5",
"_parent_code": "sample string 6",
"sales_organization_id": "9a4b959c-a9b4-4295-81b0-40fdb765a6e1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+00:00"
},
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00"
},
"equipment_model_id": "b7045db6-5a27-40cd-9d81-6cda16ff6ccd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7e5e3286-2dcc-4868-a11e-12235b2ed25e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3df7d018-1cdc-4ffc-a9fa-a220a736200d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4cffd8a2-6b4c-4af5-907e-eead333f1a32",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4a560e31-b851-47a5-a6fd-83113964b397",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+00:00"
},
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00"
},
"equipment_family_id": "f6817661-2154-4e27-bd66-fffa152e57d8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e89b0d91-2391-4ce5-9dff-e43450907026",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "991003fd-f887-4f19-a14b-614fe1f555c5",
"_parent_code": "sample string 6",
"sales_organization_id": "9a4b959c-a9b4-4295-81b0-40fdb765a6e1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+00:00"
},
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00"
},
"date_in_production_since": "2026-04-21T09:53:22.7632779+00:00",
"date_out_of_production_since": "2026-04-21T09:53:22.7632779+00:00",
"date_end_support": "2026-04-21T09:53:22.7632779+00:00",
"sales_organization_id": "86bfe9d8-a8d9-4b21-a222-dc53ced87047",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+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-21T09:53:22.7632779+00:00"
},
"project_status_id": "34330289-12d7-447f-9f03-49925b1f041c",
"project_status_code": "sample string 10",
"project_status": {
"id": "2d94319d-3de0-40c5-92ab-0e847384db2c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "13ff906c-e7c7-4af9-ba2d-f9f4445a9d52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00"
},
"company_id": "8d3d2aca-0230-4f83-97ed-f655f90ef429",
"company_code": "sample string 12",
"db_address_id": "10c1a28f-2b09-4adb-8bac-2357f31cfd82",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "296946ed-f837-407e-97c8-a8d5042d82a1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f8db23e1-1280-435e-a8ff-6defebdcb5f7",
"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-21T09:53:22.7632779+00:00",
"date_create": "2026-04-21T09:53:22.7632779+00:00",
"date_update": "2026-04-21T09:53:22.7632779+00:00",
"updated_by_user_id": "92fdadfc-fc03-4a52-8848-8d17df7c19f4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-21T09:53:22.7632779+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-21T09:53:22.7632779+00:00",
"date_last_job": "2026-04-21T09:53:22.7632779+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-21T09:53:22.7632779+00:00",
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00",
"is_mobile_installation": true
},
"job_type_id": "2d9ef727-917b-49d1-ac80-eed7649c1547",
"job_type_code": "sample string 7",
"job_type": {
"id": "bb95d4d8-59be-46ee-81a3-8648930bd9a3",
"name": "sample string 2",
"sales_organization_id": "947f5c3b-2be4-450e-9a7f-2600febb5127",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00",
"code": "sample string 7"
},
"job_priority_id": "f77f7126-3087-42e7-bd24-5be4e9acb09d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "291fe41b-6e34-4e83-bddd-f3b2f16ff34f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0c399ce0-e634-419d-a33a-d93e359fdcbe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00"
},
"job_status_id": "dad97c92-76a5-4056-8670-e6de53068790",
"job_status_code": "sample string 11",
"db_address_id": "4d8fab72-c614-47a4-967e-47b3649d5c1d",
"contact_id": "518140b1-48b5-410b-b458-75113e848e00",
"requested_by_company_id": "9a725038-391b-4b19-bffb-56a8ed66c41d",
"requested_by_contact_id": "a319cd03-8e88-4d2a-a377-8d3af3c5286d",
"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-21T09:53:22.7632779+00:00",
"due_date": "2026-04-21T09:53:22.7632779+00:00",
"date_create": "2026-04-21T09:53:22.7632779+00:00",
"date_update": "2026-04-21T09:53:22.7632779+00:00",
"date_closed": "2026-04-21T09:53:22.7632779+00:00",
"suggested_user_id": "9a151f7e-6198-4246-9a28-2e27fa306aef",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d96905f4-1b45-46f4-99df-2871c12ea569",
"db_language_id": "b5947e70-b606-4a0d-b1ce-9e7bef80ac08",
"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-21T09:53:22.7632779+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ccef1694-7ce0-4ed4-987c-89451d58e6e0",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fb692420-99e1-4ded-8d20-ce27aebbbcb0",
"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": "38b523c3-9bf1-464e-aaa9-d6b6dd7d821a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7ab01183-4529-4cae-941c-f0a3cb7a3c59"
},
"suggested_date_start": "2026-04-21T09:53:22.7632779+00:00",
"skill_id": "3455c7a8-d25c-49d8-bde1-c3e430c676e8",
"skill_code": "sample string 32",
"skill": {
"id": "72be80d4-694b-47fc-b273-f76878a90b39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dbba0a88-516c-43da-a47c-82f330f75eaf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ab6213b9-cfb1-4243-91cc-430975f6657e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7c1f0d7-d111-4a7b-bf54-854797f06091",
"db_currency_id": "1711c95f-d695-4ef6-8f0e-5d049085d1c7",
"db_language_id": "103a9f4b-d26a-4aae-8f0a-b5e93fa132dc",
"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-21T09:53:22.7632779+00:00"
},
"modified_dateutc": "2026-04-21T09:53:22.7632779+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "deb29074-cc2e-4a7d-b315-86c3be35b157",
"date_reported_by_company": "2026-04-21T09:53:22.7632779+00:00",
"id2": 36,
"company_id": "9dcdfb90-be6a-4a31-a2db-8b1a44386939",
"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": "95deef8d-38fb-40de-8e51-cb2ff2d7eac1",
"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-21T09:53:22.7632779+00:00"
},
"work_instruction_details_id": "c2e5cb80-22f0-4695-bc78-78059f1e4b34",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b30bebc3-363e-4377-b23c-53cdecec2484",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d3b77d1f-6914-4ed5-bfdb-9cb587092f6a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-21T09:53:22.7632779+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": "85a2ac85-f406-4138-a6be-c8c5c2c712db",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-21T09:53:22.7789065+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.