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": "0a9f7b6a-ba79-44a4-92c1-168277a61e20",
"jobs_id": "6ae3a034-83fc-4cf8-bd9e-5a8c2b238993",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "354af47f-3b6d-49f1-9947-e7cfca70d269",
"_parent_id": "63932454-fe35-41a4-beee-caaa3399839f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d1d63c4d-bffb-4b4d-a3ea-bff994689625",
"project_reference_back_office": "sample string 5",
"project": {
"id": "191efe7b-0d1f-4c3f-af1b-48c391bd8cb5",
"_parent_id": "44c8a3b2-dc9a-4da0-af15-2cd1e727ddf0",
"root_parent_id": "60820a2c-8241-40c1-bd64-6e5cedeae95c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a659983e-6665-44ed-812a-b76affb88e25",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "75be2ac9-e804-4467-91aa-a6333a7126a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cadcaca-e454-4347-810d-1583830acc1f",
"_parent_code": "sample string 6",
"sales_organization_id": "922fad32-0947-47b5-9d28-123c813e1b3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+00:00"
},
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00"
},
"equipment_model_id": "c0394a55-7c9d-4554-9fcc-8132254cb1a1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cc5eaf44-c41f-42c3-9cd8-183cd41662e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f2c73c0c-b234-4c44-a0af-584801b7181a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ce124276-e335-4721-a3a8-4cec5795b4fb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a73a8b79-9273-434e-82fc-afd71aeef385",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+00:00"
},
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00"
},
"equipment_family_id": "7cc7ee3e-326f-4f71-81d1-4650c6407994",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "75be2ac9-e804-4467-91aa-a6333a7126a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cadcaca-e454-4347-810d-1583830acc1f",
"_parent_code": "sample string 6",
"sales_organization_id": "922fad32-0947-47b5-9d28-123c813e1b3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+00:00"
},
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00"
},
"date_in_production_since": "2026-09-11T15:48:14.444366+00:00",
"date_out_of_production_since": "2026-09-11T15:48:14.444366+00:00",
"date_end_support": "2026-09-11T15:48:14.444366+00:00",
"sales_organization_id": "f9a7525c-6762-418c-932b-73d4d77e8a01",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+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-09-11T15:48:14.444366+00:00"
},
"project_status_id": "d772fd9b-6872-4575-a5e2-78d2e7ab7cee",
"project_status_code": "sample string 10",
"project_status": {
"id": "6dca48ec-706b-46f1-af7b-0039643e7d59",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8b3c8609-5768-4301-aae0-621f22887526",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00"
},
"company_id": "394750f0-4d9b-4473-9e95-c2112ed1ab0f",
"company_code": "sample string 12",
"db_address_id": "f93bbd19-4b73-4f6a-9eb2-6eb016c82529",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0c91b44e-941c-44bb-905b-eb97ecc8bbd9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e828fa11-7c21-4d32-adde-d2afc33ba7f5",
"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-09-11T15:48:14.444366+00:00",
"date_create": "2026-09-11T15:48:14.444366+00:00",
"date_update": "2026-09-11T15:48:14.444366+00:00",
"updated_by_user_id": "6307ece9-af8e-4652-b885-03fba2bf588e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T15:48:14.444366+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-09-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T15:48:14.444366+00:00",
"date_last_job": "2026-09-11T15:48:14.444366+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T15:48:14.444366+00:00",
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00",
"is_mobile_installation": true
},
"job_type_id": "25c932db-e688-4376-81b4-500dbeef5b67",
"job_type_code": "sample string 7",
"job_type": {
"id": "3a01857c-f5ec-4bff-a610-414fe3c7e33c",
"name": "sample string 2",
"sales_organization_id": "d20ef104-b044-4a64-a5a1-fa41bafe0ba7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00",
"code": "sample string 7"
},
"job_priority_id": "930941b3-b963-4599-9f51-083364e3335a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6d90ae15-7377-4473-bc46-344ad77b1371",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "13835c26-37d4-4782-ae15-945588258ef5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00"
},
"job_status_id": "5a7bd1a9-9278-46bc-a140-27ddc6e18cd1",
"job_status_code": "sample string 11",
"db_address_id": "bf33704b-cace-459a-a8e9-77027fb5ab50",
"contact_id": "f7b6bf62-a5ee-4f89-9d94-326d1f633745",
"requested_by_company_id": "b8ab8252-b2b2-43f4-9f00-c3cacceafd74",
"requested_by_contact_id": "6de09a96-dd46-4008-9e03-4cbf5889a91e",
"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-09-11T15:48:14.444366+00:00",
"due_date": "2026-09-11T15:48:14.444366+00:00",
"date_create": "2026-09-11T15:48:14.444366+00:00",
"date_update": "2026-09-11T15:48:14.444366+00:00",
"date_closed": "2026-09-11T15:48:14.444366+00:00",
"suggested_user_id": "0d4a1183-1e32-40d2-bdc6-20251ed87ac5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "49c6c920-3020-40e9-90ae-c7bd23f75b4a",
"db_language_id": "f9d86d15-5e91-4d3c-844d-01a225b2bace",
"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-09-11T15:48:14.444366+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "daae9155-1266-41ae-bf49-a7820e799616",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "950307b3-ad20-4f76-ac26-c252fd978b66",
"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": "71fe17fd-80fd-4ff8-b4b6-a2efd102a8ab",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ee74c3fa-8a6d-416f-a29a-49a08b9c1892"
},
"suggested_date_start": "2026-09-11T15:48:14.444366+00:00",
"skill_id": "7ab4af2b-c422-4aca-8780-6ee1d8616bd5",
"skill_code": "sample string 32",
"skill": {
"id": "db16c93c-92c7-41f3-b593-4cd206e00d72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6ac75d0b-e98d-4959-b560-50de2a49e2e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bc7c6ab8-b61a-403b-967e-57672284b1ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "383cc3cc-6564-41d1-a889-1d7f95ef43ad",
"db_currency_id": "74d2fb8a-3ed6-4ee0-945e-74cc9c2cb94b",
"db_language_id": "c9bd8b9a-420f-4f4b-80b3-7afd0b11c601",
"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-09-11T15:48:14.444366+00:00"
},
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5d6836cb-9d55-423d-a369-27e3cbf78bd5",
"date_reported_by_company": "2026-09-11T15:48:14.444366+00:00",
"id2": 36,
"company_id": "31c36696-2f95-4f38-9547-6237434da39a",
"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": "e8055763-52ca-4d1e-9836-375d698d34fb",
"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-09-11T15:48:14.444366+00:00"
},
"work_instruction_details_id": "316907cc-0ebf-4fad-ba36-9597da2fba3b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1bb1dba1-5f86-4dfa-b6f2-71b58f1956e3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a692d048-6bbe-41ac-a870-1c4ea01cf302",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T15:48:14.444366+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": "91a0a36e-b1f1-4e73-b014-f9c2ff4b40f5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T15:48:14.444366+00:00"
}