JSON Record Content List

Describes a list of data fields (as name/value pairs), nested data records (if any), along with a number of additional properties for a data record entity of a specific ID.

A data record entity (in the root or master data table) can contain one or more data tables that each contain one or more data record entities (nested data record entities).

A nested data record entity can itself contain one or more data tables that each contain one or more nested data record entities, and so on for potentially multiple levels of nested data tables and data record entities.

A data record entity that contains a data table of nested data record entities is considered to be the parent of the data record entities contained in that data table (which are considered to be the children).

See the Data Entities page of the Technical Overview section for further detail on data set and data record entities.

Structure

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

id – the data record entity identifier (type of number)
fields – a list of data fields in the data record entity, consisting of an array of objects each with the following name/value pairs:

name – the name of the data field (type of string)
value – the value of the data field (type of string)

records – a list of any nested data record entities, consisting of an array of objects each with the following name/value pairs:

id – the data record entity identifier (type of number)
table – the data record entity data table name (type of string)
parentrecordid – the data record entity identifier of parent entity (type of number)
fields – a list of data fields in the data record entity, consisting of an array of objects each with the following name/value pairs:

name – the name of the data field (type of string)
value – the value of the data field (type of string)

Specific to data record entities that are children of a data set entity (data record entities in the root or master data table), two additional name/value pairs are included:

table – the data record entity data table name (value of record) (type of string)
datasetid – the data set entity identifier of parent entity (type of number)

If a data record entity contains boundary information (set from the data source during data mapping), then an additional name/value pair is also included:

boundaries – the boundaries for the data record, consisting of an object with the following name/value pairs:

start – the starting boundary value for the data record (type of number)
end – the ending boundary value for the data record (type of number)

Specific to nested data record entities that are children of a data record entity, two additional name/value pairs are included:

table – the data record entity data table name (type of string)
parentrecordid – the data record entity identifier of parent entity (type of number)

Example

The following are examples of this structure:

{
    "id": 12345,
    "table": "record",
    "datasetid": 34567,
    "fields": [
        {
            "name": "ID",
            "value": "CU00048376"
        },
        {
            "name": "Gender",
            "value": "M."
        },
        {
            "name": "FirstName",
            "value": "Benjamin"
        },
        {
            "name": "LastName",
            "value": "Verret"
        }
    ]
}

{
    "id": 45678,
    "table": "detail",
    "parentrecordid": 23456,
    "fields": [
        {
            "name": "ItemNumber",
            "value": "PSM002"
        },
        {
            "name": "ItemDesc",
            "value": "PSM Production (unlimited)"
        },
        {
            "name": "ItemUnitPrice",
            "value": "495.00"
        },
        {
            "name": "ItemOrdered",
            "value": "2"
        },
        {
            "name": "ItemTotal",
            "value": "990.00"
        }
    ]
}

{
    "id": 23456,
    "table": "record",
    "datasetid": 12345,
    "fields": [
        {
            "name": "ID",
            "value": "CU00048376"
        },
        {
            "name": "Date",
            "value": "2012-03-29T13:00Z"
        },
        {
            "name": "DueDate",
            "value": "2012-04-28T14:00Z"
        },
        {
            "name": "InvNumber",
            "value": "INV9441991"
        },
        {
            "name": "Gender",
            "value": "M."
        },
        {
            "name": "FirstName",
            "value": "Benjamin"
        },
        {
            "name": "LastName",
            "value": "Verret"
        }
        {
            "name": "TotalOrdered",
            "value": "3"
        },
        {
            "name": "InvSubTotal",
            "value": "1485.00"
        },
        {
            "name": "InvTaxTotal",
            "value": "111.38"
        },
        {
            "name": "InvTotal",
            "value": "1596.38"
        }
    ],
    "records": [
        {
            "id": 45678,
            "table": "detail",
            "parentrecordid": 23456,
            "fields": [
                {
                    "name": "ItemNumber",
                    "value": "PSM002"
                },
                {
                    "name": "ItemDesc",
                    "value": "PSM Production (unlimited)"
                },
                {
                    "name": "ItemUnitPrice",
                    "value": "495.00"
                },
                {
                    "name": "ItemOrdered",
                    "value": "2"
                },
                {
                    "name": "ItemTotal",
                    "value": "990.00"
                }
            ]
        },
        {
            "id": 45679,
            "table": "detail",
            "parentrecordid": 23456,
            "fields": [
                {
                    "name": "ItemNumber",
                    "value": "PSM005"
                },
                {
                    "name": "ItemDesc",
                    "value": "Upgrade (Starter to Web)"
                },
                {
                    "name": "ItemUnitPrice",
                    "value": "495.00"
                },
                {
                    "name": "ItemOrdered",
                    "value": "1"
                }
                {
                    "name": "ItemTotal",
                    "value": "495.00"
                }
            ]
        }
    ]
}

{
    "id": 12345,
    "table": "record",
    "boundaries": {
        "start": 0,
        "end": 4
    },
    "datasetid": 34567,
    "fields": [
        {
            "name": "ID",
            "value": "CU00048376"
        },
        {
            "name": "Gender",
            "value": "M."
        },
        {
            "name": "FirstName",
            "value": "Benjamin"
        },
        {
            "name": "LastName",
            "value": "Verret"
        }
    ]
}