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": "8b0c2cc1-6572-4d31-a5f8-c379b7143ee3",
"jobs_id": "dad245ef-46d7-42cd-be83-67e72a401aad",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d6f08378-36c2-4088-a941-32d845015d7e",
"_parent_id": "fda33824-e423-4aa2-b51e-b5828782d7ca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5aeb11d3-a76f-402d-81c8-efd5ab3e0381",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1c64773d-77f7-4402-8c90-1334d9cadf63",
"_parent_id": "be73844b-2d07-447b-81ea-efa877e49639",
"root_parent_id": "c292b3bb-9e5d-48e1-935b-865f31eaea7e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c028ae1a-9c8c-435c-9850-f046e8f2f3da",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ec52cbdc-d2b9-4182-865f-31ce927cfb98",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e033a19c-af5b-40ec-99f2-5295ccaf16e5",
"_parent_code": "sample string 6",
"sales_organization_id": "c7381ecd-2258-4c6d-af8c-b590dfaca8de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+00:00"
},
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00"
},
"equipment_model_id": "cf56c669-9716-487b-a983-e2d957f5a414",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "77ea6d41-c2d6-4402-a212-6cf1ce1106d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "260ce5b0-ce19-40c2-ae0f-995435d3fc40",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "21c9e931-b6cb-49e9-875d-d0a60df0c7a4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5c7e8cad-4963-4120-8517-e19c30e87b17",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+00:00"
},
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00"
},
"equipment_family_id": "1175ee47-7e41-4035-8d40-06b389dded36",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ec52cbdc-d2b9-4182-865f-31ce927cfb98",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e033a19c-af5b-40ec-99f2-5295ccaf16e5",
"_parent_code": "sample string 6",
"sales_organization_id": "c7381ecd-2258-4c6d-af8c-b590dfaca8de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+00:00"
},
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00"
},
"date_in_production_since": "2026-03-07T15:48:07.6318577+00:00",
"date_out_of_production_since": "2026-03-07T15:48:07.6318577+00:00",
"date_end_support": "2026-03-07T15:48:07.6318577+00:00",
"sales_organization_id": "7f88a3c5-ba0f-4448-8bbc-d35f9ea3f900",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+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-03-07T15:48:07.6318577+00:00"
},
"project_status_id": "9354ccff-d5bb-4c4c-9d84-c2e1772d420f",
"project_status_code": "sample string 10",
"project_status": {
"id": "28313f8a-52ea-4a46-8e29-130973f81e3d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6e3e22f0-fef9-4ab3-a945-2ae9e93a4a7a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00"
},
"company_id": "f852ac88-2801-4c28-9a14-1fd781a58651",
"company_code": "sample string 12",
"db_address_id": "79b1b088-09f0-4d84-be77-086df1e4f8e5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ecf72b22-0821-495b-a7e7-9c38853ae5d0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ac333fe1-73d8-4267-bd09-36f3b71ce6f7",
"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-03-07T15:48:07.6318577+00:00",
"date_create": "2026-03-07T15:48:07.6318577+00:00",
"date_update": "2026-03-07T15:48:07.6318577+00:00",
"updated_by_user_id": "5daca05c-9466-43b1-a5e2-43427ee7f0e3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-07T15:48:07.6318577+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-03-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-07T15:48:07.6318577+00:00",
"date_last_job": "2026-03-07T15:48:07.6318577+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-07T15:48:07.6318577+00:00",
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00",
"is_mobile_installation": true
},
"job_type_id": "1b63e16f-ec99-4aba-9b47-3c1f886ca080",
"job_type_code": "sample string 7",
"job_type": {
"id": "e62789a2-1862-4042-9b71-a66c9ac74d15",
"name": "sample string 2",
"sales_organization_id": "f7b4f920-3bb7-4c03-9f4d-816da4b1c0b3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00",
"code": "sample string 7"
},
"job_priority_id": "c66b19d6-5090-4339-8c53-b39d739accee",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fc2e78bc-d3e2-4397-9263-a89cc03e27f5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0af21074-d00f-4ec3-afaa-764c0ab37a27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00"
},
"job_status_id": "a6a3f147-7f85-4e74-9dc1-dffd55262bb6",
"job_status_code": "sample string 11",
"db_address_id": "0d4964b0-3de9-4b1f-910b-33e3549d3a4a",
"contact_id": "642afc5a-5a6d-493f-b4df-2c6a43542dc4",
"requested_by_company_id": "d71c8af1-7100-434c-aa2b-9678d7e967ba",
"requested_by_contact_id": "79844231-7e64-40f6-bd12-10c8ef0058f8",
"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-03-07T15:48:07.6318577+00:00",
"due_date": "2026-03-07T15:48:07.6318577+00:00",
"date_create": "2026-03-07T15:48:07.6318577+00:00",
"date_update": "2026-03-07T15:48:07.6318577+00:00",
"date_closed": "2026-03-07T15:48:07.6318577+00:00",
"suggested_user_id": "930c0760-f5e2-4553-8f4d-81286a9bc079",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a5f43e79-53ce-4a72-9462-851acf74295f",
"db_language_id": "07b4fe2e-4706-4b1d-8256-7c20242c20b1",
"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-03-07T15:48:07.6318577+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4b5d60c4-3ba9-4938-b67a-3ec0745d39ae",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2f6cc483-1558-4b66-af72-a4a5b66b3107",
"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": "4bec64c6-c350-4ece-92cc-5d7fff7e4457",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "98e09e06-f75a-499d-841b-6c3e67b632a2"
},
"suggested_date_start": "2026-03-07T15:48:07.6318577+00:00",
"skill_id": "3196b6db-2db0-4025-9898-4ae355931632",
"skill_code": "sample string 32",
"skill": {
"id": "eb22f038-10f5-41cb-98a5-95530c169ae0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "46b41b42-988f-4824-a238-cb8ad80e2d00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e10a4008-5258-4e0b-b64c-09e259de0dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d28da25-9cc5-4a74-a348-64efd766f083",
"db_currency_id": "ab96a187-9f59-43b7-a4b6-f2e8adff881c",
"db_language_id": "409fc667-29d0-4f6a-ad74-00976c2849f1",
"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-03-07T15:48:07.6318577+00:00"
},
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "153afbb9-0b33-42b1-83b1-9574efd10109",
"date_reported_by_company": "2026-03-07T15:48:07.6318577+00:00",
"id2": 36,
"company_id": "1b7ac7e6-8f9c-45ce-b1a4-55fa103f81e9",
"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": "c807a93e-3db4-4536-99f3-f8e751cc230c",
"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-03-07T15:48:07.6318577+00:00"
},
"work_instruction_details_id": "655b9569-8376-4683-a1b9-ddf509f20a94",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5d45982a-2f8f-46a2-936d-6fe854cf0f05",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "83724f79-d29d-442e-a24b-e0e32107d708",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-07T15:48:07.6318577+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": "bc1d6d5c-199a-44c4-a60b-1e21b1328cae",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-07T15:48:07.6318577+00:00"
}