Enumeration

To enumerate objects of a given resource type, use the enumeration API by calling GET against v2.0 against the resource endpoint (without specifying a GUID).

The following query parameters are supported for enumeration requests:

• token string continuation token for the enumeration
• max-keys int maximum number of results to retrieve
• marker string object GUID from which to start
• skip int the number of results to skip, useful for pagination

Results are always sorted in descending order from the CreatedUtc property.

Example

For example, to enumerate metadata rules from the configuration server, use GET /v2.0/tenants/[tenant-guid]/metadatarules. The result will be similar to the result below.

{
    "Success": true,
    "Timestamp": {
        "Start": "2024-10-21T02:36:37.677751Z",
        "TotalMs": 23.58,
        "Messages": {}
    },
    "MaxResults": 10,
    "IterationsRequired": 1,
    "EndOfResults": true,
    "RecordsRemaining": 16,
    "Objects": [
        {
            "GUID": "example-metadata-rule",
            ... metadata rules details
        },
        { ... }
    ],
    "ContinuationToken": "[continuation-token]"
}

Enumeration result objects have the following parameters:

• Success bool indicating whether or not the enumeration succeeded
• Timestamp obj indicates the start time of the operation and the total milliseconds required to complete
• MaxResults int indicates the maximum number of results requested. This value is 1000 by default
• IterationsRequired int indicates the number of internal queries required to satisfy the request
• EndOfResults bool indicates whether or not the end of results have been reached. If this value is true no further results are available. If this value is false, more results have been reached, and the value found in ContinuationToken will indicate the value that should be specified in the token query in subsequent requests to continue the enumeration
• RecordsRemaining int specifies the number of records that remain for a subsequent enumeration at the time of the current request
• Objects list provides the list of objects included in the enumeration
• ContinuationToken string provides a continuation token if more results exist. This value should be included in the querystring using the token key for the next request