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": "e845ceea-3caa-496b-ac99-32c50e3bfa11",
"jobs_id": "a778ca33-48bd-41f9-91dd-750071646642",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a36d9ae9-a346-4e10-b805-8987fd8a1857",
"_parent_id": "ada31c57-0a9e-4f87-8e9d-d6ac9250c6ea",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "46cfc307-1d72-4276-95f5-1dd0146655a4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cef67122-088d-4299-8693-04cfe4f41aa9",
"_parent_id": "6540a915-91a8-46db-a147-70ebfebe037c",
"root_parent_id": "1b9bca71-9c1e-40b5-a012-fd1ebb33d368",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4c0589cb-0523-402b-9ceb-84f6512927a7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8cb42af3-5b27-486d-ab1e-e31b339a9e20",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19732631-a2ab-4468-9728-fe03543d1817",
"_parent_code": "sample string 6",
"sales_organization_id": "e05b63ed-5944-43ed-b272-5c2257ef102c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+00:00"
},
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00"
},
"equipment_model_id": "613ada2e-849f-47ac-91e3-dc72c77568d4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e6201a03-1415-4377-81e3-7326a4719ec5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "30768e0c-7edf-4942-a0fc-fef333908301",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9b99fa1b-eb81-4f62-b712-61ff3e9a72aa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2353b87f-d6e2-4bf3-9f2f-3b272f3316fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+00:00"
},
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00"
},
"equipment_family_id": "2f8f486a-21e9-4d3f-8c0c-a3c11450e61d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8cb42af3-5b27-486d-ab1e-e31b339a9e20",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19732631-a2ab-4468-9728-fe03543d1817",
"_parent_code": "sample string 6",
"sales_organization_id": "e05b63ed-5944-43ed-b272-5c2257ef102c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+00:00"
},
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00"
},
"date_in_production_since": "2026-02-01T21:38:50.6134096+00:00",
"date_out_of_production_since": "2026-02-01T21:38:50.6134096+00:00",
"date_end_support": "2026-02-01T21:38:50.6134096+00:00",
"sales_organization_id": "7a5c3475-b0b2-4638-a7ff-2699e42b1eb6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+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-02-01T21:38:50.6134096+00:00"
},
"project_status_id": "56dfd2a5-67aa-49c1-9d87-12fa503cba7e",
"project_status_code": "sample string 10",
"project_status": {
"id": "375580d5-41be-4c2a-92a7-87b8871ed9ea",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3686bc42-59fa-44b5-a12c-2647842e65f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00"
},
"company_id": "5c2bdd59-8d4f-4a81-8fe8-83910d3f5ee7",
"company_code": "sample string 12",
"db_address_id": "6a52dccc-3828-4052-aa6c-c6c76cc2a198",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e6fd632c-76c6-460e-a0e3-d8a6b2a9bbe6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ed4ef3f6-ce25-4bbe-b6df-e12a0e1b26ea",
"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-02-01T21:38:50.6134096+00:00",
"date_create": "2026-02-01T21:38:50.6134096+00:00",
"date_update": "2026-02-01T21:38:50.6134096+00:00",
"updated_by_user_id": "3186c798-f469-4cc7-b03a-ddcf0ffb24e8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-01T21:38:50.6134096+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-02-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-01T21:38:50.6134096+00:00",
"date_last_job": "2026-02-01T21:38:50.6134096+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-01T21:38:50.6134096+00:00",
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00",
"is_mobile_installation": true
},
"job_type_id": "a0a67525-089e-4f65-9f62-c444752cc7db",
"job_type_code": "sample string 7",
"job_type": {
"id": "b37a0279-9082-4aeb-94bd-0d4b37cfc2fb",
"name": "sample string 2",
"sales_organization_id": "d969c2df-2740-40bb-a3d5-d980556d5c6c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00",
"code": "sample string 7"
},
"job_priority_id": "1e1caa0b-a71e-49af-b99f-7de784ecbaa9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b5818c13-b23f-438b-bc4a-b108cd3a0931",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8f88f77f-f374-4781-bec4-574cde9728c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00"
},
"job_status_id": "184f2293-5ac8-493e-9a0f-bf677bae6c27",
"job_status_code": "sample string 11",
"db_address_id": "ded58e0f-3a92-4771-b3a3-d87aea21edf3",
"contact_id": "600ab122-de07-48c3-8476-7f612e3ddbdf",
"requested_by_company_id": "31fc8417-06a2-4767-946a-8ac61ea49144",
"requested_by_contact_id": "06f5a0b6-4eb1-483a-a9a3-927e6284893e",
"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-02-01T21:38:50.6134096+00:00",
"due_date": "2026-02-01T21:38:50.6134096+00:00",
"date_create": "2026-02-01T21:38:50.6134096+00:00",
"date_update": "2026-02-01T21:38:50.6134096+00:00",
"date_closed": "2026-02-01T21:38:50.6134096+00:00",
"suggested_user_id": "caa5dada-2eca-43b2-ad7b-2ddb69b45954",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6ddc49d0-8bc4-41f0-901f-69c0c27bc69b",
"db_language_id": "070ab97c-cb39-4c18-928b-29c40baf1c05",
"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-02-01T21:38:50.6134096+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "16a9bcea-2f00-44ed-bee0-bab3adaa0979",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ddb614a3-e3bc-4a55-9745-adafc4409d94",
"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": "98f9b49f-d08b-4266-8b34-9a8dec6ce0a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6f28198f-6567-403e-9a36-4896cdfb4e5c"
},
"suggested_date_start": "2026-02-01T21:38:50.6134096+00:00",
"skill_id": "99534d60-3e9e-4a89-8436-df075b2c005f",
"skill_code": "sample string 32",
"skill": {
"id": "bcacbe08-325d-441a-b251-6bb2268acc97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b190f6cd-bb4e-4c00-bc8a-242b851fa4a5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "33cfc822-9d78-48ac-acc3-9d88f0d0a61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a3f24235-534a-417f-a0aa-f5783949aaa8",
"db_currency_id": "4c220c23-0fde-4afd-a3a6-ca06dec6ce33",
"db_language_id": "28e0e9f7-9095-49b9-84f5-40de3801b59c",
"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-02-01T21:38:50.6134096+00:00"
},
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e416f931-5c45-43f4-925b-b031cb2f8a0c",
"date_reported_by_company": "2026-02-01T21:38:50.6134096+00:00",
"id2": 36,
"company_id": "1903e1d7-9c2f-43cc-8cd9-8d5c0b89e314",
"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": "064f47ff-be99-4227-879d-273e911d1d0e",
"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-02-01T21:38:50.6134096+00:00"
},
"work_instruction_details_id": "77621085-80a9-451f-8b49-d7274a3dab49",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "666e810f-47a8-412c-a44b-d3d35603abb8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cf57a20b-fadc-45a1-887c-6559389aa0fc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-01T21:38:50.6134096+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": "db5ce8c9-b0f2-4022-8d9e-5cc575f53aa0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-01T21:38:50.6134096+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.