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": "e9a44b54-cb65-4893-a1a6-0fab8fd34880",
"jobs_id": "d7319eae-2491-4b04-a68f-73456fa7c6aa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ec3d17d7-3ffb-4a8a-9d64-0ed1aef56cd1",
"_parent_id": "f5e777d3-781f-4b9c-aa2f-f9823c4969f8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "efd06d5a-b282-408d-98d2-0e139e0af476",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6fe511a8-ee9b-497c-a44e-4276ce1f9c52",
"_parent_id": "15e9ad94-3090-46cf-ba9c-568eaa48d277",
"root_parent_id": "438babeb-5a8e-4880-9927-1cf9a5327963",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "846f1c29-ac77-464b-b9d6-aac6a391b04d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3e5327c7-d360-4bd5-869d-46ac9563d9d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b652a38-d0f5-4b3a-aeff-4e8e8cb712d2",
"_parent_code": "sample string 6",
"sales_organization_id": "1ef7127b-2676-45d1-b5a0-d2489aa38302",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+00:00"
},
"modified_dateutc": "2026-10-06T15:15:10.8075972+00:00"
},
"equipment_model_id": "9a207dc9-5558-4981-85dc-8eba630883c2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2ed0e83f-9a0d-4f1a-b303-95023252c7a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b7c037f2-b7c8-41a3-b82a-691caf349739",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2d45d82f-be10-4195-b64f-84945101747b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0e03e274-40c1-4963-afdf-4ad5f6190586",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+00:00"
},
"modified_dateutc": "2026-10-06T15:15:10.8075972+00:00"
},
"equipment_family_id": "0d331d27-5b13-43f3-b8be-14992e07d08b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3e5327c7-d360-4bd5-869d-46ac9563d9d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b652a38-d0f5-4b3a-aeff-4e8e8cb712d2",
"_parent_code": "sample string 6",
"sales_organization_id": "1ef7127b-2676-45d1-b5a0-d2489aa38302",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+00:00"
},
"modified_dateutc": "2026-10-06T15:15:10.8075972+00:00"
},
"date_in_production_since": "2026-10-06T15:15:10.8075972+00:00",
"date_out_of_production_since": "2026-10-06T15:15:10.8075972+00:00",
"date_end_support": "2026-10-06T15:15:10.8075972+00:00",
"sales_organization_id": "70558d11-d658-413a-a84d-4983475ce238",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+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-10-06T15:15:10.8075972+00:00"
},
"project_status_id": "0503f64e-b2c5-4c31-998f-4fccc10b246b",
"project_status_code": "sample string 10",
"project_status": {
"id": "4dfdb3d1-cb91-4bda-a063-97183f07b3ad",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "363a2f50-17b1-441f-b34c-df7aaebd6231",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T15:15:10.8075972+00:00"
},
"company_id": "4aee5273-f957-4874-805e-feeb19609736",
"company_code": "sample string 12",
"db_address_id": "17321213-1338-46a4-99ca-4dbc1e59d5cf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c45bf93c-c00a-416d-a60d-6a7bdc4771ba",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6cbef501-9e2c-4f30-888b-770c59a1e0c2",
"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-10-06T15:15:10.8075972+00:00",
"date_create": "2026-10-06T15:15:10.8075972+00:00",
"date_update": "2026-10-06T15:15:10.8075972+00:00",
"updated_by_user_id": "7817da2e-b969-4a3a-ae8f-d33314d66a8d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T15:15:10.8075972+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-10-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T15:15:10.8075972+00:00",
"date_last_job": "2026-10-06T15:15:10.8075972+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T15:15:10.8075972+00:00",
"modified_dateutc": "2026-10-06T15:15:10.8075972+00:00",
"is_mobile_installation": true
},
"job_type_id": "a3908748-74de-4df3-a258-f8d3e5d156bf",
"job_type_code": "sample string 7",
"job_type": {
"id": "0cce1e19-d5ab-480e-933c-926633f4c6ae",
"name": "sample string 2",
"sales_organization_id": "c8fbd678-b296-49e4-8808-7250a99b3025",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T15:15:10.8075972+00:00",
"code": "sample string 7"
},
"job_priority_id": "06f3b23c-ffb0-41f8-82f6-6fbfb8e2fac7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4fac139b-b219-4462-8c9e-31838f08fb29",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "55e75cb3-0dd4-4157-bfee-a3ea289d85e5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T15:15:10.8268476+00:00"
},
"job_status_id": "7dec355c-8139-49b5-9a75-18165e3ee8d5",
"job_status_code": "sample string 11",
"db_address_id": "c733afdf-9937-40d8-bcd2-47a0fad9b6af",
"contact_id": "c1080649-c528-4751-a481-bfb994cbb7f5",
"requested_by_company_id": "01de202e-6de0-4ea5-8e6c-96a51ce07745",
"requested_by_contact_id": "50672d1a-f395-4919-b9da-2b7d31d6aeec",
"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-10-06T15:15:10.8388389+00:00",
"due_date": "2026-10-06T15:15:10.8388389+00:00",
"date_create": "2026-10-06T15:15:10.8388389+00:00",
"date_update": "2026-10-06T15:15:10.8388389+00:00",
"date_closed": "2026-10-06T15:15:10.8388389+00:00",
"suggested_user_id": "29782aa7-fa44-4827-91b1-74c390c2f681",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "24389c7d-7e00-4a55-bced-28eb949bae33",
"db_language_id": "b1a1fabb-e424-46b3-9fa8-d1ebc0b9dc49",
"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-10-06T15:15:10.8388389+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5f64b644-0e3e-4721-8ad3-29f8957622f9",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "171ac923-4d59-47db-987d-fb100b0e30ce",
"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": "842d06d4-d229-466e-8bad-487761a8d278",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T15:15:10.8388389+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9fdb6f12-3448-4554-92c5-ee4bac477424"
},
"suggested_date_start": "2026-10-06T15:15:10.8388389+00:00",
"skill_id": "74de721c-a137-4a49-b844-44108b96b048",
"skill_code": "sample string 32",
"skill": {
"id": "09289f7b-00a8-49d5-b9a7-5e137df3dac9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b442448a-1819-4424-b3a0-8727e6d9e1cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f299734-f546-4e72-929f-2ccdf7984973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "68136410-850e-4c92-bc6f-42837b6f1469",
"db_currency_id": "c305faca-4885-4a32-85c3-c7192e7a6019",
"db_language_id": "29efcb68-277a-436e-96d4-02be3a214217",
"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-10-06T15:15:10.8075972+00:00"
},
"modified_dateutc": "2026-10-06T15:15:10.8388389+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1b7c9b72-8d82-4d2a-aad9-c36eaf8380dc",
"date_reported_by_company": "2026-10-06T15:15:10.8388389+00:00",
"id2": 36,
"company_id": "e9755ff0-175d-4212-9858-1515902a64a6",
"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": "5220a67a-60d8-47bc-a2ff-cba37eed7035",
"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-10-06T15:15:10.8388389+00:00"
},
"work_instruction_details_id": "b5cb95fe-7e69-4368-b048-90c730ea3393",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fcd188a8-b905-4834-be6e-0f9239de5d5b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9f243bbb-4194-4009-b304-925f14509899",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T15:15:10.8388389+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": "361d7f22-9a15-47d2-a067-57ab1335acac",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T15:15:10.8388389+00:00"
}