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": "25f9a88d-604a-4960-bf80-98c061414b95",
"jobs_id": "0c42e1c2-b8ac-49a3-86a6-8baad9119443",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "64a195f9-35cb-4c76-aa31-b9ec6455d724",
"_parent_id": "947af37c-fa58-45ff-8a04-390645204355",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "30ba7ce4-2b20-4d17-94c3-8c54282514bf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a3fa554a-5de3-4172-84a7-e9ad8c9913bd",
"_parent_id": "33ac8610-116f-443e-9db2-22ca52ce42e7",
"root_parent_id": "1af15045-6697-4bdd-be21-dbd5f8aff7c0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "69dff7a3-a8b0-4362-a29e-9f3db45732a0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "05145699-5a90-4708-9446-671ba1e4b3b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1ea09f71-7981-467e-a6f0-48084a6b4d3a",
"_parent_code": "sample string 6",
"sales_organization_id": "c6dfe803-c00a-4451-88ff-b6e8806841be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+00:00"
},
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00"
},
"equipment_model_id": "65032896-b780-4c12-afc8-ccacee05e0b4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a32f3161-a004-46d4-ad2c-4a868d874910",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "64dbbc3c-8ad1-4524-8279-6036010369d8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "649e80f4-6aee-406d-a774-e66c86955b03",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c5df908b-134d-409e-8032-9c04086f17b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+00:00"
},
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00"
},
"equipment_family_id": "ae141bf6-83b9-4df8-a461-430e52e65ed8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "05145699-5a90-4708-9446-671ba1e4b3b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1ea09f71-7981-467e-a6f0-48084a6b4d3a",
"_parent_code": "sample string 6",
"sales_organization_id": "c6dfe803-c00a-4451-88ff-b6e8806841be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+00:00"
},
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00"
},
"date_in_production_since": "2026-01-07T10:24:31.5019716+00:00",
"date_out_of_production_since": "2026-01-07T10:24:31.5019716+00:00",
"date_end_support": "2026-01-07T10:24:31.5019716+00:00",
"sales_organization_id": "a3b3960b-5e40-426c-9ad0-35c612be3d8f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+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-01-07T10:24:31.5019716+00:00"
},
"project_status_id": "1d266a20-dc88-428f-9579-6f4ea681316a",
"project_status_code": "sample string 10",
"project_status": {
"id": "a165c44f-af26-4536-bb47-0e2852ef586c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5f856583-4935-4267-a7bd-94b539476711",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00"
},
"company_id": "ca88398e-77c9-4485-8456-69b52818a08a",
"company_code": "sample string 12",
"db_address_id": "a3508cb6-4d17-41c4-b874-541c7865ec7f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0a66ca4e-7174-4aaa-8938-c6768ccba658",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ef328f7c-7d42-484e-86e4-cfd99276a10b",
"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-01-07T10:24:31.5019716+00:00",
"date_create": "2026-01-07T10:24:31.5019716+00:00",
"date_update": "2026-01-07T10:24:31.5019716+00:00",
"updated_by_user_id": "88d8909e-d832-47e8-aa16-d5fbff27eda8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-07T10:24:31.5019716+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-01-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-07T10:24:31.5019716+00:00",
"date_last_job": "2026-01-07T10:24:31.5019716+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-07T10:24:31.5019716+00:00",
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00",
"is_mobile_installation": true
},
"job_type_id": "873a1c15-9cbd-49fd-864e-b2ea43ca9c96",
"job_type_code": "sample string 7",
"job_type": {
"id": "b381a45f-7c20-4917-a9c0-b57757781425",
"name": "sample string 2",
"sales_organization_id": "15c14989-23b6-4c89-9869-285d8cd29ad1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00",
"code": "sample string 7"
},
"job_priority_id": "4e10d23f-dab7-41e3-90ca-7ddba74498d0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2b4e702d-68ea-4742-85b9-a888d12a3fbf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ffc04d59-051a-40b7-aced-29a44e15be0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00"
},
"job_status_id": "5592e404-c399-4bb7-8734-54ff6911e364",
"job_status_code": "sample string 11",
"db_address_id": "cf1961af-e7df-46c2-a9cc-5cb089318b3f",
"contact_id": "9daf1b20-c89e-4eeb-a2f2-00d27ae25a10",
"requested_by_company_id": "9fff03bb-d179-4d2b-a4e9-62332145fb02",
"requested_by_contact_id": "d32f5526-344c-48eb-80a9-7c1a0f6cc6aa",
"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-01-07T10:24:31.5019716+00:00",
"due_date": "2026-01-07T10:24:31.5019716+00:00",
"date_create": "2026-01-07T10:24:31.5019716+00:00",
"date_update": "2026-01-07T10:24:31.5019716+00:00",
"date_closed": "2026-01-07T10:24:31.5019716+00:00",
"suggested_user_id": "4be2275f-5dba-4704-b104-ac3f0af8c9c2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4e8060b0-49fa-4983-9393-a39d8f43e9fc",
"db_language_id": "e481ebba-22c6-4c09-b871-2f966c253586",
"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-01-07T10:24:31.5019716+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "74e684b1-ed45-4e93-883b-bd43d6dd2018",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "491f00d7-8015-477e-9359-9efefc63d406",
"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": "b9a61f02-1b0d-489d-9085-02af64de3fa6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c346490c-25b9-497b-8262-f896f1cdf32e"
},
"suggested_date_start": "2026-01-07T10:24:31.5019716+00:00",
"skill_id": "a44d8516-9fda-4849-919a-8a97f6d3e478",
"skill_code": "sample string 32",
"skill": {
"id": "e3abb25b-27d5-4cd4-a1b5-184e60e46538",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6481520b-2266-46e7-a52b-74803fd973e5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7fa1451-b0e6-4cc7-84c5-9f4d6fdd0434",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14280007-a1ca-4cb5-8d7c-bf00c64bba9a",
"db_currency_id": "599ad661-8f25-4d7a-8218-54ef9f711721",
"db_language_id": "9b5c4106-2873-4178-acd6-bff2b8ad7cd2",
"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-01-07T10:24:31.5019716+00:00"
},
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "052e0143-cbf8-47d4-9722-cfa12694bd8c",
"date_reported_by_company": "2026-01-07T10:24:31.5019716+00:00",
"id2": 36,
"company_id": "77195f61-44b3-4a80-9b8e-4ecbd37891e1",
"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": "b1dd1b64-a5c9-467b-8051-aa082d299c0a",
"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-01-07T10:24:31.5019716+00:00"
},
"work_instruction_details_id": "4df5f927-348a-4e24-b4b9-5c4f579f718f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7194f796-c028-436f-b4b0-afdc03c4b64f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c3998f1e-7fde-4a03-8a8f-fe4e61d38d86",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-07T10:24:31.5019716+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": "2a7551a8-713f-4cb2-84ba-e45e0504cfad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-07T10:24:31.5019716+00:00"
}