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": "af2009a5-25fb-49cd-aec5-ac9f7a7782c9",
"jobs_id": "d9c61375-c195-45f8-913b-dae9a8d0e831",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "483491df-ddd3-4f8d-be70-a6b55622c086",
"_parent_id": "fc8352ef-8f82-43fa-9646-41aece23cbc3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f748e2da-6960-4e14-85e6-0ae3c66d9040",
"project_reference_back_office": "sample string 5",
"project": {
"id": "26da7315-8c70-4908-b2d4-0bcc72f912fa",
"_parent_id": "f418a6f2-9664-4e61-9006-391ac8161443",
"root_parent_id": "587b0f3a-0014-4157-942c-80ce22bb5af1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8c032bb6-135d-4082-b751-d568f1df241f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "64e9c39b-3896-4e13-a043-5ac88644c5ac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "738db2b7-5096-4ec7-bc42-5e9984a91642",
"_parent_code": "sample string 6",
"sales_organization_id": "86ae24fb-081e-4f33-9f49-688a0be671b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+00:00"
},
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00"
},
"equipment_model_id": "afebefa5-5555-40ed-9e89-8226cf527795",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2faf7a34-8b24-4911-b609-c8c06d4b89ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ac42c75b-d131-4821-ba52-3c2188cdaa88",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "464b20bb-7e12-4951-bb7b-9eef3fa91af0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9c031fc7-ea84-4dca-831f-1cea711e321a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+00:00"
},
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00"
},
"equipment_family_id": "38f808c0-762c-4572-bef7-7adb5ef2287f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "64e9c39b-3896-4e13-a043-5ac88644c5ac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "738db2b7-5096-4ec7-bc42-5e9984a91642",
"_parent_code": "sample string 6",
"sales_organization_id": "86ae24fb-081e-4f33-9f49-688a0be671b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+00:00"
},
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00"
},
"date_in_production_since": "2026-05-30T13:17:54.2815812+00:00",
"date_out_of_production_since": "2026-05-30T13:17:54.2815812+00:00",
"date_end_support": "2026-05-30T13:17:54.2815812+00:00",
"sales_organization_id": "076c27cf-eca1-4fd3-ab1a-611a946f9730",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+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-30T13:17:54.2815812+00:00"
},
"project_status_id": "8a4ac062-c425-4082-8d18-896a07c213a0",
"project_status_code": "sample string 10",
"project_status": {
"id": "80e2af77-bd0c-4a04-9dd1-46908e27dd1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2cbaa662-db50-4835-8313-7bd11e39db10",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00"
},
"company_id": "dc96d3a9-0fd9-4188-9fa8-29851efc8df1",
"company_code": "sample string 12",
"db_address_id": "cb406d25-33f1-4c88-90b4-bf2a408b7cd2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7e837d1e-0a29-4634-beab-f21f094a00c5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cbec9307-1d0a-4c99-9a74-4e50dd90d824",
"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-30T13:17:54.2815812+00:00",
"date_create": "2026-05-30T13:17:54.2815812+00:00",
"date_update": "2026-05-30T13:17:54.2815812+00:00",
"updated_by_user_id": "cae59fea-e5d3-4f42-924e-d408055c991a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T13:17:54.2815812+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T13:17:54.2815812+00:00",
"date_last_job": "2026-05-30T13:17:54.2815812+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T13:17:54.2815812+00:00",
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00",
"is_mobile_installation": true
},
"job_type_id": "6e901ce7-e3f3-471f-84ef-d01c2d27156e",
"job_type_code": "sample string 7",
"job_type": {
"id": "1ab5e848-43dd-4c29-9d09-d49473643434",
"name": "sample string 2",
"sales_organization_id": "86810b79-5983-411f-a5e0-55ff671e7eb0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00",
"code": "sample string 7"
},
"job_priority_id": "83cce207-d777-45c8-bace-47c626706b7a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "455b8056-5682-494c-b754-550b3e16f659",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4f3c2bff-58b5-4095-b78c-a750ac53dca1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00"
},
"job_status_id": "9af4e9c9-4a2c-4a4d-b7e1-0843cf063d18",
"job_status_code": "sample string 11",
"db_address_id": "c9b7a158-d456-4183-ad1c-f25bf697d226",
"contact_id": "3170b96f-2f60-43c2-8650-e0e6adab45b5",
"requested_by_company_id": "99679f86-1761-47dd-8385-72e37d22dc83",
"requested_by_contact_id": "d29208ba-0b23-4072-8e55-d4c674d53e21",
"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-30T13:17:54.2815812+00:00",
"due_date": "2026-05-30T13:17:54.2815812+00:00",
"date_create": "2026-05-30T13:17:54.2815812+00:00",
"date_update": "2026-05-30T13:17:54.2815812+00:00",
"date_closed": "2026-05-30T13:17:54.2815812+00:00",
"suggested_user_id": "904614b2-7156-4250-9097-11e017f0a204",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "210284ef-ba3a-4059-ac05-820af61eb012",
"db_language_id": "93ff3d25-8386-4ee0-b917-77dfb2910ff3",
"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-30T13:17:54.2815812+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5c5db288-2006-4655-8e82-098f6993e1fb",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "26c48602-159d-4541-afe2-916535073253",
"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": "1d068e15-786e-4e90-9ee3-33384e0224d3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9257fcf5-73b5-4d82-a568-999b0fd1c4bd"
},
"suggested_date_start": "2026-05-30T13:17:54.2815812+00:00",
"skill_id": "43e79e69-cdc5-4321-b365-1a166d008e39",
"skill_code": "sample string 32",
"skill": {
"id": "8ad6b4fc-c987-4948-8c5c-3237473e19f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "13a7d7a2-2ee4-4ad0-a772-fa795bc6b1dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26ecdd69-7235-40bc-bdb7-22ff8c451396",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8087b271-8cc3-4597-b3b9-b18ddda7fe49",
"db_currency_id": "485d8154-f5d4-4a52-8200-b3f5f15b491b",
"db_language_id": "702ed005-a93c-42d3-a40b-6f16b8daa3bc",
"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-30T13:17:54.2815812+00:00"
},
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8386409f-af9b-46f7-8743-64a03f8b1d0a",
"date_reported_by_company": "2026-05-30T13:17:54.2815812+00:00",
"id2": 36,
"company_id": "c90ec7ef-f8c5-4e0d-9361-2ebf5c3c550d",
"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": "3e6ec734-dcb7-4ec0-80d3-437e0ffed97e",
"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-30T13:17:54.2815812+00:00"
},
"work_instruction_details_id": "007c49e8-19ec-475c-b527-a1cd41e77bad",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f57ee871-e32e-48d8-aa00-af2a76b04398",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f7bf43f5-eac9-4d66-b53c-bcbfe877d84b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T13:17:54.2815812+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": "5e85e4ad-4003-460f-b94e-04c964187afa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T13:17:54.2815812+00:00"
}