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": "d5552eba-027e-4c72-803f-1ecf28b1052f",
"jobs_id": "8c04e600-51f8-4a73-bf2b-2b76d5012aa5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b41f66d8-4b81-493a-95c6-c09e85352fa6",
"_parent_id": "b5acb19b-dfb3-46a7-91a7-dafe5ce15c5d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d2225b76-f89b-41ab-bac5-59e2691656d9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0693f24d-53b0-4287-b806-7a0ed5117d90",
"_parent_id": "847bc05a-3b9b-4891-ad66-c0ae2ae42b21",
"root_parent_id": "109b7174-d63e-42b2-813f-b409b00b2cd2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "43cbd0a7-219f-49d8-bc09-f1ded139f376",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "005e5117-1b54-4c3d-8518-4117dd40cd13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b154be26-a6ac-42fb-a529-f4b7ca6823ac",
"_parent_code": "sample string 6",
"sales_organization_id": "ba7bc132-5df0-4bae-8bfe-5d686156e639",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+00:00"
},
"modified_dateutc": "2026-11-14T18:59:27.3282069+00:00"
},
"equipment_model_id": "afe9906e-5cc1-43fb-a56e-c2fb28c5da0b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f955f9c0-0ca8-41f6-a521-d2e40a3e7147",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b8de3f0b-7609-4a97-ac9c-2ce85eed6d12",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "37c86140-b103-47ad-98c9-95fdbfe4c8e7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b78e59b-dd52-4eb1-b2a3-aac21455294d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+00:00"
},
"modified_dateutc": "2026-11-14T18:59:27.3282069+00:00"
},
"equipment_family_id": "d05e9a02-6f23-4383-9721-dd1fdf3fac5d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "005e5117-1b54-4c3d-8518-4117dd40cd13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b154be26-a6ac-42fb-a529-f4b7ca6823ac",
"_parent_code": "sample string 6",
"sales_organization_id": "ba7bc132-5df0-4bae-8bfe-5d686156e639",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+00:00"
},
"modified_dateutc": "2026-11-14T18:59:27.3282069+00:00"
},
"date_in_production_since": "2026-11-14T18:59:27.3282069+00:00",
"date_out_of_production_since": "2026-11-14T18:59:27.3282069+00:00",
"date_end_support": "2026-11-14T18:59:27.3282069+00:00",
"sales_organization_id": "b26ed26a-f9d5-4f08-b703-9cd8804bef5e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+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-11-14T18:59:27.3282069+00:00"
},
"project_status_id": "f155386f-afe6-4eac-ab1e-57ef29342375",
"project_status_code": "sample string 10",
"project_status": {
"id": "720cc296-6adf-4883-9ae1-daf2302d3a14",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9f64213c-cf0e-45d1-971f-6df36dfcbe5b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T18:59:27.3282069+00:00"
},
"company_id": "3b30a510-1532-4984-8133-b39c808bf493",
"company_code": "sample string 12",
"db_address_id": "13f52471-fd62-4ce6-b130-5eb1541d13e1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1ae02cc1-3fdf-43e4-8dc9-1be339f52f86",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f3f80e2a-c185-416f-8d0b-d7d5fb7f7d19",
"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-11-14T18:59:27.3282069+00:00",
"date_create": "2026-11-14T18:59:27.3282069+00:00",
"date_update": "2026-11-14T18:59:27.3282069+00:00",
"updated_by_user_id": "7425bcac-cda2-46ca-84e5-b654e8387adb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-14T18:59:27.3282069+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-11-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-14T18:59:27.3416557+00:00",
"date_last_job": "2026-11-14T18:59:27.3416557+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-14T18:59:27.3416557+00:00",
"modified_dateutc": "2026-11-14T18:59:27.3416557+00:00",
"is_mobile_installation": true
},
"job_type_id": "b2c65763-6b27-4535-bbfb-ee466b62e4c0",
"job_type_code": "sample string 7",
"job_type": {
"id": "60a42482-cc1a-47f9-9fab-8d49e2949e60",
"name": "sample string 2",
"sales_organization_id": "b3159b4f-dc64-4bfa-a0d2-8fc854b0775e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-14T18:59:27.3416557+00:00",
"code": "sample string 7"
},
"job_priority_id": "c51ffd40-b5f5-44d9-9b1b-7b48d941841f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d318d329-1e19-448d-9bc4-1e9f537034a8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "789c326f-16cc-4543-8fca-e31ebec72f98",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T18:59:27.3416557+00:00"
},
"job_status_id": "cf3387d1-1093-466b-8268-f90d051f44ae",
"job_status_code": "sample string 11",
"db_address_id": "b2f569c5-ca97-4690-a7ed-5c2c0cb0982a",
"contact_id": "bbfbdb8f-40a1-4814-a244-2ceea8da0baa",
"requested_by_company_id": "424720e7-9e4b-4b60-b773-f60803181867",
"requested_by_contact_id": "86c7cc76-a532-480b-8f12-b44f90668d7e",
"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-11-14T18:59:27.3416557+00:00",
"due_date": "2026-11-14T18:59:27.3416557+00:00",
"date_create": "2026-11-14T18:59:27.3416557+00:00",
"date_update": "2026-11-14T18:59:27.3416557+00:00",
"date_closed": "2026-11-14T18:59:27.3416557+00:00",
"suggested_user_id": "e54ec8ba-6056-43df-bdd6-cfac68ee3c0e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ffde40b1-eb18-4e7e-b4f9-050c621e9960",
"db_language_id": "b747c37e-9d42-4208-968e-8307ccb25320",
"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-11-14T18:59:27.3416557+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ae12b475-5d16-4f3a-b369-e2abbeb53a0c",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5370357e-0617-40b0-841d-585e48a9b684",
"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": "cdd245ec-6374-46b7-afff-60efa17d333c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-14T18:59:27.3416557+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "52d8d6f2-4a22-4661-b7d1-73d1dd619c4a"
},
"suggested_date_start": "2026-11-14T18:59:27.3416557+00:00",
"skill_id": "ae144a60-9ebf-40fc-827d-a41efb144b78",
"skill_code": "sample string 32",
"skill": {
"id": "4a8350fc-445e-4e2b-bb1c-14ca4c925162",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b61f26c1-0d94-4eb2-b6b3-6578c4cf0e39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e4548f2-cc28-4ebb-bd38-1534f16362c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "163b70ef-3465-4e0e-8a2b-c1ba394fb724",
"db_currency_id": "752ce4b1-1009-44e9-a77b-22e0ed1f6eee",
"db_language_id": "dd3d7c57-4bfc-4287-a9f1-9267f69fc828",
"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-11-14T18:59:27.3282069+00:00"
},
"modified_dateutc": "2026-11-14T18:59:27.3416557+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bf5dc9bd-3728-4480-a898-051b8dd2353a",
"date_reported_by_company": "2026-11-14T18:59:27.3416557+00:00",
"id2": 36,
"company_id": "ac67f096-38b1-476b-81cf-39d5e1858e45",
"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": "5576780a-5c56-45fd-84c6-9afa74ee3c45",
"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-11-14T18:59:27.3416557+00:00"
},
"work_instruction_details_id": "3f1c14f4-8ffe-4947-aff1-e67c35c5d76d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "79da8e5d-1d3c-4c19-9baf-ca80b547d328",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0fe15aad-ee99-47ca-9574-1076ec1c03a9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-14T18:59:27.3416557+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": "0b715087-015d-45d4-85bc-1340c163e7f0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-14T18:59:27.3416557+00:00"
}