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": "898c1640-3baa-437f-bc73-7f04258c7001",
"jobs_id": "b8a86dd6-76ea-4090-96e5-8d630302501d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "987a8672-94f4-42d2-a3a5-4d0c978ea09c",
"_parent_id": "74248454-4697-44c5-a2cf-cdc7b831d88d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e904065d-d50f-445f-8f95-87a538b3a79b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "61081be6-6cb2-49a7-9ae1-715b68c424cd",
"_parent_id": "f199eedb-f17f-47df-8d19-0f287db4055b",
"root_parent_id": "2d8bcbd9-d595-4bc4-9050-33db539f4c26",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dc63d97b-52c4-4aa9-bc54-6f4ea2508f3f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1f65fc04-c726-4f63-a85f-e2e904fb5d9c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0dd0736d-ffc3-4105-bf95-67abb7265415",
"_parent_code": "sample string 6",
"sales_organization_id": "74444abc-15de-40f5-b703-e2a1e42231b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+00:00"
},
"modified_dateutc": "2025-12-07T14:07:26.5583601+00:00"
},
"equipment_model_id": "0c77f142-a7cb-46dd-8daa-4159c41efd87",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "592fb5ac-475f-4603-9667-b69b48ca762b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f146c8aa-ddee-4090-b618-224d6ca6096f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1757b07f-7a84-49aa-9afb-1f9bf44507e3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f38ed412-49b6-463b-b9a0-8bb9267da9d7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+00:00"
},
"modified_dateutc": "2025-12-07T14:07:26.5583601+00:00"
},
"equipment_family_id": "f600f4ce-cf5a-4038-808e-98cf58ee857d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1f65fc04-c726-4f63-a85f-e2e904fb5d9c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0dd0736d-ffc3-4105-bf95-67abb7265415",
"_parent_code": "sample string 6",
"sales_organization_id": "74444abc-15de-40f5-b703-e2a1e42231b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+00:00"
},
"modified_dateutc": "2025-12-07T14:07:26.5583601+00:00"
},
"date_in_production_since": "2025-12-07T14:07:26.5583601+00:00",
"date_out_of_production_since": "2025-12-07T14:07:26.5583601+00:00",
"date_end_support": "2025-12-07T14:07:26.5583601+00:00",
"sales_organization_id": "bb9443c4-fc92-4ef1-9ca7-cf100a9ab750",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+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-07T14:07:26.5734206+00:00"
},
"project_status_id": "3eb0382f-bffd-4e86-9f8f-e5d7453fd819",
"project_status_code": "sample string 10",
"project_status": {
"id": "185db0e1-f1e5-4d8f-baf7-c7cbebc23ef4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "da70cba0-1e48-4bf7-8254-d13fb6da7355",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-07T14:07:26.5734206+00:00"
},
"company_id": "e743f780-3694-443f-adee-637b4ab94485",
"company_code": "sample string 12",
"db_address_id": "05f3631a-4490-47b8-8158-9e59fd5f3c48",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c6212860-8f72-421e-9fe1-2516c00cc84d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5389c213-fcb6-4c0a-ad21-3ab1ac03ad97",
"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-07T14:07:26.5734206+00:00",
"date_create": "2025-12-07T14:07:26.5734206+00:00",
"date_update": "2025-12-07T14:07:26.5734206+00:00",
"updated_by_user_id": "0da0f3b5-ddfd-4f75-88ee-a5ffbeadc793",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-07T14:07:26.5734206+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-07T14:07:26.5734206+00:00",
"date_last_job": "2025-12-07T14:07:26.5734206+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-07T14:07:26.5734206+00:00",
"modified_dateutc": "2025-12-07T14:07:26.5734206+00:00",
"is_mobile_installation": true
},
"job_type_id": "85fff78e-d6ef-4b60-9128-958323211f3c",
"job_type_code": "sample string 7",
"job_type": {
"id": "119c5280-c24a-4112-9c82-e11ff971d4a5",
"name": "sample string 2",
"sales_organization_id": "f39f9770-2d5d-4417-9a0b-235f12b2971f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-07T14:07:26.5734206+00:00",
"code": "sample string 7"
},
"job_priority_id": "687f3578-94a6-4c2e-9a62-3fae5c4f2134",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "db71016d-17bd-4a75-be59-18ee22b521b1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ace7fbb5-12ca-43d8-bc1d-21a7004451df",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-07T14:07:26.5734206+00:00"
},
"job_status_id": "67c2ba40-2d6d-48e2-aa62-7917b8625555",
"job_status_code": "sample string 11",
"db_address_id": "0bcad903-69d4-40c2-b700-6d6ea51dc1d9",
"contact_id": "405ceac5-9160-4b3f-bd90-caaf9c5c0fad",
"requested_by_company_id": "795a31f9-9e81-4797-8d1c-d85b0e9cd5e8",
"requested_by_contact_id": "c3e5a9a5-bae5-43f1-808f-8219f9ef7aaf",
"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-07T14:07:26.5734206+00:00",
"due_date": "2025-12-07T14:07:26.5734206+00:00",
"date_create": "2025-12-07T14:07:26.5734206+00:00",
"date_update": "2025-12-07T14:07:26.5734206+00:00",
"date_closed": "2025-12-07T14:07:26.5734206+00:00",
"suggested_user_id": "ef5413d6-237c-4653-8a2d-e4b91e323c3b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "68a4dbf4-755d-46f9-bc28-31b56c7834a9",
"db_language_id": "4ed57cb4-7a51-41fb-b832-44a33ac63d21",
"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-07T14:07:26.5734206+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89df00e8-66d9-41d7-b0e0-8d601eb7cd3f",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "90cbacb1-f7b4-4e66-9dcc-7b49c697cff0",
"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": "52f55f17-58ae-4d1c-bd4c-6346bc31a341",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-07T14:07:26.5734206+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ffa4afd4-bb5e-41a3-92ca-5be2cdafd4f4"
},
"suggested_date_start": "2025-12-07T14:07:26.5734206+00:00",
"skill_id": "e5c9bcd8-ac40-41f6-9803-bf91b3ad7f96",
"skill_code": "sample string 32",
"skill": {
"id": "2c35946d-a01b-4fb7-87b9-025416161e32",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "95cec11f-a977-4804-a87e-1350b21df69f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d893d310-f9dd-4252-b0e9-37f2031321d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b379c9-1ffc-4412-8e44-9add4e388853",
"db_currency_id": "ededdaf6-3431-4a17-a598-c887fb210253",
"db_language_id": "c43cf91d-83c1-41d0-8c27-a9acf095803c",
"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-07T14:07:26.5583601+00:00"
},
"modified_dateutc": "2025-12-07T14:07:26.5734206+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "39a69438-ddf6-47d6-a658-dd7aff252e29",
"date_reported_by_company": "2025-12-07T14:07:26.5734206+00:00",
"id2": 36,
"company_id": "781b7627-0189-4b38-af27-e9a607ee7fc5",
"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": "92829470-ef0c-45e8-9930-5145879f7cac",
"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-07T14:07:26.5734206+00:00"
},
"work_instruction_details_id": "ce12123b-36da-48a6-bf19-a93d4806b9fa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "36c8047f-edcc-4d84-ad85-3028a57e82ae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5d160043-04a3-4187-9b20-37557cff091e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-07T14:07:26.5734206+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": "cd5d7f38-e7c2-4d26-8aef-58f92636f87f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-07T14:07:26.5734206+00:00"
}