Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "2aab37d6-d346-4826-93be-18564efc9e2c",
"jobs_id": "421e8850-2977-4021-b052-52bba5900a11",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5b9641b6-7c2b-4cc6-8b1c-b9855bd96b84",
"_parent_id": "41db532e-b975-4b3f-b1e6-7ef5cc180915",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2e9e4d47-9650-47a1-b1d6-0489b82ee162",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e65de89a-1d6c-4a26-977c-27c9536c7d45",
"_parent_id": "425ee6a2-17a5-47f8-aa37-095bf4dcd29c",
"root_parent_id": "df2d2b0f-c609-441d-8f13-ac7f914592a1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f3db92f3-f223-465b-898f-a61c4a615741",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "625bb5b0-5c6f-4724-8c7f-31236f2cda16",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "97fc2f31-16c4-4b1e-9bcd-435213b041d0",
"_parent_code": "sample string 6",
"sales_organization_id": "3e5c3aa7-8443-4412-b63e-44fe64ecfb1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+00:00"
},
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00"
},
"equipment_model_id": "370ab785-9b9e-49f1-9ec5-9fc0765ac8bf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5a6fdbcb-0387-4ca3-98df-9b96a52fdcc8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4d801507-cefb-429b-afcb-a7e7c2cf99b8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ffde198e-7161-483e-9c10-0e2f20b87cad",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9cb1f84d-7aaf-40f9-b3cd-f92dd667a9f1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+00:00"
},
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00"
},
"equipment_family_id": "ea2f5c8b-9958-4d99-ac17-d3facd99e5a1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "625bb5b0-5c6f-4724-8c7f-31236f2cda16",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "97fc2f31-16c4-4b1e-9bcd-435213b041d0",
"_parent_code": "sample string 6",
"sales_organization_id": "3e5c3aa7-8443-4412-b63e-44fe64ecfb1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+00:00"
},
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00"
},
"date_in_production_since": "2026-05-27T14:42:05.2095985+00:00",
"date_out_of_production_since": "2026-05-27T14:42:05.2095985+00:00",
"date_end_support": "2026-05-27T14:42:05.2095985+00:00",
"sales_organization_id": "5d41eabd-ed8a-48d8-bb9d-d1a5c5f9cee9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+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-27T14:42:05.2095985+00:00"
},
"project_status_id": "ba74cf34-8c52-4bf5-af3c-df24e92c24f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "e2168f5b-c1a6-46a8-b740-1fba69d1e3e3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0f2ac0f-0f4b-4e47-8c0d-b9a3978286f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00"
},
"company_id": "919e39b6-5862-449e-8f2b-7c731e7210ee",
"company_code": "sample string 12",
"db_address_id": "6eb1f48c-c115-4e31-9f62-177c566bdf6e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1077e327-4025-4822-b685-93f7ba04c4a5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5fa38449-6cf7-4508-8850-4b29822d684e",
"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-27T14:42:05.2095985+00:00",
"date_create": "2026-05-27T14:42:05.2095985+00:00",
"date_update": "2026-05-27T14:42:05.2095985+00:00",
"updated_by_user_id": "2b7a0cae-4e1f-408f-82f6-c397e68d840e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-27T14:42:05.2095985+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-27T14:42:05.2095985+00:00",
"date_last_job": "2026-05-27T14:42:05.2095985+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-27T14:42:05.2095985+00:00",
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00",
"is_mobile_installation": true
},
"job_type_id": "62bcfadb-fcb5-4b24-adbb-b5f5f8302f23",
"job_type_code": "sample string 7",
"job_type": {
"id": "2c8116d0-51dd-41b8-a5f8-6a5115d8b4c3",
"name": "sample string 2",
"sales_organization_id": "5594f50f-187d-4faa-8661-7752fbf8c438",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00",
"code": "sample string 7"
},
"job_priority_id": "8ee99852-019d-4a9f-b01e-a7de58533001",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "757a7b50-6f80-4269-bea1-62cf0b55f4ee",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7c29ef7c-0905-4aa8-b157-bade0710b59d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00"
},
"job_status_id": "d348347d-d13d-4a96-9705-a8a8dead9c96",
"job_status_code": "sample string 11",
"db_address_id": "c5d2ff5b-d0c3-44aa-b5ab-560ad91ab303",
"contact_id": "81b1e04a-ae12-46c1-bc35-8c7dcf48b137",
"requested_by_company_id": "8fbc117b-1aaf-41d0-9d69-266df4b6657d",
"requested_by_contact_id": "b2c6c5ac-e9b0-4f18-adbe-bca6f4b4bfbd",
"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-27T14:42:05.2095985+00:00",
"due_date": "2026-05-27T14:42:05.2095985+00:00",
"date_create": "2026-05-27T14:42:05.2095985+00:00",
"date_update": "2026-05-27T14:42:05.2095985+00:00",
"date_closed": "2026-05-27T14:42:05.2095985+00:00",
"suggested_user_id": "ab1fef0d-5599-468c-8000-bc02be308e38",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "063d1fc4-86c0-4d8c-9128-05b6569d0ead",
"db_language_id": "db59b179-9b06-42f6-9fb3-7d9bbef5f0d3",
"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-27T14:42:05.2095985+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b725603e-fe36-451b-a077-8262a18c7d89",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c3abf8d8-dee9-4a54-9372-8afe4a36eeb7",
"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": "0a817bbb-5fdc-466b-b8d4-9657a9641c82",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "837b7b68-3c6b-4df7-8423-169c120eeb71"
},
"suggested_date_start": "2026-05-27T14:42:05.2095985+00:00",
"skill_id": "80f99fe6-2870-41b3-8441-1711736d3ef2",
"skill_code": "sample string 32",
"skill": {
"id": "f6425d26-bfa0-4f79-bb81-6507fd82a0d2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7dc4f5d5-3993-4504-bc1b-af039c01f0f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7716f98-84d4-497a-9d49-8de46f09077c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a045b22-b2e0-4e4f-96b3-4a553cd5ee33",
"db_currency_id": "57fa2fc8-ac0f-474a-9b93-63c62eb2f082",
"db_language_id": "e7a4ff87-0e03-4cb1-8b06-99bff37888fc",
"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-27T14:42:05.2095985+00:00"
},
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b1bec9cd-6688-4fe0-891c-9d612eb4e1c3",
"date_reported_by_company": "2026-05-27T14:42:05.2095985+00:00",
"id2": 36,
"company_id": "2d4a1c63-247f-4e24-8686-68a9e5e72358",
"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": "0e8ac2e3-242c-47ea-85e9-b29c23b413e5",
"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-27T14:42:05.2095985+00:00"
},
"work_instruction_details_id": "bad372d7-0ccc-4b6b-ac20-b5e4e6056a43",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "25105a1a-018a-4169-9870-53991d55e4b8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "be3f5479-3691-47bf-a41f-d6bbf2db3804",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-27T14:42:05.2095985+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": "35d06ff5-b70a-4933-8be2-7c3c45ebd9eb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-27T14:42:05.2095985+00:00"
}