InstanceRequest

Request object to get device details

Properties

string

className Required

Device type or Class type to which instances are required

array of string

columnFilters Optional

The name of column name which has to be filter.

integer as int32

from Optional

The from parameter defines the offset from the first result you want to fetch.

array of string

groupby Optional

The field name using which result will be groupby

string

instanceName Optional

Uniquely identifies the object across domains.

string

relationshipName Optional

If traversal is true then we should provide the relationship name to get the targetType.

integer as int32

size Optional

The size parameter allows you to configure the maximum amount of records to be returned.

array of Sort

sortby Optional

The Sort object defines on how and which field sorting has to be applied.

string

targetType Optional

If traversal is true then we should provide the targetType of the relationship for which instance is required

boolean

traversal Optional

Value can be true/false. If the instance is required on the traversed class then this attribute will be true

VsaFilter

vsafilter Optional

The VSAFilter object defines how the filters has to be applied on queries.

JSON Example

Show optional properties

{
    "className": "NetworkFunction"
}

{
    "className": "NetworkFunction",
    "from": 0,
    "groupby": [
        "elementUUID"
    ],
    "instanceName": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
    "limit": 10,
    "relationshipName": "ConnectedSystems",
    "size": 1000,
    "sortby": [
        {
            "fieldName": "name",
            "order": "ASC"
        }
    ],
    "targetType": "Switch",
    "vsafilter": {
        "condition": "OR",
        "filterlist": [
            {
                "condition": "AND",
                "propfilter": [
                    {
                        "matchtype": "IN",
                        "propname": "source",
                        "values": [
                            "INCHARGE-SA-PRES",
                            "sam"
                        ]
                    },
                    {
                        "matchtype": "CONTAINS",
                        "propname": "properties.DisplayName",
                        "values": [
                            "kube-multus-ds-amd64-gv429"
                        ]
                    }
                ]
            },
            {
                "condition": "AND",
                "propfilter": [
                    {
                        "matchtype": "IN",
                        "propname": "source",
                        "values": [
                            "INCHARGE-SA-PRES",
                            "sam"
                        ]
                    },
                    {
                        "matchtype": "CONTAINS",
                        "propname": "name",
                        "values": [
                            "kube-multus-ds-amd64-gv429"
                        ]
                    },
                    {
                        "matchtype": "EQUALS",
                        "propname": "properties.DisplayName",
                        "values": [
                            ""
                        ]
                    }
                ]
            }
        ]
    }
}

[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

Parameter To

Get Instances

InstanceRequest

Properties

JSON Example

Parameter To

Was this page helpful?