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": "121a8fd1-24d7-4009-8f57-2bc181e9beaf",
"jobs_id": "a281c60d-9740-4f14-868a-ffcb552b2071",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "39daa04f-8342-481b-88a2-533ed1558557",
"_parent_id": "af36fde0-8f61-4c3c-ada2-b7535e0a7db5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7f9dbf30-4aaa-4757-bc7a-c7b569155d55",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5a01e6c8-2058-4350-a03a-460c0ea9c189",
"_parent_id": "e298d8b1-6dea-45be-ad8f-86567e36d9eb",
"root_parent_id": "9d064747-6a62-4829-b1b6-67220bf88d2b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4134b7ef-f24e-407c-999d-490b509b0704",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "22368286-aa77-47a6-ab39-2e614fb3bf71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "de810cc8-bf99-45be-b01b-19c0d6ca2e78",
"_parent_code": "sample string 6",
"sales_organization_id": "c490fb0b-0966-4480-8ca5-c0172b420c6e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00"
},
"equipment_model_id": "29542160-eadc-44ab-bf2e-0cc07d0e536c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "69d166d6-04ca-4a1b-8e29-5700e84bd37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "359382b7-de64-48c3-ada7-e4d1dec91f2a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c4b9dc90-9b26-47c4-b3c8-e24fcf5c1781",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dc39edba-1062-4dce-85e7-6f9815192984",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00"
},
"equipment_family_id": "2527d3df-2c1f-43e5-8da9-a8bcbce81767",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "22368286-aa77-47a6-ab39-2e614fb3bf71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "de810cc8-bf99-45be-b01b-19c0d6ca2e78",
"_parent_code": "sample string 6",
"sales_organization_id": "c490fb0b-0966-4480-8ca5-c0172b420c6e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00"
},
"date_in_production_since": "2025-09-15T09:08:06.8701201+00:00",
"date_out_of_production_since": "2025-09-15T09:08:06.8701201+00:00",
"date_end_support": "2025-09-15T09:08:06.8701201+00:00",
"sales_organization_id": "ff251738-3435-4b8b-b304-15bbef4cdcff",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+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": "2025-09-15T09:08:06.8701201+00:00"
},
"project_status_id": "3af321cf-81bc-4537-9e31-6d1828891287",
"project_status_code": "sample string 10",
"project_status": {
"id": "a8ae0a2b-ad9f-4eb5-ade8-0a4791bcd72b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "decc3246-0ecc-4955-87b3-a369b1b2a15b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00"
},
"company_id": "cf311467-fb06-43ea-8757-666ab4c79db3",
"company_code": "sample string 12",
"db_address_id": "fabaf8d3-7cca-4af0-8c5c-3e2d2181d3c1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ef618fb3-753b-425e-997e-ce96ba65a364",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cd66d087-0ea1-4d5c-a0b3-c8f0e0fc9b9d",
"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": "2025-09-15T09:08:06.8701201+00:00",
"date_create": "2025-09-15T09:08:06.8701201+00:00",
"date_update": "2025-09-15T09:08:06.8701201+00:00",
"updated_by_user_id": "396a2653-02b9-47c5-8eff-4be1da6219b0",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-15T09:08:06.8701201+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": "2025-09-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-15T09:08:06.8701201+00:00",
"date_last_job": "2025-09-15T09:08:06.8701201+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-15T09:08:06.8701201+00:00",
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00",
"is_mobile_installation": true
},
"job_type_id": "48e6afc8-7ecf-4f6f-b696-b1576982ad3c",
"job_type_code": "sample string 7",
"job_type": {
"id": "5192a333-94f6-4472-b329-20baf7742dd3",
"name": "sample string 2",
"sales_organization_id": "5fd19289-a3d1-45b0-91f2-a933a07b0c58",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00",
"code": "sample string 7"
},
"job_priority_id": "77d2de5d-c4fb-4f23-87f7-c05e9095a367",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ab388158-881d-4357-b5fe-713633ba4b00",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f68d161a-bbdf-4de5-8fd6-1508aebefe83",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00"
},
"job_status_id": "39479396-0b50-411c-9645-9ed1961a2f8f",
"job_status_code": "sample string 11",
"db_address_id": "a97f9bdd-9371-4a4c-8efe-eda95688b556",
"contact_id": "849b425c-1ce5-4c6e-aea5-db0bb01c344c",
"requested_by_company_id": "af540afb-fe21-4d67-9d6d-ddd33a4f3c1e",
"requested_by_contact_id": "202e937e-2bd8-495d-8dd7-8e9fd218dfa9",
"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": "2025-09-15T09:08:06.8701201+00:00",
"due_date": "2025-09-15T09:08:06.8701201+00:00",
"date_create": "2025-09-15T09:08:06.8701201+00:00",
"date_update": "2025-09-15T09:08:06.8701201+00:00",
"date_closed": "2025-09-15T09:08:06.8701201+00:00",
"suggested_user_id": "6de541ba-6ac2-4aa6-8279-9e0f81fdfe73",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8189a0a5-19cf-4495-aee6-604aa593be1f",
"db_language_id": "818b1485-03a9-4cbb-b07c-b72240316b6c",
"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": "2025-09-15T09:08:06.8701201+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "947dcce2-c45b-490d-9383-933b2638b97e",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e295bc3d-5374-4315-b8c7-ef0709ce1da3",
"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": "2ce63e50-8570-43a0-8d26-032754c52ac1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5681e820-a57e-4a3b-9414-26ea68c930d3"
},
"suggested_date_start": "2025-09-15T09:08:06.8701201+00:00",
"skill_id": "666ca0a1-3da9-48fc-8220-df4e9817cc5a",
"skill_code": "sample string 32",
"skill": {
"id": "4166a878-379d-432f-b75c-8c26b0a0ae1e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "28f2a569-dbbf-43b5-b35b-bfe79274f92b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "faff7cbf-3fde-45fe-b905-51be9bae50b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e34da232-60c1-456c-9d8f-714774419e98",
"db_currency_id": "01558e6f-a160-4308-bf3a-efd14cd056eb",
"db_language_id": "6c8994dd-7c2f-44c3-a494-c267cebf889c",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e1bd977e-909d-4bf6-a3b6-24811d3b9c1d",
"date_reported_by_company": "2025-09-15T09:08:06.8701201+00:00",
"id2": 36,
"company_id": "83bfd02b-468b-4223-ac22-927b40284ef3",
"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": "254d6ffe-8981-41b4-95dd-3a73d20fc624",
"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": "2025-09-15T09:08:06.8701201+00:00"
},
"work_instruction_details_id": "aeb74f55-ef71-45f2-b1c2-abd18786d4f6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5464d185-0ffd-4cf0-8794-1367cec8987a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "98032acd-d372-4984-8c0b-b710c933b207",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-15T09:08:06.8701201+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": "67d63322-29bc-4f82-b257-83e2ef0a08ca",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-15T09:08:06.8701201+00:00"
}