Oracle Management Cloud Common REST API

Get Entities

get

/serviceapi/entityModel/uds/entities

Retrieves the entities according to the given entity parameters in the path.

Query Entity criteria by searching for the Entity name, the Entity Type, or Tag key:value pair. For more information about Tag criteria, see API Overview.

Request

Supported Media Types

application/json

Query Parameters

entityName(optional): string

the entity name of the entities to be looked up

entityType(optional): array

Collection Format: multi

the entity type of the entities to be looked up

[0]: string

{
    "name":"entityType",
    "in":"query",
    "description":"the entity type of the entities to be looked up",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"multi",
    "x-example":"omc_host_linux"
}

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

tagKey(optional): array

Collection Format: multi

a tag key to query for

[0]: string

{
    "name":"tagKey",
    "in":"query",
    "description":"a tag key to query for",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"multi",
    "x-example":"Location"
}

tagValue(optional): array

Collection Format: multi

a tag value corresponding to a key to query for

[0]: string

{
    "name":"tagValue",
    "in":"query",
    "description":"a tag value corresponding to a key to query for",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "collectionFormat":"multi",
    "x-example":"SFO"
}

Response

Supported Media Types

application/json

200 Response

successful operation

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

Examples

Get the Entity with type HostLinux and name myHostEntity:

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/entityModel/uds/entities?entityType=HostLinux&entityName=myHostEntity"

The response might look like the following:

{
  "count": 1,
  "items": [
    {
      "entityType": "HostLinux",
      "entityName": "myHostEntity",
      "entityDisplayName": "Test Linux Server",
      "typeDisplayName": "HostLinux"
    }
  ]
}

Get the Entity with tags org:sales and loc:sfo:

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/entityModel/uds/entities?tagKey=org&tagValue=sales&tagKey=loc&tagValue=sfo"

The response might look like the following if there is only one such entity

{
  "count": 1,
  "items": [
  {
    "entityType": "HostLinux",
    "entityName": "SfoSales",
    "entityDisplayName": "SfoSales",
    "tags": {
      "loc": "sfo",
      "org": "sales"
    },
    "typeDisplayName": "HostLinux"
  }
  ]
}

Get all Entities with names starting with Sfo:

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/entityModel/uds/entities?entityName=Sfo*"

{
  "count": 2,
  "items": [
    {
      "entityType": "HostLinux",
      "entityName": "SfoSales",
      "entityDisplayName": "SfoSales",
      "tags": {
        "loc": "sfo",
        "org": "sales"
      },
      "typeDisplayName": "HostLinux"
    },
    {
      "entityType": "HostLinux",
      "entityName": "SfoSupport",
      "entityDisplayName": "SfoSupport",
      "tags": {
        "loc": "sfo",
        "org": "support"
      },
      "typeDisplayName": "HostLinux"
    }
  ]
}