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": "4c12954e-fe8e-46b7-a160-d958fcb63d33",
"jobs_id": "901ce2ed-182e-4c96-847f-e7442407e345",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c3692cc-fdb2-45ca-98e4-51fdf6481bd9",
"_parent_id": "7f38ec0c-d2c5-46d0-9646-2173a4aa115c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a052f618-8eef-4dc3-94b6-e5161c32a8c6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a7bcd35b-17e8-4df6-abf6-eeb3a0b3752d",
"_parent_id": "004f3777-5611-47a9-ae39-5eb2dee030d9",
"root_parent_id": "a54ed767-001c-4689-a389-e9f7c11a32fb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a2f77bc9-bb94-4fd8-9af9-29709e2dfc43",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a77cd920-f738-4576-9d57-136f8c49c417",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3590eda-d88f-41e7-b5a0-1264dc6ff72d",
"_parent_code": "sample string 6",
"sales_organization_id": "20903464-e41f-40ee-8f68-c136843a0d52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+00:00"
},
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00"
},
"equipment_model_id": "f9821f7a-2ab3-41e6-85a0-c8fc21152d11",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "966d880a-3a4d-4b10-a85c-2584428b815d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0337de35-3cf6-4b23-836f-44282be86def",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "753a7937-5c0b-4c5a-805a-ad1211b719c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d29daf11-6eb6-43ae-84d5-340e53eca554",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+00:00"
},
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00"
},
"equipment_family_id": "8d7dd1c6-dbee-4997-af17-08bcfa5abcba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a77cd920-f738-4576-9d57-136f8c49c417",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3590eda-d88f-41e7-b5a0-1264dc6ff72d",
"_parent_code": "sample string 6",
"sales_organization_id": "20903464-e41f-40ee-8f68-c136843a0d52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+00:00"
},
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00"
},
"date_in_production_since": "2026-08-27T17:55:20.7282076+00:00",
"date_out_of_production_since": "2026-08-27T17:55:20.7282076+00:00",
"date_end_support": "2026-08-27T17:55:20.7282076+00:00",
"sales_organization_id": "6931dd3c-6894-4939-91e7-98d1a2289a9a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+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-27T17:55:20.7282076+00:00"
},
"project_status_id": "0e3177ce-411e-4fba-950c-b14c0451abb1",
"project_status_code": "sample string 10",
"project_status": {
"id": "df1ba14d-8226-441b-b74d-ed0607b6fbe0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "01fd5985-cda9-4f7e-bbe2-0ca6a4df372d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00"
},
"company_id": "25ae1069-6435-4124-97e2-cb27dfbf0865",
"company_code": "sample string 12",
"db_address_id": "6310793b-7ee1-41be-9d9a-44611a516a9f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "48d407e1-f111-422b-915a-b95ad36337a3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5433ff50-2481-4ee4-bf31-85dd807c7ab0",
"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-27T17:55:20.7282076+00:00",
"date_create": "2026-08-27T17:55:20.7282076+00:00",
"date_update": "2026-08-27T17:55:20.7282076+00:00",
"updated_by_user_id": "db32eb4f-9a84-46fb-b03a-a0716ee0d391",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-27T17:55:20.7282076+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-27T17:55:20.7282076+00:00",
"date_last_job": "2026-08-27T17:55:20.7282076+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-27T17:55:20.7282076+00:00",
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00",
"is_mobile_installation": true
},
"job_type_id": "981b7c64-9738-4669-bae7-fba7cd86fcc8",
"job_type_code": "sample string 7",
"job_type": {
"id": "36bcd926-0687-49df-a5be-8856805ff27c",
"name": "sample string 2",
"sales_organization_id": "23d6b821-8a48-4891-9570-c6ced1628c61",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00",
"code": "sample string 7"
},
"job_priority_id": "60f94860-693f-4bf3-8552-109715ab95e2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "535afdd8-5bae-4c12-b48b-6ee09bd5f8d9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0965ab98-8698-4af3-9efd-478e0d2edd86",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00"
},
"job_status_id": "091d2bce-6f2e-48ec-85f6-6e564873f8d8",
"job_status_code": "sample string 11",
"db_address_id": "94ffe6eb-5f2a-48db-8520-f16e87a282ff",
"contact_id": "072518ae-a230-4460-871b-941d914281bf",
"requested_by_company_id": "8cfe73cc-0d36-45c9-b809-d0fdf7c0669a",
"requested_by_contact_id": "58a2207c-1c04-4bae-a1e4-7e3317e121ca",
"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-27T17:55:20.7282076+00:00",
"due_date": "2026-08-27T17:55:20.7282076+00:00",
"date_create": "2026-08-27T17:55:20.7282076+00:00",
"date_update": "2026-08-27T17:55:20.7282076+00:00",
"date_closed": "2026-08-27T17:55:20.7282076+00:00",
"suggested_user_id": "193f3206-893e-4985-8492-78371261e330",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7288a21d-3875-4a26-b7f7-0ce223a6a97f",
"db_language_id": "cecd95f5-44e2-4090-ab41-7caaa2ebb598",
"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-27T17:55:20.7282076+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dacb6157-8da2-46ef-bde6-8e14f915e182",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fc1c1afa-7d79-4c4a-9bbe-9d24bfa1ba55",
"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": "cd611b31-e017-4880-8474-a01ea3cb7998",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5fe2884a-9060-4e20-8d56-aefff5a30f78"
},
"suggested_date_start": "2026-08-27T17:55:20.7282076+00:00",
"skill_id": "e81feaf8-57a2-482e-b091-74565d3a8fff",
"skill_code": "sample string 32",
"skill": {
"id": "7597bdbe-44d8-49d9-8286-b9dd392b258c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6b209457-143f-475b-ad62-ab2b9a7b4c79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "45c0f83a-9fd1-4e8c-9c11-7ba1a05ec340",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aac37fc-6d6d-4a84-8725-50abf79ca0dd",
"db_currency_id": "e6aec70d-4ba5-46a2-9286-74e4d8b18b36",
"db_language_id": "7e1da6cf-e558-430f-9bba-740b1cd7c686",
"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-27T17:55:20.7282076+00:00"
},
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6a194293-2f83-4934-ba02-86f089e7d68c",
"date_reported_by_company": "2026-08-27T17:55:20.7282076+00:00",
"id2": 36,
"company_id": "adad3ba0-c6b4-4e2c-9f14-b1367efa26fc",
"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": "e7e0e1ea-11d0-4df6-9866-96a6afebd3a1",
"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-27T17:55:20.7282076+00:00"
},
"work_instruction_details_id": "c25d3b6b-f3b0-4707-953d-77c728be983d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e81322ae-b361-488f-8e24-d0ff24766d60",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d0930777-e1f2-420d-84ff-baaf1b3c3b03",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-27T17:55:20.7282076+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": "484adb79-8b9d-4a37-adc5-8fc6c092621a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-27T17:55:20.7282076+00:00"
}