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": "79472ac5-befe-4731-a259-17fdeebd018d",
"jobs_id": "8e8c4d30-5d57-4076-9375-f8ca8735f332",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "79d888a6-3e11-47d2-a5eb-83d009d9e87c",
"_parent_id": "ed21a92b-63ff-4209-a229-3a0123ae02f8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f6a12712-f15a-4a8c-86e9-86f620b25e4f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6c9789cd-69a5-49f5-9185-feeb38f1437d",
"_parent_id": "5b20f405-a669-4e68-8e65-6cc02ef27a2f",
"root_parent_id": "e2701ab4-8a40-4b41-8599-42bee10508e1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "21dd72cb-d538-40d3-a0bb-7a72d0c4d31a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "77ef3430-c1e7-40c9-8758-eb13485a9e05",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd66d86b-839f-488d-924e-5f3fb360d584",
"_parent_code": "sample string 6",
"sales_organization_id": "32dba9cc-4e53-4e9c-ad41-eb31b06956cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+00:00"
},
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00"
},
"equipment_model_id": "4833f068-7afb-40c2-a29f-915f4126ffad",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1fa8beb1-764b-4ec3-b8d4-e0f24e256b15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5e226162-0dd5-4c2a-a9f9-3de340ef798e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d2e444c6-acd1-4443-b1f9-c54bed06a235",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8a184ff2-8241-4706-8c0e-a66e4654aab9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+00:00"
},
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00"
},
"equipment_family_id": "50e8064e-e67f-47e5-acbd-d9a8c0abfc0b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "77ef3430-c1e7-40c9-8758-eb13485a9e05",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bd66d86b-839f-488d-924e-5f3fb360d584",
"_parent_code": "sample string 6",
"sales_organization_id": "32dba9cc-4e53-4e9c-ad41-eb31b06956cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+00:00"
},
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00"
},
"date_in_production_since": "2026-05-28T20:10:27.8293145+00:00",
"date_out_of_production_since": "2026-05-28T20:10:27.8293145+00:00",
"date_end_support": "2026-05-28T20:10:27.8293145+00:00",
"sales_organization_id": "f321d5b8-c08e-4ff5-ad03-e7a7cc4906de",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+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-05-28T20:10:27.8293145+00:00"
},
"project_status_id": "784199e1-37f5-45c1-82e9-37852f065f27",
"project_status_code": "sample string 10",
"project_status": {
"id": "0390422b-6b55-4bd4-bfc4-a99517516678",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e61bfe4c-81ad-4273-9297-df0752339c37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00"
},
"company_id": "ae6f6d3e-4002-4907-a582-474697db469c",
"company_code": "sample string 12",
"db_address_id": "01e6cf71-fd4f-47d3-8b57-ee50b9637a26",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "076e5357-cccd-43f3-9dd5-da87bcf1015c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "47d17556-fb52-439f-9e2f-9c8af59007e1",
"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-05-28T20:10:27.8293145+00:00",
"date_create": "2026-05-28T20:10:27.8293145+00:00",
"date_update": "2026-05-28T20:10:27.8293145+00:00",
"updated_by_user_id": "abfa43b7-960a-4835-8436-0bced09dec2d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-28T20:10:27.8293145+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-05-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-28T20:10:27.8293145+00:00",
"date_last_job": "2026-05-28T20:10:27.8293145+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-28T20:10:27.8293145+00:00",
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00",
"is_mobile_installation": true
},
"job_type_id": "3cf41429-0bbe-4b8b-aa93-f1184e2fa15a",
"job_type_code": "sample string 7",
"job_type": {
"id": "9ddd49da-cf5f-4913-9c63-30b1a886f49d",
"name": "sample string 2",
"sales_organization_id": "4218471d-5ae8-4883-9e1e-2c598d295af7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00",
"code": "sample string 7"
},
"job_priority_id": "2f40ebed-43fa-4144-8802-9ff060250d4c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b002da53-6986-419e-ba5f-247c7407f212",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "58f688f7-b990-4547-a241-d3dd5a00a65d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00"
},
"job_status_id": "c3836f1c-ecab-434d-b2d4-3f8f5f21ce73",
"job_status_code": "sample string 11",
"db_address_id": "af1c2fcf-634d-4bf5-8294-7a50ce650da5",
"contact_id": "2e1d9670-c88d-4d18-814d-250e05b101f5",
"requested_by_company_id": "48218fd5-f04c-4f6d-a07c-4aa77e7a4666",
"requested_by_contact_id": "70ecc16b-cee6-4d77-9c20-9097b8403a4c",
"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-05-28T20:10:27.8293145+00:00",
"due_date": "2026-05-28T20:10:27.8293145+00:00",
"date_create": "2026-05-28T20:10:27.8293145+00:00",
"date_update": "2026-05-28T20:10:27.8293145+00:00",
"date_closed": "2026-05-28T20:10:27.8293145+00:00",
"suggested_user_id": "69e0d437-b7e3-4878-87b6-a70d43423914",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "30102436-66c0-4ee1-b675-c9dbd1b616cf",
"db_language_id": "ed3dbdc1-4c99-453f-a7e5-af4933e850f2",
"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-05-28T20:10:27.8293145+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89efe23d-82a1-4171-842d-f6deb7daf165",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "34fb7322-0de4-47ff-be9d-a3eb2bda881f",
"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": "1ca6d0e9-77cc-4a3f-96f9-aa0a50bb72e9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9e14005f-05d0-4713-a155-a9dff86f87d3"
},
"suggested_date_start": "2026-05-28T20:10:27.8293145+00:00",
"skill_id": "cfde6a0d-32f2-4ece-9e42-2289b4355c78",
"skill_code": "sample string 32",
"skill": {
"id": "485baa9e-29d8-4b89-8049-d4e814db06a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "de5cb063-aff9-4334-9dee-347a8c16c682",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "56b4aeed-b749-478e-9cc0-096cb0d9d764",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37f9c85e-6f28-4e61-8219-1776872a0357",
"db_currency_id": "df16d1d1-b86e-4fbe-9637-d68dd5f287ff",
"db_language_id": "f0f17074-141d-4ce1-941c-e1c92b52e622",
"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-05-28T20:10:27.8293145+00:00"
},
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4ba37d48-4721-4646-a9b4-f2ef4149a47b",
"date_reported_by_company": "2026-05-28T20:10:27.8293145+00:00",
"id2": 36,
"company_id": "25fc9b72-df14-486d-aa12-cf7ff58a73a5",
"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": "75edd7ba-199f-4523-814f-f2ba4372d323",
"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-05-28T20:10:27.8293145+00:00"
},
"work_instruction_details_id": "afdf3646-32bf-4d32-a520-1e74cea1aa8e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a5bc942a-cd6b-4149-b42c-8ad987018931",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dd80dd0b-2d44-4c79-b699-d4ce2f1cd276",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-28T20:10:27.8293145+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": "bea3c3f9-b8a7-416a-8950-9184eb47ce72",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-28T20:10:27.8293145+00:00"
}