resource-relationships-query

resource-relationships-query
resource-relationships-query

Object used to lookup resources satisfying various filtering criteria and related to given set of resources with given relation type.

JSON Example 
{
    "hierarchyDepth": 0,
    "relationshipType": "string",
    "resourceIds": [
        "string"
    ],
    "resourceQuery": {
        "adapterInstanceId": [
            "string"
        ],
        "adapterKind": [
            "string"
        ],
        "collectorId": [
            0
        ],
        "collectorName": [
            "string"
        ],
        "credentialId": [
            "string"
        ],
        "includeRelated": "string",
        "maintenanceScheduleId": [
            "string"
        ],
        "name": [
            "string"
        ],
        "parentId": [
            "string"
        ],
        "propertyConditions": {
            "conditions": [
                {
                    "doubleValue": "number",
                    "key": "string",
                    "operator": "string",
                    "stringValue": "string"
                }
            ],
            "conjunctionOperator": "string"
        },
        "propertyName": "string",
        "propertyValue": "string",
        "recentlyAdded": 0,
        "regex": [
            "string"
        ],
        "resourceHealth": [
            "string"
        ],
        "resourceId": [
            "string"
        ],
        "resourceKind": [
            "string"
        ],
        "resourceState": [
            "string"
        ],
        "resourceStatus": [
            "string"
        ],
        "resourceTag": [
            {
                "category": "string",
                "name": "string"
            }
        ],
        "statConditions": {
            "conditions": [
                {
                    "doubleValue": "number",
                    "key": "string",
                    "operator": "string",
                    "stringValue": "string"
                }
            ],
            "conjunctionOperator": "string"
        },
        "statKey": "string",
        "statKeyInclusive": false,
        "statKeyLowerBound": "number",
        "statKeyUpperBound": "number"
    }
}
integer As int32 As int32
hierarchyDepth
Optional

Relation hierarchy depth. Used with relationship types DESCENDANT, ANCESTOR and ALL. Defaults to 10.

string
relationshipType
Required

The relationship type of the resources to be extracted. Uses the RelationshipType.representation value.

Possible values are : PARENT, CHILD, DESCENDANT, ANCESTOR, ALL,
array of string
resourceIds
Required

Resource uuids to get the related resources for

resource-query
resourceQuery
Optional

Object used to lookup resources with various filtering criteria

Parameter To