Jump to

• Request
• Response
• Examples

Query tags

get

/serviceapi/entityModel/uds/tags

Query all tags according to the given key and value.

Request

Supported Media Types

• application/json

Query Parameters

• key(optional): string
  the tag key to be looked up
• 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
• value(optional): string
  the tag value

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ItemListUdsTag

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

  Describes a tag. Tags are used to identify and query entities. Tags are managed using key/value pairs.

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

Nested Schema : UdsTag

Type: object

Describes a tag. Tags are used to identify and query entities. Tags are managed using key/value pairs.

Show Source

• key: string
  the tag key

  Example: organization
• value: string
  the tag value

  Example: dev

{
    "type":"object",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "example":"organization",
            "description":"the tag key"
        },
        "value":{
            "type":"string",
            "example":"dev",
            "description":"the tag value"
        }
    },
    "description":"<p>Describes a tag. Tags are used to identify and query entities. Tags are managed using key/value pairs.</p>"
}

Back to Top

Examples

Get all Tags for key=loc:

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/entityModel/uds/tags?key=loc"

The output looks like:

{
  "count": 3,
  "items": [
    {
      "key": "loc",
      "value": "bos"
    },
    {
      "key": "loc",
      "value": "sfo"
    },
    {
      "key": "loc",
      "value": "nyc"
    }
  ]
}

Back to Top