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": "b8093a7e-e58f-4470-a4db-e1f23f0ecb67",
"jobs_id": "28686677-1501-4400-a3a3-9e6b9e508e13",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aab1359b-9edc-4aef-a0aa-6e84304b8d93",
"_parent_id": "0b964c5d-56d6-4e4d-a07a-7ea448dd0037",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e257cad9-2d1f-4d23-ae6c-4f335bd8372a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "577bd050-8eaa-454e-befd-6bdd96f6a4a1",
"_parent_id": "716b4de4-5204-4176-a3b7-0324bd076dee",
"root_parent_id": "a8ca8d03-7e4e-4d84-8e2a-ff58d56b0cf7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5aa6ac08-ae2e-44ed-a088-b5a7fe0a4c69",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7def62e2-c48b-49dc-baca-9e76a5fe5ed9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f07a0fc3-33d5-4188-85ed-c488bab64236",
"_parent_code": "sample string 6",
"sales_organization_id": "01e85d45-88e5-4636-9ff0-833360192208",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+00:00"
},
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00"
},
"equipment_model_id": "65ea32fd-88a4-4b9c-9bc5-a7a04c1dd2aa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8b9a96a2-d11c-455c-9de4-e4ca70478177",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1a08400f-7e20-4c9b-ad16-fb5f140d980d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b289980d-c60e-47b7-89b1-23fc6a74118c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b7526692-ff6d-425d-b1e7-57b9cc883fc5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+00:00"
},
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00"
},
"equipment_family_id": "bc7cc358-011f-4561-b3d2-fbff2e3f250c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7def62e2-c48b-49dc-baca-9e76a5fe5ed9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f07a0fc3-33d5-4188-85ed-c488bab64236",
"_parent_code": "sample string 6",
"sales_organization_id": "01e85d45-88e5-4636-9ff0-833360192208",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+00:00"
},
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00"
},
"date_in_production_since": "2026-08-31T15:42:16.7943191+00:00",
"date_out_of_production_since": "2026-08-31T15:42:16.7943191+00:00",
"date_end_support": "2026-08-31T15:42:16.7943191+00:00",
"sales_organization_id": "07aeb05c-ed25-4e3b-82d1-ff0ab3ac9cab",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+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-08-31T15:42:16.7943191+00:00"
},
"project_status_id": "39591e60-c131-4581-8322-e48e1c3340ab",
"project_status_code": "sample string 10",
"project_status": {
"id": "5abf8712-b7f7-402f-ba3b-d713128cd0a1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6d4c01e8-1971-4aed-b684-e3b79599ab0c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00"
},
"company_id": "ae5edb90-3ec4-42e9-9ce5-500efd5c01c3",
"company_code": "sample string 12",
"db_address_id": "e46d46d0-6d0d-452d-b317-170b9a53e5ad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2975edd8-3ecf-4645-8170-934102bfdf8d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3fdd6a62-7971-4993-8126-3c7cacc5096e",
"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-08-31T15:42:16.7943191+00:00",
"date_create": "2026-08-31T15:42:16.7943191+00:00",
"date_update": "2026-08-31T15:42:16.7943191+00:00",
"updated_by_user_id": "217b5ac6-8f67-4d6c-9387-04447686adab",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-31T15:42:16.7943191+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-08-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-31T15:42:16.7943191+00:00",
"date_last_job": "2026-08-31T15:42:16.7943191+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-31T15:42:16.7943191+00:00",
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00",
"is_mobile_installation": true
},
"job_type_id": "cc880574-1885-4cde-96bd-3a275c043f46",
"job_type_code": "sample string 7",
"job_type": {
"id": "4e6e188d-5979-4a42-9963-e3110a399014",
"name": "sample string 2",
"sales_organization_id": "81789726-5b48-47f5-b7b8-89b6dc590230",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00",
"code": "sample string 7"
},
"job_priority_id": "1b9ecef9-b9cc-452b-ac6c-cf01628beb27",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4e4eea16-221e-4e5f-ab66-cf01e70c1bda",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d6d3efda-79dd-4a6f-a10d-27c57cbc2930",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00"
},
"job_status_id": "81bb26b7-62ee-425e-b77c-eda4d7288e1c",
"job_status_code": "sample string 11",
"db_address_id": "cf342314-c893-45a1-a9ce-945501cfaa18",
"contact_id": "0be43472-3a66-4044-8e43-6dd0b6335443",
"requested_by_company_id": "9e63d761-2913-4832-9b9b-d0ea062b0544",
"requested_by_contact_id": "7212f41b-eb9d-4fd9-83db-2b6a887d8d99",
"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-08-31T15:42:16.7943191+00:00",
"due_date": "2026-08-31T15:42:16.7943191+00:00",
"date_create": "2026-08-31T15:42:16.7943191+00:00",
"date_update": "2026-08-31T15:42:16.7943191+00:00",
"date_closed": "2026-08-31T15:42:16.7943191+00:00",
"suggested_user_id": "a1971b49-1fc6-4c4b-b90a-a51bac195540",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7f677598-c838-470e-aace-08024501f630",
"db_language_id": "1d101f1e-4a86-4fb1-b4a3-edfd06e35f52",
"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-08-31T15:42:16.7943191+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b0cc23f5-8153-4670-959d-68017b503338",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "72286fbd-ff1f-41ee-8360-6f8395bd12c3",
"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": "ec1cb5bc-ebbc-4bb0-bca9-8d22ac45bf24",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "71eb66b1-e213-46a3-b449-19244e4f0426"
},
"suggested_date_start": "2026-08-31T15:42:16.7943191+00:00",
"skill_id": "f70208f2-8223-423c-a86a-cf28155cd46a",
"skill_code": "sample string 32",
"skill": {
"id": "d1a10ac0-bf63-435e-9167-446583cfe6f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "780ecb9c-0431-49ff-97a5-6ca7c2d99236",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "280deae4-ed38-47e2-8ecc-ea75fb78247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb6aa2dc-1b8d-4c56-b89b-51a39835ab9d",
"db_currency_id": "3a4c0cd8-1a75-494e-8522-1df9b468a44d",
"db_language_id": "1f4dc770-d5ef-478a-95ee-5e3a5ac0cac6",
"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-08-31T15:42:16.7943191+00:00"
},
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "13dadefe-8758-4e11-8289-94f1cf6a31b7",
"date_reported_by_company": "2026-08-31T15:42:16.7943191+00:00",
"id2": 36,
"company_id": "518e2c2e-5f60-4918-bdf5-382e6b174122",
"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": "0972aa78-931f-42af-9142-fa77b23292ff",
"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-08-31T15:42:16.7943191+00:00"
},
"work_instruction_details_id": "a49fdc4c-7cd5-4bb5-9be8-53c02cac3620",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6e7b8514-7c77-4994-816d-ea1e4f4971ad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bf13b5fa-e6ad-4f67-8823-4fb179726ed6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-31T15:42:16.7943191+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": "1636ad0a-f3d5-4c0d-9414-0e2304277ffa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-31T15:42:16.7943191+00:00"
}