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": "26ac6fe5-28b0-4f00-aa9f-cb88353aa5b2",
"jobs_id": "d466a953-364b-4738-9006-4a3cf2ada227",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "afd13fe4-6b69-4e1d-bae2-34b18d34ef79",
"_parent_id": "941f8833-93c5-41f8-8709-27c4d2642023",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6c5c997f-9e85-414f-9d19-e77210cf3b87",
"project_reference_back_office": "sample string 5",
"project": {
"id": "56bc8661-9ed0-4124-ab1b-1153ddb92400",
"_parent_id": "3e2fec3b-79e0-49bc-a5ec-ef82f21c12f5",
"root_parent_id": "513dd818-285b-4b2f-a9a2-0ed447560127",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a87a68ee-16fe-4bd4-90b7-ae8f6b635dfc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6ac35851-833d-4b61-be47-401a0e4bcdff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d11c333-8333-4715-8d62-f910db462b27",
"_parent_code": "sample string 6",
"sales_organization_id": "22b537fa-bfe9-4295-8993-e4164e1b5a0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+00:00"
},
"modified_dateutc": "2025-08-12T12:53:51.1368311+00:00"
},
"equipment_model_id": "15489612-60fd-41df-ba4b-1b8a87e1a948",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "89c3f6af-77d7-431b-a211-8ed19553f42e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b8e6db83-5fbd-41ad-bdbc-c1422396e8a0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "97f907c1-4bb2-4436-b064-3841674aae90",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d16b9fa6-f348-4b35-b9ba-224148b6d780",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+00:00"
},
"modified_dateutc": "2025-08-12T12:53:51.1368311+00:00"
},
"equipment_family_id": "4ad3cfe5-2cd9-411a-ac79-8f38955584e7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6ac35851-833d-4b61-be47-401a0e4bcdff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d11c333-8333-4715-8d62-f910db462b27",
"_parent_code": "sample string 6",
"sales_organization_id": "22b537fa-bfe9-4295-8993-e4164e1b5a0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+00:00"
},
"modified_dateutc": "2025-08-12T12:53:51.1368311+00:00"
},
"date_in_production_since": "2025-08-12T12:53:51.1368311+00:00",
"date_out_of_production_since": "2025-08-12T12:53:51.1368311+00:00",
"date_end_support": "2025-08-12T12:53:51.1368311+00:00",
"sales_organization_id": "a28ff33f-5f21-4f80-b3ad-18ec5ece9bfb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+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": "2025-08-12T12:53:51.1368311+00:00"
},
"project_status_id": "51cda474-0621-4c10-b22f-08fb1807c589",
"project_status_code": "sample string 10",
"project_status": {
"id": "8fb36636-dab0-4378-8c14-cb523d88e837",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "26170454-c5ed-4de4-91e3-cd1cb2310ef1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:53:51.152454+00:00"
},
"company_id": "de627d6f-5f80-4dd0-a296-0ab0dfad47b0",
"company_code": "sample string 12",
"db_address_id": "075b4d98-24e5-4e58-86e0-1a527e8c4a78",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "20158952-92ac-400e-87de-7376ff2dcb91",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f9935fe6-1e0b-45a7-9ca9-ae01556038be",
"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": "2025-08-12T12:53:51.3399538+00:00",
"date_create": "2025-08-12T12:53:51.3399538+00:00",
"date_update": "2025-08-12T12:53:51.3399538+00:00",
"updated_by_user_id": "d88e437b-05ea-4eea-9280-4450b7ebdd15",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-12T12:53:51.3399538+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": "2025-08-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-12T12:53:51.3399538+00:00",
"date_last_job": "2025-08-12T12:53:51.3399538+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-12T12:53:51.3399538+00:00",
"modified_dateutc": "2025-08-12T12:53:51.3399538+00:00",
"is_mobile_installation": true
},
"job_type_id": "9dbb6591-8e3b-493a-8d78-8c04521222e1",
"job_type_code": "sample string 7",
"job_type": {
"id": "03feeeda-37ab-4178-bcef-a9c5df68d4d9",
"name": "sample string 2",
"sales_organization_id": "5a093dfa-c86b-445f-a1d1-50dac19e239a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-12T12:53:51.3399538+00:00",
"code": "sample string 7"
},
"job_priority_id": "192995c0-1fb4-438a-b07a-561c70e48f76",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c2a0dfd1-39f6-4d13-a035-cff84e692826",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0f8a6272-0763-451a-93c1-f1af231c38fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:53:51.3399538+00:00"
},
"job_status_id": "0ab2d4d8-40c6-4ece-b326-2e25dcf0c9ec",
"job_status_code": "sample string 11",
"db_address_id": "904403fb-6a73-481c-9404-aa6d19e91ea9",
"contact_id": "3dbbb2bf-7d20-4d87-a37d-013ff9507e23",
"requested_by_company_id": "1c3cab83-cb8f-4d0b-8e98-9a429c8d4f33",
"requested_by_contact_id": "cf8e49cf-cddd-417a-b9eb-a5e309e691c8",
"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": "2025-08-12T12:53:51.3399538+00:00",
"due_date": "2025-08-12T12:53:51.3399538+00:00",
"date_create": "2025-08-12T12:53:51.3399538+00:00",
"date_update": "2025-08-12T12:53:51.3399538+00:00",
"date_closed": "2025-08-12T12:53:51.3399538+00:00",
"suggested_user_id": "d162ce9d-0eae-42ac-a97c-a48349e1f71b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8005a1bd-a363-43ad-b8fd-f7e969d316b2",
"db_language_id": "fbb892f1-349f-4dd7-9afb-cf35350b4fe7",
"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": "2025-08-12T12:53:51.3399538+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c2c1f373-9a00-4dba-969b-ffcdca7c8176",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "487bf682-ffe9-4f14-b47c-567fcd5e536a",
"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": "571be431-9175-4588-8cdf-5e2dafe1318b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-12T12:53:51.3399538+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "905ce31c-66f6-42bf-aa47-75fc4f0ede0e"
},
"suggested_date_start": "2025-08-12T12:53:51.3399538+00:00",
"skill_id": "742ddc91-7bf0-40d0-b75c-23093355789b",
"skill_code": "sample string 32",
"skill": {
"id": "1c662828-324f-4a5a-9c8f-2796d7d0e3cc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1b61f528-7467-4194-b518-249633c480a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64d364fd-1027-43bf-bea4-476ddef07b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9169041a-118c-493c-a8ec-d5e4937592b5",
"db_currency_id": "76efe45a-5b9f-4244-b278-415801efe15a",
"db_language_id": "51addad9-8743-4959-aef4-6b7a64de7ce4",
"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": "2025-08-12T12:53:51.1368311+00:00"
},
"modified_dateutc": "2025-08-12T12:53:51.3399538+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "776ff2cd-2511-4805-a83a-70688dce4ddb",
"date_reported_by_company": "2025-08-12T12:53:51.3399538+00:00",
"id2": 36,
"company_id": "f3061719-f93c-42b4-b4d4-a7ebce40ee1e",
"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": "3609c97b-ab55-4031-b217-5065428555c5",
"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": "2025-08-12T12:53:51.3399538+00:00"
},
"work_instruction_details_id": "c7d9519e-3cbd-4073-a797-21907cc01a0e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d774ca02-8c8b-4342-8499-ea9389903bfd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "888dfe48-71f6-449b-973a-48e4ee1a5ed0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-12T12:53:51.3399538+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": "de2165a2-6e9b-4c58-947e-ae0609e30f59",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-12T12:53:51.3399538+00:00"
}