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": "d92cb4bd-9d83-45ef-a45e-9ec6d0d1c8c0",
"jobs_id": "abb23503-ab60-4cea-a904-a5ded81b1966",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "58bf0142-edd4-47ec-9259-836a2aed091e",
"_parent_id": "54152f35-6b48-4e8e-b6ba-5e80a3c878fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c0fde967-b201-40b1-ae19-8eb14a96d892",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e5c590d6-fc1b-4d8b-94e3-4f5f372edbe0",
"_parent_id": "a4341fa7-29a9-4622-956c-1cf77fc49ef4",
"root_parent_id": "7d100f82-4684-4a50-8088-545130050702",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a936b41e-1a76-4ef3-bd7a-f11a17b37399",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "52483fe8-6e4d-41d7-aa7c-30a42f9c270b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b0385fa-9e94-4167-a13f-5460e98ae9d7",
"_parent_code": "sample string 6",
"sales_organization_id": "378bf762-e0f5-40fb-934a-9ebe63911e39",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+00:00"
},
"modified_dateutc": "2025-06-26T11:25:41.0225115+00:00"
},
"equipment_model_id": "261d2e3a-c53b-4f1e-9f53-ab9365edacda",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "168d7d31-cef7-45fb-94fe-3608f939df16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "164db897-9151-4e8b-8015-dff174ae3948",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "94d575d5-5eda-4a0e-b8b2-bb9ce245c3e8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cef1b027-6dc2-4db0-8187-2f3a4557cd03",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+00:00"
},
"modified_dateutc": "2025-06-26T11:25:41.0225115+00:00"
},
"equipment_family_id": "bf1df444-e800-4684-ba3f-fe3fe82865c4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "52483fe8-6e4d-41d7-aa7c-30a42f9c270b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b0385fa-9e94-4167-a13f-5460e98ae9d7",
"_parent_code": "sample string 6",
"sales_organization_id": "378bf762-e0f5-40fb-934a-9ebe63911e39",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+00:00"
},
"modified_dateutc": "2025-06-26T11:25:41.0225115+00:00"
},
"date_in_production_since": "2025-06-26T11:25:41.0225115+00:00",
"date_out_of_production_since": "2025-06-26T11:25:41.0225115+00:00",
"date_end_support": "2025-06-26T11:25:41.0225115+00:00",
"sales_organization_id": "8194007f-3437-4587-94f1-05563df0f2d9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+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-06-26T11:25:41.0225115+00:00"
},
"project_status_id": "c2d47292-d3f9-49c0-98d9-0aa3eb4b7f13",
"project_status_code": "sample string 10",
"project_status": {
"id": "b9951770-d089-4eb3-a75e-f2fac0a57d81",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c2dea631-aef2-4e6f-9660-af107456ef78",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-26T11:25:41.038161+00:00"
},
"company_id": "fc421ff3-7221-42ef-841c-37c7ecfd91f8",
"company_code": "sample string 12",
"db_address_id": "3149af26-24c0-44e2-b1b1-ffcaacf8d0ad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b9563aef-e44a-4fd9-b34b-acf9abf842bd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0af738df-bfe6-435a-bb6e-b84cf343b87d",
"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-06-26T11:25:41.038161+00:00",
"date_create": "2025-06-26T11:25:41.038161+00:00",
"date_update": "2025-06-26T11:25:41.038161+00:00",
"updated_by_user_id": "83696094-24d2-40b7-a558-4158a26d199a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-26T11:25:41.038161+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-06-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-26T11:25:41.038161+00:00",
"date_last_job": "2025-06-26T11:25:41.038161+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-26T11:25:41.038161+00:00",
"modified_dateutc": "2025-06-26T11:25:41.038161+00:00",
"is_mobile_installation": true
},
"job_type_id": "3bee777b-0efc-49ee-add2-f952bc46cd7c",
"job_type_code": "sample string 7",
"job_type": {
"id": "8790d3d5-d84e-4a2d-9eef-efdd0b55a53f",
"name": "sample string 2",
"sales_organization_id": "a925024e-0fb7-4f3c-803b-aee31c16d1af",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-26T11:25:41.038161+00:00",
"code": "sample string 7"
},
"job_priority_id": "03897ff6-8519-4eac-857f-04f75baa8e77",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "59e28d78-be41-4f60-ae9c-9f4a7ff5f3f0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5059e061-6ce3-49e9-9167-914408d70764",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-26T11:25:41.038161+00:00"
},
"job_status_id": "552d2efc-2e0c-48c2-aa0f-042fccf962be",
"job_status_code": "sample string 11",
"db_address_id": "d50ddf54-0ccc-4c4d-a1cd-fc2a359f22ae",
"contact_id": "0022c945-0e00-4bef-9b34-e7d0e6ea355d",
"requested_by_company_id": "33c61467-17ca-4a53-a179-c12f1cb31b5d",
"requested_by_contact_id": "dfb6c9d9-7b16-4fad-9a5a-ca653177adbd",
"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-06-26T11:25:41.038161+00:00",
"due_date": "2025-06-26T11:25:41.038161+00:00",
"date_create": "2025-06-26T11:25:41.038161+00:00",
"date_update": "2025-06-26T11:25:41.038161+00:00",
"date_closed": "2025-06-26T11:25:41.038161+00:00",
"suggested_user_id": "d30788df-7537-4534-876b-de3b1857da1a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8d0341dd-92fb-4b16-884f-f0b4db1cbb24",
"db_language_id": "76d1c449-b988-47a4-ad6e-f0fb294cc5e3",
"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-06-26T11:25:41.038161+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "776e0a42-7e3f-4f16-842a-2c9d1da6fac1",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "453d0a77-0de1-4b77-8950-1aaae679103a",
"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": "cd4b2459-31be-4b90-808e-774db1545672",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-26T11:25:41.038161+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1fc94acc-58c3-446d-b3d4-7c041847496f"
},
"suggested_date_start": "2025-06-26T11:25:41.038161+00:00",
"skill_id": "620afdf8-df87-4ca7-9df7-4107d7e7f63b",
"skill_code": "sample string 32",
"skill": {
"id": "12f428e1-ad85-4682-9f06-f7f93d3e67f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b60d287e-8fc3-4f9a-b9a5-b1826bc8c359",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c82765a9-8358-46f1-94aa-11a4f4489de2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "02622faa-557c-4db2-a364-334c80193672",
"db_currency_id": "82e9052a-f55e-4904-bbc4-ded27e7edfe8",
"db_language_id": "67108f68-9808-4bc2-a1a1-ba89cee70f10",
"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-06-26T11:25:41.0225115+00:00"
},
"modified_dateutc": "2025-06-26T11:25:41.038161+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7357a0dd-1801-435d-92dd-e8bc87b459d9",
"date_reported_by_company": "2025-06-26T11:25:41.038161+00:00",
"id2": 36,
"company_id": "c126018d-bf8f-4382-8910-7317d4708ed8",
"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": "7361d39d-b1d2-4a45-99a3-0c3de6948744",
"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-06-26T11:25:41.038161+00:00"
},
"work_instruction_details_id": "3aad3ee3-118b-414d-a0b4-c6ee88e221ac",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "167ba3aa-b8a1-46a2-8d4d-e5edfe2023af",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dfcf758b-624d-4a6c-8293-25714bc2bfe1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-26T11:25:41.038161+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": "54d17648-96f1-423d-81ca-ed6354294ce2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-26T11:25:41.038161+00:00"
}