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": "202691c2-fa2d-46fa-a989-45d33a6ba962",
"jobs_id": "03704487-5c70-4d79-a009-932b070e1351",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bd6969ed-3853-4fce-ad1c-9fbb4bb5bc41",
"_parent_id": "6b343f5b-66bd-4865-9c36-98dbeaac1479",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f5e8cf15-9811-4822-b59b-dcd9ff59094c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bcb3ef6f-36d8-4feb-ade5-18d79a70b34a",
"_parent_id": "170e185e-f33f-4f5e-bcd3-8b73c62f29b6",
"root_parent_id": "2e1764f0-8a60-4884-a70e-ed4897b11dde",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9a624158-a701-4003-9993-97998b8af68a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5424870b-d2c0-4d30-bb87-a6b03a808011",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8f8acdd4-eb1b-4887-bf45-c5b4a2df90a6",
"_parent_code": "sample string 6",
"sales_organization_id": "4d50c4ea-0087-494d-ad5b-46c5cc397305",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+00:00"
},
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00"
},
"equipment_model_id": "62b7f14f-a153-46f5-9f0c-6f4312688f7a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f0acb667-81a8-4d6d-94fa-f11e8e069ff7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "676b47dd-c98d-41e3-9a01-06ea0e89a87b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "01aab203-4488-424d-b87e-9afc9fc72f2a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bad2e394-d263-45cd-8c9f-43355d7ee59f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+00:00"
},
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00"
},
"equipment_family_id": "189b26d3-0488-4eb9-a0d1-5770674fc3db",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5424870b-d2c0-4d30-bb87-a6b03a808011",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8f8acdd4-eb1b-4887-bf45-c5b4a2df90a6",
"_parent_code": "sample string 6",
"sales_organization_id": "4d50c4ea-0087-494d-ad5b-46c5cc397305",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+00:00"
},
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00"
},
"date_in_production_since": "2026-06-18T08:15:24.498068+00:00",
"date_out_of_production_since": "2026-06-18T08:15:24.498068+00:00",
"date_end_support": "2026-06-18T08:15:24.498068+00:00",
"sales_organization_id": "2e9c027d-3f00-4ab2-bf5f-acce7ab4c6e5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+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-06-18T08:15:24.498068+00:00"
},
"project_status_id": "adad2955-7f8b-4ed5-808a-cf2d75e2e5fa",
"project_status_code": "sample string 10",
"project_status": {
"id": "0d6a2165-76e6-49bb-b5f3-c647b5ed97d9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ca15b134-43ba-453c-9b3e-d0122b523fd9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00"
},
"company_id": "101616f3-2094-4328-959a-63cf1d6406a1",
"company_code": "sample string 12",
"db_address_id": "2aa4865f-6990-43a2-8865-bf9ba3c86463",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "604019e4-7dc7-45b4-8af6-32aad3b51e41",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dc0f717a-d5d1-4384-bd1b-2c8d80bbd60a",
"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-06-18T08:15:24.498068+00:00",
"date_create": "2026-06-18T08:15:24.498068+00:00",
"date_update": "2026-06-18T08:15:24.498068+00:00",
"updated_by_user_id": "2936fe72-318d-4d93-ae8d-4f7a26f46f9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-18T08:15:24.498068+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-06-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-18T08:15:24.498068+00:00",
"date_last_job": "2026-06-18T08:15:24.498068+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-18T08:15:24.498068+00:00",
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00",
"is_mobile_installation": true
},
"job_type_id": "08a87104-6c23-4d46-9363-438984052f65",
"job_type_code": "sample string 7",
"job_type": {
"id": "39e2ff9b-344b-465a-bfc4-b3b5c4ccdf59",
"name": "sample string 2",
"sales_organization_id": "37efdcb2-12d1-4252-8441-c531e8f0fb1f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00",
"code": "sample string 7"
},
"job_priority_id": "b9bb161a-2944-4874-815d-71acbbba3034",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d97b3f15-5ca0-46ea-b9b7-1eaa38266c2a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9e61f7d6-d8a9-426f-b563-dd2ac4636610",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00"
},
"job_status_id": "b42aa202-b7af-4500-8474-b0218af36fe9",
"job_status_code": "sample string 11",
"db_address_id": "c54176c7-6f14-4ca2-a33f-a5986e370585",
"contact_id": "6621d760-b366-4e77-9e3d-869d8d45b464",
"requested_by_company_id": "affb12c4-ecd0-4c45-ad56-bc977b99ff41",
"requested_by_contact_id": "9637751a-6c04-4ce9-9f47-21e75c1b4c17",
"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-06-18T08:15:24.498068+00:00",
"due_date": "2026-06-18T08:15:24.498068+00:00",
"date_create": "2026-06-18T08:15:24.498068+00:00",
"date_update": "2026-06-18T08:15:24.498068+00:00",
"date_closed": "2026-06-18T08:15:24.498068+00:00",
"suggested_user_id": "2b21d8a0-ea66-45bb-bf64-9e752151ac9a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "17e84e2b-c302-4efe-8b36-046e17a50149",
"db_language_id": "ac9a6142-6f7b-483f-9e4a-65a991753975",
"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-06-18T08:15:24.498068+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b25997dd-fb14-49e2-b2d7-3037e6c396f2",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c32bf06f-ecb5-4619-8063-d563e1d25659",
"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": "e2cd9591-5a55-4435-aaca-c726c97c4c9a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "97a42416-7367-4708-b827-e61dc7e2b593"
},
"suggested_date_start": "2026-06-18T08:15:24.498068+00:00",
"skill_id": "b1f66aca-9009-4d39-b58a-6c0ba97ad748",
"skill_code": "sample string 32",
"skill": {
"id": "4199d085-8045-47cb-b488-d5f771d64858",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f7470586-08ea-480e-b246-bf3cf94f8d84",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe4b7929-075c-49cb-851e-a84000b70d0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213ec31c-ce50-4b82-bf5b-4e7bb1318a95",
"db_currency_id": "9ba6f3be-48ca-4430-be82-9fb487eafba7",
"db_language_id": "1dcdc85f-7921-402d-a184-36bdc22354b5",
"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-06-18T08:15:24.498068+00:00"
},
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c8c08d1a-5859-421b-86fc-014e3bab4799",
"date_reported_by_company": "2026-06-18T08:15:24.498068+00:00",
"id2": 36,
"company_id": "a94e667c-30fa-4235-8887-87caa8e9b2d3",
"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": "4b122ad9-7e9a-4586-8188-837500326413",
"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-06-18T08:15:24.498068+00:00"
},
"work_instruction_details_id": "104359f1-372c-4c5d-ae77-004cfc06e631",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7e58b58c-bbf6-4105-983b-373a2187319d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7f50028a-35d9-4dac-bfbb-e781e19661ae",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-18T08:15:24.498068+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": "715ff796-3735-4f9b-9961-28944e35ea5a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-18T08:15:24.498068+00:00"
}