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": "9a6304e7-b31b-4103-80e5-d62b71bd5aea",
"jobs_id": "65df8b2c-3458-4185-b0e3-c6c5b3650e9d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9827714c-4a0a-44b1-be5e-73d3840ab3c7",
"_parent_id": "a4752154-795e-4425-823f-1763d8c2ee0f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b2c1a356-f254-4eb7-8fb9-5e680db1d715",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c8b891f4-cb79-4efd-93bc-5c0cca618acb",
"_parent_id": "58efab5b-d477-49c7-b915-8cb8c6551b9d",
"root_parent_id": "f287ac99-d3c0-41ff-9498-836ea9dd7f1d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "37eabd98-bd4c-418a-873a-d9fb412189b5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8c0ea557-4859-4af0-b5c0-437be5f8b53d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "43a8959c-8090-4cae-9257-15c438df6bcc",
"_parent_code": "sample string 6",
"sales_organization_id": "2be9a1e2-7159-4605-ad9f-8aac5d16a8ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+00:00"
},
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00"
},
"equipment_model_id": "fba84dde-16e9-4a16-bea5-2a9f25f57a17",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b3da2a0a-d10b-48f2-9504-99d8ab160ff7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "51cc3a0d-7316-4a97-ace7-884633028ae1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0dea9444-ccee-49dd-9161-6769d92e3da4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "63aa1a3a-66a5-4d8a-aea3-67da8d926c8c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+00:00"
},
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00"
},
"equipment_family_id": "e05d7af3-5f84-4d65-9e1f-133efe913a14",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8c0ea557-4859-4af0-b5c0-437be5f8b53d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "43a8959c-8090-4cae-9257-15c438df6bcc",
"_parent_code": "sample string 6",
"sales_organization_id": "2be9a1e2-7159-4605-ad9f-8aac5d16a8ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+00:00"
},
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00"
},
"date_in_production_since": "2026-07-28T11:59:35.9032266+00:00",
"date_out_of_production_since": "2026-07-28T11:59:35.9032266+00:00",
"date_end_support": "2026-07-28T11:59:35.9032266+00:00",
"sales_organization_id": "c9a52db4-8544-4064-af47-7bc567b10e35",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+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-07-28T11:59:35.9032266+00:00"
},
"project_status_id": "1dfe66a7-9cf8-4a1a-950e-6c05cec573d7",
"project_status_code": "sample string 10",
"project_status": {
"id": "0142fe39-883a-4d24-b8a7-b76b57fb86d8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "795ae1de-9ad2-497f-9304-108a2a5194e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00"
},
"company_id": "684ac361-a804-43af-ad69-d36273bd482a",
"company_code": "sample string 12",
"db_address_id": "bfd2f687-6655-4a00-b1e2-6462a6a41099",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f82c4233-e5f7-4447-b4d8-8be4dc51d7c2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "55146cca-2ab1-44f9-88af-410d32a04624",
"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-07-28T11:59:35.9032266+00:00",
"date_create": "2026-07-28T11:59:35.9032266+00:00",
"date_update": "2026-07-28T11:59:35.9032266+00:00",
"updated_by_user_id": "35331841-116a-4483-ba83-fed25658053b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-28T11:59:35.9032266+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-07-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-28T11:59:35.9032266+00:00",
"date_last_job": "2026-07-28T11:59:35.9032266+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-28T11:59:35.9032266+00:00",
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00",
"is_mobile_installation": true
},
"job_type_id": "62799339-ba19-4a40-9f2e-134cdd74b37c",
"job_type_code": "sample string 7",
"job_type": {
"id": "fbc9ab8a-1d42-4b90-987d-30644445ad7f",
"name": "sample string 2",
"sales_organization_id": "4a4b205a-78b6-4b5e-a631-9d6bd9ec245d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00",
"code": "sample string 7"
},
"job_priority_id": "f3fc2007-59ec-4ff4-abc7-52c7658141a9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dab620f8-7053-4130-99f1-8bad5c2f3df0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "56af9542-b93f-4211-850c-0279cf1a3c53",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00"
},
"job_status_id": "db9e3042-3db1-409e-bb47-c9ffbdc59de3",
"job_status_code": "sample string 11",
"db_address_id": "3750a77e-0cf4-42b3-8c56-0a0d029412f7",
"contact_id": "bb42b0e6-75f3-43af-a2d1-375ccaf09bd9",
"requested_by_company_id": "2649f118-6b18-4c7b-b116-1ce50268798e",
"requested_by_contact_id": "920c9279-28f1-491d-bf93-7ff92202aecd",
"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-07-28T11:59:35.9032266+00:00",
"due_date": "2026-07-28T11:59:35.9032266+00:00",
"date_create": "2026-07-28T11:59:35.9032266+00:00",
"date_update": "2026-07-28T11:59:35.9032266+00:00",
"date_closed": "2026-07-28T11:59:35.9032266+00:00",
"suggested_user_id": "0a48ae1f-cb14-474a-aca2-b8647bf79ef9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d15a3730-6c12-4f85-bcc2-288d3834b7c6",
"db_language_id": "c02613ec-e28b-43e9-bba7-74e9bf4e9098",
"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-07-28T11:59:35.9032266+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6ce4b123-86bb-43d5-910a-821cd6297dc6",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b45035a6-3a58-4bb6-ba39-16ad3c97983b",
"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": "69463bc2-ec2b-4742-ab52-ce7c72553a7e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "10439403-8b77-4c37-9e99-41488e804eaa"
},
"suggested_date_start": "2026-07-28T11:59:35.9032266+00:00",
"skill_id": "ca6dc954-6baf-4bab-b068-f6221686b083",
"skill_code": "sample string 32",
"skill": {
"id": "2e59ce45-eff3-474c-b1ca-b789b97aad16",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "049f55c7-8822-485c-9e91-208186153973",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "acfdd798-6476-45e2-b312-026352137ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af04d86f-9586-40e5-afd2-bd1641236ab2",
"db_currency_id": "0da815ef-868a-4fd8-b8a2-bc949a53a5b1",
"db_language_id": "acc3c4db-b536-46f0-af67-d842c5955073",
"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-07-28T11:59:35.9032266+00:00"
},
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "420f45d8-5385-4e9a-a82b-db5508a74de3",
"date_reported_by_company": "2026-07-28T11:59:35.9032266+00:00",
"id2": 36,
"company_id": "ee43bdf1-cc1f-49ab-b43a-19fc4f65cb58",
"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": "0bf311ef-0a89-4cb3-ac37-39648367314f",
"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-07-28T11:59:35.9032266+00:00"
},
"work_instruction_details_id": "e58ac9da-f175-456c-aef5-fffd841d5faf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "60955fdb-803f-4cd3-9f96-41a97b981d80",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "117d6b9f-345c-4164-b323-d0da0f019892",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-28T11:59:35.9032266+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": "6ec7a0bd-177b-4af5-83ea-47441a6a814d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-28T11:59:35.9032266+00:00"
}