Cartesian Join

Returns the Cartesian product of the sets of records from two or more joined datasets.

Version 1

HTTP Request
POST /ado/v1/CartesianJoin

Header

ParameterDescription
Ocp-Apim-Subscription-KeyThe subscription key you received when you purchased a plan.

Request Body

Mandatory

ParameterTypeDescription
dataObjectObject containing one or more other single level objects, or primitive type arrays. See examples for more information.
Each property defines a dataset that will form a part of the join.

Common

Further Documentation: Common Parameters

ParameterTypeDescription
filterStringA fully functioning SQL based WHERE statement that will filter the outgoing dataset to the records it determines as being included.
sortOrderObjectSorts 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).
schemaObjectYou 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.
advancedOptionsObjectIs 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

Simple
Complex

Three datasets all defined as a basic primitive array of numeric values.

Request

{
    "Data": {
        "Table1": [
            1,
            2,
            3
        ],
        "Table2": [
            1,
            2,
            3,
            4,
            5
        ],
        "Table3": [
            1,
            2
        ]
    }
}
Code language: JSON / JSON with Comments (json)

Response

[
    {
        "Table1": 1,
        "Table2": 1,
        "Table3": 1
    },
    {
        "Table1": 1,
        "Table2": 1,
        "Table3": 2
    },
    {
        "Table1": 1,
        "Table2": 2,
        "Table3": 1
    },
    {
        "Table1": 1,
        "Table2": 2,
        "Table3": 2
    },
    {
        "Table1": 1,
        "Table2": 3,
        "Table3": 1
    },
    {
        "Table1": 1,
        "Table2": 3,
        "Table3": 2
    },
    {
        "Table1": 1,
        "Table2": 4,
        "Table3": 1
    },
    {
        "Table1": 1,
        "Table2": 4,
        "Table3": 2
    },
    {
        "Table1": 1,
        "Table2": 5,
        "Table3": 1
    },
    {
        "Table1": 1,
        "Table2": 5,
        "Table3": 2
    },
    {
        "Table1": 2,
        "Table2": 1,
        "Table3": 1
    },
    {
        "Table1": 2,
        "Table2": 1,
        "Table3": 2
    },
    {
        "Table1": 2,
        "Table2": 2,
        "Table3": 1
    },
    {
        "Table1": 2,
        "Table2": 2,
        "Table3": 2
    },
    {
        "Table1": 2,
        "Table2": 3,
        "Table3": 1
    },
    {
        "Table1": 2,
        "Table2": 3,
        "Table3": 2
    },
    {
        "Table1": 2,
        "Table2": 4,
        "Table3": 1
    },
    {
        "Table1": 2,
        "Table2": 4,
        "Table3": 2
    },
    {
        "Table1": 2,
        "Table2": 5,
        "Table3": 1
    },
    {
        "Table1": 2,
        "Table2": 5,
        "Table3": 2
    },
    {
        "Table1": 3,
        "Table2": 1,
        "Table3": 1
    },
    {
        "Table1": 3,
        "Table2": 1,
        "Table3": 2
    },
    {
        "Table1": 3,
        "Table2": 2,
        "Table3": 1
    },
    {
        "Table1": 3,
        "Table2": 2,
        "Table3": 2
    },
    {
        "Table1": 3,
        "Table2": 3,
        "Table3": 1
    },
    {
        "Table1": 3,
        "Table2": 3,
        "Table3": 2
    },
    {
        "Table1": 3,
        "Table2": 4,
        "Table3": 1
    },
    {
        "Table1": 3,
        "Table2": 4,
        "Table3": 2
    },
    {
        "Table1": 3,
        "Table2": 5,
        "Table3": 1
    },
    {
        "Table1": 3,
        "Table2": 5,
        "Table3": 2
    }
]
Code language: JSON / JSON with Comments (json)