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": "8a418174-b590-4322-aa5e-79f0e08b83e8",
"jobs_id": "59a14cf8-4edf-454b-9943-621aa33bca94",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "73c98df7-2df1-415c-a173-c7ff7929319e",
"_parent_id": "40f175c8-4890-481e-82f8-a457f8e63a55",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "744578e3-c6d9-4839-8c77-60de574b77b3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f5a95610-9ebe-414c-b8fd-beaab1c3ac3f",
"_parent_id": "d5358e98-e58d-4d14-b5f1-130e43bf0543",
"root_parent_id": "b1102e47-75df-422f-9f6c-cb717beacfba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0679fc83-e135-4191-b8c2-243b32e6822c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e08efaed-fdad-4fea-bd4f-006a9d3ba72e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f37674a3-ac46-4c6b-a80c-8eeb81535537",
"_parent_code": "sample string 6",
"sales_organization_id": "488e0b52-509d-4722-b0c0-5201bed6266c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+00:00"
},
"modified_dateutc": "2025-08-12T12:42:07.5584094+00:00"
},
"equipment_model_id": "e01d716d-be4d-4bf6-977c-e9b0d6c81005",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7713d811-7dff-42f3-9ccc-0180ec5b7444",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "28bba45b-3629-4284-a518-397b0abec74e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "de9b6034-7a2e-4ce9-b227-20388bb36a9f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dd4e2dc5-af88-4eb4-9698-5c1dc7863695",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+00:00"
},
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00"
},
"equipment_family_id": "702f3529-7ff7-4531-9e8a-f09453583c77",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e08efaed-fdad-4fea-bd4f-006a9d3ba72e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f37674a3-ac46-4c6b-a80c-8eeb81535537",
"_parent_code": "sample string 6",
"sales_organization_id": "488e0b52-509d-4722-b0c0-5201bed6266c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+00:00"
},
"modified_dateutc": "2025-08-12T12:42:07.5584094+00:00"
},
"date_in_production_since": "2025-08-12T12:42:07.5740421+00:00",
"date_out_of_production_since": "2025-08-12T12:42:07.5740421+00:00",
"date_end_support": "2025-08-12T12:42:07.5740421+00:00",
"sales_organization_id": "0eeabfd6-c5df-4fee-b4fb-e21da0e5938c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+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-08-12T12:42:07.5740421+00:00"
},
"project_status_id": "756816c0-b1f1-430b-880a-02a9127c96ed",
"project_status_code": "sample string 10",
"project_status": {
"id": "5eec761c-b64c-4354-8736-c81e4f3c8cfd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ce91bbe9-bc13-4a43-91a1-17ee26aa1d31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00"
},
"company_id": "359bc879-ca71-42a8-9e4c-1f4af7c6262a",
"company_code": "sample string 12",
"db_address_id": "4a4ca0ff-4f3a-49ef-9e2a-07acd8827d3f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a9b8baa3-0a91-4741-96a3-561652a12b99",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "998b3a94-70eb-425e-99ac-68a3d0889943",
"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-08-12T12:42:07.5740421+00:00",
"date_create": "2025-08-12T12:42:07.5740421+00:00",
"date_update": "2025-08-12T12:42:07.5740421+00:00",
"updated_by_user_id": "2ac84a10-dc4d-4725-80d1-e040e415e3a0",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-12T12:42:07.5740421+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-08-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-12T12:42:07.5740421+00:00",
"date_last_job": "2025-08-12T12:42:07.5740421+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-12T12:42:07.5740421+00:00",
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00",
"is_mobile_installation": true
},
"job_type_id": "58fc0d93-1d52-4e82-be87-5e538a9db955",
"job_type_code": "sample string 7",
"job_type": {
"id": "7c0ab5cb-dfc2-4ef9-bc55-218dfd230f4b",
"name": "sample string 2",
"sales_organization_id": "b9ee3e8c-5b72-4342-97d9-8714f8993a5c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00",
"code": "sample string 7"
},
"job_priority_id": "b93ab1c7-a09f-4ede-9bc6-06b84052093b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "00906d4c-2d67-4b48-883f-8fdc37f6f023",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a13868c6-025f-4dc5-bc11-2807e9e051af",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00"
},
"job_status_id": "e260c240-fc94-423c-b119-85d357110747",
"job_status_code": "sample string 11",
"db_address_id": "67d33b47-6bf0-4bd8-89bb-2b5390cbea4a",
"contact_id": "13830569-b9fc-468e-86df-8762e37cf188",
"requested_by_company_id": "c86a125d-e9e2-4aa0-8cde-a793eeffc73a",
"requested_by_contact_id": "c1be168f-d846-42ed-a529-88f650fa0a39",
"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-08-12T12:42:07.5740421+00:00",
"due_date": "2025-08-12T12:42:07.5740421+00:00",
"date_create": "2025-08-12T12:42:07.5740421+00:00",
"date_update": "2025-08-12T12:42:07.5740421+00:00",
"date_closed": "2025-08-12T12:42:07.5740421+00:00",
"suggested_user_id": "81ecb0a6-a5c8-4bca-a2fb-25cba1bb1b4c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a4b66f9e-f877-4f31-a084-163b0bf763e9",
"db_language_id": "a756eae1-1d59-4988-abf2-b50cef2caea5",
"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-08-12T12:42:07.5740421+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8f185253-2800-424d-a6ac-a68bd307567f",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9c384ee4-b100-4b3b-9e36-525b6be2b8e6",
"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": "e4de8b09-d955-48e9-b5bd-0906ef8c5902",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cd8b599f-679c-47b3-a644-e108d41a91c1"
},
"suggested_date_start": "2025-08-12T12:42:07.5740421+00:00",
"skill_id": "0e43de86-3024-4802-bc81-04e8b4c2f7db",
"skill_code": "sample string 32",
"skill": {
"id": "8ae297af-11b6-4e18-b5b7-3e805d786252",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "feb6c081-b6fc-4e66-9017-47affb207335",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "370a3ade-1307-4645-9bf7-542b53278ddb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7393860-4e9b-4fa3-9627-877bc1c88c96",
"db_currency_id": "6dc4c1fd-fc82-458e-8e29-0e33d05d0be4",
"db_language_id": "6a6f3d38-109c-4d98-88f5-4aba21405b78",
"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-08-12T12:42:07.5584094+00:00"
},
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6a7f7d52-3ca6-4ec0-a77f-527a4a5bbe6b",
"date_reported_by_company": "2025-08-12T12:42:07.5740421+00:00",
"id2": 36,
"company_id": "9d9b7b4f-a6a7-4dac-b57d-6cdb3e2c4157",
"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": "7217eaeb-0f36-4d60-b643-3ef2edf9a4ff",
"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-08-12T12:42:07.5740421+00:00"
},
"work_instruction_details_id": "9272c7b4-2664-4b23-91f1-2c1c991140ef",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a135d7f8-6ed2-4a67-9e25-9dae18672c85",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "96287abc-6160-4326-89a7-b2a05169aa2e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-12T12:42:07.5740421+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": "1dbaf3cd-df96-40c9-9273-1a684e08ce24",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-12T12:42:07.5740421+00:00"
}