Service Modules > Scheduling and Optimization > Service Board > Max for Developers > Appendix B: Max REST API > View API Version 2 > Read Records of Views
Read Records of Views
Method
POST
URL
/v2/view/records/<view_UUID>
Parameters
limit, offset, exclude_total_count, sort, data_format
Response Content Type
application/json
Parameters
Parameter
Description
Data Type
Example
limit
The number of records to retrieve. SMQL LIMIT clause syntax is supported. If specified, the response includes the X-Total-Count header with the total count of records that can be retrieved without the limit. Consider using exclude_total_count if calculation of this value is not performant.
If not specified, all undeleted records associated with a view are retrieved.
Integer
Retrieve only 100 records for the specified view:
/v2/view/records/<view_UUID>?limit=100
offset
Offset to use to retrieve records. ServiceMax recommends combining this parameter with the sort parameter. SQML OFFSET clause syntax is supported
If not specified, records are retrieved with no offset.
Integer
Retrieve the next 100 records after the first 500 for the specified view:
/v2/view/records/<view_UUID>?limit=100&offset=500
exclude_total_count
Set this flag to exclude the X-Total-Count header, which is provided by default when you use limit to specify the number of records returned.
If limit is not set and the total number of selected records is large, performance may be impacted depending on permissions configuration. In these cases, use this parameter to reduce the number of calculation iterations of the total count.
Boolean
Retrieve the next 100 records after the first 500, ordered by name, without calculating the total count.
/v2/view/records/<view_UUID>?sort=io_name&limit=100&offset=500&exclude_total_count=true
sort
Sorting criteria for retrieved records.
If not specified, records are retrieved based on their order in the database.
For more information, see View Record Sorting.
String
Retrieve all records sorted by Created On in descending order:
/v2/view/records/<view_UUID>?sort=io_created_on.desc
data_format
The output data format. Supported values are basic (default) and extended.
The basic format corresponds to the example response shown above. The extended format includes additional information for specific data types. For more information, see Extended Output Data Format.
String
Retrieve records in extended output data format:
/v2/view/records/<view_UUID>?data_format=extended
suppress_ror
Whether to bypass recalculation for recalculate-on-read fields.
When specified, RoR fields are read instead of recalculated, and their values are returned from the database.
Boolean
Retrieve View records with recalculate-on-read suppressed:
/v2/view/records/<object_full_identifier>?suppress_ror=true
Input Example
Following is an example POST request to retrieve all records in the All Data Types view of the Showcase object, with a limit value of 10 and an offset value of 0:
POST https://<server>/v2/view/records/c36fabdb-98dd-4b09-b030-df28d922e9d5?limit=10&offset=0
Response Example
The response is a JSON representation of a list of records of the specified view. Following is an example Status Code 200 response for the previous request:
[
{
"__object_identifier": "io_showcase",
"io_uuid": "41f19ff6-2738-4000-8bfd-a18950caa1d1",
"io_showcase_number": 3.1426,
"io_showcase_text": "Sample Text",
"io_showcase_percent": 0.9999,
"io_showcase_quantity": "1888 dd574d5a-c7bf-11e0-b724-001ec950a80f"
... // The rest of the fields of the first record.
},
... // The following records up to 10.
]
Input Example: Extended Data Format
Following is an example of the previous request when data_format=extended is specified:
POST https://<server>/v2/view/records/c36fabdb-98dd-4b09-b030-df28d922e9d5?limit=10&offset=0&data_format=extended
Response Example
[
{
"__object_identifier": "io_showcase",
"io_uuid": "41f19ff6-2738-4000-8bfd-a18950caa1d1",
"__primary_name_field": "io_name",
"io_showcase_number": 3.1426,
"io_showcase_text": "Sample Text",
"io_showcase_percent": 0.9999,
"io_showcase_quantity": {
"amount": 1888,
"unit_symbol": "s",
"unit_name": "seconds",
"unit_uuid": "dd574d5a-c7bf-11e0-b724-001ec950a80f"
},
... // The rest of the fields of the first record.
},
... // The following records up to 10.
]
For more information:
Was this helpful?