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": "405ac178-ffcb-44ba-9efc-214ef673ba2d",
"jobs_id": "e343d02d-f5f6-4f3d-8f9a-58c01c258c8e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "16d5be36-26cd-4899-97d3-b3158271c209",
"_parent_id": "47b1750f-5116-4c52-985c-762c6820cbb6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2f7b0756-09bd-4585-b39e-614762373a86",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6f36aa9b-a36e-4970-ade7-87054e4a7e50",
"_parent_id": "5e9d8087-e677-4af1-ae78-bf00bac11152",
"root_parent_id": "1ed63937-8203-4977-a1f2-f8bbab08386a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f4681beb-699d-42f5-8bd8-895e63f8bf86",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "46cab257-6e2b-4619-b14d-6b62023f51c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4ecc27b6-7282-456e-b751-1f772b4e36a5",
"_parent_code": "sample string 6",
"sales_organization_id": "a7a1dd89-0e09-4b1b-b9d7-41a55c1225ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+00:00"
},
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00"
},
"equipment_model_id": "3d77240e-80d5-440b-91c5-88e309e3de54",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3ae74d21-1a88-4d20-92c8-477ef54d149e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "43cabf4b-8e5a-470e-ab8f-df927ac98865",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f8b1766e-1f0c-46ef-8ec0-593f2e6ce043",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dc09de31-5516-4360-9187-ac581757339f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+00:00"
},
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00"
},
"equipment_family_id": "caa015ac-eea2-48a1-b74a-44b5aab70b67",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "46cab257-6e2b-4619-b14d-6b62023f51c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4ecc27b6-7282-456e-b751-1f772b4e36a5",
"_parent_code": "sample string 6",
"sales_organization_id": "a7a1dd89-0e09-4b1b-b9d7-41a55c1225ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+00:00"
},
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00"
},
"date_in_production_since": "2026-10-03T07:10:24.9484719+00:00",
"date_out_of_production_since": "2026-10-03T07:10:24.9484719+00:00",
"date_end_support": "2026-10-03T07:10:24.9484719+00:00",
"sales_organization_id": "65d052a6-6013-4734-9e31-cce312b965a2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+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-03T07:10:24.9484719+00:00"
},
"project_status_id": "9f63702a-e551-4814-b656-8e6c1948d27e",
"project_status_code": "sample string 10",
"project_status": {
"id": "a896ee1a-0d21-4e9f-af0c-afe38422bda7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d79fa7bd-616d-4135-8bf1-0510e023dd6c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00"
},
"company_id": "4c0c65cc-77f0-4e41-9195-ab58d973ef2d",
"company_code": "sample string 12",
"db_address_id": "a178ebc7-c901-4b25-b1ed-5e5849b52c3d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9c75d4e7-348e-427e-bdee-59994f77a5c2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d8931eb0-2cd4-41ed-9e12-14c4972f119e",
"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-03T07:10:24.9484719+00:00",
"date_create": "2026-10-03T07:10:24.9484719+00:00",
"date_update": "2026-10-03T07:10:24.9484719+00:00",
"updated_by_user_id": "0863cb68-536e-4da2-af7d-2855b08fb7f2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-03T07:10:24.9484719+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-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-03T07:10:24.9484719+00:00",
"date_last_job": "2026-10-03T07:10:24.9484719+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-03T07:10:24.9484719+00:00",
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00",
"is_mobile_installation": true
},
"job_type_id": "10ebcaf4-1ad1-46cc-86fa-a61166d98323",
"job_type_code": "sample string 7",
"job_type": {
"id": "09a98e39-4b48-415e-beb2-935e2ec903fb",
"name": "sample string 2",
"sales_organization_id": "21fe047f-97b3-4915-96fe-3195f61f16eb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00",
"code": "sample string 7"
},
"job_priority_id": "5a802c04-af5e-42ee-a489-249e4ef46afe",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "84dbd854-4aaa-4bf3-be3c-dbbeb5e6a379",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ecf8e7ec-49de-4333-acf5-2a94cab03fed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00"
},
"job_status_id": "b89ae94f-19c1-4090-8826-28b96e134608",
"job_status_code": "sample string 11",
"db_address_id": "347faa2b-65b8-41c0-89df-c17f9fe3ecf0",
"contact_id": "ee9a4978-a59d-4176-af91-740aae801938",
"requested_by_company_id": "1851a282-06c8-4b6c-8728-263d3522db67",
"requested_by_contact_id": "ed0a9665-d31e-4225-a00a-ab5fce87ca05",
"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-03T07:10:24.9484719+00:00",
"due_date": "2026-10-03T07:10:24.9484719+00:00",
"date_create": "2026-10-03T07:10:24.9484719+00:00",
"date_update": "2026-10-03T07:10:24.9484719+00:00",
"date_closed": "2026-10-03T07:10:24.9484719+00:00",
"suggested_user_id": "8de73ee4-f2c9-4d8c-8671-f52eed6e88fc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "49c9c4cd-865d-4679-a2fe-8edc5428313c",
"db_language_id": "6f8d57e3-f1ed-4c65-9328-0af66a109216",
"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-03T07:10:24.9484719+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "68bce5c8-ba0d-47e2-9a93-5b2af4c4a3f8",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "17fafcdf-71b9-43ce-a024-51446d187df3",
"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": "d8379a77-83e6-4405-882b-4ac5b6874046",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6f3351b9-631f-4301-8dbc-168c29e73eaa"
},
"suggested_date_start": "2026-10-03T07:10:24.9484719+00:00",
"skill_id": "2ee421eb-2323-47eb-abac-c559b30ce19f",
"skill_code": "sample string 32",
"skill": {
"id": "8f08140b-3c21-43b6-8545-9ceb7d8d5340",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cfadfafa-b83b-4a75-a530-0e1a681a03fa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f6d9501-12ba-4afe-bfdf-d8d8c94389ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e9ac681-3809-434e-b247-0737f7dffd92",
"db_currency_id": "20df4c85-86ca-4f5e-a2a6-186ade562900",
"db_language_id": "e49ba909-0486-494e-8868-680d6eda0c4e",
"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-03T07:10:24.9484719+00:00"
},
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ca13b2ef-983e-4b34-8e41-01e62a061c36",
"date_reported_by_company": "2026-10-03T07:10:24.9484719+00:00",
"id2": 36,
"company_id": "d2565898-d0f5-40b9-a0ed-b7e1dfcf36b0",
"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": "1d43904a-62c4-492a-9bbb-4bfd843b8227",
"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-03T07:10:24.9484719+00:00"
},
"work_instruction_details_id": "277aa9b0-1eb7-47a9-94a4-f074e23ca96a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fc471912-dee6-430d-941b-3b5838508f5c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d27d2e34-f35d-4a57-ad04-0563fe6fcb96",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-03T07:10:24.9484719+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": "1ea39dc0-3efa-45b8-8eb1-cb332b108e29",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-03T07:10:24.9484719+00:00"
}