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": "92e75a48-ef6c-4366-b0ec-4aaab8ca3e9c",
"jobs_id": "2a699a5e-55d8-4057-8b89-55f5f480c43a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4778df5f-cb27-452c-a109-3ad73cce6210",
"_parent_id": "c17d93a9-1bc3-438d-8e0f-b83ef268aa09",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5e832504-ca93-44ca-bf9b-dab29dcbe234",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b3b081d9-fada-4e31-9690-8b4652e7f1f6",
"_parent_id": "19955a59-3d19-423d-b41d-de9a2d87d9cc",
"root_parent_id": "75e172ce-d491-4972-9f47-8b0a1a902a37",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5090d9c3-fa84-404b-bfdc-4f13458c6ace",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eddec5c6-5a53-43bf-bd42-49b20ffb90ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8250cc20-42ca-4ea1-ae11-731c615a6d88",
"_parent_code": "sample string 6",
"sales_organization_id": "15c27f4a-dd76-48f7-a8d1-848709baeb05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+00:00"
},
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00"
},
"equipment_model_id": "5374fdc4-43e8-41ec-a02d-a827fde0d7f5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a5ae4bfd-27d3-449e-8f4f-6d1bc7df48d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a9511a8d-8c5d-45c7-abef-83d1abc19a4d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b7c4cf14-3b09-4d7d-b2b6-5846e433de8d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3ade6203-cb48-4861-9b39-ab8ebbf3944e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+00:00"
},
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00"
},
"equipment_family_id": "ee2c3bc9-e45c-4424-a733-61ea462ec422",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eddec5c6-5a53-43bf-bd42-49b20ffb90ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8250cc20-42ca-4ea1-ae11-731c615a6d88",
"_parent_code": "sample string 6",
"sales_organization_id": "15c27f4a-dd76-48f7-a8d1-848709baeb05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+00:00"
},
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00"
},
"date_in_production_since": "2026-05-02T21:04:25.0696085+00:00",
"date_out_of_production_since": "2026-05-02T21:04:25.0696085+00:00",
"date_end_support": "2026-05-02T21:04:25.0696085+00:00",
"sales_organization_id": "366ab352-4e0b-4b42-9192-6679949e9430",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+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-05-02T21:04:25.0696085+00:00"
},
"project_status_id": "e3a317f5-b90e-4b68-978e-6a10eabab117",
"project_status_code": "sample string 10",
"project_status": {
"id": "17b6b15c-a379-4c5d-9e18-855f7c8f4c9a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "66943496-4051-4a31-8e9f-38ef663dedfe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00"
},
"company_id": "2801324c-44ad-4fa1-ad78-7f8dab0c3e4a",
"company_code": "sample string 12",
"db_address_id": "5c31116b-3cfe-4304-b1d5-6b3be6eac82b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8786d6f8-b410-4815-bd38-14dc103dec75",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d2e9ce92-55cf-42a6-ba7f-78577603dbf9",
"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-05-02T21:04:25.0696085+00:00",
"date_create": "2026-05-02T21:04:25.0696085+00:00",
"date_update": "2026-05-02T21:04:25.0696085+00:00",
"updated_by_user_id": "8eec0b60-dba4-46ca-b823-7463f56835c4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-02T21:04:25.0696085+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-05-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-02T21:04:25.0696085+00:00",
"date_last_job": "2026-05-02T21:04:25.0696085+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-02T21:04:25.0696085+00:00",
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00",
"is_mobile_installation": true
},
"job_type_id": "19b91dc8-0327-4c21-8319-d9429039a7b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "dd25c1bd-e44b-4965-b823-8f20596e0977",
"name": "sample string 2",
"sales_organization_id": "0b15db6c-4f87-482e-bfd8-574f0be6b939",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00",
"code": "sample string 7"
},
"job_priority_id": "ee9618c9-0b80-426c-89e9-b09fa8525e5b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "11c63782-366f-4e92-8ce6-992f9a5783ad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a2ebf0de-c571-4aed-8cd4-b21b28d12a5f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00"
},
"job_status_id": "168c8405-0fd5-4e38-897a-d9398d123f68",
"job_status_code": "sample string 11",
"db_address_id": "2abcd5e5-3649-4a8d-8f52-b0867fdf4ea7",
"contact_id": "92738ec3-89fd-4a39-b208-0b95dbaec470",
"requested_by_company_id": "98e86da5-cd97-4e16-9d33-bf8baff59fb3",
"requested_by_contact_id": "699f3e67-8805-4e97-8c65-3f9d0f54d6de",
"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-05-02T21:04:25.0696085+00:00",
"due_date": "2026-05-02T21:04:25.0696085+00:00",
"date_create": "2026-05-02T21:04:25.0696085+00:00",
"date_update": "2026-05-02T21:04:25.0696085+00:00",
"date_closed": "2026-05-02T21:04:25.0696085+00:00",
"suggested_user_id": "43b9a900-49f9-4acd-8981-5a7b1d9969f1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7bcbe28f-261b-4a41-a38f-f1446a41aa48",
"db_language_id": "b3233ca1-c21b-446f-8f05-a6016a098141",
"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-05-02T21:04:25.0696085+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4a01b47b-e65e-42a4-953a-b1078e8524e6",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "08636364-f839-4bd3-b950-38ee5e0d0c77",
"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": "9f69e38e-3e21-4f33-b2d0-78db5c70fc0d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5620d349-5c1e-4b52-8f94-10c7db704390"
},
"suggested_date_start": "2026-05-02T21:04:25.0696085+00:00",
"skill_id": "81de44f7-aa05-49e0-ac3a-7a29f140546c",
"skill_code": "sample string 32",
"skill": {
"id": "126804bf-7592-4b16-a792-75310078e29e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4c120e15-da17-4cd0-aaad-2daa19a9428e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3bca0c0-cb16-4473-abbe-3a035cd995cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ee969c3-8c40-4ce6-a042-a2639fa0b4cf",
"db_currency_id": "12e84d71-2cee-4f20-acff-29c567d1503c",
"db_language_id": "45759cea-8baa-42fd-b681-08a9a7165a04",
"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-05-02T21:04:25.0696085+00:00"
},
"modified_dateutc": "2026-05-02T21:04:25.0696085+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c4b8377-e9c0-45aa-a744-e91a4bc59244",
"date_reported_by_company": "2026-05-02T21:04:25.0696085+00:00",
"id2": 36,
"company_id": "2a098f95-e37a-43cf-ae41-28d3557c9230",
"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": "c69dd10a-fb23-4c31-a4ad-dcd7a7ac4ceb",
"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-05-02T21:04:25.0696085+00:00"
},
"work_instruction_details_id": "483bc115-c423-4ac1-9148-c397e04e05aa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "21dcb9dd-9df3-40ae-81bc-484ceef5b126",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "457d2a00-d53a-4d56-a787-a16c6260da94",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-02T21:04:25.0696085+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": "8183033b-2b82-4d32-8ac4-084ac17d93ba",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-02T21:04:25.0852279+00:00"
}