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": "e6aee91e-a454-46c2-ac72-6b51c6853785",
"jobs_id": "1b49e0c5-0db3-4f96-8857-a759c25131c0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bbd5b7e4-4830-45cf-a5a0-fac5eb7e7387",
"_parent_id": "7fa4ccdc-2faf-46b6-83a8-f3dc4dda30a7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8df7ef2d-35ad-42c0-900f-f1613440f794",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8763f979-ebdc-47fd-b9ea-ac1a09d234fe",
"_parent_id": "27396934-d579-4021-a397-3f2179be7cf8",
"root_parent_id": "e3de2d86-ebd5-4fbf-bd94-a2ce7c821a3c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "948d20bc-1d79-4986-90e2-e0a8daef5a65",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1872e7f2-79c9-469c-af6b-e014e42150a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aa7caccc-2c2f-4bfe-91ad-efaea15092ba",
"_parent_code": "sample string 6",
"sales_organization_id": "f17d4d1b-46cf-4aba-aa5b-3848a344b2a6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+00:00"
},
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00"
},
"equipment_model_id": "f3b27067-df97-4be0-886a-7245ff2e40b5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9347cd33-374e-4a99-b4da-0a85149ad8ff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e32b7f2d-58bf-442e-b358-214d14b8d961",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "86db53e1-1a52-429c-84af-96fc02bde257",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d42949bc-4fe7-4a11-adf4-ead04433cb32",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+00:00"
},
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00"
},
"equipment_family_id": "765c8b32-d36e-45f1-83d3-eccfee9bb4ca",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1872e7f2-79c9-469c-af6b-e014e42150a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aa7caccc-2c2f-4bfe-91ad-efaea15092ba",
"_parent_code": "sample string 6",
"sales_organization_id": "f17d4d1b-46cf-4aba-aa5b-3848a344b2a6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+00:00"
},
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00"
},
"date_in_production_since": "2026-05-14T00:27:13.9139+00:00",
"date_out_of_production_since": "2026-05-14T00:27:13.9139+00:00",
"date_end_support": "2026-05-14T00:27:13.9139+00:00",
"sales_organization_id": "8615eafd-3f96-4dbe-a2e9-a8dda0b4d12f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+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-05-14T00:27:13.9139+00:00"
},
"project_status_id": "a0cf1182-bcf4-4489-852e-59b9ab1eda65",
"project_status_code": "sample string 10",
"project_status": {
"id": "8abd99bd-81cf-4f0a-9be7-fda6c9556d1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "103933a7-7afb-4177-9651-a14c50c94c53",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00"
},
"company_id": "11238c25-1cf0-4b6f-8a81-a1f6074adeaf",
"company_code": "sample string 12",
"db_address_id": "5ed73b2a-1240-4bb3-aa8a-c59c61c416f7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d46bea09-cd95-404b-b8d0-ab814ebc7595",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6141143c-ef87-4ab4-ae19-b2d7b65e0b7a",
"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-05-14T00:27:13.9139+00:00",
"date_create": "2026-05-14T00:27:13.9139+00:00",
"date_update": "2026-05-14T00:27:13.9139+00:00",
"updated_by_user_id": "f3812825-6557-44fa-a548-fd49dc941cb8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-14T00:27:13.9139+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-05-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-14T00:27:13.9139+00:00",
"date_last_job": "2026-05-14T00:27:13.9139+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-14T00:27:13.9139+00:00",
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00",
"is_mobile_installation": true
},
"job_type_id": "c76a7611-6058-4abb-90a8-0dae37fa597d",
"job_type_code": "sample string 7",
"job_type": {
"id": "4f32e67a-ed00-4a72-b465-1faba739fc9b",
"name": "sample string 2",
"sales_organization_id": "eff2af7e-4161-40b5-9cf7-7c204e5a93d1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00",
"code": "sample string 7"
},
"job_priority_id": "aa58c544-6c19-418d-b19f-bcce457ea205",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "729d9f01-1686-4a6a-bbe0-90ff937d18ae",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "61a01382-51e0-4d59-a13a-d707c7014a47",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00"
},
"job_status_id": "f3c3475e-c182-49be-bc60-bfbb5031d4da",
"job_status_code": "sample string 11",
"db_address_id": "04eca1bc-c97b-449f-a262-56075056409b",
"contact_id": "0c1872ce-6d5c-462e-b88f-c30b43c07e5f",
"requested_by_company_id": "e174bc66-856f-40a6-959f-2023215cb552",
"requested_by_contact_id": "1f973c59-a162-4f17-9fce-f2b075f49619",
"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-05-14T00:27:13.9139+00:00",
"due_date": "2026-05-14T00:27:13.9139+00:00",
"date_create": "2026-05-14T00:27:13.9139+00:00",
"date_update": "2026-05-14T00:27:13.9139+00:00",
"date_closed": "2026-05-14T00:27:13.9139+00:00",
"suggested_user_id": "18338846-18da-4c7e-91e7-4da0a3d7ee50",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fe0d65fe-70bd-4ec6-b166-f30810570ccc",
"db_language_id": "ee4d23ab-e994-4306-9dc4-65b2c109955c",
"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-05-14T00:27:13.9139+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1abd2dcc-0feb-4b95-b340-3ef0142bfdc3",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c407e37c-954e-47fe-9dca-2926b5b32331",
"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": "a3c3067f-5874-4bf8-be20-0217ac8e3305",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "164e9030-c802-47a8-a44f-dcddf4c35135"
},
"suggested_date_start": "2026-05-14T00:27:13.9139+00:00",
"skill_id": "0113c634-24df-4f79-b845-6bff0076fbfd",
"skill_code": "sample string 32",
"skill": {
"id": "8984dde6-f273-4b49-b5a6-91397b6b5ab4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7d575a00-720d-453a-9660-86ef2bb6e3d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41c5561d-977f-4125-8ea6-3fb5d2f62dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6118b126-9b03-4a22-81e0-a81501b255a1",
"db_currency_id": "119b9f69-ba35-40c6-9005-faca7d8054d0",
"db_language_id": "f0584c3a-4426-46ab-bc06-56d875c86389",
"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-05-14T00:27:13.9139+00:00"
},
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "647cafe8-6826-46f1-a12a-0d85f867e576",
"date_reported_by_company": "2026-05-14T00:27:13.9139+00:00",
"id2": 36,
"company_id": "d6d59447-2851-401d-a23f-257912e384e6",
"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": "6cc305a4-1a1c-4c58-a91f-aab055af18f7",
"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-05-14T00:27:13.9139+00:00"
},
"work_instruction_details_id": "fea92f32-54b6-47d2-991d-8aeaeb58c18b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d1952aa9-ff7a-467f-bc3f-6682ab02b0c0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a7137790-5710-4a94-a14d-fc24d9d6ce65",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-14T00:27:13.9139+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": "914bc968-cb3f-40f1-bb35-b5c33235bd72",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-14T00:27:13.9139+00:00"
}