Jump to

• Request
• Response
• Examples

Get Groups

get

/serviceapi/entityModel/uds/groups

Retrieves tag-based group definitions.

If no Group name is specified all group definitions are returned.

Request

Supported Media Types

• application/json

Query Parameters

• groupName(optional): string
  the group to be retrieved
• limit(optional): integer(int32)
  the number of entries in the result to be returend in one REST call

  Default Value: 2000
• offset(optional): integer(int32)
  the offset into the result list when doing a query with limit

  Default Value: 0

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ItemListUdsGroup

Type: object

Show Source

• count: integer(int32)
  The number of items in the list
• hasMore: boolean
  Default Value: false

  Indicates if there are more items
• items: array items
  The items
• nextLink(optional): string
  The link to get the next chunk of items (if paging)
• previousLink(optional): string
  The link to the previous chunk of items (if paging)
• totalCount(optional): integer(int32)
  The total number of items (if paging)

{
    "type":"object",
    "required":[
        "count",
        "hasMore",
        "items"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in the list"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more items",
            "default":false
        },
        "items":{
            "type":"array",
            "description":"The items",
            "items":{
                "$ref":"#/definitions/UdsGroup"
            }
        },
        "nextLink":{
            "type":"string",
            "description":"The link to get the next chunk of items (if paging)"
        },
        "previousLink":{
            "type":"string",
            "description":"The link to the previous chunk of items (if paging)"
        },
        "totalCount":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of items (if paging)"
        }
    }
}

Nested Schema : items

Type: array

The items

Show Source

• Array of: object UdsGroup

  Describes a tag based group.

{
    "type":"array",
    "description":"The items",
    "items":{
        "$ref":"#/definitions/UdsGroup"
    }
}

Nested Schema : UdsGroup

Type: object

Describes a tag based group.

Show Source

• groupDisplayName(optional): string
  The group display name

  Example: My Group Name
• groupName: string
  The group name

  Example: my_group_name
• tagCriteria: string
  The tag criteria that defines the group

  Example: location=sfo AND organization=dev

{
    "type":"object",
    "required":[
        "groupName",
        "tagCriteria"
    ],
    "properties":{
        "groupDisplayName":{
            "type":"string",
            "example":"My Group Name",
            "description":"The group display name"
        },
        "groupName":{
            "type":"string",
            "example":"my_group_name",
            "description":"The group name"
        },
        "tagCriteria":{
            "type":"string",
            "example":"location=sfo AND organization=dev",
            "description":"The tag criteria that defines the group"
        }
    },
    "description":"<p>Describes a tag based group.</p>"
}

Back to Top

Examples

Get the group definition for group MyMarketingEntities

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/entityModel/uds/groups?groupName=MyMarketingEntities"

This will return the Group definition:

{
  "count": 1,
  "items":[
    {
      "groupName": "MyMarketingEntities",
      "groupDisplayName": "My Marketing Entities",
      "tagCriteria": "org=marketing"
    }
  ]
}

Back to Top