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": "743c6ee3-41e2-49d9-a5e9-62bf3abe6f04",
"jobs_id": "df9566c2-9ca4-461a-a692-48f06a10df27",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f7870c7f-c86f-4f59-8bbd-59cbe0863de0",
"_parent_id": "b7afc566-99ed-4c4b-b7db-2bffa6abc2a8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d591a11b-11cd-48b8-b5a9-93f9884b194f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c2a7fd59-7267-48e3-922a-3e7390e23641",
"_parent_id": "c63ccb19-9f08-4434-a996-9bb6f504c927",
"root_parent_id": "80b242fa-7e8c-4231-b775-2a117253cead",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b60be204-d229-4fbe-9dcc-7ec28e5818ea",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9621b51c-427c-4528-988d-d220305fa086",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "91ba225c-e15d-402b-843c-49014efa403a",
"_parent_code": "sample string 6",
"sales_organization_id": "a4aa317d-c97f-4f3d-8b9f-dfb8edfdfe0f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+00:00"
},
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00"
},
"equipment_model_id": "f908bde0-85a9-4336-9703-ff1f73a83e27",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3e6ecf02-400a-4daf-859f-3ab5881eda48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9532a6ce-eb6f-4d78-8373-7d8a0b664e0e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d24a87a6-936b-44b6-b6d0-4aa52a6cce19",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "58d4ee14-53c9-4696-9d2b-0ddf8285e25d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+00:00"
},
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00"
},
"equipment_family_id": "72db02ed-b57c-41fb-99e8-940086eac7fb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9621b51c-427c-4528-988d-d220305fa086",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "91ba225c-e15d-402b-843c-49014efa403a",
"_parent_code": "sample string 6",
"sales_organization_id": "a4aa317d-c97f-4f3d-8b9f-dfb8edfdfe0f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+00:00"
},
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00"
},
"date_in_production_since": "2026-08-24T14:08:21.784184+00:00",
"date_out_of_production_since": "2026-08-24T14:08:21.784184+00:00",
"date_end_support": "2026-08-24T14:08:21.784184+00:00",
"sales_organization_id": "540ff45f-78fa-4966-8c25-e1ffa6939457",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+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-24T14:08:21.784184+00:00"
},
"project_status_id": "f41814b2-cef4-45f0-9187-5226c8240799",
"project_status_code": "sample string 10",
"project_status": {
"id": "5203eb3b-1c29-476f-b98c-6ee9e9daac53",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b9c04ed0-7366-4b2a-bebc-01c4cdc4e14c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00"
},
"company_id": "f76628c1-aea0-4e2b-932a-7572b3f2f867",
"company_code": "sample string 12",
"db_address_id": "8d9cc27e-e9ec-498a-9ad1-c7095090268b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "60d3bc75-1d86-46bf-a112-0cd5efa5dcb8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "714df7c3-fe4b-4b1f-a7cc-0e20103fcbdb",
"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-24T14:08:21.784184+00:00",
"date_create": "2026-08-24T14:08:21.784184+00:00",
"date_update": "2026-08-24T14:08:21.784184+00:00",
"updated_by_user_id": "2ec89d9a-8f50-4e8c-a2d5-cb16974d2bd9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-24T14:08:21.784184+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-24T14:08:21.784184+00:00",
"date_last_job": "2026-08-24T14:08:21.784184+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-24T14:08:21.784184+00:00",
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00",
"is_mobile_installation": true
},
"job_type_id": "886ee69e-6cc2-4f45-b850-1f81806d44f7",
"job_type_code": "sample string 7",
"job_type": {
"id": "91c390a5-fc45-4d0b-9917-f3ea4133116f",
"name": "sample string 2",
"sales_organization_id": "4d6e0571-54ed-47e8-8ef9-aa99ae1fb444",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00",
"code": "sample string 7"
},
"job_priority_id": "a0175c55-cf28-45bf-a3f7-276f1b222046",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "388eb25b-a26d-401d-93e7-9c755b404f1a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "de2aa3f2-f733-416e-9c9b-e87e7b4afe5b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00"
},
"job_status_id": "eaadc8a8-48bd-423c-896b-c1d36835ff0c",
"job_status_code": "sample string 11",
"db_address_id": "5af08cf0-04ea-4e87-ab2c-64fd6361c5cb",
"contact_id": "da698ff4-9788-4692-9f45-4d7ac564f368",
"requested_by_company_id": "cde9a969-d71e-49a9-bbb5-6934fcf876e2",
"requested_by_contact_id": "ef5b7037-4511-4e89-a20a-ea6198029f3b",
"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-24T14:08:21.784184+00:00",
"due_date": "2026-08-24T14:08:21.784184+00:00",
"date_create": "2026-08-24T14:08:21.784184+00:00",
"date_update": "2026-08-24T14:08:21.784184+00:00",
"date_closed": "2026-08-24T14:08:21.784184+00:00",
"suggested_user_id": "ffcdf8d5-2df2-4042-b2d5-9999f1bda324",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "41cc6fb2-96e5-4d53-8870-e6397063dbc9",
"db_language_id": "0760afa6-14a1-4902-b7dd-5d14126a6dfa",
"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-24T14:08:21.784184+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "963e3600-d49c-4bf8-a4df-68b225dccadb",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1482d3ff-ef80-4c65-89b9-211c97fe45ae",
"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": "18495fcd-12ba-4bbd-9502-f0f43c90fafa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "76a86df0-94c1-4b31-ac7a-8be0ac93ae85"
},
"suggested_date_start": "2026-08-24T14:08:21.784184+00:00",
"skill_id": "d36a931c-f6e7-4431-b27f-f29a035b0c83",
"skill_code": "sample string 32",
"skill": {
"id": "f593c399-caec-4a23-aec1-67b01c634b63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b246911a-65eb-4ea8-bf86-2c7226fe7ac6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8fde16df-9209-4dea-8f30-0ee9fad9a2f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35ded835-9f90-400f-8d29-3a7f18246bf5",
"db_currency_id": "81e43f7c-9189-4b7a-af41-2aef682b4a55",
"db_language_id": "edd33ded-eda9-4b64-bed5-6a2232406fda",
"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-24T14:08:21.784184+00:00"
},
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ca5237c8-23bf-43c8-8336-abd2d8caf09c",
"date_reported_by_company": "2026-08-24T14:08:21.784184+00:00",
"id2": 36,
"company_id": "3b1ea178-bbcd-4844-9dca-ebe0c6d5f8a5",
"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": "a91ad142-d2ac-40e9-8564-f952f58da3f6",
"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-24T14:08:21.784184+00:00"
},
"work_instruction_details_id": "1917821c-29ec-4bee-bbfb-063f94e8547e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c06f2ac3-4723-4a60-9128-76b4c040add5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cc6ecac6-f594-4210-8498-1ad662821ccf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-24T14:08:21.784184+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": "07b4dfe0-a3bf-475e-811a-5a9fe7aa7b84",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-24T14:08:21.784184+00:00"
}