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": "096e4fb6-5844-4bbc-a053-0fd4ff971dfe",
"jobs_id": "d6c04a0c-6a48-4856-a6fc-46e55c4ae1c6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "11ffd4c6-cea1-4afb-8d59-cbc3558e0bf6",
"_parent_id": "4a17318c-8ead-4720-921d-eb7d3640fbaf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c78a8a69-064a-44e7-a17e-1974b36978a5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "35cc4d4a-c7ff-4cfb-9479-eb721a2d4313",
"_parent_id": "17b43a85-8022-4426-b716-7dcc8c6be4d7",
"root_parent_id": "07d73f58-ab05-4265-9475-9ce5fa4b7e7e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6959f40e-8c52-4d48-8813-9d71f4d729df",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9f84c8f5-f7f0-494e-896c-66347f3614f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e16ca30-06c0-4e84-957a-cd758be5a1d3",
"_parent_code": "sample string 6",
"sales_organization_id": "a256770c-bb87-447d-b4b8-160a635f2ff2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+00:00"
},
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00"
},
"equipment_model_id": "4cdd31a7-9b5b-480a-bd7b-0dc83bbf7772",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "73996fb4-d28f-4365-8a5e-873fedb5d701",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "46e0f067-7483-472c-9012-f4eda54c40f4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6c43d011-3e00-44b8-a4e9-437bbc2b8ac3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "84794849-b8aa-465a-a993-83ba0ed81368",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+00:00"
},
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00"
},
"equipment_family_id": "e63f9b23-850a-49ff-8ddb-c371c4a32859",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9f84c8f5-f7f0-494e-896c-66347f3614f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e16ca30-06c0-4e84-957a-cd758be5a1d3",
"_parent_code": "sample string 6",
"sales_organization_id": "a256770c-bb87-447d-b4b8-160a635f2ff2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+00:00"
},
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00"
},
"date_in_production_since": "2026-06-11T15:12:35.8873519+00:00",
"date_out_of_production_since": "2026-06-11T15:12:35.8873519+00:00",
"date_end_support": "2026-06-11T15:12:35.8873519+00:00",
"sales_organization_id": "7d6aad07-9173-487f-828a-9518028b8be4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+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-06-11T15:12:35.8873519+00:00"
},
"project_status_id": "33a7adc2-780d-4d85-b385-2f6fe5a85a41",
"project_status_code": "sample string 10",
"project_status": {
"id": "37d4faa1-115b-4c0e-bd39-c48137180a61",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "822cd6eb-2a5c-4282-b449-ae313fe9cb87",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00"
},
"company_id": "cd502649-7576-4fd1-9de0-6a08c05b00ac",
"company_code": "sample string 12",
"db_address_id": "20607478-1e35-4125-8897-cd42f17651ed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c730ca84-c4a7-4c7d-97a2-c1cee898bede",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b76dc242-7fb8-4fe1-86cd-40358edaf264",
"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-06-11T15:12:35.8873519+00:00",
"date_create": "2026-06-11T15:12:35.8873519+00:00",
"date_update": "2026-06-11T15:12:35.8873519+00:00",
"updated_by_user_id": "b8460a6c-eaef-4474-a883-a8cefed62acd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-11T15:12:35.8873519+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-06-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-11T15:12:35.8873519+00:00",
"date_last_job": "2026-06-11T15:12:35.8873519+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-11T15:12:35.8873519+00:00",
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00",
"is_mobile_installation": true
},
"job_type_id": "1f9ee081-7621-44f6-ae22-274e42600575",
"job_type_code": "sample string 7",
"job_type": {
"id": "3aed4ca0-d10b-4442-8506-ff29f7ab3290",
"name": "sample string 2",
"sales_organization_id": "76bbd07c-5046-41de-9dbf-614a4b077604",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00",
"code": "sample string 7"
},
"job_priority_id": "565722e5-88b2-4c06-9fba-907357b939c6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "454ba197-edac-4a71-ab6a-2313e02f2f9b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "60af1121-c22c-4823-8cc5-67b0140642c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00"
},
"job_status_id": "0dc536bb-dda0-4e6b-89b6-7196d7248869",
"job_status_code": "sample string 11",
"db_address_id": "41a3e649-e53a-4338-948a-f4c0c1e62963",
"contact_id": "c31ad749-cf48-4d70-a8bc-84574add4b63",
"requested_by_company_id": "e7b25f51-7411-466d-8dbc-206fa7aa8c90",
"requested_by_contact_id": "03ea193c-b715-47d4-aeb4-aa16bad9abff",
"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-06-11T15:12:35.8873519+00:00",
"due_date": "2026-06-11T15:12:35.8873519+00:00",
"date_create": "2026-06-11T15:12:35.8873519+00:00",
"date_update": "2026-06-11T15:12:35.8873519+00:00",
"date_closed": "2026-06-11T15:12:35.8873519+00:00",
"suggested_user_id": "4c0fa06b-4363-4e1c-ad3a-c84985b6ecf9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f53c63c9-100e-48c1-8e17-441d04f4e6ca",
"db_language_id": "5b0c4e23-97a8-4320-b895-176c0bf9244f",
"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-06-11T15:12:35.8873519+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0983ba55-ede8-4362-bd6a-826425fe3497",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3f3c73ce-2fec-41b7-a348-b697c82d3ca8",
"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": "e71be74b-e62a-4117-9816-6b4537eb809a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dca479ca-8f02-4614-882c-3d25c301002c"
},
"suggested_date_start": "2026-06-11T15:12:35.8873519+00:00",
"skill_id": "942f735f-6c17-4246-84f4-1749b2b7fa80",
"skill_code": "sample string 32",
"skill": {
"id": "96d5f2d1-4482-4fdf-aef3-1cdad7ffb93e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "75ef761c-4982-4c30-97d5-1215bd4d5f4c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e04845e8-4ad3-4587-bdfb-fe0da6cc4faf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5d4dcbd-ab0a-4d30-954f-d7fe9d6858ed",
"db_currency_id": "95823fff-567e-4f27-9c37-f59dfe9ba520",
"db_language_id": "76a86564-4cb9-4d3a-9903-dd7155477774",
"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-06-11T15:12:35.8873519+00:00"
},
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f26c73d-3782-4e2e-84ea-5e1ec90f6afd",
"date_reported_by_company": "2026-06-11T15:12:35.8873519+00:00",
"id2": 36,
"company_id": "8f16c595-6024-4c71-a9e1-9528e37c6faf",
"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": "44d1e8e5-7f03-4a42-a51b-557deee09149",
"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-06-11T15:12:35.8873519+00:00"
},
"work_instruction_details_id": "fed0ee54-a18c-4582-a583-ac46e392e528",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "00f2668c-f10b-4730-9187-dac388ce4f2c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d8fc30a2-db24-4a09-8196-9a6d262c45fc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-11T15:12:35.8873519+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": "1520746e-902c-4edc-b1ab-11fd16e072da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-11T15:12:35.8873519+00:00"
}