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": "ab54d09b-e08d-4b42-83ab-faa4f0b0c16b",
"jobs_id": "6a27b3de-f857-48f9-bb06-60cbc94ef77e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "13c64320-1e14-4cc3-815c-4f5c1fa44b99",
"_parent_id": "0bea1d23-ce55-4b2f-b032-7c14f1d55e47",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "360ea34f-c77e-4b73-af19-95e57607b2ab",
"project_reference_back_office": "sample string 5",
"project": {
"id": "65859c70-390c-4983-af49-acd152b5565a",
"_parent_id": "e6aaa82c-a6e8-42a4-be20-d9377943a40e",
"root_parent_id": "57688ed7-d311-4fbd-a91f-d050e6dfa083",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6d41d7a0-dd0a-4489-a1a1-c91149b51768",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5a9edb99-b375-4ee7-967c-82ae81bb270e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d0f08ba1-273d-4ee2-aad2-901187e36494",
"_parent_code": "sample string 6",
"sales_organization_id": "83772725-e63f-4fff-9e78-bbd69436f839",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+00:00"
},
"modified_dateutc": "2025-11-16T08:19:18.1847138+00:00"
},
"equipment_model_id": "b00ba852-ff47-4a2a-80e2-21755420a877",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f8ba12bd-21ae-4925-a847-c6aea4432d69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "28e8a3be-8535-46c3-af0e-5bae0bfccf04",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b8b896cd-c470-4db7-9cba-4a17c3f8b269",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a040ffd3-7a41-48e9-bb40-2f283a895180",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+00:00"
},
"modified_dateutc": "2025-11-16T08:19:18.1847138+00:00"
},
"equipment_family_id": "91d18c44-4744-411a-9c7d-cf0f2d1820ae",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5a9edb99-b375-4ee7-967c-82ae81bb270e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d0f08ba1-273d-4ee2-aad2-901187e36494",
"_parent_code": "sample string 6",
"sales_organization_id": "83772725-e63f-4fff-9e78-bbd69436f839",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+00:00"
},
"modified_dateutc": "2025-11-16T08:19:18.1847138+00:00"
},
"date_in_production_since": "2025-11-16T08:19:18.1847138+00:00",
"date_out_of_production_since": "2025-11-16T08:19:18.1847138+00:00",
"date_end_support": "2025-11-16T08:19:18.1847138+00:00",
"sales_organization_id": "e8544a77-059e-4f4e-a468-dda222802705",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+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-11-16T08:19:18.2003393+00:00"
},
"project_status_id": "593a2301-a671-4304-99ae-7c8fbed3247f",
"project_status_code": "sample string 10",
"project_status": {
"id": "3d48c828-d6c2-44ed-9230-8087d14f3933",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0a5b27c1-6b47-4a69-bb15-c7368e341c73",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T08:19:18.2003393+00:00"
},
"company_id": "e0a9df74-669e-4348-b558-44a2bacda929",
"company_code": "sample string 12",
"db_address_id": "b9dd277a-dba5-4108-9f4e-1b0bd5eb761b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1e881ef0-9aac-43bb-84fb-5d52759d2cc8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4ef2eba1-142b-4081-bd08-4bbb6e4f6d47",
"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-11-16T08:19:18.2003393+00:00",
"date_create": "2025-11-16T08:19:18.2003393+00:00",
"date_update": "2025-11-16T08:19:18.2003393+00:00",
"updated_by_user_id": "bb75f2bb-b0a6-40c9-939b-b45e77f3732d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-16T08:19:18.2003393+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-11-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-16T08:19:18.2003393+00:00",
"date_last_job": "2025-11-16T08:19:18.2003393+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-16T08:19:18.2003393+00:00",
"modified_dateutc": "2025-11-16T08:19:18.2003393+00:00",
"is_mobile_installation": true
},
"job_type_id": "4884eea5-01f9-4396-977f-ffcb3e50ff75",
"job_type_code": "sample string 7",
"job_type": {
"id": "29bd0532-b06e-4d6c-9e91-27bece3c91c7",
"name": "sample string 2",
"sales_organization_id": "c98b3d5e-3ab6-411a-a98f-9fb3ff5c3764",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-16T08:19:18.2003393+00:00",
"code": "sample string 7"
},
"job_priority_id": "580aea2b-53c5-4791-8204-7b28c20b7cff",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ce98827a-ef38-4cbd-97e7-27eedc71b1e2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "16fe1625-7613-445d-9b1e-7ca4fe6abe0f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T08:19:18.2003393+00:00"
},
"job_status_id": "e81017c2-56c1-4631-83ac-b78e292234e8",
"job_status_code": "sample string 11",
"db_address_id": "e942b2a9-ab14-4240-9e45-3a2bc3eb267e",
"contact_id": "e27896d6-1b71-494c-9216-57ca760981a6",
"requested_by_company_id": "b9f8ceff-b4dd-4a59-b3e9-e96366c73618",
"requested_by_contact_id": "ab6704db-52a2-49e5-90c9-521a36033767",
"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-11-16T08:19:18.2003393+00:00",
"due_date": "2025-11-16T08:19:18.2003393+00:00",
"date_create": "2025-11-16T08:19:18.2003393+00:00",
"date_update": "2025-11-16T08:19:18.2003393+00:00",
"date_closed": "2025-11-16T08:19:18.2003393+00:00",
"suggested_user_id": "c920c2b6-53fa-4eb0-a55f-24dfd8ef8a1e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f47ed273-12e7-4229-8157-e31b70e644f3",
"db_language_id": "201fd84d-ab8e-4516-9785-380ec663496c",
"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-11-16T08:19:18.2003393+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ab162a0b-f30e-4004-ac36-0bafbff1066f",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c79eb006-eae5-4bc7-86b7-59d450a330ce",
"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": "ea13b4e2-426b-4142-bcc2-cf3bfff675e3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-16T08:19:18.2003393+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "06609d38-a59e-42d6-9983-96d9e4805d31"
},
"suggested_date_start": "2025-11-16T08:19:18.2003393+00:00",
"skill_id": "955cddef-a223-4eaf-9cde-2d7556056e62",
"skill_code": "sample string 32",
"skill": {
"id": "888b3cb5-db81-411e-a492-3602bed3fa86",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "588e2821-d11d-43ae-9307-7cb5eb90c4dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "697fcd34-7949-4717-af10-f5f7f11ae8ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff96f13-4125-452a-8462-18293d3303ba",
"db_currency_id": "52a9b00c-a834-4770-9f07-9cf54acdd5d7",
"db_language_id": "b137380e-4aed-46d7-a8a0-ca235d7f9457",
"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-11-16T08:19:18.1847138+00:00"
},
"modified_dateutc": "2025-11-16T08:19:18.2003393+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6864f2f6-3351-4fec-ba96-a269473941ff",
"date_reported_by_company": "2025-11-16T08:19:18.2003393+00:00",
"id2": 36,
"company_id": "562f0a35-d440-4716-be41-4a33c8344f11",
"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": "cece548d-6be5-4c62-8469-f92fbc9addc5",
"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-11-16T08:19:18.2003393+00:00"
},
"work_instruction_details_id": "a1319bf5-e34f-4f79-ad83-b4bec775522b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "941ce84c-7105-409a-85bd-38d30b625494",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1d3ddcf6-3c6b-48e5-9b7d-26cb148e3a5a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-16T08:19:18.2003393+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": "a10d98d9-905a-49de-a240-469273e94dbe",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-16T08:19:18.2003393+00:00"
}