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": "45a31f36-c112-4522-b970-dff8196c0e43",
"jobs_id": "e67322a0-ee92-43c9-a6de-ec3808ca188d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "34154909-b2ab-4319-9d72-5dfc65a786c4",
"_parent_id": "4bc92652-309e-4bf2-a159-5e526536bbc0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f34b5db3-51fd-4f87-86da-6edda8ea1831",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0b9faf12-71ec-4208-87a5-a5a33290037c",
"_parent_id": "c9f7a81e-64e0-4495-b69a-ac85f3341c8d",
"root_parent_id": "c815cfd2-04ce-42fe-a39b-0a30b2c6e8b4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "983e8a5e-b227-42c8-97ad-43fbea5b5359",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b5bb7f6d-5c79-4b9f-a0f5-a0f0ba4cd914",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "40434450-4202-465e-97f4-5024db55e124",
"_parent_code": "sample string 6",
"sales_organization_id": "5a60f8f8-e607-489a-8602-8c3e28c5c917",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+00:00"
},
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00"
},
"equipment_model_id": "8ceb8952-b52d-4396-b1d4-e4ad4dd230a1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "16f60a26-90b5-468f-afea-bae0e5643d17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "710f83e4-da14-432a-950a-fcd32d1e45aa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "debfbdfa-8033-4a9e-bb4d-0c53a5f36660",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "914976fe-fd8c-48c5-b2b6-2d67baccf488",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+00:00"
},
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00"
},
"equipment_family_id": "bf347401-89d6-4396-9304-e4b7813a7df7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b5bb7f6d-5c79-4b9f-a0f5-a0f0ba4cd914",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "40434450-4202-465e-97f4-5024db55e124",
"_parent_code": "sample string 6",
"sales_organization_id": "5a60f8f8-e607-489a-8602-8c3e28c5c917",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+00:00"
},
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00"
},
"date_in_production_since": "2026-10-14T14:02:15.1462188+00:00",
"date_out_of_production_since": "2026-10-14T14:02:15.1462188+00:00",
"date_end_support": "2026-10-14T14:02:15.1462188+00:00",
"sales_organization_id": "2c5f1eb7-209a-4d33-9649-ba840807f2ce",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+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-10-14T14:02:15.1462188+00:00"
},
"project_status_id": "efc6ccdb-31be-4a71-8744-251a7e432eb7",
"project_status_code": "sample string 10",
"project_status": {
"id": "62242fc8-5b37-400e-bf8c-8dd3c417b23d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "03b30c4a-8350-43bd-9422-2468bdf57501",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00"
},
"company_id": "e2142113-9656-4eaa-b07f-4c7272f2fc80",
"company_code": "sample string 12",
"db_address_id": "1a187f74-ac9e-4561-acae-3c200fc72c42",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ab8cd81b-3025-4e58-86dc-10a1dd62ad4e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bbf68713-ebfa-44c7-95dd-55a3941c2a1a",
"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-10-14T14:02:15.1462188+00:00",
"date_create": "2026-10-14T14:02:15.1462188+00:00",
"date_update": "2026-10-14T14:02:15.1462188+00:00",
"updated_by_user_id": "250dca66-6fe6-4a79-a6a8-a2fa21302c53",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-14T14:02:15.1462188+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-10-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-14T14:02:15.1462188+00:00",
"date_last_job": "2026-10-14T14:02:15.1462188+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-14T14:02:15.1462188+00:00",
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00",
"is_mobile_installation": true
},
"job_type_id": "ac796cd6-284a-45f0-94cc-11aa762bf9f2",
"job_type_code": "sample string 7",
"job_type": {
"id": "08d9b6e6-76dd-4969-a5be-7d9ee4538aea",
"name": "sample string 2",
"sales_organization_id": "8ec48094-fafd-419f-a5f1-973164362b6b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00",
"code": "sample string 7"
},
"job_priority_id": "7dc167b8-1a20-418c-8868-74ec6d4786bf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fc75d48f-d465-43c3-9c22-e463b5eb7b0e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fb848715-bc48-4c4b-8f46-e7b4cfebef63",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00"
},
"job_status_id": "4460fae1-07cb-4f4d-adc2-4191a44fe0f7",
"job_status_code": "sample string 11",
"db_address_id": "ac5fe608-5cc9-4c59-b2eb-5e11bfd605d9",
"contact_id": "ae0ce74c-13dc-47cb-a060-1a9bdf00bb41",
"requested_by_company_id": "bc4def9f-e69b-49b1-a4f4-1086258cbb1a",
"requested_by_contact_id": "bf1f1696-d595-4aff-90c8-925636d7553e",
"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-10-14T14:02:15.1462188+00:00",
"due_date": "2026-10-14T14:02:15.1462188+00:00",
"date_create": "2026-10-14T14:02:15.1462188+00:00",
"date_update": "2026-10-14T14:02:15.1462188+00:00",
"date_closed": "2026-10-14T14:02:15.1462188+00:00",
"suggested_user_id": "0acd4b5f-3647-4d72-ab54-c9e7eb97ff3d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "580da679-e6c0-41a1-912a-0e4ca6889b89",
"db_language_id": "c1e5102b-4520-4792-a9d2-edc35d80fdeb",
"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-10-14T14:02:15.1462188+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ad0af47a-f83a-43d7-acf4-61d39c749f0c",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e8b88902-0f53-4ded-80fe-e69dec464feb",
"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": "b3b2c7a4-b5d4-4e04-8658-2b53dccc06c5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cd91c09e-8b6a-4178-91b3-b0ef73cacc22"
},
"suggested_date_start": "2026-10-14T14:02:15.1462188+00:00",
"skill_id": "92616443-b303-4c71-a24a-b7ced5cbd60f",
"skill_code": "sample string 32",
"skill": {
"id": "32599131-7fa4-4f35-a669-7c827e77f649",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "da3ffc09-4a9d-4c7d-9282-b647822b9d9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bd6d8cc-877b-4376-b86e-3e87a07788e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7f1ad2bd-8b9b-4533-a9ec-e29712918833",
"db_currency_id": "d3321b01-7b54-4648-899f-b68b03580028",
"db_language_id": "85aec768-0b33-4bb6-b8d8-f402d5137290",
"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-10-14T14:02:15.1462188+00:00"
},
"modified_dateutc": "2026-10-14T14:02:15.1462188+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "057980e8-ab7f-4076-a23b-31216ca4618a",
"date_reported_by_company": "2026-10-14T14:02:15.1462188+00:00",
"id2": 36,
"company_id": "f7566895-d01f-441a-8622-452031693d48",
"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": "2a61a4c4-d279-445c-820f-85f7ac290722",
"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-10-14T14:02:15.1462188+00:00"
},
"work_instruction_details_id": "f6a8d784-7e04-45e6-8dc8-07edd1418453",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0fddcf94-ad23-4a6c-9bbc-1f9d1a63c333",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f040e42-ccaf-4a2e-9f02-077459947d93",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-14T14:02:15.1462188+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": "97ffff1c-e5ec-4791-a7dc-99456793388a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-14T14:02:15.1655238+00:00"
}