Get Multiple Data Record Values
Returns a list of the values for one or more Data Record entities, and potentially the values of any nested Data Records (if recursive).
Request takes no content, and on success returns a response containing either:
- JSON Record Content Lists of all the values for each Data Record.
- JSON Record Content Lists (Explicit Types) of all the values and data types for each Data Record
- JSON Record Content Lists (simplified) of all the values for each Data Record.
Request
Method Type: |
GET |
---|---|
URI: | |
Content: | – |
Content Type: |
– |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Query
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
id |
– |
– |
– |
ID of each Data Record entity in Server |
recursive |
– |
– |
False |
Recurse all Data Tables within each Data Record and retrieve the values of any nested Data Records |
outputFormat |
– |
– |
default |
The output format of the data (either |
Note: Query parameters are case-sensitive.
Response
Success
The following lists status codes indicative of a successful response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
200 OK |
JSON Record Content Lists of the values for each Data Record | application/json | – | Data Record entity values successfully retrieved |
Error
The following lists status codes indicative of a failed or error response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
401 Unauthorized |
JSON Error specifying error message |
application/json |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication has failed. Response when either:
|
403 Forbidden |
JSON Error specifying error message |
application/json |
– |
Server authentication has succeeded, but user authorization for this specific method has failed. Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges. |
500 |
JSON Error specifying error message |
application/json |
– |
Server error or invalid Data Record ID specified |