Retrieves 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 :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "106ebddc-927e-4da6-828a-17f76b188fe1",
"jobs_id": "288e28cc-9367-4360-a33a-8938c58b68ee",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d3695e5a-82e9-44d4-a00f-652a5164dba6",
"_parent_id": "f6a6b489-95f6-4178-9db6-761bd18b3290",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db7c827d-ffea-480d-9a6f-1900f21d52a0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9a39c6a5-0a21-4922-a381-cf47371e97bf",
"_parent_id": "1d0e7bcd-ef1a-4046-8b4a-78839e072495",
"root_parent_id": "c0b5ccff-8d5b-4b53-92eb-95b7deb96a90",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cf857f32-e102-44dd-8a28-0b460e40a4be",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3c8e67ea-75bf-4164-8048-940e897c9509",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2df318f5-8efa-4e7e-8261-8e58b7b4766f",
"_parent_code": "sample string 6",
"sales_organization_id": "0f0a9726-fe1b-45eb-a6d6-459864034fd1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+00:00"
},
"modified_dateutc": "2026-06-25T04:53:21.7388712+00:00"
},
"equipment_model_id": "6166746a-7dcc-4aae-a435-66e294a86570",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "31c759c8-34b5-4485-8c2c-29c27d8d76a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "11ae4c7f-22f3-4d00-bec7-7c8ca27886b1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "70d04eb1-f277-45a4-aa3a-f5c38a239b41",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2e0e59fd-9b1f-46ae-bd02-25cedd5e6951",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+00:00"
},
"modified_dateutc": "2026-06-25T04:53:21.7388712+00:00"
},
"equipment_family_id": "dddc4a90-d9bc-40ec-972c-b9978e6b9ea6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3c8e67ea-75bf-4164-8048-940e897c9509",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2df318f5-8efa-4e7e-8261-8e58b7b4766f",
"_parent_code": "sample string 6",
"sales_organization_id": "0f0a9726-fe1b-45eb-a6d6-459864034fd1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+00:00"
},
"modified_dateutc": "2026-06-25T04:53:21.7388712+00:00"
},
"date_in_production_since": "2026-06-25T04:53:21.7388712+00:00",
"date_out_of_production_since": "2026-06-25T04:53:21.7388712+00:00",
"date_end_support": "2026-06-25T04:53:21.7388712+00:00",
"sales_organization_id": "ff798150-cf35-4619-8cae-390de5aed847",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+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-06-25T04:53:21.7388712+00:00"
},
"project_status_id": "9dc9b8aa-b91a-4598-aba3-7b0cb5ba2f5e",
"project_status_code": "sample string 10",
"project_status": {
"id": "637381fd-d6c0-455e-b434-0aee66859819",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3116cc1e-b6fa-400a-b417-e73d90f8dbb6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T04:53:21.7544933+00:00"
},
"company_id": "434581de-20f4-49ac-859c-b60efd1ede58",
"company_code": "sample string 12",
"db_address_id": "2e2ae005-a6fd-4065-be33-848fe9b2e4c0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b2f35382-5a0f-405a-bbd4-5b58d3c99d75",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c552063b-de13-4f49-b283-46e1f8767daa",
"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-06-25T04:53:21.7544933+00:00",
"date_create": "2026-06-25T04:53:21.7544933+00:00",
"date_update": "2026-06-25T04:53:21.7544933+00:00",
"updated_by_user_id": "9eb30c57-16bb-4d68-9f9e-28ed8e431210",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-25T04:53:21.7544933+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-06-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-25T04:53:21.7544933+00:00",
"date_last_job": "2026-06-25T04:53:21.7544933+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-25T04:53:21.7544933+00:00",
"modified_dateutc": "2026-06-25T04:53:21.7544933+00:00",
"is_mobile_installation": true
},
"job_type_id": "d71d1808-f97c-46c5-8f25-b2317c4fa4a3",
"job_type_code": "sample string 7",
"job_type": {
"id": "a019c542-377c-4e38-b4f5-d25b957b2a39",
"name": "sample string 2",
"sales_organization_id": "42339879-4f88-4951-9308-db7871630510",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-25T04:53:21.7544933+00:00",
"code": "sample string 7"
},
"job_priority_id": "f9103a2a-68d9-47e4-99ea-743932ecbdc5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8531ad28-5ba6-4c84-bcaa-ff493bd9a92e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4ab1185f-16ad-440d-8243-c03f31b8cd5a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T04:53:21.7544933+00:00"
},
"job_status_id": "3b87c325-076d-4fa2-9260-a7cac46dfa2c",
"job_status_code": "sample string 11",
"db_address_id": "aae7accb-589d-44db-b1aa-1380fe8d2618",
"contact_id": "9f29eb52-703a-45e0-a51d-2dcce124f79d",
"requested_by_company_id": "92459126-5344-4204-a38c-93ab2bc56d01",
"requested_by_contact_id": "6bbbb5d0-b254-41a5-b22e-c135e2ecaf6f",
"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-06-25T04:53:21.7544933+00:00",
"due_date": "2026-06-25T04:53:21.7544933+00:00",
"date_create": "2026-06-25T04:53:21.7544933+00:00",
"date_update": "2026-06-25T04:53:21.7544933+00:00",
"date_closed": "2026-06-25T04:53:21.7544933+00:00",
"suggested_user_id": "3d5e2148-1ff0-485f-bf23-3374c3ab755f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d7209a75-abc3-4cf4-bb46-2acc9722c90c",
"db_language_id": "d5a47de3-ea47-4702-b8b0-b62aab934276",
"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-06-25T04:53:21.7544933+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "71791846-cd5d-4f23-b58c-e5093cc89475",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c502a7a8-802a-43ef-9dcd-96ef5f227386",
"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": "f8f87b71-07cb-46cf-a61c-23c9306d36e1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-25T04:53:21.7544933+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "52c631ce-530f-4035-be06-50987a138f02"
},
"suggested_date_start": "2026-06-25T04:53:21.7544933+00:00",
"skill_id": "76494ebc-c2ae-4d1a-b022-dd07efd5aed0",
"skill_code": "sample string 32",
"skill": {
"id": "a6f9d718-f96c-4f57-b0df-9bf0d54816ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "54b0f47b-191b-480b-ac54-69d1e790d946",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4ba3d14-825a-4a64-a466-a12999f7779e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e87d43f-5278-44d8-b723-a94dbd8427b2",
"db_currency_id": "d6ad8416-26ec-4110-bf52-ea68dc00430c",
"db_language_id": "7db40acb-0f5d-4400-8a4a-3e2b173fb9fd",
"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-06-25T04:53:21.7388712+00:00"
},
"modified_dateutc": "2026-06-25T04:53:21.7544933+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3f54ddb7-ac32-4d8f-86d8-54ae508ed94a",
"date_reported_by_company": "2026-06-25T04:53:21.7544933+00:00",
"id2": 36,
"company_id": "6690db37-a7e8-4138-a0ff-1c2f4ef99900",
"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": "f052b990-0d11-42c3-864d-b3f046eae5ac",
"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-06-25T04:53:21.7544933+00:00"
},
"work_instruction_details_id": "a30e250f-2e16-42cc-b05a-fb67fa2c4445",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "246c4056-f20e-4a7c-aa62-8bd79f34f5db",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dfa5a317-f9e4-488e-94b8-37507d12f858",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-25T04:53:21.7544933+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": "be07f222-f916-487b-af2e-4be36241a2e4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-25T04:53:21.7544933+00:00"
}