Jump to

• Request
• Response
• Examples

Get Group Members

get

/serviceapi/entityModel/uds/groups/{groupName}/members

Retrieves the members of a tag-based group.

Request

Supported Media Types

• application/json

Path Parameters

• groupName: string
  the group name

Query Parameters

• 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 : ItemListUdsManageableEntity

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/UdsManageableEntity"
            }
        },
        "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 UdsManageableEntity

  This model describes an entity managed by Oracle Management Cloud. An entity is defined by its name and type. It can have a different display name than the entity name. The display name is used in the GUI to display the entity. There can be associations to other entities and an entity can be tagged by a key/value pair.

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

Nested Schema : UdsManageableEntity

Type: object

This model describes an entity managed by Oracle Management Cloud. An entity is defined by its name and type. It can have a different display name than the entity name. The display name is used in the GUI to display the entity. There can be associations to other entities and an entity can be tagged by a key/value pair.

Show Source

• associations(optional): array associations
  The associated entities
• entityDisplayName(optional): string
  The entity display name

  Example: My Entity Name
• entityName: string
  The entity name

  Example: my_entity_name
• entityType: string
  The entity type

  Example: my_entity_type
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  The properties assigned to the entity
• tags(optional): object tags
  Additional Properties Allowed: additionalProperties

  The tags assigned to the entity
• typeDisplayName(optional): string
  The entity type display name

  Example: My Entity Type

{
    "type":"object",
    "required":[
        "entityName",
        "entityType"
    ],
    "properties":{
        "associations":{
            "type":"array",
            "description":"The associated entities",
            "items":{
                "$ref":"#/definitions/UdsAssociation"
            }
        },
        "entityDisplayName":{
            "type":"string",
            "example":"My Entity Name",
            "description":"The entity display name"
        },
        "entityName":{
            "type":"string",
            "example":"my_entity_name",
            "description":"The entity name"
        },
        "entityType":{
            "type":"string",
            "example":"my_entity_type",
            "description":"The entity type"
        },
        "properties":{
            "type":"object",
            "description":"The properties assigned to the entity",
            "additionalProperties":{
                "type":"string"
            }
        },
        "tags":{
            "type":"object",
            "description":"The tags assigned to the entity",
            "additionalProperties":{
                "type":"string"
            }
        },
        "typeDisplayName":{
            "type":"string",
            "example":"My Entity Type",
            "description":"The entity type display name"
        }
    },
    "description":"<p>\n    This model describes an entity managed by Oracle Management Cloud.\n    An entity is defined by its name and type. It can have a different display\n    name than the entity name. The display name is used in the GUI to\n    display the entity. There can be associations to other entities and an\n    entity can be tagged by a key/value pair.\n</p>"
}

Nested Schema : associations

Type: array

The associated entities

Show Source

• Array of: object UdsAssociation

  This model describes an association between two or more entities. An entity can have associations to other entities which are called associates.

{
    "type":"array",
    "description":"The associated entities",
    "items":{
        "$ref":"#/definitions/UdsAssociation"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The properties assigned to the entity",
    "additionalProperties":{
        "type":"string"
    }
}

The properties assigned to the entity

Nested Schema : tags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The tags assigned to the entity",
    "additionalProperties":{
        "type":"string"
    }
}

The tags assigned to the entity

Nested Schema : UdsAssociation

Type: object

This model describes an association between two or more entities. An entity can have associations to other entities which are called associates.

Show Source

• entityName: string
  The entity name of the associate

  Example: MyLinuxHost
• entityType: string
  The entity type of the associate

  Example: omc_host_linux
• tags: object tags
  Additional Properties Allowed: additionalProperties

  The association tags

{
    "type":"object",
    "required":[
        "entityName",
        "entityType",
        "tags"
    ],
    "properties":{
        "entityName":{
            "type":"string",
            "example":"MyLinuxHost",
            "description":"The entity name of the associate"
        },
        "entityType":{
            "type":"string",
            "example":"omc_host_linux",
            "description":"The entity type of the associate"
        },
        "tags":{
            "type":"object",
            "description":"The association tags",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"<p>\n    This model describes an association between two or more entities. An entity\n    can have associations to other entities which are called associates.\n</p>"
}

Nested Schema : tags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The association tags",
    "additionalProperties":{
        "type":"string"
    }
}

The association tags

Back to Top

Examples

Get all the members of Group MyMarketingEntities:

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

Result might look like

{
  "count": 2,
  "items": [
    {
      "entityType": "MyHostType",
      "entityName": "MyHostBosMarketing",
      "entityDisplayName": "MyHostBosMarketing",
      "tags": {
        "loc": "bos",
        "org": "marketing"
      },
      "typeDisplayName": "MyHostType"
    },
    {
      "entityType": "MyHostType",
      "entityName": "MyHostSfoMarketing",
      "entityDisplayName": "MyHostSfoMarketing",
      "tags": {
        "loc": "sfo",
        "org": "marketing"
      },
      "typeDisplayName": "MyHostType"
    }
  ]
}

Back to Top