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": "4143a6e4-d793-4439-a820-db49e53d46c3",
"jobs_id": "74a265d6-0eb1-4624-b74e-f300b1838719",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2ec37ade-3104-456b-87dd-1a9fb7503bea",
"_parent_id": "f777722b-393a-4ef7-b0a4-36323467100a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d1f76273-ac09-44e3-adff-c1198fa5055c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f6e31bee-4d9d-4845-9a23-983959d605a9",
"_parent_id": "41ba8c55-20fd-4524-883a-d490b62ae800",
"root_parent_id": "fc8f10f5-f6b0-4825-bcad-5117c6fe635c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5d1ffeec-c5a0-4f2d-b900-0b4cf09ff362",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c1670dcd-eef9-41e1-93c7-ec8671efc0a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3838357-5643-40f4-94a3-5c8e74021cef",
"_parent_code": "sample string 6",
"sales_organization_id": "6367ad4c-edbb-4ffb-bbdb-2900609f3814",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+00:00"
},
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00"
},
"equipment_model_id": "cc82eab4-10a3-4e1e-9f42-1c4fcd399615",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2f63773a-b74a-4468-ab62-523843aca8a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6ed9d87e-b962-49e3-b59b-6524c1f7836c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9add5164-dce4-4868-885d-763cd5a275b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5115cbb0-2498-484a-9334-4a890e78e046",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+00:00"
},
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00"
},
"equipment_family_id": "cd725d76-c0c8-4831-af73-3bbdc1018e78",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c1670dcd-eef9-41e1-93c7-ec8671efc0a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3838357-5643-40f4-94a3-5c8e74021cef",
"_parent_code": "sample string 6",
"sales_organization_id": "6367ad4c-edbb-4ffb-bbdb-2900609f3814",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+00:00"
},
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00"
},
"date_in_production_since": "2026-07-08T09:56:55.6146089+00:00",
"date_out_of_production_since": "2026-07-08T09:56:55.6146089+00:00",
"date_end_support": "2026-07-08T09:56:55.6146089+00:00",
"sales_organization_id": "9f167c37-116d-4f21-a41d-92844a681dd2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+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-07-08T09:56:55.6146089+00:00"
},
"project_status_id": "ff73997e-da46-42fb-8d7e-136768b2e49d",
"project_status_code": "sample string 10",
"project_status": {
"id": "0595e04d-a26e-477f-b8db-1e07a77ff45b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b7a1a74a-6345-4a48-b3fa-3e289aec5b95",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00"
},
"company_id": "f90f5d2c-2852-4284-983e-a48c15533a81",
"company_code": "sample string 12",
"db_address_id": "a4ea142e-1afe-400f-af6d-d10ec51a117d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a17d3eb1-a3b0-493b-b338-6548d973c6e8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "abc81f15-ae72-4ad5-b1f8-04a16d5f2c14",
"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-07-08T09:56:55.6146089+00:00",
"date_create": "2026-07-08T09:56:55.6146089+00:00",
"date_update": "2026-07-08T09:56:55.6146089+00:00",
"updated_by_user_id": "b98def77-511e-4610-98e0-73c4f1697e98",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-08T09:56:55.6146089+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-07-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-08T09:56:55.6146089+00:00",
"date_last_job": "2026-07-08T09:56:55.6146089+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-08T09:56:55.6146089+00:00",
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00",
"is_mobile_installation": true
},
"job_type_id": "804b250e-6958-4599-8bc7-076cd3ec815c",
"job_type_code": "sample string 7",
"job_type": {
"id": "87f4a8f7-31de-46b6-a06d-801b14744305",
"name": "sample string 2",
"sales_organization_id": "a4c6095b-52a5-45b6-8b43-a468e66215e0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00",
"code": "sample string 7"
},
"job_priority_id": "9e2e1306-9956-43c9-a5bd-37727517a3c5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b4c2e04-97c7-49ef-80a1-b8ed1f4be25a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c7058a58-700b-4bd7-8380-3d397c0510c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00"
},
"job_status_id": "f5174789-7b3d-4a12-81b0-f2d65c7fbaea",
"job_status_code": "sample string 11",
"db_address_id": "97819592-6326-4e61-a9af-346c7b461026",
"contact_id": "a1ad6f3f-be09-4d91-9bcc-6c29ff45d19e",
"requested_by_company_id": "dfc131a8-3e04-4538-a9d1-a0478bc24cda",
"requested_by_contact_id": "83f81a86-9227-45fe-8696-5fbd0955d0cc",
"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-07-08T09:56:55.6146089+00:00",
"due_date": "2026-07-08T09:56:55.6146089+00:00",
"date_create": "2026-07-08T09:56:55.6146089+00:00",
"date_update": "2026-07-08T09:56:55.6146089+00:00",
"date_closed": "2026-07-08T09:56:55.6146089+00:00",
"suggested_user_id": "b04fb6f5-cf68-4472-b5b3-12d55f1ff5d8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "889b70db-e71f-430c-b2ac-86d06dd9532e",
"db_language_id": "f845f6a0-d627-4b19-8ad3-32fe337fa5b6",
"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-07-08T09:56:55.6146089+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9216458e-bd9b-4b29-aeb4-76fb3bf55ce8",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ef2b430f-0195-4658-ba12-c1892314328c",
"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": "cd5d3331-290e-4af1-9fc6-475798f32794",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "104d6e13-a718-44c1-8262-d454d4af2245"
},
"suggested_date_start": "2026-07-08T09:56:55.6146089+00:00",
"skill_id": "12dab374-cf2f-40f1-8fce-169cbe960449",
"skill_code": "sample string 32",
"skill": {
"id": "f3376e99-18f8-4fb0-a992-e8fd67079620",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "272fb8e8-41c0-4c8c-880e-d5c754b2de0d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a7e9a014-0e56-4ba0-a953-4166f10e5bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e1b4e8-021c-4853-af4a-996bb2ef5869",
"db_currency_id": "f3c16220-11d4-49cb-8fb1-9e27dbc9de0c",
"db_language_id": "0dd0534b-8d26-48bd-88c5-867058ae987f",
"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-07-08T09:56:55.6146089+00:00"
},
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "553dc24a-9577-407f-9a3d-dadccff2ac31",
"date_reported_by_company": "2026-07-08T09:56:55.6146089+00:00",
"id2": 36,
"company_id": "b37d2263-98f2-4f18-9302-69aa6e1c03de",
"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": "0044b8cb-1986-4796-a4fe-c0e13108554b",
"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-07-08T09:56:55.6146089+00:00"
},
"work_instruction_details_id": "2d0d00da-3000-49b8-9ea6-b0335b23d9dd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "01a3034c-a594-45a3-9280-4a5661a91477",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fd7b4f32-4bc4-41bb-94d8-ff897c5746dc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-08T09:56:55.6146089+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": "c98f40e2-0d3a-40f8-9901-272069c3d8ad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-08T09:56:55.6146089+00:00"
}