JSON Data Record Identifier List (with Parameters)

Describes a list of identifiers for multiple data entities (specifically data record entities), along with additional parameters.

It is used specifically with the Data Record Entity service as input to the Get Multiple Data Record Values (JSON) resource method. The value of the explicitTypes parameter determines if the result returned is either a JSON Record Content Lists or JSON Record Content Lists (Explicit Types) structure.

Structure

The structure consists of an object with the following name/value pairs:

• recordids – an array of data record entity identifiers (type of number)

• recursive – parameter to specify if all data tables within each data record should be recursed and the values of any nested data records retrieved also (type of boolean)

• explicitTypes – parameter to specify if both data record values and data types are to be retrieved (type of boolean)

• optimized (optional) – parameter to specify whether the method can retrieve items in an optimized way.
  If true, the resulting JSON is streamed back to the client as soon as the first record is available to return. Duplicate record IDs from the request are ignored: for any duplicated record ID in a list of requested IDs, a single entry is returned. The resulting JSON does not respect the order of requested record IDs. The resulting JSON has ASC order based on the data record IDs.
  Default: false.

• batchsize (optional) - parameter to specify a custom batch size. For smaller records the batch size can be over 1000; for bigger records it has to be less. Default: 1000.

Example

The following is an example of this structure:

{
    "recordids": [ 12345, 23456, 34567 ],
    "recursive": true,
    "explicitTypes": false,
    "optimized": true, 
    "batchsize": 1200
}