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": "b35e417c-44d0-45c5-b483-03acf3bf19ae",
"jobs_id": "3e886712-69f3-441d-ad13-78ed17a8c0f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "047eba95-6d9a-4c9a-876a-66f07af810cc",
"_parent_id": "76c1b623-6cab-47ce-baf2-2890f1d9e124",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "335b27d1-47b8-4351-8119-495e0bccf1bd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "99e6b12c-de96-4c3b-b21d-b5cd2dcd5dae",
"_parent_id": "ac26a86d-026b-484d-87f3-a75c2f6752a8",
"root_parent_id": "c038d515-a035-4c3e-8af3-516866d25de7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4bcf5e79-1b16-45a3-b962-0ff924ee03c7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a93ef7ec-f587-4e17-9bdb-d6385accdad5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c28cb392-60d2-4d27-bce4-ad043483f7a1",
"_parent_code": "sample string 6",
"sales_organization_id": "a84b8276-bc4b-4d33-8399-2b92a4b28a41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+00:00"
},
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00"
},
"equipment_model_id": "7e35f56f-5b55-473e-ae30-72a3016f76ae",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "01614264-4a75-4139-8d07-8548a64334c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "024df1dd-f3c1-482d-b64e-6e3c30e43200",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9d1736d0-d583-47b9-a7a1-65e7bf14b1ca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "79ff527c-7978-4acf-8e91-188c4f781a5d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+00:00"
},
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00"
},
"equipment_family_id": "ea838f91-3d7e-4e7a-96b4-7c76da3699eb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a93ef7ec-f587-4e17-9bdb-d6385accdad5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c28cb392-60d2-4d27-bce4-ad043483f7a1",
"_parent_code": "sample string 6",
"sales_organization_id": "a84b8276-bc4b-4d33-8399-2b92a4b28a41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+00:00"
},
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00"
},
"date_in_production_since": "2026-08-30T15:02:03.8138966+00:00",
"date_out_of_production_since": "2026-08-30T15:02:03.8138966+00:00",
"date_end_support": "2026-08-30T15:02:03.8138966+00:00",
"sales_organization_id": "b64e15c6-95b7-4d05-99ae-086a82fcf6df",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+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-08-30T15:02:03.8138966+00:00"
},
"project_status_id": "abee92dc-662c-44d4-89a5-f5eb436de965",
"project_status_code": "sample string 10",
"project_status": {
"id": "1b15c432-3c5b-4df0-b284-6a57d5d06ec8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8831fc35-4a09-48c5-8e08-9ace92e5f916",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00"
},
"company_id": "a226a6a8-27de-4ac6-992b-d07622e82078",
"company_code": "sample string 12",
"db_address_id": "9fbfa7d5-e0e2-4413-921b-4042b787e299",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a8ecff2f-59fc-4c54-8d9b-482ebb30d8f8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d39932e4-d940-4401-ba98-8426a249d5bf",
"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-08-30T15:02:03.8138966+00:00",
"date_create": "2026-08-30T15:02:03.8138966+00:00",
"date_update": "2026-08-30T15:02:03.8138966+00:00",
"updated_by_user_id": "e7ed84e2-f5b0-4d65-b300-2405e986d16b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-30T15:02:03.8138966+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-08-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-30T15:02:03.8138966+00:00",
"date_last_job": "2026-08-30T15:02:03.8138966+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-30T15:02:03.8138966+00:00",
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00",
"is_mobile_installation": true
},
"job_type_id": "4f6a491c-892d-4be4-8170-df2c463ab696",
"job_type_code": "sample string 7",
"job_type": {
"id": "0704a1dc-24c0-4d7f-b55b-de866db0371a",
"name": "sample string 2",
"sales_organization_id": "fde0d345-d658-445d-a43a-3d868b25b44f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00",
"code": "sample string 7"
},
"job_priority_id": "8d1b3f99-e9db-4ea7-bd54-6bb61085a2d5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "70c6c8b2-a82f-4d59-9a64-0a325c3ed5cf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "26971cbf-47a9-4d1e-aee4-c08e3205d785",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00"
},
"job_status_id": "e0188d4b-883d-4169-9ee0-b5b2233b2e44",
"job_status_code": "sample string 11",
"db_address_id": "6e557428-4667-4ff5-8af5-0fbe9ec3f2c3",
"contact_id": "e3ce8576-47dc-4f52-8cf8-e96fc6dacb10",
"requested_by_company_id": "3071f980-d9f4-498d-87d5-09f0a31ffcab",
"requested_by_contact_id": "efd32c2c-3754-4e67-869b-b4d40bd7d384",
"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-08-30T15:02:03.8138966+00:00",
"due_date": "2026-08-30T15:02:03.8138966+00:00",
"date_create": "2026-08-30T15:02:03.8138966+00:00",
"date_update": "2026-08-30T15:02:03.8138966+00:00",
"date_closed": "2026-08-30T15:02:03.8138966+00:00",
"suggested_user_id": "976ef447-d6c8-47d1-a59c-3ff6fa656a92",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8ba7f12b-1108-49e8-941b-7e3dfcca2a3d",
"db_language_id": "a1509f8f-b91d-4d6d-ac36-d6fdf2f8f881",
"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-08-30T15:02:03.8138966+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bae1dd18-57b0-4195-a408-f8a499bee032",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "99d025d4-2a7f-4ec3-8379-7374280020e5",
"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": "8e9d45b1-2586-429d-9fb3-94b2f213bacb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d4f6b503-c842-4a34-a158-6d88c47db880"
},
"suggested_date_start": "2026-08-30T15:02:03.8138966+00:00",
"skill_id": "9f7d5409-8984-4225-9bc7-88e6bf8a3d1a",
"skill_code": "sample string 32",
"skill": {
"id": "50bb20f4-de0f-4628-be9d-173d2bfc072f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "82a3539a-cb1f-4f92-88fd-ea0174ef4e65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de0fb388-08fc-4cf8-9a53-0bc86f2154a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4e9c40-a1bb-4b97-b829-ab886ddc3b64",
"db_currency_id": "72a19cc2-7239-4986-bf07-6360022dcd91",
"db_language_id": "c2737880-afdd-47b1-a6ec-50989371b641",
"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-08-30T15:02:03.8138966+00:00"
},
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d6d52d4b-308a-48bd-ac5e-f7a56266b37d",
"date_reported_by_company": "2026-08-30T15:02:03.8138966+00:00",
"id2": 36,
"company_id": "fe00e9ce-a1dd-45c2-ad7b-a766db074d6b",
"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": "08f077d3-3a8d-4355-9dfd-76e6748d5ac0",
"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-08-30T15:02:03.8138966+00:00"
},
"work_instruction_details_id": "ea997e10-fe2f-4aee-9db5-acc1bd4343aa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6dc5d204-c4e9-4573-8fa9-fc30a93ae84d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "593ba414-0bf2-4548-8995-be989b6be04d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-30T15:02:03.8138966+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": "db442c27-ec46-4aee-9c77-b99de86eee2f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-30T15:02:03.8138966+00:00"
}