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

Retrieve both values and data types of the Data Record

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

WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)

Server authentication is required.

Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

401 Unauthorized

Error message

Server authentication has failed.

Response when the authorization token specified in the request headers has now expired.

403 Forbidden

Error message

Server authentication has failed.

Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

500
Internal Server Error

Server error or invalid Data Record ID specified