Get Services | vRealize Automation Catalog Service API

Get Services

Get all Active Services the current user is entitled to see. Each returned services must own at least one Catalog Item the current user is entitled to.
Here are some common OData properties to use for $filter or $orderby
name - filter based off catalog service's name
description - filter based off catalog service's name
status - filter based off catalog service's status (e.g.: ACTIVE, RETIRED, DELETED)
organization/subTenant/id - filter based off catalog service's business group id (which can be found in service payload under organization -> subtenantRef)
organization/subTenant/name - filter based off catalog service's business group name (which can be found in service payload under organization -> subtenantLabel)
owner/ref - filter based off catalog service's owner principal (e.g.: [email protected])
supportTeam/ref - filter based off catalog service's support team principal (e.g.: [email protected])
icon/id - filter based off catalog service's icon id

Request

URI

GET

https://{api_host}/catalog-service/api/consumer/services

COPY

Query Parameters

string

onBehalfOf

Optional

The value of the user Id when the intention is to request on behalf of someone else

integer

page

Optional

Page Number

integer

limit

Optional

Number of entries per page

string

$orderby

Optional

Multiple comma-separated properties sorted in ascending or descending order

integer

$top

Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer

$skip

Optional

Sets how many entries you would like to skip

string

$filter

Optional

Boolean expression for whether a particular entry should be included in the response

Responses

200

successful operation

Returns PageService of type(s) */*

{
    "number": 0,
    "size": 0,
    "last": false,
    "numberOfElements": 0,
    "totalPages": 0,
    "content": [
        {
            "iconId": {
                "image": [
                    "string"
                ],
                "fileName": "string",
                "id": "string",
                "contentType": "string"
            },
            "owner": {
                "ref": "string",
                "lastSync": "string",
                "expired": false,
                "tenantName": "string",
                "name": "string",
                "id": "string",
                "type": "string"
            },
            "lastUpdatedBy": "string",
            "hours": {
                "startTime": "string",
                "endTime": "string"
            },
            "description": "string",
            "supportTeam": {
                "ref": "string",
                "lastSync": "string",
                "expired": false,
                "tenantName": "string",
                "name": "string",
                "id": "string",
                "type": "string"
            },
            "version": 0,
            "lastUpdatedDate": "string",
            "changeWindow": {
                "hours": {
                    "startTime": "string",
                    "endTime": "string"
                },
                "dayOfWeek": "string"
            },
            "name": "string",
            "statusName": "string",
            "newDuration": {
                "unit": "string",
                "amount": 0
            },
            "id": "string",
            "status": "string"
        }
    ],
    "first": false,
    "totalElements": 0
}

integer As int32 As int32

number

Optional

number

integer As int32 As int32

size

Optional

size

boolean

last

Optional

last