Руководство

Типы данных

Типы данных при работе с API Status200.

Select

Select can be used to select fields from an Object in List or Get Item API. By default only IDs are returned. Use a select object mapping field names to booleans.

Example Select Request Body

{
    "select": {
        "name": true, 
        // other fields
    }
}

Sort

Sort list results by field. Default is createdAt descending. Use a sort object with field names mapped to ASC or DESC.

Example Sort Request Body

{
    "sort": {
        "name": "ASC", 
        // other fields
    }
}

Query

Equal To

Filter with exact equality on a field using Equal To.

Example EqualTo Request Body

{
    "query": {
        "age": {
            "_type": "EqualTo",
            value: 10
        }
    }
}

Equal To Or Null

Match a field equal to a value or null.

Example EqualToOrNull Request Body

{
    "query": {
        "age": {
            "_type": "EqualToOrNull",
            value: 10
        }
    }
}

Not Equal To

Exclude rows where a field equals a value.

Example Not EqualTo Request Body

{
    "query": {
        "name": {
            "_type": "NotEqual",
            "value": "Hello"
        }
    }
}

Is Null

Match rows where a field is null.

Example

{
    "query": {
        "age": {
            "_type": "IsNull"
        }
    }
}

Is Not Null

Match rows where a field is not null.

Example

{
    "query": {
        "age": {
            "_type": "NotNull"
        }
    }
}

Greater Than

Numeric or date comparisons: greater than.

Example

{
    "query": {
        "age": {
            "_type": "GreaterThan",
            "value": 10
        }
    }
}

Greater Than or Equal

Greater than or equal comparison.

Example

{
    "query": {
        "age": {
            "_type": "GreaterThanOrEqual",
            "value": 10
        }
    }
}

Less Than

Less than comparison.

Example

{
    "query": {
        "age": {
            "_type": "LessThan",
            "value": 10
        }
    }
}

Less Than or Equal

Less than or equal comparison.

Example

{
    "query": {
        "age": {
            "_type": "LessThanOrEqual",
            "value": 10
        }
    }
}

Includes

Match if a field value is in a set of values (array).

Example

{
    "query": {
        "labels": {
            "_type": "Includes",
            "value": [
                "aaa00000-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
                "bbb00000-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
            ]
        }
    }
}

All types

General

Monitor