Get Data Record Values

Returns a list of the values for a specific Data Record entity, and potentially the values of any nested Data Records (if recursive).

Request takes no content, and on success returns a response containing either:

Request

Method Type:

GET

URI:

/rest/serverengine/entity/datarecords/{dataRecordId}/values

Content: –
Content Type:

–

Add. Headers:

If server security settings are enabled, then one of the following:

  • Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded)
  • auth_token – Authorization Token

Parameters

Path

Name Required Type Default Value Description
dataRecordId

–

–

–

ID of the Data Record entity in Server

Query

Name Required Type Default Value Description
recursive

–

–

False

Recurse all Data Tables within the Data Record and retrieve the values of any nested Data Records
explicitTypes

–

–

False

Deprecated

Retrieve both values and data types of the Data Record
outputFormat

–

–

default

The output format of the data (either default, explicitTypes or simplified).

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 List of the values for Data Record application/json – Data Record entity values successfully retrieved
200
OK		 JSON Record Content List (Explicit Types) of the values and data types for Data Record application/json – Data Record entity values and data types 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:

  • basic authentication credentials nor an authorization token have been specified in the request headers

  • the basic authentication credentials or the authorization token specified in the request headers are invalid

  • the authorization token specified in the request headers has now expired

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
Internal Server Error

JSON Error specifying error message

application/json

–

 Server error or invalid Data Record ID specified