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": "eb087834-f8fa-4046-b7f6-f572f4a223e9",
"jobs_id": "e3938cc1-cd0e-4155-ab0f-2d454a9de814",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dbeefd99-a190-4a4d-bb95-a27225d187e5",
"_parent_id": "a79709ef-1a09-4e42-92ba-5ee118ba492d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2abdc688-6591-4d31-bf7b-92d19dff1eaf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "59bc4105-e631-4377-9b94-ed3e41455160",
"_parent_id": "b99c71b6-1778-41dc-84ac-8ed5dbdb5b4c",
"root_parent_id": "dd0e6990-4f4c-4431-ad1f-26570f61bdc9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fd5692f9-90ac-418a-b48d-dc8156a92b19",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "10cdc1b6-82aa-42d2-8c23-e8feeed85b25",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c736c499-34fe-4230-ae93-086003d7679f",
"_parent_code": "sample string 6",
"sales_organization_id": "6b883d0f-6f34-4238-b789-305ffcc05e4f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00"
},
"equipment_model_id": "bf522d5c-420c-4675-87e9-12704ce3e835",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f6c95765-8bd2-4aea-a54f-4acfcc202b6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dba397e0-67c5-4851-bfd4-fa6e742f26ee",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3ae78a25-0514-46e1-82a7-13329e19ad17",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8250df4a-6f50-46bd-b1a5-55ec8211d213",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00"
},
"equipment_family_id": "02d5ce96-c485-41ab-91df-2f2990b0c92f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "10cdc1b6-82aa-42d2-8c23-e8feeed85b25",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c736c499-34fe-4230-ae93-086003d7679f",
"_parent_code": "sample string 6",
"sales_organization_id": "6b883d0f-6f34-4238-b789-305ffcc05e4f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00"
},
"date_in_production_since": "2025-12-27T08:26:03.5241069+00:00",
"date_out_of_production_since": "2025-12-27T08:26:03.5241069+00:00",
"date_end_support": "2025-12-27T08:26:03.5241069+00:00",
"sales_organization_id": "06e85369-84d9-4649-b379-ce4448304b2a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+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": "2025-12-27T08:26:03.5241069+00:00"
},
"project_status_id": "f67fca7c-a7bc-4ee0-b754-815e31ca170c",
"project_status_code": "sample string 10",
"project_status": {
"id": "7579c890-0401-42ae-91a8-9db2c6ca7475",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2bee780e-ee58-401d-829f-f041f0b553ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00"
},
"company_id": "716ad25b-2c4f-4164-932a-2142a96064bc",
"company_code": "sample string 12",
"db_address_id": "5703b0e2-3050-4b6a-92ed-23aaf47bab82",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3e1031c2-b758-4c90-ad94-916987bffd2a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c325bcba-1ce6-4c81-8850-9e6ed5e2c551",
"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": "2025-12-27T08:26:03.5241069+00:00",
"date_create": "2025-12-27T08:26:03.5241069+00:00",
"date_update": "2025-12-27T08:26:03.5241069+00:00",
"updated_by_user_id": "50ae51f4-e943-438a-ac3f-227050887aa9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-27T08:26:03.5241069+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": "2025-12-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-27T08:26:03.5241069+00:00",
"date_last_job": "2025-12-27T08:26:03.5241069+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-27T08:26:03.5241069+00:00",
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00",
"is_mobile_installation": true
},
"job_type_id": "ad529a40-f4de-4bac-95b2-856a0e497eb7",
"job_type_code": "sample string 7",
"job_type": {
"id": "6bb5a86d-8b0d-45a0-9c97-b9b95466bcd4",
"name": "sample string 2",
"sales_organization_id": "12742866-d022-4a08-aed0-ab07f46d7d7f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00",
"code": "sample string 7"
},
"job_priority_id": "dd3c1748-7e5d-4637-99f5-c3938a17ca5f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2ed7306a-45ca-4fc5-bae6-1888bf43651d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b4456735-1c34-4cc8-9287-bff8db87b844",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00"
},
"job_status_id": "5b1eaac1-fdc9-4582-b3fa-5ea03f7b40e2",
"job_status_code": "sample string 11",
"db_address_id": "ec15140f-3a79-40f6-8648-30b682feb99d",
"contact_id": "70300192-794b-4d02-a0e0-fed93cfa57c2",
"requested_by_company_id": "9c60ddf1-1965-4c60-a0e6-b113fb3bffe4",
"requested_by_contact_id": "c70e2cad-bbb7-4255-aa83-eeb9adb25474",
"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": "2025-12-27T08:26:03.5241069+00:00",
"due_date": "2025-12-27T08:26:03.5241069+00:00",
"date_create": "2025-12-27T08:26:03.5241069+00:00",
"date_update": "2025-12-27T08:26:03.5241069+00:00",
"date_closed": "2025-12-27T08:26:03.5241069+00:00",
"suggested_user_id": "c3d80ab8-b26f-4e26-92d8-e4dc82c4105a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fdec005c-b18b-42f9-a89d-42e6cd7a9fbf",
"db_language_id": "bbf05904-32e3-4b61-9970-f2b78cea9840",
"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": "2025-12-27T08:26:03.5241069+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a709a1e2-db30-4fb9-8200-19e08a8d2ecf",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "14ad1304-b816-4aa8-922e-a7798b249726",
"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": "7f57eefc-ee2c-4ea2-a529-a18e72d853e2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e5793068-9762-46e6-bde4-aaaea5ae18f4"
},
"suggested_date_start": "2025-12-27T08:26:03.5241069+00:00",
"skill_id": "345ae66d-0d98-4678-96b9-43e077285d2c",
"skill_code": "sample string 32",
"skill": {
"id": "ac95a7ab-9430-4b89-8e50-53db3b982e28",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8fd5c3f6-7ccc-4235-846e-ca731c055538",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "98c9866f-8366-48b0-b29c-abcb791f4718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf671a9-6e1d-437a-9976-f6829c8ac3b3",
"db_currency_id": "5bc8e415-e7e5-4d89-b150-eb1c65602dc2",
"db_language_id": "f7eada38-54af-4020-b65d-c793c37e6741",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "31e3cf29-6be6-42ba-ada6-34d8c4650156",
"date_reported_by_company": "2025-12-27T08:26:03.5241069+00:00",
"id2": 36,
"company_id": "46978e72-de20-4c6e-9d65-25d9cd0a7334",
"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": "7b25a333-6fa4-4c98-a3ff-f850bc2881af",
"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": "2025-12-27T08:26:03.5241069+00:00"
},
"work_instruction_details_id": "a8e8ed02-2d0c-4bde-a8bb-d7dec41d27e3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "da381184-aa0c-4c9c-b273-393fa8b27a40",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "07cb2810-bf7d-40d7-8df0-2f75b24c73ec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-27T08:26:03.5241069+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": "dd7794de-db9c-437f-99f3-ae327288066c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-27T08:26:03.5241069+00:00"
}