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": "efbcd18b-7605-475c-9e98-4f8e00203e90",
"jobs_id": "b20a4f40-948e-4607-a37d-ec9391fdc76d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "beafb895-db72-4832-b179-db18d852e522",
"_parent_id": "9b7ff1c0-a938-4290-98e3-759eaf92865c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "893dfa0b-daa3-48f4-9241-3f5201df87e5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bd716958-770f-4cdf-8a65-82cf531f29e3",
"_parent_id": "bdbe3a7f-6aac-4352-92dc-61a905b22c6b",
"root_parent_id": "9ad7c44a-8022-45cc-963f-cb7da8057f74",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4e81139a-ff0f-40cb-b220-fa5e991c9c2d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cd6fc6cd-2261-44f8-b53e-5f4f9a66e60d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bbc55a7b-f486-433b-80d3-4023c8ab2fcd",
"_parent_code": "sample string 6",
"sales_organization_id": "fbe59e0a-973b-47f3-b32e-08e5fc23d05a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+00:00"
},
"modified_dateutc": "2026-05-08T06:20:15.9346186+00:00"
},
"equipment_model_id": "fdaf2748-4fe6-4f31-8904-eb2e2516adfa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8391ddda-994b-4419-a709-963eb04aba9a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4d3b22cf-ebb5-4fda-9323-d5042058ad01",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8454ca39-17c3-48b7-ab91-88620382360e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b55362d8-5d26-464a-8065-b8fb0db9d749",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+00:00"
},
"modified_dateutc": "2026-05-08T06:20:15.9346186+00:00"
},
"equipment_family_id": "3f4b8e08-a1cb-4cb6-ac40-9c7915593c5b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cd6fc6cd-2261-44f8-b53e-5f4f9a66e60d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bbc55a7b-f486-433b-80d3-4023c8ab2fcd",
"_parent_code": "sample string 6",
"sales_organization_id": "fbe59e0a-973b-47f3-b32e-08e5fc23d05a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+00:00"
},
"modified_dateutc": "2026-05-08T06:20:15.9346186+00:00"
},
"date_in_production_since": "2026-05-08T06:20:15.9346186+00:00",
"date_out_of_production_since": "2026-05-08T06:20:15.9346186+00:00",
"date_end_support": "2026-05-08T06:20:15.9346186+00:00",
"sales_organization_id": "d8d727fe-3f67-42ee-bfbb-ce9b8be4d803",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+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-08T06:20:15.9502417+00:00"
},
"project_status_id": "2ded1e60-1b6e-4a00-8459-3416b57ffb86",
"project_status_code": "sample string 10",
"project_status": {
"id": "ec18338f-a7bb-427c-9954-fa083ea3751c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "49668702-5fa3-47d6-bab5-ab2339306a3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-08T06:20:15.9502417+00:00"
},
"company_id": "2990319c-a983-4867-9fa8-5495aeb07017",
"company_code": "sample string 12",
"db_address_id": "dfd97bba-64a7-4654-8b33-2aa2a227252a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5c6b5d07-4b30-4a17-93a4-a144275a2ef1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "049c7059-9742-4b7c-908d-96c60be7a49a",
"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-08T06:20:15.9502417+00:00",
"date_create": "2026-05-08T06:20:15.9502417+00:00",
"date_update": "2026-05-08T06:20:15.9502417+00:00",
"updated_by_user_id": "dddb7ec5-ad9c-4ce3-9bee-1c6e73b9caa3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-08T06:20:15.9502417+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-08T06:20:15.9502417+00:00",
"date_last_job": "2026-05-08T06:20:15.9502417+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-08T06:20:15.9502417+00:00",
"modified_dateutc": "2026-05-08T06:20:15.9502417+00:00",
"is_mobile_installation": true
},
"job_type_id": "7bebe919-3bea-494e-9666-ab19826700be",
"job_type_code": "sample string 7",
"job_type": {
"id": "2e2d4cf3-3c73-4582-891a-d1715343f0a1",
"name": "sample string 2",
"sales_organization_id": "9d4ecad1-eaf2-4ab0-876a-a1e56f340351",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-08T06:20:15.9502417+00:00",
"code": "sample string 7"
},
"job_priority_id": "7ee6c33a-ed92-4b75-8ae0-434aabde2138",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4d8372f2-fd56-42a8-859f-77c085c2e285",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "31d83dc0-0c54-4e86-9724-0bd0ffb3edba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-08T06:20:15.9502417+00:00"
},
"job_status_id": "c9d49901-993c-4cdf-a236-d3830c235b8d",
"job_status_code": "sample string 11",
"db_address_id": "8bc9df47-76b5-44fb-98cc-40d8b39483d9",
"contact_id": "9046ec4f-7988-4084-9aee-97278b8eb769",
"requested_by_company_id": "d2e356f2-7746-4402-a5ce-081046663af3",
"requested_by_contact_id": "611020a8-0f87-43ea-b725-87478cd2901e",
"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-08T06:20:15.9502417+00:00",
"due_date": "2026-05-08T06:20:15.9502417+00:00",
"date_create": "2026-05-08T06:20:15.9502417+00:00",
"date_update": "2026-05-08T06:20:15.9502417+00:00",
"date_closed": "2026-05-08T06:20:15.9502417+00:00",
"suggested_user_id": "fe28d83f-c2d0-4fdc-b5df-e97946e302e3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "02fc5b63-983e-4b1f-87df-fc8cd826ed95",
"db_language_id": "7800bde9-b94b-459a-9f7b-1e2506430369",
"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-08T06:20:15.9502417+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1f2c1b7a-7222-4dfc-8ce6-e145b94645a9",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c71e9c10-3a42-44b4-bbc0-19b1628e22c0",
"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": "62a8d4bb-90c4-4e04-b93a-6f8629ddddc8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-08T06:20:15.9502417+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "15ead5a7-9a58-42e8-8493-7c725474a722"
},
"suggested_date_start": "2026-05-08T06:20:15.9502417+00:00",
"skill_id": "8afdc1ee-a886-4b83-9f28-e0d040f200e2",
"skill_code": "sample string 32",
"skill": {
"id": "c4e4ada0-b33c-484f-8802-e09b1635834d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b717400f-f065-46d0-ab64-739995364b00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03bfa81b-571d-45e9-9fa3-d3ab47a35a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e5b58ce-ee33-4c1a-b401-298d32f28302",
"db_currency_id": "ed52b886-7d8b-49e1-868f-e1fe4634e462",
"db_language_id": "32bc22a0-6708-4202-b997-232d03f8c5bb",
"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-08T06:20:15.9346186+00:00"
},
"modified_dateutc": "2026-05-08T06:20:15.9502417+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "303d1213-1eba-48d7-b83d-d4b3003f2f31",
"date_reported_by_company": "2026-05-08T06:20:15.9502417+00:00",
"id2": 36,
"company_id": "2e14e754-4e9d-46d2-9839-0b3a5c61d517",
"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": "b5dda833-05a5-44de-8c2e-423cc8b9dab9",
"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-08T06:20:15.9502417+00:00"
},
"work_instruction_details_id": "1bc5aaa9-d8cf-45b9-a1fc-06ce51b238e8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "96000683-b0d8-4890-9f98-bc6494a87256",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5a27affe-8493-4bb4-ae28-7fea289e661e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-08T06:20:15.9502417+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": "1c7fe8dd-1566-456a-aed8-84d5e94b4bd1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-08T06:20:15.9502417+00:00"
}