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": "c470cc67-8397-42cb-8878-79d7bb078dd4",
"jobs_id": "728a7580-46b8-4160-8c33-82eddc95bb4b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8c680e5a-aa38-4d63-a016-9db93d6c9082",
"_parent_id": "e9e1c07c-c480-4c35-851e-3effcd11e09b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "64991817-ba9f-486a-bc8a-f1163895a4c4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2b225108-07d2-4222-9fab-c70dc2590bf6",
"_parent_id": "65186497-d0fa-4d5c-8d04-77f9f616fd8c",
"root_parent_id": "0a56f10c-e37e-4ee0-8b7d-628867e3ed0c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d0fea2ff-9582-4614-9b21-5b96a8338d08",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "103c16e5-3179-4a51-8446-f9b32455d689",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "128d88f7-2fb5-4c9f-91f5-5fae770a23a7",
"_parent_code": "sample string 6",
"sales_organization_id": "a1dda1ef-b3c8-4fb0-a0c1-1319f2e2be82",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+00:00"
},
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00"
},
"equipment_model_id": "6cedc755-d96c-404e-8772-86f55f0f1459",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f7f2f7ad-6eb4-4ff8-894d-c609a1e686f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b28dcaba-19ea-45e2-98d8-77280391fff4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bbfa883c-b2bf-446d-8aa0-51470854033d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3d5ca996-b38a-407d-9f5f-2651abfa42ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+00:00"
},
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00"
},
"equipment_family_id": "3e5af013-e684-4758-84c5-e1d5f2540332",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "103c16e5-3179-4a51-8446-f9b32455d689",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "128d88f7-2fb5-4c9f-91f5-5fae770a23a7",
"_parent_code": "sample string 6",
"sales_organization_id": "a1dda1ef-b3c8-4fb0-a0c1-1319f2e2be82",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+00:00"
},
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00"
},
"date_in_production_since": "2026-02-28T02:32:50.6201256+00:00",
"date_out_of_production_since": "2026-02-28T02:32:50.6201256+00:00",
"date_end_support": "2026-02-28T02:32:50.6201256+00:00",
"sales_organization_id": "c755c89d-219f-43b4-a636-caef114c2452",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+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-02-28T02:32:50.6201256+00:00"
},
"project_status_id": "1a1f70e2-062a-415c-8279-6336ba7c2ea0",
"project_status_code": "sample string 10",
"project_status": {
"id": "733e2367-ebea-4ebb-96c4-44c85e406163",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fa658771-3a30-4c50-959e-747b8df4007b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00"
},
"company_id": "662a9c15-f5e2-4237-8e26-89d079ba5b98",
"company_code": "sample string 12",
"db_address_id": "d2ff3a19-9d5d-49fc-a9cd-309d632e919f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b28837ce-3e88-447b-aaa6-213d18e40245",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9857cc70-4061-4981-a423-42e37e941aa4",
"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-02-28T02:32:50.6201256+00:00",
"date_create": "2026-02-28T02:32:50.6201256+00:00",
"date_update": "2026-02-28T02:32:50.6201256+00:00",
"updated_by_user_id": "134932e7-a44d-40af-90d9-8af6f0892214",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-28T02:32:50.6201256+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-02-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-28T02:32:50.6201256+00:00",
"date_last_job": "2026-02-28T02:32:50.6201256+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-28T02:32:50.6201256+00:00",
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00",
"is_mobile_installation": true
},
"job_type_id": "ceb83911-9d43-41e7-8a4e-069823ecaafa",
"job_type_code": "sample string 7",
"job_type": {
"id": "e20df37b-2898-4aa8-b43b-94c50243c0ab",
"name": "sample string 2",
"sales_organization_id": "d7ab6317-3977-41ac-8e58-3c1ca96fd810",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00",
"code": "sample string 7"
},
"job_priority_id": "043f6fb1-b63a-4d70-aea2-3a8f8efc82ae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3daa32b5-f6fd-43e8-ae8e-2c8e46485d5a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "65a02424-e4cd-4302-88fa-ce0f8a8ba72b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00"
},
"job_status_id": "67122fba-05d0-41fd-8416-8488e7f0e945",
"job_status_code": "sample string 11",
"db_address_id": "1b8c1e51-8b82-4513-8cc4-becac25cc0b1",
"contact_id": "39840ade-9bf2-4596-8e04-e516b160abde",
"requested_by_company_id": "943428f8-9b2c-4fee-b43c-7a6eba6c0df8",
"requested_by_contact_id": "b5d6dbf7-628e-4688-9264-3d83ea8d8841",
"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-02-28T02:32:50.6201256+00:00",
"due_date": "2026-02-28T02:32:50.6201256+00:00",
"date_create": "2026-02-28T02:32:50.6201256+00:00",
"date_update": "2026-02-28T02:32:50.6201256+00:00",
"date_closed": "2026-02-28T02:32:50.6201256+00:00",
"suggested_user_id": "8443b555-b780-44f7-be36-208e7c83355b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "87c06b7f-b468-4c81-92b6-0ae79b09e37e",
"db_language_id": "4c68eb31-dd69-4bd6-b6a5-c64dfba0c769",
"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-02-28T02:32:50.6201256+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b9022ecb-b2ce-4780-9f2b-e71a59c0776a",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cc227d09-13fc-43db-b388-940bf120ff48",
"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": "444fbd59-9c94-4828-b8f6-20518743b428",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "affe625e-9c1f-4f4d-bb01-6323b7f2fc20"
},
"suggested_date_start": "2026-02-28T02:32:50.6201256+00:00",
"skill_id": "beae5c88-8464-4e97-bd59-050c058f8d80",
"skill_code": "sample string 32",
"skill": {
"id": "6918864d-6446-4d31-ae1c-89b25664fa4d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "90e6e67a-29b9-4804-af11-a9b7b7cdd72d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af504190-ae58-432e-a343-6fc25778637e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc6429b8-0529-431b-aeac-7cf220ece9ef",
"db_currency_id": "1b76c98e-8076-4d7b-8b5c-b239a2c67eff",
"db_language_id": "a1569510-f67f-4c95-b536-4196884e4ca6",
"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-02-28T02:32:50.6201256+00:00"
},
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a8225fa1-5d34-4e6a-9a68-ec4b72a08bb6",
"date_reported_by_company": "2026-02-28T02:32:50.6201256+00:00",
"id2": 36,
"company_id": "d9b3177c-bd15-4382-92c7-39d68cf94156",
"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": "4ffb93ed-8fbc-4664-a2cb-c2a0b189ad0a",
"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-02-28T02:32:50.6201256+00:00"
},
"work_instruction_details_id": "9ebccecf-eaa3-4692-a58f-474d268ce5c3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "be4b39ee-7b92-438d-91b6-bf588b8ee162",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f830ec2-3570-4960-b7d0-4bed09b39888",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-28T02:32:50.6201256+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": "2321a743-d153-4430-9043-f683b4426113",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-28T02:32:50.6201256+00:00"
}