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": "f81584ca-1981-4f02-b177-2713982fecb2",
"jobs_id": "1eef5681-5330-4737-bfe5-d5be7f3edc02",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0704837a-f8e7-4d43-bb97-c31475190d2e",
"_parent_id": "1d8e9a68-325a-4af1-9c99-eeb6e01117d4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "caf2474e-d2a0-4377-a10a-b7deb122140b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3d39abaa-1917-4118-b928-4bd3d5792a04",
"_parent_id": "0dbd9388-aba8-4546-b431-daaa278ef716",
"root_parent_id": "72399622-edb1-4bd0-a7ef-436a7f2d8bc8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "164a20f5-99ff-4130-9353-b71266109fdd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f0adeb54-736f-4110-ad63-be0c5db6349f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9d2cdc4-0c42-4644-b050-a7d68100d944",
"_parent_code": "sample string 6",
"sales_organization_id": "a3d3c113-d6b3-49a2-88c6-3ce2ddad6534",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+00:00"
},
"modified_dateutc": "2026-10-30T06:39:22.6255888+00:00"
},
"equipment_model_id": "21601fa1-4990-40b0-a4f6-3fa0f23f1961",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d25c455d-bb13-434f-948c-a5d283f5e302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "307e9b1c-15fd-4e04-9425-fe279a33dd70",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fa136e61-1123-45a2-8d77-45d6818f46e3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "db58d3be-3f58-4d0f-a891-87f2a2db9943",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+00:00"
},
"modified_dateutc": "2026-10-30T06:39:22.6255888+00:00"
},
"equipment_family_id": "b86fd610-afb1-46a6-9b3a-87d7d8a86072",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f0adeb54-736f-4110-ad63-be0c5db6349f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9d2cdc4-0c42-4644-b050-a7d68100d944",
"_parent_code": "sample string 6",
"sales_organization_id": "a3d3c113-d6b3-49a2-88c6-3ce2ddad6534",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+00:00"
},
"modified_dateutc": "2026-10-30T06:39:22.6255888+00:00"
},
"date_in_production_since": "2026-10-30T06:39:22.6255888+00:00",
"date_out_of_production_since": "2026-10-30T06:39:22.6255888+00:00",
"date_end_support": "2026-10-30T06:39:22.6255888+00:00",
"sales_organization_id": "d5239891-f29d-4d34-be80-6053f417b41c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+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-10-30T06:39:22.6442606+00:00"
},
"project_status_id": "c1bd25df-5366-4229-a163-e18ed869bde5",
"project_status_code": "sample string 10",
"project_status": {
"id": "7b298bc3-36b0-451a-89c6-13ae13d2f3a8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a73df39e-ba8f-412d-a59c-34745ea6dba7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T06:39:22.6442606+00:00"
},
"company_id": "7b20d121-88e1-4182-bbf0-6d8cea784aac",
"company_code": "sample string 12",
"db_address_id": "1d54a7ee-757c-4521-ba6b-2cad49db3b0c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bf40091c-f27e-4e00-a463-942132914a28",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "67fb11f4-7860-433e-a94d-e97f17c5685b",
"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-10-30T06:39:22.6442606+00:00",
"date_create": "2026-10-30T06:39:22.6442606+00:00",
"date_update": "2026-10-30T06:39:22.6442606+00:00",
"updated_by_user_id": "c97dcb97-ac2a-47b0-92f2-3fdbc1c9afbf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-30T06:39:22.6442606+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-10-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-30T06:39:22.6442606+00:00",
"date_last_job": "2026-10-30T06:39:22.6442606+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-30T06:39:22.6442606+00:00",
"modified_dateutc": "2026-10-30T06:39:22.6442606+00:00",
"is_mobile_installation": true
},
"job_type_id": "5aef803b-fcc5-48ab-a264-080ac9825424",
"job_type_code": "sample string 7",
"job_type": {
"id": "7358ee9a-141a-438d-8295-3ac79b9309dc",
"name": "sample string 2",
"sales_organization_id": "429c7aea-c943-4730-ab4a-6e9af6aa33a0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-30T06:39:22.6442606+00:00",
"code": "sample string 7"
},
"job_priority_id": "d447684d-c36e-4cf9-b9ad-fe0b7e183fec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ab70d6e5-c6a1-46c7-8c5f-4d14dad7ddd6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0124b7f7-222d-47ba-8661-0d2ad12f3efa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T06:39:22.6442606+00:00"
},
"job_status_id": "24defef1-a2c7-4b3c-baa6-d2b0a8eee4f6",
"job_status_code": "sample string 11",
"db_address_id": "0bd7e694-2e0f-456f-827b-ffefaacfaa2d",
"contact_id": "6a261b32-0392-4f08-b899-a9cec95572d5",
"requested_by_company_id": "f9ea517b-5813-46ef-9950-d252d25c612b",
"requested_by_contact_id": "d3288ddb-2ed1-488e-8e5c-a7950103267a",
"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-10-30T06:39:22.6442606+00:00",
"due_date": "2026-10-30T06:39:22.6442606+00:00",
"date_create": "2026-10-30T06:39:22.6442606+00:00",
"date_update": "2026-10-30T06:39:22.6442606+00:00",
"date_closed": "2026-10-30T06:39:22.6442606+00:00",
"suggested_user_id": "497f98cc-2d22-4160-ae32-ed37cd20a0f3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0461ab36-3740-4d1c-857f-541feb970303",
"db_language_id": "335db573-07cb-434d-9403-f9bf04dc96d5",
"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-10-30T06:39:22.6442606+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a76746f2-8f29-47ec-b838-d990cc50761b",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c56e2883-4cef-45d2-9e44-34297e79f1ef",
"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": "9a78133b-b57d-4b8b-9593-17797868bb4b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-30T06:39:22.6442606+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "15595bc4-58a3-4020-90b6-451374484275"
},
"suggested_date_start": "2026-10-30T06:39:22.6442606+00:00",
"skill_id": "e5d945e0-ce2b-447a-b178-b104b5c057e7",
"skill_code": "sample string 32",
"skill": {
"id": "4b590692-0b01-4608-b7da-3956ee4261d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1bb9f724-a0fc-427c-be5c-c16ddbf66bc2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b49647c7-eb11-44f4-b1f2-73f8773fa4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c61b08d-b61a-49d5-bdcc-4ad0c134d25d",
"db_currency_id": "c0a1f51a-829c-49ca-a352-03bcaa5ec13c",
"db_language_id": "172f5760-5a05-45aa-9c38-c2a19dd5c2a1",
"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-10-30T06:39:22.6255888+00:00"
},
"modified_dateutc": "2026-10-30T06:39:22.6442606+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b439a684-f957-4fe7-b40e-b7a7ba57101d",
"date_reported_by_company": "2026-10-30T06:39:22.6442606+00:00",
"id2": 36,
"company_id": "6595c2b7-c949-455b-bcd9-aecec1152105",
"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": "a4d55c67-e693-4880-a218-b34180aca51f",
"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-10-30T06:39:22.6442606+00:00"
},
"work_instruction_details_id": "a0f20b78-9c73-4e9a-b7bf-7c8d18f8f588",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c778dc95-6e93-4dab-ac7f-2685b01228ca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "10bbcbca-a99e-437b-a457-ed3ffd0cf539",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-30T06:39:22.6442606+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": "2ea23aad-bb1a-41c7-b002-85ec5c0ca3c5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-30T06:39:22.6550074+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.