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": "1c188856-b4e0-44bb-9d7e-aeea59e8909c",
"jobs_id": "fcb3dc47-b90f-4092-a696-f54920e56f17",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1106fa6b-c729-4ec1-b1fb-4b908bad399e",
"_parent_id": "9805d647-9b29-40d0-a5b5-4ce8b08815ad",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "402c1b12-6ebe-4e8e-8928-2ab8cc1ce3a8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2e372712-d6ca-4ac5-8870-0014864a0479",
"_parent_id": "203f2f67-141d-4a94-94d9-a6340d66cf66",
"root_parent_id": "a8d520c9-d615-45b7-8cbc-071e0a81ecdf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8bb5f8eb-8451-4d5b-a15b-566babc208a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "12808f98-213d-4efa-9bdd-65f41803eb87",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1e863c4-8f46-4397-b5c9-bef16427a0ff",
"_parent_code": "sample string 6",
"sales_organization_id": "e8155ec2-c058-4dd9-88e9-cfbf1c5819c4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+00:00"
},
"modified_dateutc": "2025-11-24T19:56:44.2274224+00:00"
},
"equipment_model_id": "5041dbe6-a4e1-44bf-a356-05f2b8e09535",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2d21c922-e01a-4963-8523-0cef86ef3c73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fd1a4ecd-bb4c-42cd-a70a-4c524b58400a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "536b4bba-a335-4ca6-b0c7-6154d279c15e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d53d5977-055d-4c07-9f34-e9b4cbaaadac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+00:00"
},
"modified_dateutc": "2025-11-24T19:56:44.2274224+00:00"
},
"equipment_family_id": "0698099d-3f27-4a3b-bd0f-e6a89fad1123",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "12808f98-213d-4efa-9bdd-65f41803eb87",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1e863c4-8f46-4397-b5c9-bef16427a0ff",
"_parent_code": "sample string 6",
"sales_organization_id": "e8155ec2-c058-4dd9-88e9-cfbf1c5819c4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+00:00"
},
"modified_dateutc": "2025-11-24T19:56:44.2274224+00:00"
},
"date_in_production_since": "2025-11-24T19:56:44.2274224+00:00",
"date_out_of_production_since": "2025-11-24T19:56:44.2274224+00:00",
"date_end_support": "2025-11-24T19:56:44.2274224+00:00",
"sales_organization_id": "2dfb8da9-7f70-4019-88ec-b47632d20cae",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+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-11-24T19:56:44.2431052+00:00"
},
"project_status_id": "38b4d4cc-30b8-4d43-94ff-46e979ffebae",
"project_status_code": "sample string 10",
"project_status": {
"id": "7e8cf0eb-a8d4-4227-8b06-c9c663a091fd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "08b55798-14a0-47ce-aed3-b2dba560946f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T19:56:44.2431052+00:00"
},
"company_id": "6217b785-fbc6-40bd-bfda-5b5264ec20c4",
"company_code": "sample string 12",
"db_address_id": "b9788c90-8e6a-451c-8a4a-c986bb20581e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "74726052-3458-442e-ab6f-6fc32042e50a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6410fca3-2753-4825-beba-18ec2733f982",
"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-11-24T19:56:44.2431052+00:00",
"date_create": "2025-11-24T19:56:44.2431052+00:00",
"date_update": "2025-11-24T19:56:44.2431052+00:00",
"updated_by_user_id": "9f257214-1bf1-4994-abec-c52e95b0bcd2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-24T19:56:44.2431052+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-11-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-24T19:56:44.2431052+00:00",
"date_last_job": "2025-11-24T19:56:44.2431052+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-24T19:56:44.2431052+00:00",
"modified_dateutc": "2025-11-24T19:56:44.2431052+00:00",
"is_mobile_installation": true
},
"job_type_id": "d9c89848-acfc-470a-987b-2434cd34e258",
"job_type_code": "sample string 7",
"job_type": {
"id": "a6b42930-3187-4c6c-8206-259aa9a0f523",
"name": "sample string 2",
"sales_organization_id": "87242280-60a8-472c-aa74-e1899fad44bf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-24T19:56:44.2431052+00:00",
"code": "sample string 7"
},
"job_priority_id": "8163b23d-8be8-4b64-bdc9-a93fa41c897c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "848b8a5f-244a-4916-bacc-4ed69353eeb5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cb0e15ad-7fea-45f4-b503-411a0ca6df64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T19:56:44.2431052+00:00"
},
"job_status_id": "6f0b5693-d0a4-4db9-8082-a010cd6170e2",
"job_status_code": "sample string 11",
"db_address_id": "eac5dcfa-cbb1-454f-a301-d419427dff0b",
"contact_id": "3d5420bf-2463-4025-8df4-d640c319e533",
"requested_by_company_id": "1fe13bb8-e65a-4a5c-841e-9b12c56a99a6",
"requested_by_contact_id": "054bc9d5-1925-4295-8c77-7b0bf43a36d6",
"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-11-24T19:56:44.2431052+00:00",
"due_date": "2025-11-24T19:56:44.2431052+00:00",
"date_create": "2025-11-24T19:56:44.2431052+00:00",
"date_update": "2025-11-24T19:56:44.2431052+00:00",
"date_closed": "2025-11-24T19:56:44.2431052+00:00",
"suggested_user_id": "00728dd4-9724-4a78-bece-8e939795559a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "702d5c5b-ac66-4ee2-a179-246ae79cc1ef",
"db_language_id": "bcfd142f-cca3-4868-a578-527ddc9b53f8",
"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-11-24T19:56:44.2431052+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "75c04648-975f-4f79-a604-ab7980778565",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "98428e1b-b858-42fa-93ae-81b6bb2fb7d7",
"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": "a5f2fe2d-923a-4370-bf3d-442ba222c1be",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-24T19:56:44.2431052+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "40f36f14-8de3-4452-9221-536f9adbee55"
},
"suggested_date_start": "2025-11-24T19:56:44.2431052+00:00",
"skill_id": "e33e94bd-c5b6-4dc4-a121-485ff309f668",
"skill_code": "sample string 32",
"skill": {
"id": "97133ea4-78dc-4172-a45f-0650a1c2ec72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "92ba2715-2d21-4d13-baa1-02916e66285f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d2ae71b-2444-4ba5-9346-57c7ca9a63f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c526039-4b43-4044-9aea-45aff3930c60",
"db_currency_id": "5e6862c0-ac9c-4e15-9b51-8911e40475a4",
"db_language_id": "894a26ff-335a-473e-8dcc-108db839fdd0",
"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-11-24T19:56:44.2274224+00:00"
},
"modified_dateutc": "2025-11-24T19:56:44.2431052+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bad1399b-5945-4cd3-8157-f0b11fd2cf59",
"date_reported_by_company": "2025-11-24T19:56:44.2431052+00:00",
"id2": 36,
"company_id": "fac7f576-07fc-4b81-a522-cc27f0a663f3",
"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": "bb00db52-27fe-4d8a-a8e9-0172f25eeb1b",
"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-11-24T19:56:44.2431052+00:00"
},
"work_instruction_details_id": "7e007a0a-4d4c-4cb9-8a65-7b475980837e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "429404d2-e01c-4e06-9d4a-f23cbd652160",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bfdcccad-db0f-4476-835d-d216fc69fe05",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-24T19:56:44.2431052+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": "cdd6265f-c97d-441e-98b3-646315006630",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-24T19:56:44.2431052+00:00"
}