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": "abc46f94-8354-487b-b1af-4e9cf3d6244c",
"jobs_id": "17f9a0a7-9d08-4f04-853a-36113965d5c1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7c3fa3ca-eba2-4c23-b6ae-6a9f6b035e6b",
"_parent_id": "ba8bce33-d180-4399-8d7c-7fffc21a66f3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "44e56174-ea52-4536-adb6-6d65cb731f2e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e3413f51-9fde-4ae5-a207-5c8693574393",
"_parent_id": "61a77348-0386-41e4-8878-275279a94cb1",
"root_parent_id": "ac93b727-839c-4bb5-b1c5-b75df025dc66",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "520c53d8-7975-46e0-bf65-bbd531a455f2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c63ef9db-388f-4446-9772-815542928b02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "897d2ff6-e513-4acc-9a46-27caee5df0d8",
"_parent_code": "sample string 6",
"sales_organization_id": "1c9aef4e-0008-4593-9265-eeef6a628571",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+00:00"
},
"modified_dateutc": "2026-07-22T08:32:43.2447976+00:00"
},
"equipment_model_id": "752a2876-a27c-453f-873d-432dc3e27ae4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "07a0e35d-1240-46b9-9f29-2555bb97320f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dad2bfcc-b10b-4f2f-91ec-48976e807af4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a9b4e304-c1e5-4206-9547-efc79fb212e5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "072bce75-d3ff-4abd-9c5a-48b37aecb627",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+00:00"
},
"modified_dateutc": "2026-07-22T08:32:43.2447976+00:00"
},
"equipment_family_id": "57fa1e4f-678a-4750-b0a1-d4f2af5bfea8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c63ef9db-388f-4446-9772-815542928b02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "897d2ff6-e513-4acc-9a46-27caee5df0d8",
"_parent_code": "sample string 6",
"sales_organization_id": "1c9aef4e-0008-4593-9265-eeef6a628571",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+00:00"
},
"modified_dateutc": "2026-07-22T08:32:43.2447976+00:00"
},
"date_in_production_since": "2026-07-22T08:32:43.2447976+00:00",
"date_out_of_production_since": "2026-07-22T08:32:43.2447976+00:00",
"date_end_support": "2026-07-22T08:32:43.2447976+00:00",
"sales_organization_id": "93a0bbb7-734e-41eb-8419-b80394d083ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+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-07-22T08:32:43.2447976+00:00"
},
"project_status_id": "637bf337-2cb8-4002-947a-500f169f6eda",
"project_status_code": "sample string 10",
"project_status": {
"id": "dcb3dce6-6dfc-4968-b0e9-316ea486bdfd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f83df977-54ba-4597-9f54-dbfe6784e449",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T08:32:43.2447976+00:00"
},
"company_id": "12ebfd07-f4da-4ef4-8b4e-4fe90880985f",
"company_code": "sample string 12",
"db_address_id": "6a3b9258-5603-487c-9fe3-96a24740bb12",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "80122b8d-e9df-45d5-9bba-9005455151fd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "70bef298-bb4a-4fcc-a63d-48e8ce488526",
"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-07-22T08:32:43.2447976+00:00",
"date_create": "2026-07-22T08:32:43.2447976+00:00",
"date_update": "2026-07-22T08:32:43.2447976+00:00",
"updated_by_user_id": "2c7bd80c-b9c2-427a-bb47-df0893ea985b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-22T08:32:43.2447976+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-07-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-22T08:32:43.2447976+00:00",
"date_last_job": "2026-07-22T08:32:43.2447976+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-22T08:32:43.2447976+00:00",
"modified_dateutc": "2026-07-22T08:32:43.2447976+00:00",
"is_mobile_installation": true
},
"job_type_id": "20f20861-7329-495b-98d5-b3c53409561f",
"job_type_code": "sample string 7",
"job_type": {
"id": "755758b8-a701-4a13-b867-aee2ad6c0322",
"name": "sample string 2",
"sales_organization_id": "62f2543e-057a-4ad1-b5bf-b42b6dd697ed",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-22T08:32:43.2604225+00:00",
"code": "sample string 7"
},
"job_priority_id": "c5d162ad-72a2-4255-9e32-10eab14306b9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "10db8448-c3fe-4051-8338-36286c824d5c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "521afa80-fca9-4a49-b809-5dba7e9d1a6c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T08:32:43.2604225+00:00"
},
"job_status_id": "4c76f948-c685-4dd6-8eb2-dcc619f15f81",
"job_status_code": "sample string 11",
"db_address_id": "a517e5e3-3c27-40ae-b95f-8a18ab5e2bc3",
"contact_id": "b31fd468-9afc-4ebf-8ab1-964f043008c6",
"requested_by_company_id": "80da1f07-0e3b-4139-836a-0adf35e43d42",
"requested_by_contact_id": "5bd80557-2019-4a76-b14d-9700d5f19105",
"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-07-22T08:32:43.2604225+00:00",
"due_date": "2026-07-22T08:32:43.2604225+00:00",
"date_create": "2026-07-22T08:32:43.2604225+00:00",
"date_update": "2026-07-22T08:32:43.2604225+00:00",
"date_closed": "2026-07-22T08:32:43.2604225+00:00",
"suggested_user_id": "6a28815d-fea3-460f-b69a-54caf9c51fc2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9afde7ce-8b32-4e3a-8862-b770398dadaf",
"db_language_id": "947043f6-151d-4c07-9d6f-afb2e0c3f4e4",
"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-07-22T08:32:43.2604225+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fb98704f-031c-4590-bee2-6d5f09392c22",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "44e9fd48-d3d9-4f0c-8343-1be8c19c4089",
"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": "0fc097fd-c6dc-4e7f-b6e0-92eb77b344f4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-22T08:32:43.2604225+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0323cef6-d21b-4756-b4cd-192494003b63"
},
"suggested_date_start": "2026-07-22T08:32:43.2604225+00:00",
"skill_id": "20b64a44-2d55-459c-b522-1d3d2e65748d",
"skill_code": "sample string 32",
"skill": {
"id": "840c3344-75e0-4c2a-b607-e906d7ce414f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8f31eb71-f84d-4a42-b1da-a279832b9939",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "287a7500-b5d5-4240-8b9f-2474572105f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6fff599-05e7-4197-a545-a6de4589783f",
"db_currency_id": "79342d5a-321f-49f4-a6c8-dd611da15fed",
"db_language_id": "d4176b86-2570-4624-bf6d-96744bdabeb9",
"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-07-22T08:32:43.2447976+00:00"
},
"modified_dateutc": "2026-07-22T08:32:43.2604225+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9ff3a902-1b3d-4a34-9e3c-9205dfea6ad2",
"date_reported_by_company": "2026-07-22T08:32:43.2604225+00:00",
"id2": 36,
"company_id": "25b7086e-7c09-4d20-b709-dc03cb9850d6",
"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": "0181ba6c-e55b-41cd-889a-f3ee4dc54402",
"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-07-22T08:32:43.2604225+00:00"
},
"work_instruction_details_id": "08a269ab-98b9-434c-9c34-dd8662c1d90d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "309e4e82-ea03-4ef8-a3df-baea1a48ee73",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "89709193-3145-4694-8496-5f3fefaf49f2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-22T08:32:43.2604225+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": "33fd6f83-54ea-4992-a2c4-3d727b7de4b2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-22T08:32:43.2604225+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.