AnswerX RKS API Data

This section provides you with the data model for the AnswerX RKS API.

Row

Encapsulates data for a row with either a call to a unique service ID or a call to a product name and contract ID.

For all REST methods (GET, PUT/POST, and DELETE), there are two ways to access your data: instance ID or product type and contract ID. See the Overview for more information.

This object may represent data with both static and RTT or dynamic tables.

Sample JSON response:

{
    "Key": "127.0.0.1",
    "Columns": [
        {
            "Value": "Utah"
        },
        {
            "Value": "127.0.0.1"
        }
    ]
}

Sample XML response:

<Row>
    <Key>127.0.0.1</Key>
    <Columns>
        <Column>
            <Value>127.0.0.1</Value>
        </Column>
        <Column>
            <Value>Utah</Value>
        </Column>
    </Columns>
</Row>

Row Members

Member Type Description
Required
Key String The value of the key column in the row to be returned. If no rows have a key column matching this string, an error will be returned. If the key column is of type STRING, then the key must be enclosed in URL-encoded double quotes (%22key%22).
Value String The value of the data to be returned.

Schema

Encapsulates the schema for a table with either a call to a unique service ID or a call to a product name and contract ID. Applies in GET operations when the action is set to schema or subscribe. This object only applies to dynamic tables.

Sample JSON response:

{
    "Field": [
        {
            "Name": "HostIP",
            "Type": "CIDR"
        },
        {
            "Name": "SubscriberID",
            "Type": "STRING"
        }
    ]
}

Sample XML response:

<Schema>
    <Field>
        <Name>HostIP</Name>
        <Type>CIDR</Type>
    </Field>
    <Field>
        <Name>SubscriberID</Name>
        <Type>STRING</Type>
    </Field>
</Schema>

Schema Members

Member Type Description
Required
Name String The name of the column.
Type Enumeration The type of data. The allowed types are INT, UINT64, STRING, or CIDR.

Last modified: 12/6/2016