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
{
"id": "5da74381-5878-4ccd-8119-be3b0e5cd88d",
"jobs_id": "26efdc86-5103-4a5f-ba06-5922af157933",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3fcd2be3-97a2-420d-b24c-3f93aeebc3c1",
"_parent_id": "1e63d83d-7333-4302-a7b9-920cb5df3d94",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "609c5222-ffe3-4578-b092-dddb566634d9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9f293cd8-d1b9-4099-ae12-acaefff99a6b",
"_parent_id": "4b16e32b-dfe9-4e52-8dd6-07470254320a",
"root_parent_id": "40d17c8c-ed91-4d81-8a89-958530c73052",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b2fefe4b-f855-41ba-8571-a8649962f9f0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0b8b8398-c9ad-41e8-8354-8cc9a0c01179",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "33f5de9c-e329-4c4b-8ddd-287ce0a5acca",
"_parent_code": "sample string 6",
"sales_organization_id": "7db0032c-5035-40e7-831e-8373b9bfcae3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+00:00"
},
"modified_dateutc": "2026-11-21T14:23:21.6590622+00:00"
},
"equipment_model_id": "e3edbb5e-8041-4044-ba8e-b618358e31fb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d3c43a5f-8622-415a-85d0-14e79779367c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "68da947c-da4a-4dbb-a5db-b51209748e4f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3743e068-dcdf-43be-b2ce-15d35d661a19",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "309b796d-889b-4ca6-80c7-204ce781c88f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+00:00"
},
"modified_dateutc": "2026-11-21T14:23:21.6590622+00:00"
},
"equipment_family_id": "1b211e90-1f3c-4654-94c8-eebc7af5ad66",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0b8b8398-c9ad-41e8-8354-8cc9a0c01179",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "33f5de9c-e329-4c4b-8ddd-287ce0a5acca",
"_parent_code": "sample string 6",
"sales_organization_id": "7db0032c-5035-40e7-831e-8373b9bfcae3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+00:00"
},
"modified_dateutc": "2026-11-21T14:23:21.6590622+00:00"
},
"date_in_production_since": "2026-11-21T14:23:21.6590622+00:00",
"date_out_of_production_since": "2026-11-21T14:23:21.6590622+00:00",
"date_end_support": "2026-11-21T14:23:21.6590622+00:00",
"sales_organization_id": "c7fd50b7-67a9-4f5b-a003-8e1efa49d92d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+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-11-21T14:23:21.6590622+00:00"
},
"project_status_id": "4f2ceae9-7005-4fe2-bf68-a62a7769b3f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "6109d541-0a6e-4aa8-8115-6c303cbdf393",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9d911b85-51ac-44e5-b790-86f0f1332297",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-21T14:23:21.6590622+00:00"
},
"company_id": "e0d0e2b6-cea2-4775-90db-1cdac8d8eacc",
"company_code": "sample string 12",
"db_address_id": "eab63ab4-c5f8-4527-874b-6b5ea99b8fc9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0397a820-ed72-459b-9367-3a8a8810e86d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "79762d4e-7d1c-4c05-9e3d-3b4f8aa2b2bc",
"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-11-21T14:23:21.6590622+00:00",
"date_create": "2026-11-21T14:23:21.6590622+00:00",
"date_update": "2026-11-21T14:23:21.6590622+00:00",
"updated_by_user_id": "7257eb01-2879-4148-9f1e-21739d64d41f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-21T14:23:21.6590622+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-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-21T14:23:21.6757621+00:00",
"date_last_job": "2026-11-21T14:23:21.6757621+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-21T14:23:21.6757621+00:00",
"modified_dateutc": "2026-11-21T14:23:21.6757621+00:00",
"is_mobile_installation": true
},
"job_type_id": "6d9783dc-33e0-4600-b623-0bb23d946a03",
"job_type_code": "sample string 7",
"job_type": {
"id": "ac06c8e7-3057-45ac-9ba3-6449f2ea6e62",
"name": "sample string 2",
"sales_organization_id": "8d327fda-77bb-4172-a2dc-8424cec01638",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-21T14:23:21.6757621+00:00",
"code": "sample string 7"
},
"job_priority_id": "f4108485-03fa-438d-8120-825c5105d3bd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ea023032-d88a-4aff-9b29-78e71ba0445a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "aef0afc7-e8b9-444d-ab80-0ff7e4c0fe3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-21T14:23:21.6757621+00:00"
},
"job_status_id": "f269ba2e-552c-4779-b0a3-25d19691f1c3",
"job_status_code": "sample string 11",
"db_address_id": "a7e76e1e-214c-47db-bbbc-b5c8f867539d",
"contact_id": "75399bc7-5794-40e0-ad12-d6814aa7a725",
"requested_by_company_id": "2fcf69a9-43ac-4c47-9a38-a0356309c8c5",
"requested_by_contact_id": "fc170cf1-040a-4ce8-97e1-ee4d245eac47",
"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-11-21T14:23:21.6757621+00:00",
"due_date": "2026-11-21T14:23:21.6757621+00:00",
"date_create": "2026-11-21T14:23:21.6757621+00:00",
"date_update": "2026-11-21T14:23:21.6757621+00:00",
"date_closed": "2026-11-21T14:23:21.6757621+00:00",
"suggested_user_id": "06ced3d6-a335-40c6-99b6-d437205a90c1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8610ece7-94c5-4501-a3ba-cd71d11b2eb2",
"db_language_id": "bcf42c98-93c6-4821-9870-481d656df165",
"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-11-21T14:23:21.6757621+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "805d9340-034e-42f8-a6c2-18dc9c26534d",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "affd0867-8452-4e46-a44f-12f294a707fc",
"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": "5e3350e0-4bfc-4d0c-8dd4-54f6ce183224",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-21T14:23:21.6757621+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b5b69528-245a-489b-b441-127c7efe8390"
},
"suggested_date_start": "2026-11-21T14:23:21.6757621+00:00",
"skill_id": "261071ec-5db2-4be8-b8f8-5052332a8a2d",
"skill_code": "sample string 32",
"skill": {
"id": "8a69357b-9bc6-4a1b-850e-52c053992ef8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1e013d2b-6eef-4944-9224-1f21e413d84a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa8e0d4f-d371-4f90-a8f0-e8f5bcf32d1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5fbfddd-7b34-4349-8803-a2aaaae61ffd",
"db_currency_id": "b29ca577-cc1e-44d4-9dd8-93f51ef062da",
"db_language_id": "6d2a93fd-d8f9-4ffe-88c2-25c875d7c67e",
"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-11-21T14:23:21.6463023+00:00"
},
"modified_dateutc": "2026-11-21T14:23:21.6757621+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "95edd6a5-66c5-40d7-bdca-47c61a3dadf4",
"date_reported_by_company": "2026-11-21T14:23:21.6757621+00:00",
"id2": 36,
"company_id": "659c95f5-fe78-44cb-8485-24defeec6049",
"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": "2b11fd20-dff9-411b-a49d-73fb080fb325",
"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-11-21T14:23:21.6757621+00:00"
},
"work_instruction_details_id": "091c3ffa-a043-48d1-b40f-e9dcad8983f7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ab135f2b-c612-49e0-81ce-51b2e7498b1e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4a416a8d-f71e-4678-aa53-a4289c41ac07",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-21T14:23:21.6757621+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": "e1141661-e129-4213-9156-b8fac5cb1ad5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-21T14:23:21.6948104+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.