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": "906869b2-142f-4af3-a245-2bf45f9282b4",
"jobs_id": "312c75b1-5266-42c5-b5b7-136dcdd819c0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "16b081c7-2998-48dc-9e81-865d38c71415",
"_parent_id": "00fab344-3569-4098-b104-a4f1eebf48ca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b990a501-8862-49b8-8b9b-3e8772c79d5b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "82d6f555-3d48-4b5d-9fb7-e9d48ec49cc0",
"_parent_id": "40b8d48f-eeb8-4a7b-939a-382ea477df2d",
"root_parent_id": "ba63e599-d99b-4d51-8ba4-5318f5732565",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6285bf73-30f0-4760-981f-d5a88923f3b2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9b4d06f3-2769-4418-bcfb-25e680244c17",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cde66b4a-c3db-4a28-af8b-dd707672b1ad",
"_parent_code": "sample string 6",
"sales_organization_id": "4399f33b-8390-48bc-8b37-13b0ad72288d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+00:00"
},
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00"
},
"equipment_model_id": "5425fb50-c334-4da8-a72b-6a0c0d9c385d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "449ca5ac-af83-4bb2-9988-c297825832e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2f57c985-c873-4196-a275-24f066268fd8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "483dfe48-d935-46d4-bfc0-829ed295b913",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "be0e997f-73ff-4fde-9f4d-47e431cad1b6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+00:00"
},
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00"
},
"equipment_family_id": "59f462ff-f932-41b9-864f-5ba13b56d386",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9b4d06f3-2769-4418-bcfb-25e680244c17",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cde66b4a-c3db-4a28-af8b-dd707672b1ad",
"_parent_code": "sample string 6",
"sales_organization_id": "4399f33b-8390-48bc-8b37-13b0ad72288d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+00:00"
},
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00"
},
"date_in_production_since": "2026-07-25T15:30:57.3251261+00:00",
"date_out_of_production_since": "2026-07-25T15:30:57.3251261+00:00",
"date_end_support": "2026-07-25T15:30:57.3251261+00:00",
"sales_organization_id": "11824d1e-8aa6-43df-b98f-4bec11fd2612",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+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-25T15:30:57.3251261+00:00"
},
"project_status_id": "56ab3a9f-dfe2-43cf-b544-66c40887c68e",
"project_status_code": "sample string 10",
"project_status": {
"id": "a1e01522-327d-4426-ac5c-cb73abb82216",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8858b83e-580e-4b7f-a3b1-9b4552b22ab3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00"
},
"company_id": "fd828428-519c-4713-8454-1dba78f26480",
"company_code": "sample string 12",
"db_address_id": "3106f4ff-a832-470c-aaa8-017959f2c0ef",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "49285af3-5ac8-4acf-a0b3-ea2776f1f86b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e595d9c6-7462-49d8-a34b-edfab2582abc",
"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-25T15:30:57.3251261+00:00",
"date_create": "2026-07-25T15:30:57.3251261+00:00",
"date_update": "2026-07-25T15:30:57.3251261+00:00",
"updated_by_user_id": "de989668-423d-40bb-acbb-034a6144b3c0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-25T15:30:57.3251261+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-25T15:30:57.3251261+00:00",
"date_last_job": "2026-07-25T15:30:57.3251261+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-25T15:30:57.3251261+00:00",
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00",
"is_mobile_installation": true
},
"job_type_id": "4f3c0ff2-0ffc-42d1-9b56-90d72cb997f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "ae2c211a-0003-4100-bcff-091d9438deac",
"name": "sample string 2",
"sales_organization_id": "c4006710-76cf-4285-964e-03dea5c8644e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00",
"code": "sample string 7"
},
"job_priority_id": "442e6e82-dc94-4bac-9170-6c2fe5485c62",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "99af5f9f-a4c1-407f-9b9c-9af9d3438060",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d9f2480-8f8e-4299-93db-ed22d3e24dbd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00"
},
"job_status_id": "e95eaaea-eb1d-4835-bce6-6971d9b7910d",
"job_status_code": "sample string 11",
"db_address_id": "8b43c027-ebb9-4a56-8c76-e922ab07cb2d",
"contact_id": "faa5d9e9-9083-4c1f-9430-8c8892b7c7e7",
"requested_by_company_id": "a6ef2bda-90d6-41c9-bb93-e3c10b7c5a3d",
"requested_by_contact_id": "6864ea99-5ba2-46ff-b26c-e813b31f4f69",
"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-25T15:30:57.3251261+00:00",
"due_date": "2026-07-25T15:30:57.3251261+00:00",
"date_create": "2026-07-25T15:30:57.3251261+00:00",
"date_update": "2026-07-25T15:30:57.3251261+00:00",
"date_closed": "2026-07-25T15:30:57.3251261+00:00",
"suggested_user_id": "bf4352ed-ea95-44e4-a4b8-9345beb183aa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e0cc374b-8a9f-490e-a817-4b23ccb2fdb3",
"db_language_id": "1eac2ff5-8363-4ab1-bf06-4bc0c34bdbb5",
"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-25T15:30:57.3251261+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a7dddf49-1b64-479c-b5d5-b8bb01a89103",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "061947dc-b956-4e3a-baa1-3bda4b0241a8",
"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": "a833537c-9e5e-4a33-ad06-f0065bea3c1b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5c6d3854-605e-405c-94a1-7044cfc6c6df"
},
"suggested_date_start": "2026-07-25T15:30:57.3251261+00:00",
"skill_id": "019ef1ae-f0b7-447f-98e7-f76d190a9aa8",
"skill_code": "sample string 32",
"skill": {
"id": "256b87ca-45d5-45c0-9159-ec5d1d4d0efb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fb73feea-7862-41d8-a1a7-7608a40a5f01",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d51f47c8-ca71-446d-bf13-4a46d9317b01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c8b8cd8-aeae-4036-b89a-e4109f6cb5a3",
"db_currency_id": "4ebf717a-afaf-4625-9b90-51d4c20e74d2",
"db_language_id": "4ceef6da-2074-4b95-80f1-a517c7c7f182",
"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-25T15:30:57.3251261+00:00"
},
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f8dfd745-a63d-43b0-8d83-94eef3728c50",
"date_reported_by_company": "2026-07-25T15:30:57.3251261+00:00",
"id2": 36,
"company_id": "490a2be7-fd49-4f06-8616-aeb3a160b3d8",
"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": "5cb5efa0-a702-4464-b3f4-377feaa8dd2c",
"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-25T15:30:57.3251261+00:00"
},
"work_instruction_details_id": "24a275af-b0e9-442c-ad16-3eaf0b77b19c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c08fdea4-b9a3-4606-aba0-22c3d72e6416",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "653487b7-476e-4c69-9ff2-a8c6d7b38bac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-25T15:30:57.3251261+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": "d92422cd-da74-4638-9800-9c79f460f3ad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-25T15:30:57.3251261+00:00"
}