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": "c33f4867-beb5-4add-aa43-2ed11c178e88",
"jobs_id": "38bb50e2-1d6a-44de-9f69-60543e062d16",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "713dddfe-8cd6-44ff-a720-19e4e0213032",
"_parent_id": "dd54f34e-a807-4264-883d-f7f74bb66540",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a9c75186-1e25-4769-b90b-fcdaf42c42ec",
"project_reference_back_office": "sample string 5",
"project": {
"id": "627ff84f-8e3e-4e6e-8f28-c20c4ac510ce",
"_parent_id": "1e6cb90a-4b63-4334-b25e-d254672d1d94",
"root_parent_id": "97e7ec91-982d-432b-b6d1-10cd0f4d292a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fcacd629-6ccc-4164-80d1-8a0c2144d4d0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "227e7af2-6c7d-43ed-b87b-095d0d780d39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06eaffdd-c025-41ec-8d47-9c60a9bd4a08",
"_parent_code": "sample string 6",
"sales_organization_id": "4fea8d23-de49-479a-83fa-36af0f4aa2e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+00:00"
},
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00"
},
"equipment_model_id": "292823fa-1d4c-46d9-a031-4e3bd57b5a7b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9fa8b0a1-85ab-4f35-9f1a-d2c387b9e430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a065212e-2936-4213-adc9-a922e17cebce",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "84ae357d-41ad-4e24-bcb7-73d8204a3b3a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "552880dd-11c8-4fbb-bc5c-6073bc148ed8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+00:00"
},
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00"
},
"equipment_family_id": "f32811ff-02e3-45fb-89b5-234e7aa1a6de",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "227e7af2-6c7d-43ed-b87b-095d0d780d39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06eaffdd-c025-41ec-8d47-9c60a9bd4a08",
"_parent_code": "sample string 6",
"sales_organization_id": "4fea8d23-de49-479a-83fa-36af0f4aa2e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+00:00"
},
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00"
},
"date_in_production_since": "2026-08-21T12:39:13.7803148+00:00",
"date_out_of_production_since": "2026-08-21T12:39:13.7803148+00:00",
"date_end_support": "2026-08-21T12:39:13.7803148+00:00",
"sales_organization_id": "9cc34e88-7701-4333-b8c8-5e5db93bba58",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+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-08-21T12:39:13.7803148+00:00"
},
"project_status_id": "c351327b-97a2-4bfa-a540-125c5596e746",
"project_status_code": "sample string 10",
"project_status": {
"id": "7cc08b83-6648-40a9-8e74-07f41f648cd4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "76f903ba-f6f0-49e5-a1e3-6eeacb1268ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00"
},
"company_id": "9f554a54-f7ca-4006-afa8-9e70916beb81",
"company_code": "sample string 12",
"db_address_id": "872de6f6-9903-4677-b871-eef7f80a1aad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bcdf722a-146c-412b-a57f-0c1a542259df",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "102a1120-8841-4b75-97b6-8afff6dbc35f",
"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-08-21T12:39:13.7803148+00:00",
"date_create": "2026-08-21T12:39:13.7803148+00:00",
"date_update": "2026-08-21T12:39:13.7803148+00:00",
"updated_by_user_id": "d9a98be6-f2b0-4407-baa9-2b8a751ef79c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-21T12:39:13.7803148+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-08-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-21T12:39:13.7803148+00:00",
"date_last_job": "2026-08-21T12:39:13.7803148+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-21T12:39:13.7803148+00:00",
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00",
"is_mobile_installation": true
},
"job_type_id": "5abced09-3bd9-42fe-bba1-236ff01f11f5",
"job_type_code": "sample string 7",
"job_type": {
"id": "9eaae0a3-7ca6-4a2a-9a9d-793c2426f41f",
"name": "sample string 2",
"sales_organization_id": "5ef4a99e-33b6-4c00-b8db-f382257079d2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00",
"code": "sample string 7"
},
"job_priority_id": "b9cd3178-5c60-41e1-b326-b0d09e7327a3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3c5c6e74-e5d9-4ffc-adb1-01bf1a921000",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7f277f80-d75c-4194-90a0-0f0d5f420cd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00"
},
"job_status_id": "4525f1e4-0c32-474e-8341-6a9cfcd0290d",
"job_status_code": "sample string 11",
"db_address_id": "6d31d78b-ebce-476c-b903-72989c18f03a",
"contact_id": "2989ba9a-4a47-47e0-afe5-e2b03ac64f54",
"requested_by_company_id": "47b54da9-d7ef-42a6-8b02-2ab74309eee6",
"requested_by_contact_id": "2cc033a1-9a91-4c50-9171-07c13e3fe0a3",
"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-08-21T12:39:13.7803148+00:00",
"due_date": "2026-08-21T12:39:13.7803148+00:00",
"date_create": "2026-08-21T12:39:13.7803148+00:00",
"date_update": "2026-08-21T12:39:13.7803148+00:00",
"date_closed": "2026-08-21T12:39:13.7803148+00:00",
"suggested_user_id": "dad4d554-8535-4a15-8efc-29141bdb2aab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2af6bd71-55be-4b62-9d82-41c58bfac162",
"db_language_id": "9e295b2e-457b-4352-85dc-6e56e63871c2",
"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-08-21T12:39:13.7803148+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aa3ac78f-9893-4e1d-bdef-7a5dd04cdf99",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ec230467-f12f-44aa-8f16-0670fe5e7623",
"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": "641d99d9-1669-476b-9f0e-14f98ec31438",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "38284110-8778-46a2-b27b-0387f1d202d2"
},
"suggested_date_start": "2026-08-21T12:39:13.7803148+00:00",
"skill_id": "2affcc08-01df-42b8-86f7-7b4da82bbb6d",
"skill_code": "sample string 32",
"skill": {
"id": "e8a0fe8a-af0b-4976-bc05-6abe1bb89d88",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fa0ea9d4-8377-4b16-bfb6-3ae0885570b8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "79a65494-523e-495a-804f-beae8e4fbf13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a5c8322-dd32-402d-92c9-34ea63cb359a",
"db_currency_id": "7143d5fd-649d-449e-9f61-d1bb78618773",
"db_language_id": "e87857f7-c4dc-4b4b-9575-3536c89a0144",
"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-08-21T12:39:13.7803148+00:00"
},
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e2344b60-4287-4c59-8b90-140438c23f15",
"date_reported_by_company": "2026-08-21T12:39:13.7803148+00:00",
"id2": 36,
"company_id": "f72f97dd-1308-4225-b7f1-16490e3a9857",
"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": "224ea80f-c369-44dc-a32d-8d08b6934198",
"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-08-21T12:39:13.7803148+00:00"
},
"work_instruction_details_id": "fb6a8e07-18c3-46a2-9213-721b76c55675",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9fba326f-2d1b-4206-8eab-7bb1940135d0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "202587fc-ff81-49b3-a7c0-a68f7c20f4bd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-21T12:39:13.7803148+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": "0c8df4bc-b6b2-4b60-bb27-51f048185cf7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-21T12:39:13.7803148+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.