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": "5e03de7b-4759-4245-aa9b-f9e8f11552a5",
"jobs_id": "f4555923-e472-4b67-bdef-f8c566165c86",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aee337ac-36bd-4b2b-aa97-b5a6f71566eb",
"_parent_id": "7275d0f4-4cd3-46c5-a5d5-f7cc35288505",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ef71e07c-70a2-4294-b17c-0d222e8dc4fb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "04eccfcc-2e87-4570-b37c-591f0c828d22",
"_parent_id": "f003fad1-ef91-446e-bd9d-9904ddd70024",
"root_parent_id": "d219b99e-0161-4ca4-9520-9b7d2bd12a0c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "09607563-02bb-4452-84f3-11fd52f7fbdc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "672d3dd0-d192-4ecf-8a29-16108fd943d5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3917f3b-7cb6-4d47-a67c-f95ba6ed0b47",
"_parent_code": "sample string 6",
"sales_organization_id": "7fa8b1dc-db86-441a-8b80-93be85b2f5e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+00:00"
},
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00"
},
"equipment_model_id": "20ba74c3-15a8-4d27-8413-2430b61339ef",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7adea151-2208-42d4-9f4c-65e17db9c8b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f1bbc2a9-fbce-4733-9d50-c54618cd8b3f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5f249fdd-50c9-4b04-a99d-274dea973197",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fafe2490-abf3-492f-9454-0548c2ab287d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+00:00"
},
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00"
},
"equipment_family_id": "f8213fd5-36c2-4aee-ad9b-353a0b041893",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "672d3dd0-d192-4ecf-8a29-16108fd943d5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3917f3b-7cb6-4d47-a67c-f95ba6ed0b47",
"_parent_code": "sample string 6",
"sales_organization_id": "7fa8b1dc-db86-441a-8b80-93be85b2f5e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+00:00"
},
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00"
},
"date_in_production_since": "2025-12-15T15:44:28.1606069+00:00",
"date_out_of_production_since": "2025-12-15T15:44:28.1606069+00:00",
"date_end_support": "2025-12-15T15:44:28.1606069+00:00",
"sales_organization_id": "3a6b4b45-8728-45b2-b762-64be1ecd027c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+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-12-15T15:44:28.1606069+00:00"
},
"project_status_id": "5cf331af-bd84-4da5-8a6e-8386f917f9f8",
"project_status_code": "sample string 10",
"project_status": {
"id": "a84a8539-a7cb-4f09-84f9-5fb13768f47c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c6a82fcd-ec03-42b2-981a-37a6a28517e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00"
},
"company_id": "9ff0769f-d684-4525-b618-e0fc462d8c42",
"company_code": "sample string 12",
"db_address_id": "2c07b34b-e1d7-4d12-87dc-5f13a737c2ea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d9c58029-3b18-4e12-9d4f-c689b7f14b99",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8a33baab-8b9c-4124-a73b-a03c1e0f3134",
"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-12-15T15:44:28.1606069+00:00",
"date_create": "2025-12-15T15:44:28.1606069+00:00",
"date_update": "2025-12-15T15:44:28.1606069+00:00",
"updated_by_user_id": "7224b3f3-2a52-49f5-9f4e-09a3642dd9df",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-15T15:44:28.1606069+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-12-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-15T15:44:28.1606069+00:00",
"date_last_job": "2025-12-15T15:44:28.1606069+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-15T15:44:28.1606069+00:00",
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00",
"is_mobile_installation": true
},
"job_type_id": "e6737174-670a-4d26-94b9-d9fb39c75a10",
"job_type_code": "sample string 7",
"job_type": {
"id": "ee3916a5-a285-4f2e-8988-a58b768d3531",
"name": "sample string 2",
"sales_organization_id": "35761a40-fa8a-4bad-8d2f-b331c3404284",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00",
"code": "sample string 7"
},
"job_priority_id": "0bedb2ea-4d2b-4c3a-8c23-db6ab22a8807",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ad4c815f-e5a3-4dfa-9cfa-477134140b15",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ddc494bf-cc28-45ea-ad77-5e6a51c70442",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00"
},
"job_status_id": "e69ed7c1-95d3-4e0b-bdc8-eed29d515b57",
"job_status_code": "sample string 11",
"db_address_id": "f0da23b3-87bc-4a73-8548-904c8d9ebf37",
"contact_id": "e9fb0d34-8660-43a5-9db6-53337b0eaaea",
"requested_by_company_id": "394720b7-9bc6-4649-ac19-a102b2b98012",
"requested_by_contact_id": "886cc457-10c8-440c-807b-75c4c4f54c4d",
"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-12-15T15:44:28.1606069+00:00",
"due_date": "2025-12-15T15:44:28.1606069+00:00",
"date_create": "2025-12-15T15:44:28.1606069+00:00",
"date_update": "2025-12-15T15:44:28.1606069+00:00",
"date_closed": "2025-12-15T15:44:28.1606069+00:00",
"suggested_user_id": "36c59136-8ac0-45c9-aded-9d019f2eb81a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1b511c78-a500-4f6e-aa9f-4d6995374ea4",
"db_language_id": "9deb4fba-bdb7-4f52-b91d-bbde6c1ed71d",
"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-12-15T15:44:28.1606069+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8c1c0a6e-e887-41b3-8dea-4ceeef1fb4ec",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "24b09d64-1915-4a6c-a83f-d850b7a1b439",
"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": "26b11927-28e8-418c-8924-ba6b3a871d9b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c73f7453-8c70-4627-834b-fb878eeef13b"
},
"suggested_date_start": "2025-12-15T15:44:28.1606069+00:00",
"skill_id": "841a4f53-43ea-402c-992c-a100241c11e6",
"skill_code": "sample string 32",
"skill": {
"id": "91160ddf-188c-4203-b850-4548b9c5cee5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a17e75ba-22b9-47eb-a8c1-c43b694d1eb9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae5dd735-3a4e-4732-8d7a-5042184d4f24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0c8d97b-5164-4976-ab2b-e467a23fdac6",
"db_currency_id": "4e8cdc59-c8db-4840-b484-c2095f947c87",
"db_language_id": "5cf96d9d-c5f1-4494-9d27-556ed3fc664a",
"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-12-15T15:44:28.1606069+00:00"
},
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d26cd720-baf1-4a94-abe1-aaa51b0b339d",
"date_reported_by_company": "2025-12-15T15:44:28.1606069+00:00",
"id2": 36,
"company_id": "e681bedc-6074-484d-b725-7048a7270550",
"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": "6f7adaf8-6cf6-4ed9-88bc-ea4a31a01d69",
"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-12-15T15:44:28.1606069+00:00"
},
"work_instruction_details_id": "709b3f3a-84df-46d7-a47b-42bb6ab8b8fc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "325307ee-ff58-4138-b393-7bf18d46f131",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "30420aba-97df-4e51-abea-c6e4320b457b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-15T15:44:28.1606069+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": "258d22ed-cc42-46b1-9553-5a71bbca1d52",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-15T15:44:28.1606069+00:00"
}