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": "19858a15-fdf1-4840-ae0f-b6905f412ec9",
"jobs_id": "8017e103-10f7-4562-84d1-8ac68f0af902",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f35a24b6-d187-4694-a45e-1e296a6a9fbf",
"_parent_id": "5922fd82-b75c-4994-a2cd-81d8cab3eddc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e91083ca-6fb8-4af1-93e5-1df969c0530b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "57176c86-d4c8-4dca-918e-40d517dc7cec",
"_parent_id": "c2dd3dfc-7366-4f0b-b237-62c4dd1ea848",
"root_parent_id": "6666a43d-2890-413b-967c-b7bb2a7daa57",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d104e6bc-d60d-4b6f-9b03-8baefa2b2b4d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8824d210-55e1-452b-b888-52275c9ff697",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "51e21200-db39-4c13-8158-01cee5a25bcd",
"_parent_code": "sample string 6",
"sales_organization_id": "053224a9-a2fd-460c-bb81-e1459da6b4c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+00:00"
},
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00"
},
"equipment_model_id": "cbaff35f-665c-444c-9c5f-d2332a8abd07",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d6d8af1b-db99-44cb-969f-aeeb8a035b5c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2a40d9af-7aa7-446c-bef6-d1b75ed3186b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "28da1c2e-97da-4b63-865d-34b56d828c9b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1fc36b82-654d-47f1-b9f7-104d43f58bc1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+00:00"
},
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00"
},
"equipment_family_id": "06a7de0d-7f6d-4f2c-910d-8a9a6d483ee4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8824d210-55e1-452b-b888-52275c9ff697",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "51e21200-db39-4c13-8158-01cee5a25bcd",
"_parent_code": "sample string 6",
"sales_organization_id": "053224a9-a2fd-460c-bb81-e1459da6b4c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+00:00"
},
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00"
},
"date_in_production_since": "2026-07-28T07:00:07.2089189+00:00",
"date_out_of_production_since": "2026-07-28T07:00:07.2089189+00:00",
"date_end_support": "2026-07-28T07:00:07.2089189+00:00",
"sales_organization_id": "6f50c95f-7767-45b1-81a1-7be6e1a5a831",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+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-07-28T07:00:07.2089189+00:00"
},
"project_status_id": "bed56966-8e88-4e2b-a0bc-c6dbc2c9593d",
"project_status_code": "sample string 10",
"project_status": {
"id": "fa578d8f-34ad-4fff-b792-6374d1a04a06",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5cfabf47-d9c0-445b-b366-69dc42be1e6d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00"
},
"company_id": "f36be611-dd6a-489b-ab6a-104dafb26012",
"company_code": "sample string 12",
"db_address_id": "4d1ae953-7a10-4903-8352-e2ddcb2ee6ce",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "84b5f71c-4672-40ef-ac91-51a8b5baf99b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2c9a500b-6ca4-4f1c-a5ef-bf532c6abe3f",
"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-07-28T07:00:07.2089189+00:00",
"date_create": "2026-07-28T07:00:07.2089189+00:00",
"date_update": "2026-07-28T07:00:07.2089189+00:00",
"updated_by_user_id": "a07cb9cc-f74c-417f-9bab-31ce7f10dad1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-28T07:00:07.2089189+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-07-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-28T07:00:07.2089189+00:00",
"date_last_job": "2026-07-28T07:00:07.2089189+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-28T07:00:07.2089189+00:00",
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00",
"is_mobile_installation": true
},
"job_type_id": "a4af4402-ff6c-4373-b970-9df90da41afb",
"job_type_code": "sample string 7",
"job_type": {
"id": "c9db3b73-ae81-4aaa-9b82-be4ca72a856f",
"name": "sample string 2",
"sales_organization_id": "0c05bcd2-ede5-467d-b642-8d4da9502d70",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00",
"code": "sample string 7"
},
"job_priority_id": "06f38df9-7195-44aa-8fc6-380c2c06f634",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "909bbecc-881c-4b6a-b530-dc46767ce810",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a5391b01-db60-48ad-ad48-ba76f0962842",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00"
},
"job_status_id": "cd23a462-9bee-406e-b943-aa69e52bd1ec",
"job_status_code": "sample string 11",
"db_address_id": "7cd07591-c9ee-4cdd-b37f-9936e4bf8907",
"contact_id": "6df88c19-905f-4867-a298-8f50d925cda5",
"requested_by_company_id": "4411af01-26c9-4f1a-8bd7-f26d60a23010",
"requested_by_contact_id": "3328ab77-133e-4e27-b199-577dc5b5b71e",
"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-07-28T07:00:07.2089189+00:00",
"due_date": "2026-07-28T07:00:07.2089189+00:00",
"date_create": "2026-07-28T07:00:07.2089189+00:00",
"date_update": "2026-07-28T07:00:07.2089189+00:00",
"date_closed": "2026-07-28T07:00:07.2089189+00:00",
"suggested_user_id": "e2762447-32ad-4326-b75b-b9250e6aefea",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3112c45b-7d3c-4e72-ad53-2435a407e421",
"db_language_id": "4dc01fd2-c300-44aa-b303-eb380dd1af1c",
"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-07-28T07:00:07.2089189+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "992f9133-83be-4a17-aafc-60e85456b6de",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bd956295-c0fb-44e2-a8dc-d9efdec704a2",
"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": "bae515d5-bd45-4162-817a-1af513bcf1fe",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "92aa48c8-f570-4f9a-9e49-c16948d54f48"
},
"suggested_date_start": "2026-07-28T07:00:07.2089189+00:00",
"skill_id": "ac9e6ebd-4820-463a-84b9-922f3d385164",
"skill_code": "sample string 32",
"skill": {
"id": "3801b71b-5704-44eb-b907-41052ceb866a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6dfb9c8c-90f6-45f0-b283-c592939bb27b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "15348c6f-d1dc-4a71-bea7-a5c230fffc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5dfb148-ec64-4273-a0b3-b4246e9ecd91",
"db_currency_id": "bdba3c97-2c79-4c14-ab5a-3d1c057f8198",
"db_language_id": "6eefdc8a-2dad-4827-ad17-b6b827c5355e",
"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-07-28T07:00:07.2089189+00:00"
},
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c3731e2b-5867-4442-8a0f-8f9433795efa",
"date_reported_by_company": "2026-07-28T07:00:07.2089189+00:00",
"id2": 36,
"company_id": "4ce02563-1b5a-4956-9785-445fe4c7d384",
"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": "f8b40ba1-34db-42f4-8871-d3234e0b5610",
"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-07-28T07:00:07.2089189+00:00"
},
"work_instruction_details_id": "c256bffe-6ff3-492c-a5cf-09b8a9590c0c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c3bc7d01-c793-460f-9b7b-2345bb46782a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a7bb80dc-50c4-4a20-bb1d-531843edd030",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-28T07:00:07.2089189+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": "03603336-5cb6-4c73-a5e6-9f660d1de657",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-28T07:00:07.2089189+00:00"
}