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": "e116d2af-3846-4498-906d-b9325f23583c",
"jobs_id": "ea29be8e-9c0d-4f6e-b992-95a67fdb6c0e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "550ed15d-65f6-495d-b39c-a288eaaa90c4",
"_parent_id": "31d06531-94a9-474f-bf1b-6c5ccb30fdf2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4b899779-583a-433f-890b-d89fb902086f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fb377814-c272-4a66-9d51-51191fe7a75a",
"_parent_id": "846ad80b-a9ce-400f-81e4-6a97451bbc1f",
"root_parent_id": "69c1d939-7474-471c-9fad-20085a51609f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "577e7071-e52c-4297-8d5f-47af0fb32180",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4410b776-5379-4ab5-9184-a3278e59d703",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46411c28-4222-4001-9c8c-d28e45143f94",
"_parent_code": "sample string 6",
"sales_organization_id": "6e1869d2-d7d4-4886-b899-2f5bded1d928",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+00:00"
},
"modified_dateutc": "2026-08-27T15:54:38.678386+00:00"
},
"equipment_model_id": "d25f5325-10e3-474d-a2d9-76effc5ff21a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f838dccb-375b-425d-9628-33ce2da51520",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eb2ec803-01f8-41b9-b1a9-6cb0080aaefa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d5d9c10c-6e9f-4827-93ab-02a5502074bb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ded0130e-aea9-4104-9efa-a9014ac0de2c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+00:00"
},
"modified_dateutc": "2026-08-27T15:54:38.678386+00:00"
},
"equipment_family_id": "e2eff31c-b15e-453e-a8df-ef1971a55370",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4410b776-5379-4ab5-9184-a3278e59d703",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46411c28-4222-4001-9c8c-d28e45143f94",
"_parent_code": "sample string 6",
"sales_organization_id": "6e1869d2-d7d4-4886-b899-2f5bded1d928",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+00:00"
},
"modified_dateutc": "2026-08-27T15:54:38.678386+00:00"
},
"date_in_production_since": "2026-08-27T15:54:38.678386+00:00",
"date_out_of_production_since": "2026-08-27T15:54:38.678386+00:00",
"date_end_support": "2026-08-27T15:54:38.678386+00:00",
"sales_organization_id": "0648e0d8-8219-436f-aed5-7ce19b63a200",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+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-27T15:54:38.678386+00:00"
},
"project_status_id": "ce63750f-cdb4-4ff6-a68b-5e0e07954a02",
"project_status_code": "sample string 10",
"project_status": {
"id": "d04d8e9e-2d94-4450-809d-02c498894d94",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ec0c8631-8791-4542-b2a7-5f76730bdcb3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T15:54:38.6940076+00:00"
},
"company_id": "b0ba398e-f58a-4c4a-8037-5fca9738472b",
"company_code": "sample string 12",
"db_address_id": "a852cd9e-1b42-46ea-b460-c89f3bdb0a1b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7a6cde31-a036-4a04-a944-871c3d057bcf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b67df415-ee3d-41b6-a307-2a5dcea67b37",
"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-27T15:54:38.6940076+00:00",
"date_create": "2026-08-27T15:54:38.6940076+00:00",
"date_update": "2026-08-27T15:54:38.6940076+00:00",
"updated_by_user_id": "60bf5145-3f06-4528-bc2b-e526313dead0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-27T15:54:38.6940076+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-27T15:54:38.6940076+00:00",
"date_last_job": "2026-08-27T15:54:38.6940076+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-27T15:54:38.6940076+00:00",
"modified_dateutc": "2026-08-27T15:54:38.6940076+00:00",
"is_mobile_installation": true
},
"job_type_id": "48d1bd3e-57ec-49ea-9b7a-6f97f763df3a",
"job_type_code": "sample string 7",
"job_type": {
"id": "691954cd-ced7-4c9f-987e-30a368667049",
"name": "sample string 2",
"sales_organization_id": "3ee285ad-e1e3-4a7b-9a4f-c9b078faf151",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-27T15:54:38.6940076+00:00",
"code": "sample string 7"
},
"job_priority_id": "25f2f552-6631-4f10-a357-56566e8a6f2b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8ac48861-d6e4-46a4-944c-19baa29e196f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c817cbbf-570b-4613-9549-16b987ae8797",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T15:54:38.6940076+00:00"
},
"job_status_id": "f9ea2063-f657-4bb3-9e5a-6e3894517247",
"job_status_code": "sample string 11",
"db_address_id": "ff9931cd-14ea-4400-8e0b-27d9681f5e59",
"contact_id": "ef42cd55-6bcf-4e34-abc1-81f1c8b84f0e",
"requested_by_company_id": "ecc435b5-c66a-4e4b-bd2b-ea03a752c1ea",
"requested_by_contact_id": "1a872289-0e42-4e4c-b458-8320d4539b96",
"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-27T15:54:38.6940076+00:00",
"due_date": "2026-08-27T15:54:38.6940076+00:00",
"date_create": "2026-08-27T15:54:38.6940076+00:00",
"date_update": "2026-08-27T15:54:38.6940076+00:00",
"date_closed": "2026-08-27T15:54:38.6940076+00:00",
"suggested_user_id": "b96c150a-f090-4195-a982-0fddbcb8fb62",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "58d766a7-b5f8-4de9-82d9-b3fe5509fe17",
"db_language_id": "42f5382b-b4c4-4c44-82f3-8f5dde95b568",
"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-27T15:54:38.6940076+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ef36ddf7-d387-4924-bdd1-0719bcd7e431",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d120429a-d356-4e8c-9393-3e013685e107",
"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": "bc530679-ac0b-4a0f-bc62-c0dfa4569faf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-27T15:54:38.6940076+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "be152305-ceec-4801-8e87-8271a9161c68"
},
"suggested_date_start": "2026-08-27T15:54:38.6940076+00:00",
"skill_id": "6347efd2-b57b-472f-90d8-e600327bfde1",
"skill_code": "sample string 32",
"skill": {
"id": "b4e992fa-026a-4e03-a955-19e7d8b0c5c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9351a079-fce2-4a3e-955b-313bea53918a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb918680-9e8f-470f-9f3f-b4a7510c6238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04186c8-3e90-42f2-aa68-c64184ee065e",
"db_currency_id": "ceec5558-c782-4f5f-bab7-57140b6370ac",
"db_language_id": "7f0b27c1-83de-423c-b541-88fcce1ec0fc",
"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-27T15:54:38.678386+00:00"
},
"modified_dateutc": "2026-08-27T15:54:38.6940076+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2d2dbc10-66dc-472b-9b58-c86fe7d8ad78",
"date_reported_by_company": "2026-08-27T15:54:38.6940076+00:00",
"id2": 36,
"company_id": "da949021-5832-4861-8e63-aa9fea931c37",
"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": "d536cf05-9522-4c8b-bdf6-689c5a048797",
"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-27T15:54:38.6940076+00:00"
},
"work_instruction_details_id": "b766507d-1d5c-45b5-8678-3b129fd27864",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ce5ca4ae-13c5-459d-8137-be34d97c769b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4bdb9ed4-29da-4d82-a947-7fda75c2c924",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-27T15:54:38.6940076+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": "a9a79287-7b52-4e80-b635-b74fed58d7cf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-27T15:54:38.6940076+00:00"
}