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": "d27294be-670e-411e-ac36-43b48b40b840",
"jobs_id": "df255087-6138-40b7-8a86-8f913f46643e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "590fbd0c-fbba-4ee6-86fe-39a584aaa651",
"_parent_id": "503b5552-923a-41a9-bf22-11b94ca13e88",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2bcc039b-5fc5-4318-bf3b-7bb8bef293c9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5b13bfcd-9db5-434b-9408-96364ca7ac2f",
"_parent_id": "be6bdf00-8017-4d31-9edd-8f1be06b2c1f",
"root_parent_id": "cb8e473d-7ced-4533-9b57-91862412a1bf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5b1cb7e9-8576-4dda-973f-95095a02d308",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "160e2e3f-f6a6-4695-9869-41c8bd2f8925",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "58bab03f-9903-4b20-b3f5-56282dddcf0e",
"_parent_code": "sample string 6",
"sales_organization_id": "d5301595-f898-4d26-8ca2-a084fe3cf1c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+00:00"
},
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00"
},
"equipment_model_id": "0b5dd671-245c-401b-aaa8-136c75df2c8a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4239a7a8-4e56-436b-bd6c-3f29786c55c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9f59b67b-4a35-4e28-bb72-7f4075c954e2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e98f1ffb-7484-4b3d-8ec0-62066e74780e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0d90600a-ce3a-4412-857c-02503f1c59ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+00:00"
},
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00"
},
"equipment_family_id": "ef114bd6-892f-445f-bbda-32fbf87b8b7b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "160e2e3f-f6a6-4695-9869-41c8bd2f8925",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "58bab03f-9903-4b20-b3f5-56282dddcf0e",
"_parent_code": "sample string 6",
"sales_organization_id": "d5301595-f898-4d26-8ca2-a084fe3cf1c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+00:00"
},
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00"
},
"date_in_production_since": "2026-09-18T17:32:55.185845+00:00",
"date_out_of_production_since": "2026-09-18T17:32:55.185845+00:00",
"date_end_support": "2026-09-18T17:32:55.185845+00:00",
"sales_organization_id": "213bf3e9-def8-4c15-aba4-957193f4d606",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+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-18T17:32:55.185845+00:00"
},
"project_status_id": "b9373404-25f0-442c-85f2-29e45d5c0d06",
"project_status_code": "sample string 10",
"project_status": {
"id": "3b07dce3-c800-4d48-bf7a-432a98b62bbd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fa891622-d099-4900-84af-06b56d0e054c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00"
},
"company_id": "61939f21-949b-445d-b2ba-a5e207c9051a",
"company_code": "sample string 12",
"db_address_id": "02f1308a-1ee4-42c1-9fe8-0f878f0dd475",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e2358551-3a7d-4490-98d7-00f831df3808",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b664cddf-ed3e-426b-bc51-953686c577c5",
"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-18T17:32:55.185845+00:00",
"date_create": "2026-09-18T17:32:55.185845+00:00",
"date_update": "2026-09-18T17:32:55.185845+00:00",
"updated_by_user_id": "300827e1-56c4-4c66-9da6-7f178cfd143c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-18T17:32:55.185845+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-18T17:32:55.185845+00:00",
"date_last_job": "2026-09-18T17:32:55.185845+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-18T17:32:55.185845+00:00",
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00",
"is_mobile_installation": true
},
"job_type_id": "0952fe89-b162-43d2-a881-97e7db5f4212",
"job_type_code": "sample string 7",
"job_type": {
"id": "db660fdc-891b-4bd9-96e6-465475d644a5",
"name": "sample string 2",
"sales_organization_id": "0e678c41-262a-45d9-927a-06d112f36ab4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00",
"code": "sample string 7"
},
"job_priority_id": "ce066b51-4443-47be-90d4-a0038888094d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b974637c-e20e-4c24-abdc-afdecf6eaa06",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b46d1e12-17ff-45d3-935d-bdc501eeecc7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00"
},
"job_status_id": "30b81964-4c7c-4f2b-9cb1-7909e3a23ee2",
"job_status_code": "sample string 11",
"db_address_id": "cb35a574-7100-4be6-85a8-8a9a7e5839c0",
"contact_id": "63ce3a4c-7ae9-4e46-84e7-5798d13ad109",
"requested_by_company_id": "5d97d921-f124-4047-bc5b-b3761b671168",
"requested_by_contact_id": "8fe89e5a-eca2-430e-9674-5b3986dc047d",
"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-18T17:32:55.185845+00:00",
"due_date": "2026-09-18T17:32:55.185845+00:00",
"date_create": "2026-09-18T17:32:55.185845+00:00",
"date_update": "2026-09-18T17:32:55.185845+00:00",
"date_closed": "2026-09-18T17:32:55.185845+00:00",
"suggested_user_id": "17271bd3-286a-4a2d-8a32-46721a8bc1ae",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cb7a4d9b-5fd8-40b2-a5d6-d24ca1f1f96f",
"db_language_id": "ee5d5d9e-4ccb-4eb9-9ed7-492857943a39",
"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-18T17:32:55.185845+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "971dba0c-3f48-4152-8aa2-2eb1e923091f",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4eab6a39-03f6-4266-891b-4652e864bc6f",
"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": "d86fdedb-8980-4114-bb93-b654ab98e46e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d2c66bf8-1507-43d0-bfdc-fd005d06e1c9"
},
"suggested_date_start": "2026-09-18T17:32:55.185845+00:00",
"skill_id": "45d04252-3363-4943-966d-ca93e168caff",
"skill_code": "sample string 32",
"skill": {
"id": "48fec6b1-4822-4a26-9012-ff29fdaca8dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1a10e1b0-78d8-4d2a-870b-25cec0de3f75",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c01112d-2bc6-4ba6-bd4c-c6ccf55c34ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b7d1ff8-3d0e-4472-a0f7-fedb1c1faac2",
"db_currency_id": "b2b48c5a-2d2a-48d4-9ad4-e62048e17dff",
"db_language_id": "96695d26-a213-4aaa-aa85-6341108475fb",
"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-18T17:32:55.185845+00:00"
},
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c6ec1591-4b1b-4d03-a387-c7752cae2e5a",
"date_reported_by_company": "2026-09-18T17:32:55.185845+00:00",
"id2": 36,
"company_id": "adf0b42e-6484-4e5b-99fe-750a1d675c4f",
"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": "13ac6db2-9323-4dee-9674-e7d6eb0e5616",
"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-18T17:32:55.185845+00:00"
},
"work_instruction_details_id": "6491607c-70b9-435a-9142-470e96ba5d23",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "768f7f2d-d3be-4aeb-b5e5-ff0ee275d67f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0b27042d-5499-4098-917b-2dabf314aa77",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-18T17:32:55.185845+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": "b2cba8da-432b-4e42-8762-894c792d9e25",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-18T17:32:55.185845+00:00"
}