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": "4a266813-135d-4f35-a552-707d38f33f2b",
"jobs_id": "f78e8d34-a8d0-42ce-aa98-a1c8011dacc0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e8fa31e5-6442-433a-b97e-17f78906edfc",
"_parent_id": "33256249-ec93-4260-bea7-0d617dc6aca4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9ccf6e7c-42aa-419e-b815-c5626d4f5c6e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fd997556-a43f-4488-a0cf-641975fed592",
"_parent_id": "49b66fa5-5c5e-48b3-ae93-1a23becbff30",
"root_parent_id": "0e0e5955-2cc6-4a3e-93ee-d253a90be83f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f38502f2-cb4c-4386-b943-57ade7ee1473",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8968d928-babb-4fcc-8d53-eb97f1bcd831",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b427531-99d4-4b92-998a-6b2b92f3dfc7",
"_parent_code": "sample string 6",
"sales_organization_id": "9c76f9b0-e136-458e-8bb3-6b399e1b499b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+00:00"
},
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00"
},
"equipment_model_id": "30284bbc-1685-4f05-9f54-2ba6439c5d0f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d2f6238f-f720-4f2c-bcf0-5f4c6c7a7e3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5e3127f2-737b-4367-aefb-f87114c22728",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5b904011-569b-46df-911f-070d0be64306",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5e13d065-20f7-47f9-9583-f3221c06a407",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+00:00"
},
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00"
},
"equipment_family_id": "86ca76ce-070b-4cc0-b57c-05368a6e2ea1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8968d928-babb-4fcc-8d53-eb97f1bcd831",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b427531-99d4-4b92-998a-6b2b92f3dfc7",
"_parent_code": "sample string 6",
"sales_organization_id": "9c76f9b0-e136-458e-8bb3-6b399e1b499b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+00:00"
},
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00"
},
"date_in_production_since": "2026-10-28T08:12:24.6567615+00:00",
"date_out_of_production_since": "2026-10-28T08:12:24.6567615+00:00",
"date_end_support": "2026-10-28T08:12:24.6567615+00:00",
"sales_organization_id": "14e30f7e-411c-4a50-8d54-607e50902f13",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+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-10-28T08:12:24.6567615+00:00"
},
"project_status_id": "ea43ba2d-8278-4ce2-955e-934f736dd167",
"project_status_code": "sample string 10",
"project_status": {
"id": "89e24484-ec5d-40b8-b00b-da25262cdf6a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6521a801-535f-46ca-a6f8-9776ffe3c7fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00"
},
"company_id": "c00e7c13-f667-4483-a0b8-e1bcddf76277",
"company_code": "sample string 12",
"db_address_id": "db4f9e83-b2bd-4e3a-a785-70fe666f98f0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5ca2cdb4-9a64-4a12-bb67-3cbf28002198",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3850d2c3-02f1-42f9-9569-c892228cf9be",
"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-10-28T08:12:24.6567615+00:00",
"date_create": "2026-10-28T08:12:24.6567615+00:00",
"date_update": "2026-10-28T08:12:24.6567615+00:00",
"updated_by_user_id": "8179d88a-6697-4231-84ac-42aada00555a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-28T08:12:24.6567615+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-10-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-28T08:12:24.6567615+00:00",
"date_last_job": "2026-10-28T08:12:24.6567615+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-28T08:12:24.6567615+00:00",
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00",
"is_mobile_installation": true
},
"job_type_id": "f95b865e-ecf7-4558-8fd7-77eb1e14d1c1",
"job_type_code": "sample string 7",
"job_type": {
"id": "39c1a56c-8cbe-46a8-a867-fb383e630c84",
"name": "sample string 2",
"sales_organization_id": "5ca53a6b-0226-4cae-8cfb-599faa69dfd8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00",
"code": "sample string 7"
},
"job_priority_id": "dac43181-8855-48bf-a358-0b1898dc11c8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5ce451e7-5eea-4cc7-b10a-2be1cb248283",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9df6c2ae-e839-4d97-8d16-d60524a28057",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00"
},
"job_status_id": "17719df8-4c8b-4d62-906b-8269c5ef1ff5",
"job_status_code": "sample string 11",
"db_address_id": "2c574eb8-dafd-4d81-afbe-7f771e6bbe50",
"contact_id": "c639556e-5f41-4362-b3cf-9727e755db6c",
"requested_by_company_id": "1c8076ff-8383-4506-9544-b12124d83b13",
"requested_by_contact_id": "d5181781-c8c9-418d-8b2f-f93510ac08cd",
"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-10-28T08:12:24.6567615+00:00",
"due_date": "2026-10-28T08:12:24.6567615+00:00",
"date_create": "2026-10-28T08:12:24.6567615+00:00",
"date_update": "2026-10-28T08:12:24.6567615+00:00",
"date_closed": "2026-10-28T08:12:24.6567615+00:00",
"suggested_user_id": "fd3c6845-4ed9-4f1e-8e12-c0d701844048",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ad3dfb0c-1c74-4d23-8e5a-11ed68295aaa",
"db_language_id": "60054f06-7f78-431e-8520-25e826e33d77",
"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-10-28T08:12:24.6567615+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ade87dea-20b1-435f-9bc3-7561f16e19eb",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "284096a8-4148-438d-9f75-8dfa676c595f",
"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": "1e3e8d50-3b76-4165-aed2-3ecbd795771a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3a6b41ae-8d64-480b-8388-f3e6ce8b37d5"
},
"suggested_date_start": "2026-10-28T08:12:24.6567615+00:00",
"skill_id": "d99d7eec-d0e7-4f6d-a621-645998850c2b",
"skill_code": "sample string 32",
"skill": {
"id": "f28e0ec8-2a91-4d02-acf9-70c0a680b63f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "92b70eeb-3ebe-49c9-bf78-e37472fe13ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a85ee0a9-bbb9-4673-900f-6cb554783156",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c10ed68-3376-4132-928b-1485cb93a808",
"db_currency_id": "1001d565-fc95-4cfc-91e8-1f73cfaec53d",
"db_language_id": "9b32c7ad-d7ac-4155-9397-97c82adbeeaa",
"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-10-28T08:12:24.6567615+00:00"
},
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "46bc7705-f754-4df4-b17f-ea867a4f4178",
"date_reported_by_company": "2026-10-28T08:12:24.6567615+00:00",
"id2": 36,
"company_id": "67c64ae3-5f9c-45e3-9e79-d4fa954e6e52",
"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": "081f0889-4353-4511-9ffc-1d00a0a3b62d",
"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-10-28T08:12:24.6567615+00:00"
},
"work_instruction_details_id": "c2fdc68b-89b0-48d5-8363-ed24e1454256",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "415e791c-b9f2-43a6-b10f-2569c3e9482f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d29c3321-45c1-48fc-8d3a-83ce65ea6fda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-28T08:12:24.6567615+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": "ffefaec8-74d5-49d5-9bff-e1fdfc58092b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-28T08:12:24.6567615+00:00"
}