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": "7b48833f-b26a-400e-af05-1f0cd3117224",
"jobs_id": "3cf1511e-7bc9-41d1-ac98-4af06f0adb29",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aa42b3da-5a31-4d49-b55d-a70114a8cf71",
"_parent_id": "df4ad910-8823-4743-8598-0d23c15b90c8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "382fd341-930c-4a61-bdc3-f2c5a3d6eb08",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f406d48a-c674-46a6-8edb-7013e5f263ec",
"_parent_id": "8387c19a-1017-4799-96b4-77aed15624f8",
"root_parent_id": "0f00fcb9-cee6-43e9-9bb5-ad8bd1264ad1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8bb4ae8d-ddaf-443e-ac97-c440e6d6f588",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9eece043-6edf-4105-8e3e-72f2fc841055",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1fa658cc-357a-4f45-8557-a3deae5239f5",
"_parent_code": "sample string 6",
"sales_organization_id": "beb082a5-10ee-42cf-9dcf-f2d5b499cfd5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+00:00"
},
"modified_dateutc": "2026-10-20T13:31:35.5145931+00:00"
},
"equipment_model_id": "ab117733-c4cb-4837-b549-c00ac3be8cea",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8bfc187d-7eed-47dc-a831-b0078c014182",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d9968fdd-6596-4db1-b0f8-0dbcaedf5b14",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "599bde8b-50f7-4d60-bcc0-4c6f941d5372",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c3d5d577-eb3f-4d5d-978c-8875022f84e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+00:00"
},
"modified_dateutc": "2026-10-20T13:31:35.5145931+00:00"
},
"equipment_family_id": "31f7ea70-fd70-4151-acf6-1716d5aa769f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9eece043-6edf-4105-8e3e-72f2fc841055",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1fa658cc-357a-4f45-8557-a3deae5239f5",
"_parent_code": "sample string 6",
"sales_organization_id": "beb082a5-10ee-42cf-9dcf-f2d5b499cfd5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+00:00"
},
"modified_dateutc": "2026-10-20T13:31:35.5145931+00:00"
},
"date_in_production_since": "2026-10-20T13:31:35.5145931+00:00",
"date_out_of_production_since": "2026-10-20T13:31:35.5145931+00:00",
"date_end_support": "2026-10-20T13:31:35.5145931+00:00",
"sales_organization_id": "f825566b-46c9-4cda-8008-6c906ae9673c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+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-20T13:31:35.5250473+00:00"
},
"project_status_id": "1f236a1c-13fe-4484-ab3d-dcb9603ef619",
"project_status_code": "sample string 10",
"project_status": {
"id": "8c33d58e-1aa0-43ea-91e6-86e15d8f2baa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2f994f89-e2e2-457e-82eb-e30abee0afa6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T13:31:35.5250473+00:00"
},
"company_id": "3e7bb1ee-6760-4126-9360-f9bde6e5ef0f",
"company_code": "sample string 12",
"db_address_id": "f167f61f-5675-4bf8-aeef-e194f1270aa3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "63409648-ca91-4906-a61a-eb2e7a321b66",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ee27f977-c80a-48fc-a861-5c98b8c6f6ca",
"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-20T13:31:35.5250473+00:00",
"date_create": "2026-10-20T13:31:35.5250473+00:00",
"date_update": "2026-10-20T13:31:35.5250473+00:00",
"updated_by_user_id": "d2cc99ef-d77f-4463-af7f-c0ce7175b72d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-20T13:31:35.5250473+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-20T13:31:35.5250473+00:00",
"date_last_job": "2026-10-20T13:31:35.5250473+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-20T13:31:35.5250473+00:00",
"modified_dateutc": "2026-10-20T13:31:35.5250473+00:00",
"is_mobile_installation": true
},
"job_type_id": "2019ae84-dcdb-4320-8a92-a651f0076261",
"job_type_code": "sample string 7",
"job_type": {
"id": "8d00e428-f633-497d-a5b6-9dde4532dbf4",
"name": "sample string 2",
"sales_organization_id": "ae1f0e69-0728-400f-8c1e-08555feda912",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-20T13:31:35.5250473+00:00",
"code": "sample string 7"
},
"job_priority_id": "6fc0fe74-48e0-4e4a-a94b-6efb9b6bbbc9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "15f6e1cd-b3f2-41f8-8993-10baa8c486f4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f8b4c82b-a827-42ef-83e3-e7b6fe3f5128",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T13:31:35.5250473+00:00"
},
"job_status_id": "39821024-475a-4e1e-a4de-856b78690ed0",
"job_status_code": "sample string 11",
"db_address_id": "361b4b50-c202-47d3-b3cc-4cc0f0fb5f00",
"contact_id": "2e7c886f-49b4-4ca0-9868-625a1f7b503a",
"requested_by_company_id": "ef3b8a52-a88b-4051-8707-570b614b5192",
"requested_by_contact_id": "3746e46c-de52-4e17-b80b-2347186f2a8f",
"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-20T13:31:35.5250473+00:00",
"due_date": "2026-10-20T13:31:35.5250473+00:00",
"date_create": "2026-10-20T13:31:35.5250473+00:00",
"date_update": "2026-10-20T13:31:35.5250473+00:00",
"date_closed": "2026-10-20T13:31:35.5250473+00:00",
"suggested_user_id": "1dbab8c5-2574-4e86-99a6-00cd92fb7ab9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b3db9102-64da-467b-866f-783f92b7636d",
"db_language_id": "8f5a6be9-a8a8-471b-beef-3a6c4d4220c6",
"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-20T13:31:35.5250473+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8f5962be-b837-4f20-911d-20a55cf3c93c",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fb5cee0a-319b-4631-abc2-1347416a4010",
"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": "76edf65b-be54-41e7-ae33-ac8302ac78f6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-20T13:31:35.5250473+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "27bd150e-3c0b-47cf-979b-2b3c1c9b6dce"
},
"suggested_date_start": "2026-10-20T13:31:35.5250473+00:00",
"skill_id": "e82c04ae-df23-4142-bb44-9a22f7cc75a9",
"skill_code": "sample string 32",
"skill": {
"id": "5ba71391-efc9-4333-921c-1b85bb142be9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d6bd1a73-860f-40dc-b371-83c9a5abf5a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "62e4eeca-98d3-4f11-a2c4-6a7e1c65d1e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95006a58-8a90-447d-b09c-c2effbc685f6",
"db_currency_id": "79be573a-3bf0-4f6d-947e-3e1640f62dd1",
"db_language_id": "73649a5e-6961-4231-8467-f091e3d52520",
"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-20T13:31:35.5145931+00:00"
},
"modified_dateutc": "2026-10-20T13:31:35.5444742+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3b93c9c5-5610-4c3d-a13e-dee36c2a18c9",
"date_reported_by_company": "2026-10-20T13:31:35.5444742+00:00",
"id2": 36,
"company_id": "46b1ff0a-99f4-4e1c-8413-3fa62dff2422",
"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": "90896d86-9b94-41e0-a642-4503f445a9de",
"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-20T13:31:35.5444742+00:00"
},
"work_instruction_details_id": "395bafab-f35e-4489-8eb5-040951b3c4a0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "13725f8c-3c44-4357-97bd-d47029c99238",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d853ba49-2883-4143-81a4-10da4ba9b952",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-20T13:31:35.5444742+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": "db278126-6415-48aa-b6c2-e194dbbe21e3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-20T13:31:35.5444742+00:00"
}