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": "672fd5bb-5f46-4706-85b2-388d0a8a3f77",
"jobs_id": "c298b7e5-893b-4620-9c49-34857ea394b2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ee6e59a9-a78f-46df-a74d-bc8b84fdbf44",
"_parent_id": "c991c52a-77c4-4d8c-8178-62dcea373eed",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f95ac98b-1bcb-498b-8c75-8fbc63e9568e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1572a3ab-040c-4ac2-971f-29f55c86ccae",
"_parent_id": "a550e875-5b56-4ce5-8a41-f7e5e3941c01",
"root_parent_id": "85104e2b-1cee-4938-9634-7243c53080d9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4475a7d2-a732-4f92-9f5d-207d8905ab9c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2fbeaf1c-ab82-41e1-b293-ef552c9f7bd4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b270058-6bfa-4a8d-90b7-fe55e28fab53",
"_parent_code": "sample string 6",
"sales_organization_id": "63a4b13d-2a56-47c5-975d-358e6f040968",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+00:00"
},
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00"
},
"equipment_model_id": "af415878-7640-4f4e-8185-4635766ef1fc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "90101005-c3e3-4c21-a9b8-c95d6593d231",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b5acef0e-da3e-450d-bfec-23726ef48753",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f078df0a-efff-4bbb-bed1-f689622f63eb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8a5cbe16-0fd5-4318-abab-071f5da9bade",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+00:00"
},
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00"
},
"equipment_family_id": "2ce2cb3d-95da-46e2-86cc-d9a72de10e1e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2fbeaf1c-ab82-41e1-b293-ef552c9f7bd4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b270058-6bfa-4a8d-90b7-fe55e28fab53",
"_parent_code": "sample string 6",
"sales_organization_id": "63a4b13d-2a56-47c5-975d-358e6f040968",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+00:00"
},
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00"
},
"date_in_production_since": "2025-11-17T12:17:54.0489218+00:00",
"date_out_of_production_since": "2025-11-17T12:17:54.0489218+00:00",
"date_end_support": "2025-11-17T12:17:54.0489218+00:00",
"sales_organization_id": "ec44cf70-87e1-476b-bab4-55a4c7902c0a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+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-17T12:17:54.0489218+00:00"
},
"project_status_id": "8c282a45-bd83-421c-9e1a-fa609d7cf08c",
"project_status_code": "sample string 10",
"project_status": {
"id": "e3b1d73c-d260-426b-b241-52c6a4eeed06",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8687692f-eb7b-479e-8a56-156bbc7a6f28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00"
},
"company_id": "e99a8c9a-cc66-410d-b7b5-829ddceafe90",
"company_code": "sample string 12",
"db_address_id": "a1bb7041-fc06-4ba7-b7d6-cc46339bb389",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fe8d60ca-a6dc-43f3-b802-c51c520a4c68",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d803c375-746c-4fe5-8c74-799c76ab828d",
"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-17T12:17:54.0489218+00:00",
"date_create": "2025-11-17T12:17:54.0489218+00:00",
"date_update": "2025-11-17T12:17:54.0489218+00:00",
"updated_by_user_id": "01327ec8-3690-4259-9c23-70b77769422f",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-17T12:17:54.0489218+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-17T12:17:54.0489218+00:00",
"date_last_job": "2025-11-17T12:17:54.0489218+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-17T12:17:54.0489218+00:00",
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00",
"is_mobile_installation": true
},
"job_type_id": "5a01d4d0-edd9-4b95-88d5-ed114707239c",
"job_type_code": "sample string 7",
"job_type": {
"id": "4f535156-5bbb-44a5-b75e-08e62e545efc",
"name": "sample string 2",
"sales_organization_id": "8fcaf81f-3a85-4f17-a323-63b94750012b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00",
"code": "sample string 7"
},
"job_priority_id": "b9cd2db1-93df-445e-b495-6d4860457f1c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c70f6ad5-96ca-441e-85f8-9b1ef4f66de7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f08c53e6-aa47-497c-9005-2f0db883a1ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00"
},
"job_status_id": "c71436ab-351c-4e54-8e69-7eb90d293f61",
"job_status_code": "sample string 11",
"db_address_id": "75dae6ed-f2c0-4d42-84a1-24510a1f731f",
"contact_id": "2763ae16-a217-422b-b0e0-dba5a6db020e",
"requested_by_company_id": "8a18b615-1360-4bb6-bd0a-c9cf958c9a21",
"requested_by_contact_id": "fc2f923b-9b14-48eb-9167-35199e5c6d88",
"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-17T12:17:54.0489218+00:00",
"due_date": "2025-11-17T12:17:54.0489218+00:00",
"date_create": "2025-11-17T12:17:54.0489218+00:00",
"date_update": "2025-11-17T12:17:54.0489218+00:00",
"date_closed": "2025-11-17T12:17:54.0489218+00:00",
"suggested_user_id": "b177c2c5-bdc3-4a13-9bfc-313f537d4987",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "16d6df11-c041-421c-a463-98e81cb47790",
"db_language_id": "b15f661f-922a-4ec9-8e87-447f454a9f48",
"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-17T12:17:54.0489218+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "61d0cf61-8bc0-4078-8ce0-31e26bc2f7c0",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "510012c0-8847-457a-b297-53558fb4b8c1",
"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": "12ec1e2d-d93d-4ab5-b382-034ddbe2acfa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8944db7c-6cd5-4620-a000-c39a5a70c35c"
},
"suggested_date_start": "2025-11-17T12:17:54.0489218+00:00",
"skill_id": "7f149230-9fec-4e76-861f-9222b4dee8db",
"skill_code": "sample string 32",
"skill": {
"id": "666b1270-2e9d-4241-9871-64ce796ab168",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "391aaf43-9af5-4b21-a485-a020fe86a3ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c1feb6b-3540-4620-b624-b0b9b5a0afae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d962896-4035-4961-8d51-87f91477ee91",
"db_currency_id": "d92aafc6-b79a-46a4-b285-60e8806abd68",
"db_language_id": "e3accb58-534f-4f81-a7dc-0419f6f89c53",
"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-17T12:17:54.0489218+00:00"
},
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7fa8aafb-6df7-457c-93d6-3574db3b4e2a",
"date_reported_by_company": "2025-11-17T12:17:54.0489218+00:00",
"id2": 36,
"company_id": "944bf65a-e503-4205-b614-407b49196d53",
"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": "99b4412e-0653-45a5-82d3-f8185c402c94",
"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-17T12:17:54.0489218+00:00"
},
"work_instruction_details_id": "6671341f-9e5b-474a-9c93-19c84a7a1870",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "29bb4042-d875-406b-a88d-777f3d406923",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f694df52-9ef4-4c1f-b38b-b7b6d8bab4a2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-17T12:17:54.0489218+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": "471ec08a-69ab-4e0b-9c08-e9778d2077fa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-17T12:17:54.0489218+00:00"
}