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": "1c3d2b27-f550-4ba1-976e-e43cd3e098ad",
"jobs_id": "be130b72-9258-4ba9-984a-8d94995650fc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "da47365e-728b-479b-8fe6-3cea6238c434",
"_parent_id": "d9f0de67-238d-48de-a22b-9b206d5b6140",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "caefdb03-f9d7-4005-802b-c203f09c5657",
"project_reference_back_office": "sample string 5",
"project": {
"id": "91b497c5-2e21-45a9-96e8-a4c200a1d1c3",
"_parent_id": "fbf74fb5-dcec-49fa-8760-ff324a1659b3",
"root_parent_id": "c7460712-a019-40dc-8e9f-1ef8a65c1d4e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fbf3b8ae-56e0-4660-8b36-b4dd71500dc1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9291a0ca-570a-4e55-8031-846423f301dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b28b425-b69e-4c10-85aa-6ff82f4b80f2",
"_parent_code": "sample string 6",
"sales_organization_id": "edcac1e9-0906-4b4f-9087-f03d0fb90a5a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+00:00"
},
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00"
},
"equipment_model_id": "210bd5eb-3b6e-4303-bc02-cccb462bcc93",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "033b790c-83d3-40d4-8983-fe5fdd2e6501",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c5257859-c6b9-423d-84ae-88222b59345b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "863aee70-5e3f-4faf-bc0c-d2f692c13437",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd0bbf90-3ab9-4242-9758-404f4fa6a2e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+00:00"
},
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00"
},
"equipment_family_id": "1380ec43-ac9f-4edb-b636-6da518212a0a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9291a0ca-570a-4e55-8031-846423f301dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b28b425-b69e-4c10-85aa-6ff82f4b80f2",
"_parent_code": "sample string 6",
"sales_organization_id": "edcac1e9-0906-4b4f-9087-f03d0fb90a5a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+00:00"
},
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00"
},
"date_in_production_since": "2026-07-28T02:57:04.3211839+00:00",
"date_out_of_production_since": "2026-07-28T02:57:04.3211839+00:00",
"date_end_support": "2026-07-28T02:57:04.3211839+00:00",
"sales_organization_id": "06e9300a-db4f-498c-8175-0ec336589e68",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+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-07-28T02:57:04.3211839+00:00"
},
"project_status_id": "fd88fd17-e1f8-43f7-8833-f29ebd216b28",
"project_status_code": "sample string 10",
"project_status": {
"id": "12df31b3-6180-49bc-b9d7-912932291611",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5c12d5ea-bc1d-4fe1-b242-a542e3e07d78",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00"
},
"company_id": "7a97562e-b238-4240-bd5c-1e7e05c41a74",
"company_code": "sample string 12",
"db_address_id": "f174cfec-e080-44e9-8bd9-09f140634d18",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fac0b380-1ff7-4dca-8016-9d9635717bee",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fd24d59f-7907-4591-8326-589b88d6ffb1",
"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-07-28T02:57:04.3211839+00:00",
"date_create": "2026-07-28T02:57:04.3211839+00:00",
"date_update": "2026-07-28T02:57:04.3211839+00:00",
"updated_by_user_id": "72af41b0-8095-4f61-9b10-de716ad14b10",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-28T02:57:04.3211839+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-07-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-28T02:57:04.3211839+00:00",
"date_last_job": "2026-07-28T02:57:04.3211839+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-28T02:57:04.3211839+00:00",
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00",
"is_mobile_installation": true
},
"job_type_id": "e851573a-00f2-467e-8658-ceee7eff3bf3",
"job_type_code": "sample string 7",
"job_type": {
"id": "99123c29-28cb-4d5b-8aa5-7b49cbaf5e8e",
"name": "sample string 2",
"sales_organization_id": "a182dc65-bc5d-4e54-a9d5-dc98a7783182",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00",
"code": "sample string 7"
},
"job_priority_id": "169b678e-48e9-4820-8c68-e3bafd790ca0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "71e5a27d-f75b-40e5-8273-ab7fd27ad899",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8bcc56f6-ccb2-4dbb-90e5-de85b5e576fa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00"
},
"job_status_id": "dbf3114c-1858-46a5-abc1-38df688133c8",
"job_status_code": "sample string 11",
"db_address_id": "e178413e-fd53-4bba-b831-2f523114596d",
"contact_id": "80ed7d5e-11c1-4e01-bcc5-3062864f25f4",
"requested_by_company_id": "96dbf862-26aa-43cb-b9e0-b54c9585db8a",
"requested_by_contact_id": "1e96a4e6-c185-4344-9f62-6157a49118db",
"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-07-28T02:57:04.3211839+00:00",
"due_date": "2026-07-28T02:57:04.3211839+00:00",
"date_create": "2026-07-28T02:57:04.3211839+00:00",
"date_update": "2026-07-28T02:57:04.3211839+00:00",
"date_closed": "2026-07-28T02:57:04.3211839+00:00",
"suggested_user_id": "e5bdae5f-de15-4272-8a24-e5440a23dccc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "578a1441-629d-40bb-9c02-fa01ac9ddb7d",
"db_language_id": "ff3004e1-5d7a-46f3-8710-38ed1745f41e",
"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-07-28T02:57:04.3211839+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "232d00f9-9a32-4460-a756-653657cabbe9",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f1e4bef3-a228-4a40-8dcf-166e9f5cb06e",
"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": "fa93d618-3f78-4a5a-a54c-3e10124e259d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "48f7b13e-5b0b-4f9d-a173-699fc253f668"
},
"suggested_date_start": "2026-07-28T02:57:04.3211839+00:00",
"skill_id": "61545648-942f-4e5e-8542-41c2df91424d",
"skill_code": "sample string 32",
"skill": {
"id": "b6108e76-952f-4564-890e-51482ed0d6dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "84106932-3e44-43ac-a8e0-656307b2d668",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f59cc071-6ced-4689-b7af-99d1a5fd3317",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea463923-c8a7-4bfe-8d4c-4b1dcc63b222",
"db_currency_id": "aa156d53-85aa-4221-aece-cd60cb894748",
"db_language_id": "9dd2f3b3-993c-4143-9380-d61b076f3556",
"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-07-28T02:57:04.3211839+00:00"
},
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dd74ca33-b194-41b5-a2e7-6975c24df569",
"date_reported_by_company": "2026-07-28T02:57:04.3211839+00:00",
"id2": 36,
"company_id": "8aea1d7a-2905-4dfc-a62a-7e4edd63828c",
"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": "77a3c69b-6dbb-4a7d-84d9-5dff33dfa205",
"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-07-28T02:57:04.3211839+00:00"
},
"work_instruction_details_id": "aeaa6d9d-558a-4570-9370-a1ccb212da7b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "77977688-2e9b-47af-af4a-f7069a128c6a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3889effc-7ac4-463c-8f60-b9a1adfb9956",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-28T02:57:04.3211839+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": "d92bfd41-8044-4fe6-9c30-b2503bfce6b7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-28T02:57:04.3211839+00:00"
}