Get Data Schema - State Solutions

Provides data types and field names into the schema derived from a complex array of objects.

Version 1

HTTP Request
POST /ado/v1/GetDataSchema

Header

Parameter	Description
Ocp-Apim-Subscription-Key	The subscription key you received when you purchased a plan.

Request Body

Mandatory

Parameter	Type	Description
data	Object[]	Array containing one or more single level objects.

Common

Further Documentation: Common Parameters

Parameter	Type	Description
filter	String	A fully functioning SQL based WHERE statement that will filter the outgoing dataset to the records it determines as being included.
sortOrder	Object	Sorts the resulting dataset by the criteria provided. The object should contain property names that represent properties contained within the resulting dataset with a value corresponding to the desired sort direction (i.e. `ASC` or `DESC`).
schema	Object	You can use this parameter to override the inferred schema for properties in the incoming dataset(s). A field will be inferred unless specific explicitly within this object.
advancedOptions	Object	Is an object with the following properties. cultureName (String) The specified culture determines the behaviour for aspects related to formatting numeric values and dates. Is extremely important when converting strings to dates, e.g. 05/03/2022 will be treated differently between locales. For more information on the accepted values for this property, please consult the documentation from Microsoft … https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-6.0#culture-names-and-identifiers isBoolean (string[]) A list of strings that are the names of all properties in the resulting dataset that should be treated as boolean values. By default, the framework treats boolean values as 1 (true) or 0 (false). In order to differentiate the integer as a boolean, the property in question needs to be called out explicitly in this list.

Examples

Basic

A basic example demonstrating multiple types of data and the resulting response.

Request

{
    "Data": [
        {
            "DateTimeField": "2022-04-23T18:25:43",
            "Field1": "Value 1.1",
            "Field2": "Value 1.2",
            "Field3": "Value 1.3",
            "KeyFigure1": 10.3232,
            "KeyFigure2": 10,
            "BooleanField": true
        },
        {
            "DateTimeField": "2022-05-03T14:45:15",
            "Field1": "Value 2.1",
            "Field2": "Value 2.2",
            "Field3": "Value 2.3",
            "KeyFigure1": 16.3212,
            "KeyFigure2": 16,
            "BooleanField": false
        }
    ]
}
Code language: JSON / JSON with Comments (json)

Response

[
    {
        "fieldName": "DateTimeField",
        "fieldType": "DATETIME"
    },
    {
        "fieldName": "Field1",
        "fieldType": "TEXT"
    },
    {
        "fieldName": "Field2",
        "fieldType": "TEXT"
    },
    {
        "fieldName": "Field3",
        "fieldType": "TEXT"
    },
    {
        "fieldName": "KeyFigure1",
        "fieldType": "REAL"
    },
    {
        "fieldName": "KeyFigure2",
        "fieldType": "INT"
    },
    {
        "fieldName": "BooleanField",
        "fieldType": "BOOLEAN"
    }
]
Code language: JSON / JSON with Comments (json)