Jump to

• Request
• Response
• Examples

Get applications eligible for a plan

get

/apiplatform/management/v1/plans/{planId}/subscriptions/applications

Returns a collection of all applications that can subscribe to the {planId} plan.

Users requesting this resource must be assigned the API Manager, Plan Manager role and must be issued the Manage API, Subscribe, or Manage a Subscribed Application grants for the plan. Applications the user is issued the Manage Application grant for are returned.

Request

Supported Media Types

• application/json

Path Parameters

• planId: string
  A unique ID referencing a specific plan.

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
• 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 applications

Body ()

Root Schema : GetApplicationsResponse

Match All

Show Source

• object CollectionResponseFeature
• object LinksResponseFeature
• object CollectionResponsePagingFeature
• object GetApplicationsResponse-allOf[3]

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

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 : LinksResponseFeature

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

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 : GetApplicationsResponse-allOf[3]

Type: object

Show Source

• items(optional): array items

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

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: GetApplicationsItem

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

Nested Schema : GetApplicationsItem

Match All

Show Source

• Application
• object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/Application"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : Application

Match All

Show Source

• object ApplicationId
• object ApplicationIdentity
• object ApplicationDef
• object ApplicationKey
• object ApplicationMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/ApplicationId"
        },
        {
            "$ref":"#/definitions/ApplicationIdentity"
        },
        {
            "$ref":"#/definitions/ApplicationDef"
        },
        {
            "$ref":"#/definitions/ApplicationKey"
        },
        {
            "$ref":"#/definitions/ApplicationMetadata"
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : ApplicationId

Type: object

Show Source

• id: string
  The application's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The application's ID."
        }
    }
}

Nested Schema : ApplicationIdentity

Type: object

Show Source

• name: string
  The application's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The application's name."
        }
    }
}

Nested Schema : ApplicationDef

Type: object

Show Source

• contact(optional): object contact
  The application owner's contact information.
• description(optional): string
  The application's description.
• types(optional): array types

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The application's description."
        },
        "contact":{
            "type":"object",
            "description":"The application owner's contact information.",
            "properties":{
                "firstName":{
                    "type":"string",
                    "description":"The owner's first name."
                },
                "lastName":{
                    "type":"string",
                    "description":"The owner's last name."
                },
                "phone":{
                    "type":"string",
                    "description":"The owner's phone number."
                },
                "company":{
                    "type":"string",
                    "description":"The owner's company."
                },
                "email":{
                    "type":"string",
                    "description":"The owner's email address."
                }
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ApplicationKey

Type: object

Show Source

• key(optional): string
  The application's key.

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The application's key."
        }
    }
}

Nested Schema : ApplicationMetadata

Type: object

Show Source

• createdAt(optional): string
  The date and time the application was created.
• createdBy(optional): string
  The user who created the application.
• updatedAt(optional): string
  The date and time the application was last updated.
• updatedBy(optional): string
  The user who last updated the application.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the application."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the application was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the application."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date and time the application was last updated."
        }
    }
}

Nested Schema : contact

Type: object

The application owner's contact information.

Show Source

• company(optional): string
  The owner's company.
• email(optional): string
  The owner's email address.
• firstName(optional): string
  The owner's first name.
• lastName(optional): string
  The owner's last name.
• phone(optional): string
  The owner's phone number.

{
    "type":"object",
    "description":"The application owner's contact information.",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"The owner's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The owner's last name."
        },
        "phone":{
            "type":"string",
            "description":"The owner's phone number."
        },
        "company":{
            "type":"string",
            "description":"The owner's company."
        },
        "email":{
            "type":"string",
            "description":"The owner's email address."
        }
    }
}

Nested Schema : types

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

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 all available applications that can subscribe to a plan 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/management/v1/plans/{planId}/subscriptions/applications

{planId} is the unique Id for a plan. To retrieve available plan Ids, see Get plans.

You can pass the following optional field values in the fields query parameter, separated by commas, to include them in the response:

• description: The application???s description.

• key: The application???s key.

• contact.firstName: The application owner???s first name.

• contact.lastName: The application owner???s last name.

• contact.email: The application owner???s email address.

• contact.phone: The application owner???s phone number.

• contact.company: The application owner???s company.

• types: The application???s types.

• createdAt: The date and time the application was created.

• createdBy: The user who created the application.

• updatedAt: The date and time the application was last updated.

• updatedBy: The user who last updated the application

The following example shows you how to include these fields in the response:

curl -i -X GET 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/plans/{planId}/subscriptions/applications?fields=key,contact.email

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:  Wed, 15 Mar 2017 06:13:34 GMT
Content-Length:  1494
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00021aa8
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 details about the eligible applications.

{
    "offset": 0,
    "count": 6,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:7201/apiplatform/management/v1/plans/119/subscriptions/applications?offset=0&=128"
        }
    ],
    "items": [
        {
            "createdAt": "2018-02-08T00:39:42-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Allied Mortgage Calculator",
            "description": "Fast and easy real estate mortgage payment calculator",
            "id": "104",
            "updatedAt": "2018-02-08T00:39:42-0800"
        },
        {
            "createdAt": "2018-02-06T22:19:15-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Temperature",
            "id": "103",
            "updatedAt": "2018-02-09T01:36:45-0800"
        },
        {
            "createdAt": "2018-02-05T10:27:30-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "World Weather",
            "description": "Weather reports and forecasts for the entire world",
            "id": "101",
            "updatedAt": "2018-02-05T11:30:46-0800"
        },
        {
            "createdAt": "2018-02-05T10:27:30-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Western Real Estate",
            "description": "View Real Estate Trends, Analysis and Statistics",
            "id": "102",
            "updatedAt": "2018-02-05T11:30:20-0800"
        },
        {
            "createdAt": "2018-02-08T00:42:27-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Temperature",
            "description": "Application for Temperature",
            "id": "105",
            "updatedAt": "2018-02-08T23:23:05-0800"
        },
        {
            "createdAt": "2018-02-09T02:57:15-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Postman FAON",
            "description": "Postman FAON",
            "id": "106",
            "updatedAt": "2018-02-09T02:57:15-0800"
        }
    ]
}

Back to Top