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": "c99dcf57-ebe5-4d4c-a6aa-56aa7516f042",
"jobs_id": "c8e37b72-5ed4-49c5-add1-305c9700195e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9e6e6807-1f07-4223-96ef-2e7b2bc3549b",
"_parent_id": "d7b4f849-c8ee-4866-b62f-08b807bc0a49",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d8d3e715-6ab5-4826-b12f-95aac5c4c13a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cc73c209-f92d-4db3-a45f-a0fd5d011438",
"_parent_id": "5179f3d2-67a9-4c95-be5f-a4965947f9f1",
"root_parent_id": "0bb65d5f-2ff0-46a1-85a9-cf9204e46c7f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b5a02696-3feb-47ee-8328-c7d8392c9789",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7e384e4b-bc13-4ffc-a7eb-a183a8689254",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "38fe7e32-9289-4619-a7cb-ddd131a1274c",
"_parent_code": "sample string 6",
"sales_organization_id": "338232e0-b6ae-408a-bf6e-92b86a181b1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+00:00"
},
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00"
},
"equipment_model_id": "e9832fcf-19c7-4e8c-be2c-eb593563ed1e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "972f86ef-8525-4e20-9454-8a3ef92dff17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3969fe93-f45a-4b2f-8805-66fbf16efc77",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "32eb8ee9-cc84-4f17-bda1-ab025d160f41",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8b1b813d-9c5e-43bf-94a4-d90ddf8498ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+00:00"
},
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00"
},
"equipment_family_id": "8b4af4d1-ad32-426c-a248-b9dc2ddf2313",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7e384e4b-bc13-4ffc-a7eb-a183a8689254",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "38fe7e32-9289-4619-a7cb-ddd131a1274c",
"_parent_code": "sample string 6",
"sales_organization_id": "338232e0-b6ae-408a-bf6e-92b86a181b1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+00:00"
},
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00"
},
"date_in_production_since": "2025-12-18T16:41:50.3023018+00:00",
"date_out_of_production_since": "2025-12-18T16:41:50.3023018+00:00",
"date_end_support": "2025-12-18T16:41:50.3023018+00:00",
"sales_organization_id": "3c050dc5-8ee8-4b48-b908-cbd2bd1e86f3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+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-12-18T16:41:50.3023018+00:00"
},
"project_status_id": "59d04661-38db-4215-88a0-30688e838f7e",
"project_status_code": "sample string 10",
"project_status": {
"id": "cce9a8fe-0835-40f1-9450-1e318e2ffabe",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "96ff8b02-6343-4b02-a4cd-830dc849cc93",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00"
},
"company_id": "7c8c53db-2d14-4762-9b9c-ed95608d7acf",
"company_code": "sample string 12",
"db_address_id": "558220cb-a35d-46cd-a49d-8e89700e66f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cd4d4408-0717-427b-ba39-47df9d7188fc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3cdfc5e4-aad4-4522-b073-d073737b10b4",
"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-12-18T16:41:50.3023018+00:00",
"date_create": "2025-12-18T16:41:50.3023018+00:00",
"date_update": "2025-12-18T16:41:50.3023018+00:00",
"updated_by_user_id": "62c32389-8e47-4105-939e-f4023b9a6c38",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-18T16:41:50.3023018+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-12-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-18T16:41:50.3023018+00:00",
"date_last_job": "2025-12-18T16:41:50.3023018+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-18T16:41:50.3023018+00:00",
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00",
"is_mobile_installation": true
},
"job_type_id": "97f9127e-5677-4487-bd52-e1a84c7ac612",
"job_type_code": "sample string 7",
"job_type": {
"id": "9f0fd0a9-c971-4c1a-bb72-69b89bb8319b",
"name": "sample string 2",
"sales_organization_id": "13dc0aa1-4935-46cd-8ae2-4ead1b74ee08",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00",
"code": "sample string 7"
},
"job_priority_id": "5c2f0bcc-4549-4e40-bb0a-d7a84c06c1f4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c1d8a22c-e9d0-4550-92b1-2259bf005af4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "122a97b0-7f86-4d81-8bc3-238a9df6f581",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00"
},
"job_status_id": "16f42fa0-7206-4178-98b0-79bbf6e6a130",
"job_status_code": "sample string 11",
"db_address_id": "69f66ca0-cf8e-49ff-9326-573b48aaf6c7",
"contact_id": "5c1f01d6-1e1e-409d-929f-d7a16ac419da",
"requested_by_company_id": "8c5e6186-ce78-480c-8a91-6402570de225",
"requested_by_contact_id": "1d08fe27-ab08-4242-8d37-9bf7f38c1857",
"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-12-18T16:41:50.3023018+00:00",
"due_date": "2025-12-18T16:41:50.3023018+00:00",
"date_create": "2025-12-18T16:41:50.3023018+00:00",
"date_update": "2025-12-18T16:41:50.3023018+00:00",
"date_closed": "2025-12-18T16:41:50.3023018+00:00",
"suggested_user_id": "08d97e91-35ca-406c-bc68-25fc821cc546",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a86c3998-d25f-4936-95ec-13e65653bfee",
"db_language_id": "56dcaead-2bba-4bf2-a159-d4a1f434b676",
"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-12-18T16:41:50.3023018+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "38347b59-5ccc-42a2-a7ec-3ef1316b7eed",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dbb2aab6-ce1d-4994-a365-804f43da7552",
"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": "92e914c2-7b09-4402-a26d-78a7e9b19e02",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "24810358-1b1d-4243-8759-af9bc19f5ba7"
},
"suggested_date_start": "2025-12-18T16:41:50.3023018+00:00",
"skill_id": "808ff4fd-0df9-46af-8990-a8b99b93072a",
"skill_code": "sample string 32",
"skill": {
"id": "e0d505fe-52bb-4ab9-b867-cfa0b79538fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0804be8d-e837-452f-9d6f-25c2e8fdddcc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47f0846e-2361-4fcb-9b28-19916b0cf3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a25920e3-4512-44b8-aedd-5c3cca6b3058",
"db_currency_id": "83f16f56-5744-4b18-a5ec-d85e3e575c3a",
"db_language_id": "d1ec60f0-4620-42d6-92d5-aa0bb6abf5ad",
"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-12-18T16:41:50.3023018+00:00"
},
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "97833670-adbd-47cc-b4f4-d3fa19a7a66b",
"date_reported_by_company": "2025-12-18T16:41:50.3023018+00:00",
"id2": 36,
"company_id": "084af03f-f210-4e98-a8a9-7a9bad2b3fd7",
"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": "3daa6b24-77a4-4370-abe4-a578d54f9912",
"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-12-18T16:41:50.3023018+00:00"
},
"work_instruction_details_id": "e250d05c-657a-4eaa-b47b-ab58e868fd8a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ee5a4840-d467-47a7-abbc-4c9bb1e26fd9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7e139989-b60e-420b-aeb6-9a155454716c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-18T16:41:50.3023018+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": "541ab7c9-9e2d-4e04-8d67-e25df34189c3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-18T16:41:50.3023018+00:00"
}