Add Data Records

Submits a request to add one or more Data Record entities to one or more entities in the Server as either:

  • a Data Record of an existing Data Set entity in the Server, or
  • a nested Data Record in a Data Table of an existing Data Record entity in the Server

Request takes JSON New Record Lists as content (each with the Data Set/Data Record ID, Data Table and the new records/values), and on success returns a response containing no content.

Request

Method Type:

POST

URI:

/rest/serverengine/entity/datarecords

Content: JSON New Record Lists of the new Data Records
Content Type:

application/json

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

Response

Success

The following lists status codes indicative of a successful response:

Status Code Content Content-Type Add. Headers Description
200
OK
Data Records for Data Set/Data Record entities successfully added

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

JSON New Record Lists invalid or missing required structure