The platform's Record APIs can be used to retrieve data in the form of individual records, or pages of multiple records.
Listing records
The platform can be used to retrieve a page of matching records of a specific type (a "Record Type").
The pattern for the URL used to list records of a specific (preview) record type is:
GET https://{mydomain}.readinow.com/api/v1/preview/records/{record-type-name}The pattern for the URL used to list records of a specific (published) record type is:
GET https://{mydomain}.readinow.com/api/v1/records/{record-type-name}/r{record-type-revision}The following query parameters are supported:
| Parameter | Description |
|---|---|
| $filter | A Calculation expression used to filter the returned records |
| $sort | A comma-separated list of field names used to sort the returned records |
| $skip | The (0-based) index of the first record to return. If omitted, defaults to 0 (i.e. the first record). |
| $take | The number of records to return. If omitted, the system default is used (usually 25). |
Example
Using Postman, a new request was created and GET was selected from the method drop down.
Selected the Authorization tab and for the Type drop down, Bearer Token was selected.
The value of the Response Payload attribute called “access_token” generated using the token service was pasted into the Token field (Refer to Record APIs - Getting Started, under Requesting an Access Token for instructions on how to generate the Access Token).
The Params tab was selected and populated as shown in the screenshot below. This example lists all matching Person records.
In this case there are only 2 Person records that exist, which results in the following response:
{
"status": "Success",
"message": "2 record(s) returned.",
"correlationCode": "Z564973-070925",
"type": {
"id": 16017,
"name": "Person",
"slug": "person",
"application": {
"name": "ReadiNow Core"
},
"revision": 1
},
"sort": [{
"field": "Name",
"direction": "Ascending"
}],
"count": 2,
"first": 1,
"last": 2,
"data": [{
"uid": "f70aa441-f9ba-470a-986b-26959e759cd6",
"lid": 16318,
"name": "Jack Admin",
"firstName": "Jack",
"lastName": "Admin"
},
{
"uid": "38614861-6593-4044-bb33-b1876b4b343c",
"lid": 27465,
"name": "Shared Service Account",
"firstName": "Shared",
"lastName": "Service Account"
}
]
}Retrieving a specific record
The platform can be used to retrieve a specific record of a specific type (a "Record Type"). Each record has a unique identifier (UID) which is fixed for the lifetime of that record.
The pattern for the URL used to retrieve a specific record of a specific (preview) record type is:
GET https://{mydomain}.readinow.com/api/v1/preview/records/{record-type-name}/by/uid/{record-uid}The pattern for the URL used to retrieve a specific record of a specific (published) record type is:
GET https://{mydomain}.readinow.com/api/v1/records/{record-type-name}/r{record-type-revision}/by/uid/{record-uid}Example
The following example uses Postman to retrieve the Person record with UID "f70aa441-f9ba-470a-986b-26959e759cd6".
Which returns the following response:
{
"status": "Success",
"correlationCode": "Z403181-071244",
"type": {
"id": 16017,
"name": "Person",
"slug": "person",
"application": {
"name": "ReadiNow Core"
},
"revision": 1
},
"data": {
"uid": "f70aa441-f9ba-470a-986b-26959e759cd6",
"lid": 16318,
"name": "Jack Admin",
"firstName": "Jack",
"lastName": "Admin"
}
}