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": "c85d8710-f651-4c2f-b243-4f5dfa7f2da7",
"jobs_id": "0768c8ac-e21a-4a7b-8706-e87ad00e1291",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5ad7f957-f1e6-41cc-a34e-ae3455efa319",
"_parent_id": "89d0c181-acb6-4a8c-ad6c-a3166316a7f3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7a16375c-b655-4a7d-8ef9-5ca6c0d3b7b7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "000530ae-a427-4069-b637-2b048fcf02e8",
"_parent_id": "b478f352-2351-460e-ad43-f015f0216673",
"root_parent_id": "eb66b5fb-86e0-4bba-8c2c-98b267df1d96",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8758835-ec46-43cf-baa0-15f40268712c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3959e0ce-5602-4966-8e28-072ca19e5988",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c6aec25e-2452-4373-ac9a-59c8a9a1f4fa",
"_parent_code": "sample string 6",
"sales_organization_id": "1a430a6e-9abd-4e74-9e8b-1305bc5f7f3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+00:00"
},
"modified_dateutc": "2026-03-13T04:03:03.0104471+00:00"
},
"equipment_model_id": "eb49416c-5c3b-410f-9b10-0ae04ae11eb6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6795db44-8227-4f30-a791-528f3e9cd99d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b8fcb887-6d26-480c-86e7-ad34b1196d49",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2f1bd70f-babe-40dd-88e2-801f7b9a1623",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8e32c48c-2ae1-4de2-8002-5935942ad930",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+00:00"
},
"modified_dateutc": "2026-03-13T04:03:03.0104471+00:00"
},
"equipment_family_id": "78196997-0dff-41b4-9e74-9eaed75188cf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3959e0ce-5602-4966-8e28-072ca19e5988",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c6aec25e-2452-4373-ac9a-59c8a9a1f4fa",
"_parent_code": "sample string 6",
"sales_organization_id": "1a430a6e-9abd-4e74-9e8b-1305bc5f7f3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+00:00"
},
"modified_dateutc": "2026-03-13T04:03:03.0104471+00:00"
},
"date_in_production_since": "2026-03-13T04:03:03.0270683+00:00",
"date_out_of_production_since": "2026-03-13T04:03:03.0270683+00:00",
"date_end_support": "2026-03-13T04:03:03.0270683+00:00",
"sales_organization_id": "702d05c4-7b71-426d-824b-6052f34be2a6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+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-03-13T04:03:03.0270683+00:00"
},
"project_status_id": "3e4295c1-5b6d-44ab-aeac-e4c28b1ed627",
"project_status_code": "sample string 10",
"project_status": {
"id": "128dde56-6754-4507-86b1-931c7453a6ab",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "538248e1-6372-4d35-a933-6b4e17c9d504",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-13T04:03:03.0270683+00:00"
},
"company_id": "8663b5d1-766e-4ec7-9cf4-ced9d314c62e",
"company_code": "sample string 12",
"db_address_id": "2808bcd1-a4af-4c34-a542-1368b575219e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b7aa04e4-30f5-4a9a-8520-f4e14313d848",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "39c23331-8db7-40a3-b03d-12e3b44edc04",
"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-03-13T04:03:03.0270683+00:00",
"date_create": "2026-03-13T04:03:03.0270683+00:00",
"date_update": "2026-03-13T04:03:03.0270683+00:00",
"updated_by_user_id": "89dcc6fb-6dd3-48a8-ad3b-767bc3818b09",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-13T04:03:03.0270683+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-03-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-13T04:03:03.0270683+00:00",
"date_last_job": "2026-03-13T04:03:03.0270683+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-13T04:03:03.0270683+00:00",
"modified_dateutc": "2026-03-13T04:03:03.0270683+00:00",
"is_mobile_installation": true
},
"job_type_id": "66dfe4b2-bddb-4f56-bd06-711291c01449",
"job_type_code": "sample string 7",
"job_type": {
"id": "845a4fd9-0b1a-4e0d-9831-1c9b19201c0b",
"name": "sample string 2",
"sales_organization_id": "02a8acc4-c1cb-4e3c-82e6-87e6e6b59b7c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-13T04:03:03.0270683+00:00",
"code": "sample string 7"
},
"job_priority_id": "3b21cf5a-0b0b-477a-8a9e-7b73638367ad",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "23971a97-1b0d-4f85-9a7e-7c3fc8fbafd5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a243fcd6-75b9-4154-9b4c-d12b2e122909",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-13T04:03:03.0270683+00:00"
},
"job_status_id": "8a473e5c-1c3e-4296-8df5-781ecdb83bc8",
"job_status_code": "sample string 11",
"db_address_id": "0929eb40-5f81-4f07-bcbd-62cd791823fd",
"contact_id": "b37e3c7d-7846-421e-ba14-13cee3ac9995",
"requested_by_company_id": "f5c65359-7dfe-4247-9076-1d5cb9767c2f",
"requested_by_contact_id": "e7df68ba-904c-424b-a283-20489f70d7e4",
"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-03-13T04:03:03.0270683+00:00",
"due_date": "2026-03-13T04:03:03.0270683+00:00",
"date_create": "2026-03-13T04:03:03.0270683+00:00",
"date_update": "2026-03-13T04:03:03.0270683+00:00",
"date_closed": "2026-03-13T04:03:03.0270683+00:00",
"suggested_user_id": "c85303f0-d52b-4e7a-af12-f646785da675",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6a80680f-cdfb-4dc4-bfbc-5c5bb402b944",
"db_language_id": "78ab47cc-979c-424d-9357-074212910304",
"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-03-13T04:03:03.0270683+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a80b75a9-b050-4f89-b3e1-30777d1823f0",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea70d004-e3bb-42bd-a84f-26d977947089",
"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": "a9d84fcd-613a-4d44-b948-c71c4fce640a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-13T04:03:03.0270683+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f4eedfbf-5847-4c39-8183-408712797597"
},
"suggested_date_start": "2026-03-13T04:03:03.0270683+00:00",
"skill_id": "ea118649-7305-4966-ac07-db68522bf284",
"skill_code": "sample string 32",
"skill": {
"id": "c4ae67e0-9134-4c27-a266-0f2a9e47511b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3b9e7772-aee7-4ad3-b99c-293ca2cbaba8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8778a4a9-c250-4b14-8d2d-7f6ddb07162a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a7dc466-4070-43c8-9c53-72a365689dc5",
"db_currency_id": "a3961500-843e-4049-b6f3-41e71f17d101",
"db_language_id": "e517d37b-6124-459d-9a71-acbcf36c5c76",
"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-03-13T04:03:03.0104471+00:00"
},
"modified_dateutc": "2026-03-13T04:03:03.0270683+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5c147aaa-4cf7-4b21-90db-2c6060f2df18",
"date_reported_by_company": "2026-03-13T04:03:03.0270683+00:00",
"id2": 36,
"company_id": "d8aea1cd-701a-4ff4-a5b6-5ca6063af69b",
"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": "e369fe98-ea00-4dc3-b34b-196f6119be86",
"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-03-13T04:03:03.0270683+00:00"
},
"work_instruction_details_id": "bc860b90-a286-48b5-9e46-a921127b2e67",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "597c460b-1378-4eb1-9971-cfd76ed35548",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ab99bdc-f269-4d22-9e8c-6b716a1b4bac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-13T04:03:03.0270683+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": "4fe63ae4-f400-48f8-bbc1-9cf8344ca0aa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-13T04:03:03.0270683+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.