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": "98099236-4503-4df6-9ccd-805e869073ac",
"jobs_id": "c3fc331c-14ea-4222-a75c-4c6ae9bd6b33",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1ad7a4df-7b5b-4403-a0c9-aca24e3f767b",
"_parent_id": "e58ade64-7260-40e3-b180-73ecd32ec3f2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ebd16bef-e734-465a-9e89-8b5213a597bd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7f21f758-d70e-49ac-adc0-b78802517aa2",
"_parent_id": "6f8c80da-a481-494c-bd00-3d0151d87439",
"root_parent_id": "d4720087-746b-499a-ac1c-e542f9a90dfc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7086285f-7353-4e1c-b31f-710fe1a0c051",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c4bb4883-c6b0-4a8d-bdb9-9bffbc46fee5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "68704f4c-33c0-41db-bea7-04601ebef0b4",
"_parent_code": "sample string 6",
"sales_organization_id": "dc3b386b-3427-4855-98cb-c04ccf7e3557",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+00:00"
},
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00"
},
"equipment_model_id": "6bed7197-8219-41f9-88ba-d82922ab53f6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1de4b3de-2675-483a-ba41-c5a058a26f01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f751ee47-c520-4491-9cb1-d20cbc5e6626",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7433bfb0-224f-4740-8549-07b82b980a76",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c8789d53-1233-4c58-9165-33ba72ae74b9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+00:00"
},
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00"
},
"equipment_family_id": "e0706a5c-4191-406c-baec-7f3783c1ada5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c4bb4883-c6b0-4a8d-bdb9-9bffbc46fee5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "68704f4c-33c0-41db-bea7-04601ebef0b4",
"_parent_code": "sample string 6",
"sales_organization_id": "dc3b386b-3427-4855-98cb-c04ccf7e3557",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+00:00"
},
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00"
},
"date_in_production_since": "2026-08-28T14:43:26.3014354+00:00",
"date_out_of_production_since": "2026-08-28T14:43:26.3014354+00:00",
"date_end_support": "2026-08-28T14:43:26.3014354+00:00",
"sales_organization_id": "7725e983-d709-4cfc-bf30-2a9b763205e4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+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-28T14:43:26.3014354+00:00"
},
"project_status_id": "22900072-d5df-4134-854e-197e353a44e8",
"project_status_code": "sample string 10",
"project_status": {
"id": "f0afa3a3-3468-460d-982a-9436f224ba1b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fb7e2d6e-6737-4588-8438-80bc28da8d4d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00"
},
"company_id": "dae41d9e-aec7-46a3-b6f5-f3d926d6e576",
"company_code": "sample string 12",
"db_address_id": "59f221cd-f3f7-4c21-a9bb-bff6f312d8d6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e82a2f55-4d57-44cc-982c-582872591586",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dfee1980-422e-4720-b0b3-28be466af65d",
"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-28T14:43:26.3014354+00:00",
"date_create": "2026-08-28T14:43:26.3014354+00:00",
"date_update": "2026-08-28T14:43:26.3014354+00:00",
"updated_by_user_id": "cbdadab7-91ea-49b0-9279-470146ec9ee7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-28T14:43:26.3014354+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-28T14:43:26.3014354+00:00",
"date_last_job": "2026-08-28T14:43:26.3014354+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-28T14:43:26.3014354+00:00",
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00",
"is_mobile_installation": true
},
"job_type_id": "2d88980d-0d8a-4970-8be2-6159a1a9a96f",
"job_type_code": "sample string 7",
"job_type": {
"id": "9e5aad1c-b9a4-495e-a2c7-72b8def14bee",
"name": "sample string 2",
"sales_organization_id": "834aa3f1-9fbd-4671-bc26-9961033db9ca",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00",
"code": "sample string 7"
},
"job_priority_id": "21902a5a-7830-4b3f-b9ec-1714808d42fb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b034c7c0-b3d0-443f-b06d-812368cebb5a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2631f706-5d45-4700-9ee7-5b840cb82808",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00"
},
"job_status_id": "60f83e4e-6b0f-47b0-9cd4-1752871e3f66",
"job_status_code": "sample string 11",
"db_address_id": "eddb98c5-9bea-49d0-b572-85edcba040a3",
"contact_id": "834e22c1-6037-4203-babb-86444367e26c",
"requested_by_company_id": "d0434e3e-3fd9-45ba-9aa2-d463227e3a34",
"requested_by_contact_id": "341386dc-8a96-4a0f-a499-17880ecf97ba",
"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-28T14:43:26.3014354+00:00",
"due_date": "2026-08-28T14:43:26.3014354+00:00",
"date_create": "2026-08-28T14:43:26.3014354+00:00",
"date_update": "2026-08-28T14:43:26.3014354+00:00",
"date_closed": "2026-08-28T14:43:26.3014354+00:00",
"suggested_user_id": "bb09fb72-210f-44af-a754-eef8f6ef3ae4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a0bdd8e2-adbc-4927-a3f2-813714b9b985",
"db_language_id": "2d9320f5-08cb-4998-ae6f-c0fe77238dc2",
"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-28T14:43:26.3014354+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "deed2b3e-9e13-4d83-8d4b-decdff332863",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9b33db41-b5d9-4f4e-a9d2-7b9e69317a67",
"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": "5b16d4d7-6aaa-41f4-a60c-36f86aff5ec5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c5b09e73-13f1-4cbe-b0ae-65454f414678"
},
"suggested_date_start": "2026-08-28T14:43:26.3014354+00:00",
"skill_id": "9b1ce96a-ca2b-4620-92a6-f68ac24c5853",
"skill_code": "sample string 32",
"skill": {
"id": "e91288ce-4635-482f-ac34-724e556ce2e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fa042ea2-dbd5-4b5e-9657-f40addbb606e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "57507349-7d31-4865-89f2-a8df64fa2430",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e75b93e-9c10-42ed-adcc-a6b6f95c78fa",
"db_currency_id": "c4526f2d-5056-4763-bc11-d02bc6608f2c",
"db_language_id": "2da722e3-6b2a-4d6b-a285-1d21df06e176",
"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-28T14:43:26.3014354+00:00"
},
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c3a97300-ea61-4e64-bc66-a961ea094b6d",
"date_reported_by_company": "2026-08-28T14:43:26.3014354+00:00",
"id2": 36,
"company_id": "f9dc0d58-674f-4321-9892-d6a25d662878",
"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": "023b90ac-a904-40e5-b864-5935d0b0c799",
"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-28T14:43:26.3014354+00:00"
},
"work_instruction_details_id": "02a383c3-ecfd-498d-9e93-53a04d12544d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2c46cd72-b09c-464e-87f5-df83c14f3d66",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2595cce5-36aa-47bb-a4dc-05c38b923533",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-28T14:43:26.3014354+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": "7acdee46-70f4-4990-ab13-1fb9f29478cb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-28T14:43:26.3014354+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.