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": "d2df69b6-fe3f-4449-a4dc-efb8226cc797",
"jobs_id": "1c3d995a-431d-4cb8-8e29-a023530310d5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "517c385e-52d3-4040-ab62-613f49633fb8",
"_parent_id": "35f465d6-0a05-425f-9708-75ed07ef6a3c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "84a73449-baad-4a86-948e-23f98e3f68f2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2f101c10-830d-4bb9-859a-bd94e486575d",
"_parent_id": "6e0a1828-8811-4a27-8226-c172a74b0bf8",
"root_parent_id": "c7b6a7e4-962f-449e-9366-3a2c6b0facd1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dbc3f75c-c752-4108-88c3-3ebe4bd058fd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "009d7058-436c-4d84-8475-b353e7ca769d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5fac8169-e857-44c1-ae17-3a3ce63f6e50",
"_parent_code": "sample string 6",
"sales_organization_id": "fddf3d7c-9a63-4de1-bd3e-6fc5a839c1f7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+00:00"
},
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00"
},
"equipment_model_id": "468a26df-e072-4884-be2e-ce08f50e3934",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a3263cee-21ae-4c56-9e52-2a2aa631b198",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8ae8d44a-d759-4e7e-bea9-af87b85d9496",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "82509aa7-0041-45e8-b8b3-e0dbc1db7ec4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "22ebb464-bcdf-471c-ac58-dd4d4f3c46d3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+00:00"
},
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00"
},
"equipment_family_id": "def90d4f-c762-4746-be89-5c92196ad685",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "009d7058-436c-4d84-8475-b353e7ca769d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5fac8169-e857-44c1-ae17-3a3ce63f6e50",
"_parent_code": "sample string 6",
"sales_organization_id": "fddf3d7c-9a63-4de1-bd3e-6fc5a839c1f7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+00:00"
},
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00"
},
"date_in_production_since": "2025-12-10T15:04:50.210234+00:00",
"date_out_of_production_since": "2025-12-10T15:04:50.210234+00:00",
"date_end_support": "2025-12-10T15:04:50.210234+00:00",
"sales_organization_id": "37b985ae-c9ef-4b54-b0f8-b929535fcf36",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+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-10T15:04:50.210234+00:00"
},
"project_status_id": "f16a54f9-007a-465a-8826-266511a7c8bc",
"project_status_code": "sample string 10",
"project_status": {
"id": "b3f23476-48af-4170-bfdd-33b1fdc7cf3a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3a21add6-a071-40cb-b33f-a1f1f41aa5e1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00"
},
"company_id": "16aecfe4-4d5e-4675-8825-dbe1821fd1f5",
"company_code": "sample string 12",
"db_address_id": "174f1600-2583-413d-80d9-f3f04d2c169f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "71366803-9f07-4557-ada1-d8a080b44d1b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "962d115e-279a-44d6-9d3f-ac19a86d5d94",
"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-10T15:04:50.210234+00:00",
"date_create": "2025-12-10T15:04:50.210234+00:00",
"date_update": "2025-12-10T15:04:50.210234+00:00",
"updated_by_user_id": "1491947c-729c-4d9b-82b9-da1e0b690e9f",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-10T15:04:50.210234+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-10T15:04:50.210234+00:00",
"date_last_job": "2025-12-10T15:04:50.210234+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-10T15:04:50.210234+00:00",
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00",
"is_mobile_installation": true
},
"job_type_id": "d12f6ba4-0771-465e-a7c1-6a8ab235bc14",
"job_type_code": "sample string 7",
"job_type": {
"id": "9deff5f7-66e9-4baf-8336-e9e163269281",
"name": "sample string 2",
"sales_organization_id": "9b618303-65c3-45b0-8e91-066c75c92e25",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00",
"code": "sample string 7"
},
"job_priority_id": "5ed91d4e-6b09-4283-98ba-91277e07008d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fab43b09-dd27-49d5-aeae-8160e93c8bac",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "16f98e8f-aaf6-4b60-8df7-791c43e24dbd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00"
},
"job_status_id": "cdb1d595-a647-49ca-9f7d-b36c8df8acbc",
"job_status_code": "sample string 11",
"db_address_id": "061bb1c0-3079-47a1-9279-9c837b6b8e4e",
"contact_id": "4df29bec-2cd6-447b-a2b0-81e3cfc7c9e1",
"requested_by_company_id": "c9d971dd-b654-47e9-93f4-2c93e293b36e",
"requested_by_contact_id": "f1ea7521-3b7b-4dfb-b60c-89a8dabb486f",
"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-10T15:04:50.210234+00:00",
"due_date": "2025-12-10T15:04:50.210234+00:00",
"date_create": "2025-12-10T15:04:50.210234+00:00",
"date_update": "2025-12-10T15:04:50.210234+00:00",
"date_closed": "2025-12-10T15:04:50.210234+00:00",
"suggested_user_id": "a5e45723-6abf-4ee5-857d-655906bc5f69",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "91291a23-d912-47fe-a5f0-eccdb254a443",
"db_language_id": "8d6f27b4-de62-4047-ab1d-d9af674e1e4b",
"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-10T15:04:50.210234+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9778e576-a973-466d-8893-5b4dcaed09f4",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5ffe3f7e-111f-4e49-a50b-179832ebeb2c",
"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": "c1affd95-bab1-4c5e-8271-4e069682a383",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0d6bbd8c-8cf5-4d0d-a450-9753d71d26eb"
},
"suggested_date_start": "2025-12-10T15:04:50.210234+00:00",
"skill_id": "316fb6b7-43f5-4149-9103-2681291b9fc7",
"skill_code": "sample string 32",
"skill": {
"id": "d9286852-88d7-49c4-9869-599c0ea1f55a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1bdbc0e8-cf7d-40b9-975e-c94ef3eeb0af",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96ee3d3a-1321-4246-a42f-e9f5255d960a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63f39f0d-4f74-4bb0-b97c-fbf13dfa3f64",
"db_currency_id": "9e0cc5d3-ff4c-4698-bdd5-009f4eb4c651",
"db_language_id": "03ab86eb-5923-4388-9365-2a1e03dbff82",
"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-10T15:04:50.210234+00:00"
},
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "747f0a3e-8974-493c-8071-066386e5e01e",
"date_reported_by_company": "2025-12-10T15:04:50.210234+00:00",
"id2": 36,
"company_id": "6ae0e36c-aa44-4ac7-a263-0dffac2a8948",
"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": "2dcacc2b-4a3c-477e-b31f-b40c738e676e",
"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-10T15:04:50.210234+00:00"
},
"work_instruction_details_id": "d9c89cbe-9b60-4487-a85f-db53ff608c81",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "68f83e29-6f8f-4c4e-b0ac-9603bcd87461",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "39988dd8-8bff-4e7d-b0d3-5815bea37f56",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-10T15:04:50.210234+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": "28e20d11-04e8-450c-85fc-96e037eebf43",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-10T15:04:50.210234+00:00"
}