Jump to

• Request
• Response
• Examples

Get list of active gateways, APIs or applications

get

/apiplatform/analytics/v1/categorical/active/{category}

Returns a list of active gateways, APIs, or applications. Use the category parameter to specify the type of measures returned.

This operation returns the intersection of all applied query parameter filters.

You can also use subcategory filters to refine the search. The following are the subcategory filters details:

• apis?gatewayIds=100: Returns apiIds that are deployed to gateway 100 even if they are not invoked.
• apis?appIds=100: This subcategory filter parameter is not supported.
• apps?gatewayIds=100: Returns appIds that are deployed to gateway 100 even if they are not invoked.
• apps?apiIds=100: Returns appIds that are registered to api 100 even if they are not invoked.
• apps?gatewayIds=100&apiIds=101: This subcategory filter parameter is not supported.

Any authenticated user can request this resource. The response contains data the requesting user is authorized to view based on their role and the resources they are issued grants to (APIs, applications, and gateways).

Request

Path Parameters

• category: string
  Pattern: (gateways|apis|apps)

  Type of active items to return. gateways shows active gateways, apis returns apiIds that have been invoked, and apps returns appIds that have been invoked.

Query Parameters

• apiIds(optional): array
  Collection Format: multi

  Filter data by apiIds as repeated query parameters (like ?apiIds=2&apiIds=3) or a single-comma separated query parameter (like ?apiIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"apiIds",
      "description":"Filter data by apiIds as repeated query parameters (like <code>?apiIds=2&apiIds=3</code>) or a single-comma separated query parameter (like <code>?apiIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• appIds(optional): array
  Collection Format: multi

  Filter data by appIds as repeated query parameters (like ?appIds=2&appIds=3) or a single comma separated query parameter (like ?appIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"appIds",
      "description":"Filter data by appIds as repeated query parameters (like <code>?appIds=2&appIds=3</code>) or a single comma separated query parameter (like <code>?appIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• gatewayIds(optional): array
  Collection Format: multi

  Filter data by gatewayIds as repeated query parameters (like ?gatewayIds=2&gatewayIds=3) or a single-comma separated query parameter (like ?gatewayIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"gatewayIds",
      "description":"Filter data by gatewayIds as repeated query parameters (like <code>?gatewayIds=2&gatewayIds=3</code>) or a single-comma separated query parameter (like <code>?gatewayIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• iterations(optional): array
  Collection Format: multi

  Filter data by iterationIds as repeated query parameters (like ?iterationIds=2&iterationIds=3) or a single comma separated query parameter (like ?iterationIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"iterations",
      "description":"Filter data by iterationIds as repeated query parameters (like <code>?iterationIds=2&iterationIds=3</code>) or a single comma separated query parameter (like <code>?iterationIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• methods(optional): array
  Collection Format: multi

  Filter data by methods as repeated query parameters (like ?methods=GET&methods=PUT) or a single comma separated query parameter (like ?methods=GET,PUT).

  • [0]: string

  {
      "in":"query",
      "name":"methods",
      "description":"Filter data by methods as repeated query parameters (like <code>?methods=GET&methods=PUT</code>) or a single comma separated query parameter (like <code>?methods=GET,PUT</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• planIds(optional): array
  Collection Format: multi

  Filter data by planIds as repeated query parameters (like ?planIds=2&planIds=3) or a single comma separated query parameter (like ?planIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"planIds",
      "description":"Filter data by planIds as repeated query parameters (like <code>?planIds=2&planIds=3</code>) or a single comma separated query parameter (like <code>?planIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• serviceIds(optional): array
  Collection Format: multi

  Filter data by serviceIds as repeated query parameters (like ?serviceIds=2&serviceIds=3) or a single comma separated query parameter (like ?serviceIds=2,3).

  • [0]: string

  {
      "in":"query",
      "name":"serviceIds",
      "description":"Filter data by serviceIds as repeated query parameters (like <code>?serviceIds=2&serviceIds=3</code>) or a single comma separated query parameter (like <code>?serviceIds=2,3</code>).",
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "required":false
  }

• timeEnd(optional): string
  End time filter as ISO8601 offset date. Example: 2016-01-01T00:00:00-07:00, 2016-01-01T00:00:00Z, 2016-01-01T00:00:00. The default value is no filtering. You must use this in conjunction with the timeSetting=custom query parameter.
• timeOffsetId(optional): string

  ISO8601 time offset ID. Example: Z. This parameter overrides the time offset of timeStart or timeEnd. This parameter is also used when calculating the start of time groups. The value of this parameter defaults to Z. (GMT).

  Note: Best effort is made to apply this parameter, but its accuracy may be limited by existing data granularity.

• timeSetting(optional): string
  Time setting mode. Defaults to custom. Valid values include: custom, currentHour, currentWeek, currentMonth, last15minutes, last60minutes, last24hours, last7days, last30days, last365days, january, february, march, april, may, june, july, august, september, october, november, december, year-2015, year-2016, etc.
• timeStart(optional): string
  Start time filter as ISO8601 offset date. Example: 2016-01-01T00:00:00-07:00, 2016-01-01T00:00:00Z, 2016-01-01T00:00:00. The default value is no filtering. You must use this in conjunction with the timeSetting=custom query parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

JSON response with active items.

Body ()

Contains a single measure value.

Root Schema : IdNameCollectionResponse

Type: object

Contains a single measure value.

Show Source

• count(optional): integer(int32)
  Response item count.
• hasMore(optional): boolean
  Default Value: false

  Indicates if there are more results after the current batch.
• items: array items
  The actual response items.
• limit(optional): integer(int32)
  Paging limit.
• links(optional): array links
  HATEOAS links.
• offset(optional): integer(int32)
  Paging offset.
• states(optional): array states
  An optional list for API states. This is null by default.

{
    "description":"Contains a single measure value.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "offset":{
            "format":"int32",
            "description":"Paging offset.",
            "type":"integer"
        },
        "count":{
            "format":"int32",
            "description":"Response item count.",
            "type":"integer"
        },
        "limit":{
            "format":"int32",
            "description":"Paging limit.",
            "type":"integer"
        },
        "hasMore":{
            "default":false,
            "description":"Indicates if there are more results after the current batch.",
            "type":"boolean"
        },
        "links":{
            "description":"HATEOAS links.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "items":{
            "description":"The actual response items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdNameItem"
            }
        },
        "states":{
            "description":"An optional list for API states. This is null by default.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

The actual response items.

Show Source

• Array of: object IdNameItem
  An ID and name pair.

{
    "description":"The actual response items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/IdNameItem"
    }
}

Nested Schema : links

Type: array

HATEOAS links.

Show Source

• Array of: object GenericLink
  HATEOAS generic link representation.

{
    "description":"HATEOAS links.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/GenericLink"
    }
}

Nested Schema : states

Type: array

An optional list for API states. This is null by default.

Show Source

• Array of: string

{
    "description":"An optional list for API states. This is null by default.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : IdNameItem

Type: object

An ID and name pair.

Show Source

• id: integer(int64)
  An item's ID.
• name: string
  An item's name.

{
    "description":"An ID and name pair.",
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "name":{
            "description":"An item's name.",
            "type":"string"
        },
        "id":{
            "format":"int64",
            "description":"An item's ID.",
            "type":"integer"
        }
    }
}

Nested Schema : GenericLink

Type: object

HATEOAS generic link representation.

Show Source

• href: string
  Link reference string.
• method(optional): string
  HTTP method used with the link.
• rel: string
  Link relation string Value is either canonical or a specific string value.
• templated(optional): string
  Allowed Values: [ "true", "false" ]

  Indicates if the link has templated parts.

{
    "description":"HATEOAS generic link representation.",
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "templated":{
            "description":"Indicates if the link has templated parts.",
            "type":"string",
            "enum":[
                "true",
                "false"
            ]
        },
        "method":{
            "description":"HTTP method used with the link.",
            "type":"string"
        },
        "rel":{
            "description":"Link relation string Value is either <code>canonical</code> or a specific string value.",
            "type":"string"
        },
        "href":{
            "description":"Link reference string.",
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Unauthorized

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to retrieve details of all active applications by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-H "Authorization: Bearer access_token
https://example.com/apiplatform/analytics/v1/categorical/active/apps

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Fri, 30 Dec 2016 17:18:50 GMT
Content-length: 221
Content-type: application/json
X-oracle-dms-ecid: Pdymv09^S00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including the name and ID of all active applications.

{
  "count": 6,
  "items": [
    {
      "name": "myAPP_294",
      "id": 325
    },
    {
      "name": "RestE2E_AnalyticsRestAPP1",
      "id": 380
    },
    {
      "name": "weatherapp2",
      "id": 336
    },
    {
      "name": "newAPP",
      "id": 333
    },
    {
      "name": "appTest3",
      "id": 131
    },
    {
      "name": "testwithouttype",
      "id": 368
    }
  ]
}

Back to Top