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": "97d168f6-d6f5-4018-ae8a-f019fb38afe0",
"jobs_id": "2f422fa6-f99d-4e06-a830-5d12df4efc72",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "61637803-c6f8-4541-894f-4f53420fdcda",
"_parent_id": "bf25d251-49fa-419b-99da-175097ed5a71",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eaf1de10-40fa-4d75-bf4a-95d22cff43d6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ff02b418-feed-4fc3-9774-9a6055399193",
"_parent_id": "959c88ad-22e0-4cf0-93a8-bb63f893e608",
"root_parent_id": "db0fb68f-3341-47b0-882d-0ae76f54a7f3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3ec2a856-f612-4966-b462-a61fa63c8679",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a65e0cba-8aab-4144-9b52-46a92e313b72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "00845e7b-7d98-4f93-ad87-b097c711b75f",
"_parent_code": "sample string 6",
"sales_organization_id": "fd548e77-50d3-4a36-a2b0-4ad4d28c7144",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+00:00"
},
"modified_dateutc": "2026-10-25T05:15:21.1762157+00:00"
},
"equipment_model_id": "8770829f-f201-4bfa-a204-1a703aafc984",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "71aee52b-fff0-44b5-9d53-82a3cde2b300",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "50393657-6a91-45d2-af0a-25ddfc87e232",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a028dd69-387f-4719-933b-e4a3685ce2a4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ce204b20-4427-461f-8605-96dcc979024f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+00:00"
},
"modified_dateutc": "2026-10-25T05:15:21.1762157+00:00"
},
"equipment_family_id": "c643633d-7b59-4a77-9438-1e84c20f117c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a65e0cba-8aab-4144-9b52-46a92e313b72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "00845e7b-7d98-4f93-ad87-b097c711b75f",
"_parent_code": "sample string 6",
"sales_organization_id": "fd548e77-50d3-4a36-a2b0-4ad4d28c7144",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+00:00"
},
"modified_dateutc": "2026-10-25T05:15:21.1762157+00:00"
},
"date_in_production_since": "2026-10-25T05:15:21.1762157+00:00",
"date_out_of_production_since": "2026-10-25T05:15:21.1762157+00:00",
"date_end_support": "2026-10-25T05:15:21.1762157+00:00",
"sales_organization_id": "3b1acad6-1cf1-4440-9486-f1b4604b3381",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+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-25T05:15:21.1762157+00:00"
},
"project_status_id": "4603eb3c-baa6-49f0-a61b-0196f023c46d",
"project_status_code": "sample string 10",
"project_status": {
"id": "2a73db0a-1b8a-4c6c-befd-5b45e4e7e1f3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cd43950a-78b5-42cc-ab3e-b8f7d2bd3eb3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-25T05:15:21.1874671+00:00"
},
"company_id": "1510976b-193c-4d25-904d-b2a1e9eda7d5",
"company_code": "sample string 12",
"db_address_id": "6a4d455b-d42b-4283-a350-6fc74b71a3aa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d1dda7a5-4059-4713-84e9-3f9c3494c318",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fc495e1a-ad32-4668-b6a8-f6f38fba4de6",
"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-25T05:15:21.1874671+00:00",
"date_create": "2026-10-25T05:15:21.1874671+00:00",
"date_update": "2026-10-25T05:15:21.1874671+00:00",
"updated_by_user_id": "b55eefe1-0b30-45ec-bcba-93509c270e6e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-25T05:15:21.1874671+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-25T05:15:21.1874671+00:00",
"date_last_job": "2026-10-25T05:15:21.1874671+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-25T05:15:21.1874671+00:00",
"modified_dateutc": "2026-10-25T05:15:21.1874671+00:00",
"is_mobile_installation": true
},
"job_type_id": "0f5090e6-fcac-4cce-8fa1-3ebababab285",
"job_type_code": "sample string 7",
"job_type": {
"id": "a6d87348-0546-4ee7-833f-38ca26efca67",
"name": "sample string 2",
"sales_organization_id": "c2aaf3d2-9c5c-4b73-af26-ad607c6c8317",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-25T05:15:21.1874671+00:00",
"code": "sample string 7"
},
"job_priority_id": "a8f8a614-c96d-4273-9540-787d297b1fb9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f3bedb40-89c9-4081-bf73-e5b8f5492f27",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2ce90e61-b753-4fe0-8cec-58bb54b72c22",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-25T05:15:21.1874671+00:00"
},
"job_status_id": "0a042518-aab0-423d-8d3a-a23d9c92e58e",
"job_status_code": "sample string 11",
"db_address_id": "70bc2b1f-99da-46dd-9bfe-aab2d254abb2",
"contact_id": "99be9652-2ca0-4e1d-8f0c-ef865483b75d",
"requested_by_company_id": "8b20073c-a46a-4179-92a0-4b4d130def06",
"requested_by_contact_id": "4d222d4b-d87b-4f5b-a769-e5f7d31c68da",
"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-25T05:15:21.1874671+00:00",
"due_date": "2026-10-25T05:15:21.1874671+00:00",
"date_create": "2026-10-25T05:15:21.1874671+00:00",
"date_update": "2026-10-25T05:15:21.1874671+00:00",
"date_closed": "2026-10-25T05:15:21.1874671+00:00",
"suggested_user_id": "669cb1f9-1b58-4caf-9165-ea223520f722",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "79b2ed25-9e38-4452-a145-f044d798edaf",
"db_language_id": "9509848b-2527-4f0a-b0e4-89b690fb30c5",
"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-25T05:15:21.2032268+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cf3cae7e-91da-4e79-8212-c746f4e45fe8",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "71667bbd-1717-4abd-99ee-a87b248ba376",
"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": "ccde457a-5d9a-4e3a-8cbf-2ab3231ceec0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-25T05:15:21.2032268+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8ddbf56d-719e-4632-9ec8-cf4bb90e104e"
},
"suggested_date_start": "2026-10-25T05:15:21.2032268+00:00",
"skill_id": "aee6b23f-f8cb-4c78-97cf-2977cf241298",
"skill_code": "sample string 32",
"skill": {
"id": "d499b26a-3a8e-4307-9cba-7942d72df3a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ef99b2f0-7d38-4e1b-a4c7-2173a7e11b60",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11a23950-83cb-4d23-8a49-a60db33a5625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "186bbaa7-5429-46ca-93c1-3b5902ecb18f",
"db_currency_id": "99981566-7aae-4412-bf48-b120e47ef1fb",
"db_language_id": "36d23ad8-e519-49a9-8975-df6c587de544",
"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-25T05:15:21.1762157+00:00"
},
"modified_dateutc": "2026-10-25T05:15:21.2213462+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4696b7f5-8adc-4355-a385-85e0a1a29b6a",
"date_reported_by_company": "2026-10-25T05:15:21.2213462+00:00",
"id2": 36,
"company_id": "005cd1a2-43c7-4244-be3d-1cbd2fea027c",
"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": "3870dc64-8085-4c78-80f8-f99014738d4b",
"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-25T05:15:21.2213462+00:00"
},
"work_instruction_details_id": "e3cd623e-7a02-4960-aab0-a6b34ee52ad0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "50c98dfd-5738-4555-bc6b-4d7c193c37fc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "50e56115-1bf4-4255-aea3-5e632a003d6b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-25T05:15:21.2213462+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": "e4b8efca-fc03-49a4-9520-e2c595df36f7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-25T05:15:21.2213462+00:00"
}