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": "5009cde3-2c58-49f4-a610-62f4eeb9ea2d",
"jobs_id": "097af338-3eca-4ad0-8ffc-8cd1c6043910",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2558114f-af70-4413-83ed-1cde011491b2",
"_parent_id": "5ea79560-0b5b-472e-8d4b-146c91396b30",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "985851fe-4a55-49df-b3a3-f50f1880c11b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0eef80bf-3e05-4ce8-a0ca-37c7c65187f3",
"_parent_id": "4de24d27-1457-41fb-98fe-5947d20ac081",
"root_parent_id": "026b0055-e2d1-4eec-941f-78ecef34fe5d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "af96b2a2-9a1e-4386-8801-e5459f107259",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4f31f23b-70a9-4f04-988c-95ae7fbea055",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1487b358-d7fd-4fec-aada-e08569438678",
"_parent_code": "sample string 6",
"sales_organization_id": "54c43cf1-9211-4c2a-8489-fcfa4d7765c5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+00:00"
},
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00"
},
"equipment_model_id": "25c53809-61e3-43ac-9627-1211efb5589a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0d33f08a-2f55-4705-b288-bd72d6b5b115",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8cde7dd3-9b1c-4973-bbb5-3625a059b5b0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d4a0657a-63a5-4861-8414-322e015e01fe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "165e2d54-e23b-412e-b860-078fea98a171",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+00:00"
},
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00"
},
"equipment_family_id": "35cdb6f4-670c-4a70-b94a-fd5666fe2e36",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4f31f23b-70a9-4f04-988c-95ae7fbea055",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1487b358-d7fd-4fec-aada-e08569438678",
"_parent_code": "sample string 6",
"sales_organization_id": "54c43cf1-9211-4c2a-8489-fcfa4d7765c5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+00:00"
},
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00"
},
"date_in_production_since": "2026-09-16T07:01:22.9024597+00:00",
"date_out_of_production_since": "2026-09-16T07:01:22.9024597+00:00",
"date_end_support": "2026-09-16T07:01:22.9024597+00:00",
"sales_organization_id": "7392f3f4-79ca-4fdb-8059-66ffce25a44c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+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-09-16T07:01:22.9024597+00:00"
},
"project_status_id": "f360190d-4bce-46fc-ab5c-f07b1e528047",
"project_status_code": "sample string 10",
"project_status": {
"id": "9b727de9-01da-4c72-b8df-e5744be98ee9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e0a44b71-35ed-48f7-87fa-2182b4f5c78b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00"
},
"company_id": "7f4dac7b-6dbb-45c5-a7ea-6fead4410558",
"company_code": "sample string 12",
"db_address_id": "18ce26ab-3ce4-433f-b113-fb8b27621b5e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "084526f5-eb54-47fa-a79b-1cae83106dbc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e145697e-4ba2-46eb-b650-9a50e86f20fb",
"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-09-16T07:01:22.9024597+00:00",
"date_create": "2026-09-16T07:01:22.9024597+00:00",
"date_update": "2026-09-16T07:01:22.9024597+00:00",
"updated_by_user_id": "2c6ddb11-6500-4694-9c64-2d7bc1fe4268",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-16T07:01:22.9024597+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-09-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-16T07:01:22.9024597+00:00",
"date_last_job": "2026-09-16T07:01:22.9024597+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-16T07:01:22.9024597+00:00",
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00",
"is_mobile_installation": true
},
"job_type_id": "3966c028-4646-4161-b2d8-5be7131b5a99",
"job_type_code": "sample string 7",
"job_type": {
"id": "005286ac-ab7b-43be-88cf-77378ac13854",
"name": "sample string 2",
"sales_organization_id": "bd028c89-25bf-4cb0-b9e8-a30a1fc86de9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00",
"code": "sample string 7"
},
"job_priority_id": "8cc5be68-7c5a-44e8-a9e2-b20fc215a554",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f8c57b4c-dbd9-4c60-8e1f-ed2e1182d68c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6eb13a78-0aa7-4d3c-97b0-b9420f4f041f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00"
},
"job_status_id": "25902c1d-a4ad-45e0-a439-b9a4d16c2293",
"job_status_code": "sample string 11",
"db_address_id": "a1cea127-a0d6-4bfb-b2a3-2cf0f102276a",
"contact_id": "cf013da8-211c-4916-9c86-9f6c1d192428",
"requested_by_company_id": "d7dd03ec-3fbc-4f23-8717-741d7809720e",
"requested_by_contact_id": "e6bee09c-f2ff-40d4-bbc0-7b5213c9366e",
"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-09-16T07:01:22.9024597+00:00",
"due_date": "2026-09-16T07:01:22.9024597+00:00",
"date_create": "2026-09-16T07:01:22.9024597+00:00",
"date_update": "2026-09-16T07:01:22.9024597+00:00",
"date_closed": "2026-09-16T07:01:22.9024597+00:00",
"suggested_user_id": "ca3f30c4-0e6b-40aa-a800-96937d101e10",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "efad66d7-c5dc-49b9-ab98-34d4a88a05d2",
"db_language_id": "4b20d7a0-1d87-4360-a01b-72e69808112e",
"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-09-16T07:01:22.9024597+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7a822e19-030b-4f5f-93f5-4bc25111734a",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9a0064d0-f163-4a70-b76a-5404aef98a43",
"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": "91226a94-a467-47c1-966c-8ef96e1f911c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c2980290-4389-402c-83a8-d6d6e0be7d36"
},
"suggested_date_start": "2026-09-16T07:01:22.9024597+00:00",
"skill_id": "3cf261b4-c7b4-4426-960a-85fcbe1ba963",
"skill_code": "sample string 32",
"skill": {
"id": "6df8424b-f0c1-4572-990f-d16c6c07a6a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1762258f-51e6-4995-9fa5-7bfa854cce54",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ae2e85c-e486-4e7b-b330-ca861d12995f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da03aae2-5af2-4e2e-af96-b2b161708fa7",
"db_currency_id": "d2fa853d-ba8c-434b-8896-36ec4969f8ce",
"db_language_id": "63c1f8fb-e73d-4a1b-84a0-27b139fa08e7",
"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-09-16T07:01:22.9024597+00:00"
},
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "57989496-d438-4297-8a83-608daafb6eba",
"date_reported_by_company": "2026-09-16T07:01:22.9024597+00:00",
"id2": 36,
"company_id": "af963772-4221-4560-8cff-3c3d74a4a751",
"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": "4898c3c7-fe7e-4cf7-9f01-f03b97426ec8",
"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-09-16T07:01:22.9024597+00:00"
},
"work_instruction_details_id": "c23c107b-1f22-4518-bce3-5c6f09543073",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9d3bde4e-a4ec-403e-bb7b-45b13b024d3b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "645bcf38-54b6-43df-b49f-f661a4bd3fc1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-16T07:01:22.9024597+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": "3a53a976-a0b1-49e3-b0aa-311adc7cdc78",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-16T07:01:22.9024597+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.