Jump to

• Request
• Response
• Examples

Get plans

get

/apiplatform/management/v1/plans

Returns plans the requesting user is authorized to view. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the Plan Manager or API Manager role. Plans the user is issued Manage Plan, View All Details or View Public Details grant are returned.

If users requesting this resource are assigned the View All Details grant, Plans with View All Details and View Public Details grants are returned.

If users requesting this resource are assigned the View All Details grant, Plans with View All Details and View Public Details grants are returned.

Request

Supported Media Types

• application/json

Query Parameters

• expand(optional): array
  Collection Format: csv

  Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of expand values.

  • [0]: string

  {
      "name":"expand",
      "in":"query",
      "description":"Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of expand values.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• fields(optional): array
  Collection Format: csv

  Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• limit(optional): integer(int32)
  Number of items to retrieve. 1 is the minumum; 128 is the maximum.

  Default Value: 128
• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• offset(optional): integer(int32)
  Offset the list returned results by this amount. Default is zero.

  Default Value: 0
• orderBy(optional): array
  Collection Format: csv

  Pass sorting criteria, comma separated.

  • [0]: string

  {
      "name":"orderBy",
      "in":"query",
      "description":"Pass sorting criteria, comma separated.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• q(optional): string
  Pass filtering criteria, using the SCIM filter expression syntax
• totalResults(optional): boolean
  Include the total result count in the response.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of plans.

Body ()

Root Schema : GetPlansResponse

Match All

Show Source

• object CollectionResponseFeature
• object CollectionResponsePagingFeature
• object GetPlansResponse-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/CollectionResponsePagingFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Plan"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : CollectionResponsePagingFeature

Type: object

Show Source

• totalResults(optional): integer(int32)
  The total number of results available. Only provided if the showTotalResults query parameter is set to true

{
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of results available. Only provided if the showTotalResults query parameter is set to true"
        }
    }
}

Nested Schema : GetPlansResponse-allOf[2]

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Plan"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Plan

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Plan"
    }
}

Nested Schema : Plan

Type: object

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve the plans the requesting user is authorized to view by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/management/v1/plans

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: Mon, 02 Jan 2017 19:00:41 GMT
Content-length: 6342
Content-type: application/json
X-oracle-dms-ecid: 7smGS1D2S00000000
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 ID of each plan and HATEOAS links to related operations.

{
  "count": 3,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "https://example.com:443/apiplatform/management/v1/plans"
    },
    {
      "method": "GET",
      "rel": "canonical",
      "href": "https://example.com:443/apiplatform/management/v1/plans"
    }
  ],
  "items": [
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/management/v1/plans/116"
        }
      ],
      "id": "116"
    },
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/management/v1/plans/117"
        }
      ],
      "id": "117"
    },
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/management/v1/plans/137"
        }
      ],
      "id": "137"
    }
  ]
}

Back to Top