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": "99f7785f-2f02-4904-822c-5108a3534450",
"jobs_id": "acf33d2a-f88c-487d-832a-ad780c07ef0b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5ce9c300-09a9-423e-b300-ee1685fed349",
"_parent_id": "0f758a9a-a311-457e-abd0-5e2e2689756a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "61b39390-4400-4c64-9d59-11626d4335c8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dcb639a4-6006-47aa-a08e-bba670fd39fd",
"_parent_id": "d83cebba-a1d4-4702-a66c-2c7dcf44c8e4",
"root_parent_id": "80154c2c-9b5f-4773-ba18-1910735804b5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0386282d-dfd3-4cf1-b405-2a5b0a5d9688",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab597df6-5571-440c-983f-0b29249c6861",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e8dcf397-697b-4f70-9286-19de1a294521",
"_parent_code": "sample string 6",
"sales_organization_id": "fcffd28e-67ea-4abd-bfd3-8bb5f293a437",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+00:00"
},
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00"
},
"equipment_model_id": "9035ad5f-8f44-4e1d-ab4d-2aa1638270d5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "25598f9a-dd2e-4576-b530-d2024b6cf5ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2c1110a2-db91-40ea-b073-101dc31d69d3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3a6b686d-acdf-4e3c-b761-deb1ff5bf8ce",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "97630f47-c491-41b4-88cf-fce1824cfb95",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+00:00"
},
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00"
},
"equipment_family_id": "61e77ec6-de0c-491e-bf32-fb629f2c9176",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab597df6-5571-440c-983f-0b29249c6861",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e8dcf397-697b-4f70-9286-19de1a294521",
"_parent_code": "sample string 6",
"sales_organization_id": "fcffd28e-67ea-4abd-bfd3-8bb5f293a437",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+00:00"
},
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00"
},
"date_in_production_since": "2026-08-18T13:15:41.0285887+00:00",
"date_out_of_production_since": "2026-08-18T13:15:41.0285887+00:00",
"date_end_support": "2026-08-18T13:15:41.0285887+00:00",
"sales_organization_id": "b2be10e8-d7e1-46c1-957a-dee9b2e7b2a4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+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-18T13:15:41.0285887+00:00"
},
"project_status_id": "a009f442-9621-427b-ba24-e3d3adf4a948",
"project_status_code": "sample string 10",
"project_status": {
"id": "e55fe9a7-f632-479c-8103-8a8fdb5e2c7a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dc33e779-d207-40d4-8d71-c36919482d9b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00"
},
"company_id": "2c2e0527-c49e-48b2-bfd5-95107c950f93",
"company_code": "sample string 12",
"db_address_id": "0d115b6c-5b1e-458e-be31-c482d788149a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5f34d4ce-8282-4b14-b584-13ab11371099",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3512d921-432d-4c34-b3dd-5ed9356fba49",
"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-18T13:15:41.0285887+00:00",
"date_create": "2026-08-18T13:15:41.0285887+00:00",
"date_update": "2026-08-18T13:15:41.0285887+00:00",
"updated_by_user_id": "f3b442a5-af08-4591-bab3-936a6de38d7e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-18T13:15:41.0285887+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-18T13:15:41.0285887+00:00",
"date_last_job": "2026-08-18T13:15:41.0285887+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-18T13:15:41.0285887+00:00",
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00",
"is_mobile_installation": true
},
"job_type_id": "11fc6434-0fb5-40c4-9437-97d07f8979ba",
"job_type_code": "sample string 7",
"job_type": {
"id": "b4ec428a-d93c-43f0-8a0f-854451311666",
"name": "sample string 2",
"sales_organization_id": "74834208-39e4-44ad-bb73-585520daf4d5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00",
"code": "sample string 7"
},
"job_priority_id": "aacf5465-4d90-495c-aa1f-9f64cafd53a3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cc0de033-fbb0-411b-a78a-8e1a5098d832",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6935c49d-6704-4dc3-b29c-795faa2e164d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00"
},
"job_status_id": "76152539-6189-4ec1-9b3f-f236cddc46e9",
"job_status_code": "sample string 11",
"db_address_id": "9385214b-51bd-46cc-bf02-10390e2266fe",
"contact_id": "b8122e53-0ad2-4f42-a7f9-0ce727779613",
"requested_by_company_id": "38419f72-4d04-4f80-9e7f-fd01f9cb2305",
"requested_by_contact_id": "adef8534-e6d9-418e-ab6b-daabf73b17d4",
"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-18T13:15:41.0285887+00:00",
"due_date": "2026-08-18T13:15:41.0285887+00:00",
"date_create": "2026-08-18T13:15:41.0285887+00:00",
"date_update": "2026-08-18T13:15:41.0285887+00:00",
"date_closed": "2026-08-18T13:15:41.0285887+00:00",
"suggested_user_id": "d313aa96-91fe-49e4-b2e8-495435c4a769",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e8631116-4962-4b76-99e3-dda7649a150f",
"db_language_id": "b063ec96-efd9-4085-a3ae-57531842b61c",
"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-18T13:15:41.0285887+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "50361852-1adc-4f26-85bf-54859c762b06",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a6a7276-c597-40bd-9b52-a0674a9abc93",
"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": "2c10ee72-5f70-4e53-8ae6-9039b11fb853",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bd0809c3-79de-42f5-9c5c-a6ac7c24a85d"
},
"suggested_date_start": "2026-08-18T13:15:41.0285887+00:00",
"skill_id": "b717b899-ff35-4ad9-9ce7-55309675d9be",
"skill_code": "sample string 32",
"skill": {
"id": "166c9484-017d-4f5e-bfcd-669380db4f71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "95832021-79ab-4569-b3ca-3fc593fd548f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d2fd366-2643-45d6-81af-8910600632b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a35047ad-9330-4872-b71d-dd73e33b9688",
"db_currency_id": "b2964f12-0914-457d-940a-63d8d30dfbf2",
"db_language_id": "69e8358f-470a-4297-800a-339284b7c1b7",
"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-18T13:15:41.0285887+00:00"
},
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f5ff78fa-b775-45bf-b157-3a5d578e60bb",
"date_reported_by_company": "2026-08-18T13:15:41.0285887+00:00",
"id2": 36,
"company_id": "0f904456-b226-4533-9139-8c885cc062a4",
"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": "6750d173-2b25-4246-b2d0-e1a112c40d18",
"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-18T13:15:41.0285887+00:00"
},
"work_instruction_details_id": "dcf54e11-eb53-4657-b13f-5f84c00ef65a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a73fec28-0785-44f6-9827-ad0dcf4355ca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3297cb7e-3dcd-4727-988f-1376b26effb2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-18T13:15:41.0285887+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": "26050180-9750-4e79-b410-41f978bbde3f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-18T13:15:41.0285887+00:00"
}