JSON New Record List

Describes a list of new data records (and their data field values (as name/value pairs)) to be added as data record entities to either an existing data set or data record entity of a specific ID.

Structure

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

  • records – a list of the new data records to be added, consisting of an array of objects each with the following name/value pairs:

    • fields – a list of data fields for the data record, 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 the adding of data records to the record data table of an existing data set entity, an additional name/value pair is included:

  • datasetid – the data set entity identifier of parent entity (type of number)

Specific to the adding of nested data records to a data table of an existing data record entity, two additional name/value pairs are included:

  • recordid – the data record entity identifier of parent entity (type of number)

  • table – the data record entity data table name (type of string)

Example

The following are examples of this structure:

{
    "datasetid": 12345,
    "records": [
        {
            "fields": [
                {
                    "name": "ID",
                    "value": "CU00048376"
                },
                {
                    "name": "Gender",
                    "value": "M."
                },
                {
                    "name": "FirstName",
                    "value": "Benjamin"
                },
                {
                    "name": "LastName",
                    "value": "Verret"
                }
            ]
        },
        {
            "fields": [
                {
                    "name": "ID",
                    "value": "CU01499303"
                },
                {
                    "name": "Gender",
                    "value": "Miss"
                },
                {
                    "name": "FirstName",
                    "value": "Dianne"
                },
                {
                    "name": "LastName",
                    "value": "Straka"
                }
            ]
        }
    ]
}
{
    "recordid": 12345,
    "table": "detail",
    "records": [
        {
            "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"
                }
            ]
        },
        {
            "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"
                }
            ]
        }
    ]
}