Jump to

• Request
• Response
• Examples

Get applications

get

/developers/services/v1/applications

All authenticated users can request this resource. Only applications that the user is issued the Manage Application or View All Details application grant for are returned.

Request

Query Parameters

• editable(optional): boolean
  Determines if only editable applications (those the user is issued the Manage Application grant for) are returned. A value of true returns only editable applications; all applications are returned otherwise or if this parameter is absent.

  Default Value: false
• limit(optional): integer(int32)
  Requested limit for the results list.

  Default Value: 0
• offset(optional): integer(int32)
  Requested offset in the results list.
• orderBy(optional): array
  Collection Format: multi

  {ApplicationRestService.getApplicationList.param.orderBy}

  • [0]: string
    Default Value: name ASC

  {
      "name":"orderBy",
      "in":"query",
      "description":"{ApplicationRestService.getApplicationList.param.orderBy}",
      "required":false,
      "type":"array",
      "items":{
          "type":"string",
          "default":"name ASC"
      },
      "collectionFormat":"multi"
  }

• q(optional): string
  {ApplicationRestService.getApplicationList.param.query}

Back to Top

Response

Supported Media Types

• application/json

200 Response

JSON structure with list of all applications.

Body ()

HATEOAS Application collection response representation.

Root Schema : ApplicationCollectionResponse

Type: object

HATEOAS Application collection response representation.

Show Source

• count(optional): integer(int32)
  Item count in this response.
• filters(optional): array filters
  List of filters applicable for the current API list. This is null by default.
• hasMore(optional): boolean
  Default Value: false

  Indicates if there are more results after the current batch.
• items: array items
  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
  Optional list of API states. This is null by default.
• totalResults(optional): integer(int32)
  Response item count (excluding the paging parameters).

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Response item count (excluding the paging parameters)."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"Paging offset."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Item count in this response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Paging limit."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more results after the current batch.",
            "default":false
        },
        "links":{
            "type":"array",
            "description":"HATEOAS links.",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "filters":{
            "type":"array",
            "description":"List of filters applicable for the current API list. This is <code>null</code> by default.",
            "items":{
                "type":"string"
            }
        },
        "items":{
            "type":"array",
            "description":"Actual response items.",
            "items":{
                "$ref":"#/definitions/PortalApplication"
            }
        },
        "states":{
            "type":"array",
            "description":"Optional list of API states. This is <code>null</code> by default.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"HATEOAS Application collection response representation."
}

Nested Schema : filters

Type: array

List of filters applicable for the current API list. This is null by default.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of filters applicable for the current API list. This is <code>null</code> by default.",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Actual response items.

Show Source

• Array of: object PortalApplication
  Application resource representation.

{
    "type":"array",
    "description":"Actual response items.",
    "items":{
        "$ref":"#/definitions/PortalApplication"
    }
}

Nested Schema : links

Type: array

HATEOAS links.

Show Source

• Array of: object GenericLink
  HATEOAS generic link representation.

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

Nested Schema : states

Type: array

Optional list of API states. This is null by default.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Optional list of API states. This is <code>null</code> by default.",
    "items":{
        "type":"string"
    }
}

Nested Schema : PortalApplication

Type: object

Application resource representation.

Show Source

• applicationKey: string
  The application's key.
• contactCompany(optional): string
  The owner's company.
• contactEmail(optional): string
  The owner's email address.
• contactFirstName(optional): string
  The owner's first name.
• contactLastName(optional): string
  The owner's last name.
• contactLdapName(optional): string
  The owner's LDAP user name.
• contactPhone(optional): string
  The owner's phone number.
• createdAt(optional): string
  The date and time the application was created.
• createdBy(optional): string
  The user who created the application.
• description(optional): string
  The application's description.
• id: integer(int32)
  The application's ID.
• lastUpdatedAt(optional): string
  The date and time the application was last updated.
• lastUpdatedBy(optional): string
  The user who last updated the application.
• links(optional): array links
  HATEOAS links for the application.
• name: string
  The application's name.
• plans(optional): array plans
  The application's plans.
• types(optional): array types
  The application's types.

{
    "type":"object",
    "required":[
        "applicationKey",
        "id",
        "name"
    ],
    "properties":{
        "contactCompany":{
            "type":"string",
            "description":"The owner's company."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the application."
        },
        "types":{
            "type":"array",
            "description":"The application's types.",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "lastUpdatedAt":{
            "type":"string",
            "description":"The date and time the application was last updated."
        },
        "contactEmail":{
            "type":"string",
            "description":"The owner's email address."
        },
        "contactFirstName":{
            "type":"string",
            "description":"The owner's first name."
        },
        "applicationKey":{
            "type":"string",
            "description":"The application's key."
        },
        "description":{
            "type":"string",
            "description":"The application's description."
        },
        "contactLdapName":{
            "type":"string",
            "description":"The owner's LDAP user name."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the application was created."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the application."
        },
        "plans":{
            "type":"array",
            "description":"The application's plans.",
            "items":{
                "$ref":"#/definitions/PlanForApplication"
            }
        },
        "name":{
            "type":"string",
            "description":"The application's name."
        },
        "contactLastName":{
            "type":"string",
            "description":"The owner's last name."
        },
        "links":{
            "type":"array",
            "description":"HATEOAS links for the application.",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"The application's ID."
        },
        "contactPhone":{
            "type":"string",
            "description":"The owner's phone number."
        }
    },
    "description":"Application resource representation."
}

Nested Schema : links

Type: array

HATEOAS links for the application.

Show Source

• Array of: object GenericLink
  HATEOAS generic link representation.

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

Nested Schema : plans

Type: array

The application's plans.

Show Source

• Array of: object PlanForApplication
  Application-specific plan resource representation.

{
    "type":"array",
    "description":"The application's plans.",
    "items":{
        "$ref":"#/definitions/PlanForApplication"
    }
}

Nested Schema : types

Type: array

The application's types.

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "description":"The application's types.",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

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.

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

Nested Schema : PlanForApplication

Type: object

Application-specific plan resource representation.

Show Source

• constraints(optional): object Constraints
  Plan subscription constraints.
• description(optional): string
  The application plan's description.
• entitlements(optional): array entitlements
  List of APIs the application registers to.
• icon(optional): string
  The plan's icon.
• id: integer(int32)
  The application plan's ID.
• links(optional): array links
  HATEOAS links.
• name: string
  The application plan's name.
• publicationSettings(optional): object PublicationSettings
  Publication settings for the given plan.
• publishedState: boolean
  Default Value: false

  {dto.PlanForApplication.publishedState}
• registrationId: integer(int32)
  The contract's ID.
• registrationState: string
  Allowed Values: [ "SUBSCRIBED", "REQUESTING", "SUSPENDED", "REJECTED" ]

  The contract's state.
• state: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  The application plan's state.
• vanityName: string
  {dto.PlanForApplication.vanityName}

{
    "type":"object",
    "required":[
        "id",
        "name",
        "publishedState",
        "registrationId",
        "registrationState",
        "state",
        "vanityName"
    ],
    "properties":{
        "entitlements":{
            "type":"array",
            "description":"List of APIs the application registers to.",
            "items":{
                "$ref":"#/definitions/Entitlement"
            }
        },
        "vanityName":{
            "type":"string",
            "description":"{dto.PlanForApplication.vanityName}"
        },
        "publishedState":{
            "type":"boolean",
            "description":"{dto.PlanForApplication.publishedState}",
            "default":false
        },
        "icon":{
            "type":"string",
            "description":"The plan's icon."
        },
        "description":{
            "type":"string",
            "description":"The application plan's description."
        },
        "constraints":{
            "description":"The plan subscription constraints, such as rate, limit, etc.",
            "$ref":"#/definitions/Constraints"
        },
        "publicationSettings":{
            "description":"The plan publication settings (information display related flags)",
            "$ref":"#/definitions/PublicationSettings"
        },
        "name":{
            "type":"string",
            "description":"The application plan's name."
        },
        "registrationId":{
            "type":"integer",
            "format":"int32",
            "description":"The contract's ID."
        },
        "links":{
            "type":"array",
            "description":"HATEOAS links.",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"The application plan's ID."
        },
        "state":{
            "type":"string",
            "description":"The application plan's state.",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "registrationState":{
            "type":"string",
            "description":"The contract's state.",
            "enum":[
                "SUBSCRIBED",
                "REQUESTING",
                "SUSPENDED",
                "REJECTED"
            ]
        }
    },
    "description":"Application-specific plan resource representation."
}

Nested Schema : Constraints

Type: object

Plan subscription constraints.

Show Source

• rate(optional): object Rate
  Rate for plan subscription constraints.

{
    "type":"object",
    "properties":{
        "rate":{
            "description":"Subscription rate (for invocations).",
            "$ref":"#/definitions/Rate"
        }
    },
    "description":"Plan subscription constraints."
}

Nested Schema : entitlements

Type: array

List of APIs the application registers to.

Show Source

• Array of: Entitlement

{
    "type":"array",
    "description":"List of APIs the application registers to.",
    "items":{
        "$ref":"#/definitions/Entitlement"
    }
}

Nested Schema : links

Type: array

HATEOAS links.

Show Source

• Array of: object GenericLink
  HATEOAS generic link representation.

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

Nested Schema : PublicationSettings

Type: object

Publication settings for the given plan.

Show Source

• constraints(optional): object ConstraintSettings
  Plan publication setting's constraint display options.
• description(optional): object DescriptionSettings
  Plan publication setting's description display options.
• icon(optional): object IconSettings
  Plan publication setting's plan icon options.
• recommended(optional): boolean
  Default Value: false

  Flag whether the plan should be listed as recommended.

{
    "type":"object",
    "properties":{
        "icon":{
            "description":"Plan icon display setting.",
            "$ref":"#/definitions/IconSettings"
        },
        "description":{
            "description":"Plan description setting.",
            "$ref":"#/definitions/DescriptionSettings"
        },
        "constraints":{
            "description":"Constraint related display settings.",
            "$ref":"#/definitions/ConstraintSettings"
        },
        "recommended":{
            "type":"boolean",
            "description":"Flag whether the plan should be listed as recommended.",
            "default":false
        }
    },
    "description":"Publication settings for the given plan."
}

Nested Schema : Rate

Type: object

Rate for plan subscription constraints.

Show Source

• invocations(optional): array invocations
  Invocation constraint parameters list.

{
    "type":"object",
    "properties":{
        "invocations":{
            "type":"array",
            "description":"Invocation constraint parameters list.",
            "items":{
                "$ref":"#/definitions/Invocation"
            }
        }
    },
    "description":"Rate for plan subscription constraints."
}

Nested Schema : invocations

Type: array

Invocation constraint parameters list.

Show Source

• Array of: object Invocation
  Plan constraint - invocation parameters.

{
    "type":"array",
    "description":"Invocation constraint parameters list.",
    "items":{
        "$ref":"#/definitions/Invocation"
    }
}

Nested Schema : Invocation

Type: object

Plan constraint - invocation parameters.

Show Source

• limit: string
  Maximum number of invocations for the given period.
• period: string
  Time period, such as minutes, days, months, etc.

{
    "type":"object",
    "required":[
        "limit",
        "period"
    ],
    "properties":{
        "period":{
            "type":"string",
            "description":"Time period, such as minutes, days, months, etc."
        },
        "limit":{
            "type":"string",
            "description":"Maximum number of invocations for the given period."
        }
    },
    "description":"Plan constraint - invocation parameters."
}

Nested Schema : Entitlement

Match All

Show Source

• object EntitlementId
• object EntitlementDef
• object Entitlement-allOf[2]
• object Entitlement-allOf[3]
• object EntitlementState
• object Entitlement-allOf[5]
• object EntitlementMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/EntitlementId"
        },
        {
            "$ref":"#/definitions/EntitlementDef"
        },
        {
            "type":"object",
            "properties":{
                "api":{
                    "$ref":"#/definitions/Api"
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "plan":{
                    "$ref":"#/definitions/Plan"
                }
            }
        },
        {
            "$ref":"#/definitions/EntitlementState"
        },
        {
            "type":"object",
            "properties":{
                "publication":{
                    "$ref":"#/definitions/EntitlementPublication"
                }
            }
        },
        {
            "$ref":"#/definitions/EntitlementMetadata"
        }
    ]
}

Nested Schema : EntitlementId

Type: object

Show Source

• id: string
  The entitlement's ID.

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

Nested Schema : EntitlementDef

Type: object

Nested Schema : Entitlement-allOf[2]

Type: object

Show Source

• api(optional): Api

{
    "type":"object",
    "properties":{
        "api":{
            "$ref":"#/definitions/Api"
        }
    }
}

Nested Schema : Entitlement-allOf[3]

Type: object

Show Source

• plan(optional): object Plan

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

Nested Schema : EntitlementState

Type: object

Show Source

• state(optional): string
  The entitlement's state.
• stateComments(optional): string
  Comments regarding the entitlement's state.
• stateUpdatedAt(optional): string
  The date and time the entitlement's state was last updated.
• stateUpdatedBy(optional): string
  The user who last updated the entitlement's state.

{
    "type":"object",
    "properties":{
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the entitlement's state was last updated."
        },
        "state":{
            "type":"string",
            "description":"The entitlement's state."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments regarding the entitlement's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the entitlement's state."
        }
    }
}

Nested Schema : Entitlement-allOf[5]

Type: object

Show Source

• publication(optional): object EntitlementPublication

{
    "type":"object",
    "properties":{
        "publication":{
            "$ref":"#/definitions/EntitlementPublication"
        }
    }
}

Nested Schema : EntitlementMetadata

Type: object

Show Source

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

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

Nested Schema : Api

Match All

Show Source

• object ApiId
• object ApiIdentity
• object ApiMetadata
• object ApiState
• object Api-allOf[4]
• object ApiIterationId
• object ApiDetails
• object ApiImpl
• object ApiArtifacts

{
    "allOf":[
        {
            "$ref":"#/definitions/ApiId"
        },
        {
            "$ref":"#/definitions/ApiIdentity"
        },
        {
            "$ref":"#/definitions/ApiMetadata"
        },
        {
            "$ref":"#/definitions/ApiState"
        },
        {
            "type":"object",
            "properties":{
                "publication":{
                    "$ref":"#/definitions/ApiPublication"
                }
            }
        },
        {
            "$ref":"#/definitions/ApiIterationId"
        },
        {
            "$ref":"#/definitions/ApiDetails"
        },
        {
            "$ref":"#/definitions/ApiImpl"
        },
        {
            "$ref":"#/definitions/ApiArtifacts"
        }
    ]
}

Nested Schema : ApiId

Type: object

Show Source

• id: string
  The API's id.

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

Nested Schema : ApiIdentity

Type: object

Show Source

• name: string
  The API's name.
• vanityName(optional): string
  The API's vanity name.
• version: string
  The API's version.

{
    "type":"object",
    "required":[
        "name",
        "version"
    ],
    "properties":{
        "vanityName":{
            "type":"string",
            "description":"The API's vanity name."
        },
        "name":{
            "type":"string",
            "description":"The API's name."
        },
        "version":{
            "type":"string",
            "description":"The API's version."
        }
    }
}

Nested Schema : ApiMetadata

Type: object

Show Source

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

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

Nested Schema : ApiState

Type: object

Show Source

• state(optional): string
  The API's state. Valid values are ALPHA, BETA, DEPRECATED, RELEASED, and RETIRED.
• stateComments(optional): string
  Comments about the API's state.
• stateUpdatedAt(optional): string
  The date and time the API state was last updated.
• stateUpdatedBy(optional): string
  The user who last updated the API state.

{
    "type":"object",
    "properties":{
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the API state was last updated."
        },
        "state":{
            "type":"string",
            "description":"The API's state. Valid values are <code>ALPHA</code>, <code>BETA</code>, <code>DEPRECATED</code>, <code>RELEASED</code>, and <code>RETIRED</code>."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the API's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the API state."
        }
    }
}

Nested Schema : Api-allOf[4]

Type: object

Show Source

• publication(optional): object ApiPublication

{
    "type":"object",
    "properties":{
        "publication":{
            "$ref":"#/definitions/ApiPublication"
        }
    }
}

Nested Schema : ApiIterationId

Type: object

Show Source

• iterationId(optional): string
  The API's iteration.

{
    "type":"object",
    "properties":{
        "iterationId":{
            "type":"string",
            "description":"The API's iteration."
        }
    }
}

Nested Schema : ApiDetails

Type: object

Show Source

• description(optional): string
  The API's description.
• documentation(optional): object documentation
  Describes the API's documenation resource
• icon(optional): string
  The API's icon.
• overview(optional): object overview
  Describes the API's overview text resource.

{
    "type":"object",
    "properties":{
        "overview":{
            "type":"object",
            "description":"Describes the API's overview text resource.",
            "properties":{
                "doctype":{
                    "type":"string",
                    "description":"The documentation type of the overview text resource. Valid values are <code>markdown</code> and <code>html</code>."
                },
                "data":{
                    "type":"string",
                    "description":"The name of the resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text."
                },
                "dataType":{
                    "type":"string",
                    "description":"The method used to attach overview text to the API. Valid values are <code>link</code>, <code>file</code>, and <code>text</code>."
                }
            }
        },
        "documentation":{
            "type":"object",
            "description":"Describes the API's documenation resource",
            "properties":{
                "doctype":{
                    "type":"string",
                    "description":"The documentation type of the documentation resource. Valid values are markdown, html, and apiary."
                },
                "data":{
                    "type":"string",
                    "description":"The path to the documentation resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text."
                },
                "dataType":{
                    "type":"string",
                    "description":"The method used to attach documentation to the API. Valid values are <code>link</code>, <code>file</code>, and <code>text</code>. The value is <code>link</code> if Apiary documentation is added."
                }
            }
        },
        "icon":{
            "type":"string",
            "description":"The API's icon."
        },
        "description":{
            "type":"string",
            "description":"The API's description."
        }
    }
}

Nested Schema : ApiImpl

Type: object

Nested Schema : ApiArtifacts

Type: object

Show Source

• artifacts(optional): array artifacts

{
    "type":"object",
    "properties":{
        "artifacts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "content-type":{
                        "type":"string",
                        "description":"The content type of the attached resource, like <code>text/html; charset=utf-8</code>."
                    },
                    "content":{
                        "type":"string",
                        "description":""
                    },
                    "pathname":{
                        "type":"string",
                        "description":"The path to the API resource."
                    }
                },
                "required":[
                    "content-type",
                    "pathname"
                ]
            }
        }
    }
}

Nested Schema : ApiPublication

Type: object

Show Source

• iterationId(optional): string
  The iteration ID of the API published to the Developer Portal.
• portalUrl(optional): string
  The URL of the API's page on the Developer Portal.
• state(optional): string
  The API's publication state. This value indicates if the API is published to the Developer Portal. Valid values are PUBLISHED and UNPUBLISHED.
• stateComments(optional): string
  Comments about the publication's state.
• stateUpdatedAt(optional): string
  The date and time the publication state was last updated.
• stateUpdatedBy(optional): string
  The user who last updated the publication state.
• visibility(optional): string
  The API's visibility level.

{
    "type":"object",
    "properties":{
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the publication state was last updated."
        },
        "visibility":{
            "type":"string",
            "description":"The API's visibility level."
        },
        "portalUrl":{
            "type":"string",
            "description":"The URL of the API's page on the Developer Portal."
        },
        "state":{
            "type":"string",
            "description":"The API's publication state. This value indicates if the API is published to the Developer Portal. Valid values are <code>PUBLISHED</code> and <code>UNPUBLISHED</code>."
        },
        "iterationId":{
            "type":"string",
            "description":"The iteration ID of the API published to the Developer Portal."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the publication's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the publication state."
        }
    }
}

Nested Schema : documentation

Type: object

Describes the API's documenation resource

Show Source

• data(optional): string
  The path to the documentation resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text.
• dataType(optional): string
  The method used to attach documentation to the API. Valid values are link, file, and text. The value is link if Apiary documentation is added.
• doctype(optional): string
  The documentation type of the documentation resource. Valid values are markdown, html, and apiary.

{
    "type":"object",
    "description":"Describes the API's documenation resource",
    "properties":{
        "doctype":{
            "type":"string",
            "description":"The documentation type of the documentation resource. Valid values are markdown, html, and apiary."
        },
        "data":{
            "type":"string",
            "description":"The path to the documentation resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text."
        },
        "dataType":{
            "type":"string",
            "description":"The method used to attach documentation to the API. Valid values are <code>link</code>, <code>file</code>, and <code>text</code>. The value is <code>link</code> if Apiary documentation is added."
        }
    }
}

Nested Schema : overview

Type: object

Describes the API's overview text resource.

Show Source

• data(optional): string
  The name of the resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text.
• dataType(optional): string
  The method used to attach overview text to the API. Valid values are link, file, and text.
• doctype(optional): string
  The documentation type of the overview text resource. Valid values are markdown and html.

{
    "type":"object",
    "description":"Describes the API's overview text resource.",
    "properties":{
        "doctype":{
            "type":"string",
            "description":"The documentation type of the overview text resource. Valid values are <code>markdown</code> and <code>html</code>."
        },
        "data":{
            "type":"string",
            "description":"The name of the resource, if attached as a file, the URL of the resource, if added as a link, or the overview text itself, if entered as text."
        },
        "dataType":{
            "type":"string",
            "description":"The method used to attach overview text to the API. Valid values are <code>link</code>, <code>file</code>, and <code>text</code>."
        }
    }
}

Nested Schema : artifacts

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "content-type":{
                "type":"string",
                "description":"The content type of the attached resource, like <code>text/html; charset=utf-8</code>."
            },
            "content":{
                "type":"string",
                "description":""
            },
            "pathname":{
                "type":"string",
                "description":"The path to the API resource."
            }
        },
        "required":[
            "content-type",
            "pathname"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• content(optional): string
• content-type: string
  The content type of the attached resource, like text/html; charset=utf-8.
• pathname: string
  The path to the API resource.

{
    "type":"object",
    "properties":{
        "content-type":{
            "type":"string",
            "description":"The content type of the attached resource, like <code>text/html; charset=utf-8</code>."
        },
        "content":{
            "type":"string",
            "description":""
        },
        "pathname":{
            "type":"string",
            "description":"The path to the API resource."
        }
    },
    "required":[
        "content-type",
        "pathname"
    ]
}

Nested Schema : Plan

Type: object

Nested Schema : EntitlementPublication

Type: object

Show Source

• state(optional): string
  The entitlement's publication state. This value determines if the entitlement is published to the Plan. Valid values are PUBLISHED and UNPUBLISHED.
• stateComments(optional): string
  Comments about the publication's state.
• stateUpdatedAt(optional): string
  The date and time the publication state was last updated.
• stateUpdatedBy(optional): string
  The user who last updated the publication state.

{
    "type":"object",
    "properties":{
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the publication state was last updated."
        },
        "state":{
            "type":"string",
            "description":"The entitlement's publication state. This value determines if the entitlement is published to the Plan. Valid values are PUBLISHED and UNPUBLISHED."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the publication's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the publication state."
        }
    }
}

Nested Schema : ConstraintSettings

Type: object

Plan publication setting's constraint display options.

Show Source

• rate(optional): object RateSettings
  Plan publication setting's invocation rate display options flag.

{
    "type":"object",
    "properties":{
        "rate":{
            "description":"Subscription rate display settings.",
            "$ref":"#/definitions/RateSettings"
        }
    },
    "description":"Plan publication setting's constraint display options."
}

Nested Schema : DescriptionSettings

Type: object

Plan publication setting's description display options.

Show Source

• displayed(optional): boolean
  Default Value: false

  Display flag (boolean).

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Display flag (boolean).",
            "default":false
        }
    },
    "description":"Plan publication setting's description display options."
}

Nested Schema : IconSettings

Type: object

Plan publication setting's plan icon options.

Show Source

• displayed(optional): boolean
  Default Value: false

  Display flag (boolean).

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Display flag (boolean).",
            "default":false
        }
    },
    "description":"Plan publication setting's plan icon options."
}

Nested Schema : RateSettings

Type: object

Plan publication setting's invocation rate display options flag.

Show Source

• invocations(optional): object InvocationSettings
  Plan invocation's display options.

{
    "type":"object",
    "properties":{
        "invocations":{
            "description":"Invocation display options.",
            "$ref":"#/definitions/InvocationSettings"
        }
    },
    "description":"Plan publication setting's invocation rate display options flag."
}

Nested Schema : InvocationSettings

Type: object

Plan invocation's display options.

Show Source

• displayed(optional): boolean
  Default Value: false

  Display flag (boolean).
• displayText(optional): string
  Text to display.

{
    "type":"object",
    "properties":{
        "displayed":{
            "type":"boolean",
            "description":"Display flag (boolean).",
            "default":false
        },
        "displayText":{
            "type":"string",
            "description":"Text to display."
        }
    },
    "description":"Plan invocation's display options."
}

400 Response

Bad request: indicates a problem with the input parameters.

401 Response

Authentication required.

500 Response

Server error.

Back to Top

Examples

The following example shows how to retrieve a collection of applications 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:443/developers/services/v1/applications

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle Traffic Director
Date: Wed, 20 Dec 2017 05:19:46 GMT
Content-type: application/json
X-oracle-dms-ecid: 6^3rv0_eR00000000
X-oracle-dms-rid: 0:1

Example of Response Body

The following example shows the contents of the response body in JSON format, including the IDs of each application and HATEOAS links to related resources.

{
    "totalResults": 6,
    "offset": 0,
    "count": 6,
    "hasMore": true,
    "limit": 0,
    "links": [
        {
            "method": "GET",
            "templated": "false",
            "rel": "canonical",
            "href": "http://example.com:443/developers/services/v1/applications"
        },
        {
            "method": "POST",
            "templated": "false",
            "rel": "create",
            "href": "http://example.com:443/developers/services/v1/applications"
        }
    ],
    "items": [
        {
            "plans": [
                {
                    "name": "Mobile Device 18.1.1",
                    "registeredApis": [
                        {
                            "vanityName": "creditcheck",
                            "name": "Mobile Device",
                            "links": [
                                {
                                    "method": "GET",
                                    "templated": "false",
                                    "rel": "canonical",
                                    "href": "http://example.com:443/developers/services/v1/applications"
                                },
                                {
                                    "method": "GET",
                                    "templated": "true",
                                    "rel": "canonical",
                                    "href": "http://example.com:443/developers/services/v1/apis/creditcheck"
                                },
                                {
                                    "method": "DELETE",
                                    "templated": "true",
                                    "rel": "unregister",
                                    "href": "http://example.com:443/developers/services/v1/plans/102/subscriptions/102"
                                }
                            ],
                            "id": 102,
                            "version": "18.1.1"
                        }
                    ],
                    "registrationId": 101,
                    "description": "default",
                    "links": [
                        {
                            "method": "POST",
                            "templated": "true",
                            "rel": "register",
                            "href": "http://example.com:443/developers/services/v1/plans/102/subscriptions"
                        }
                    ],
                    "id": 102,
                    "state": "PUBLISHED",
                    "registrationState": "REGISTERED"
                }
            ],
            "name": "Mobile",
            "links": [
                {
                    "method": "GET",
                    "templated": "false",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications/100"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "edit",
                    "href": "http://example.com:443/developers/services/v1/applications/100"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "delete",
                    "href": "http://example.com:443/developers/services/v1/applications/100"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "reissuekey",
                    "href": "http://example.com:443/developers/services/v1/applications/100/key"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "analytics",
                    "href": "http://example.com:443/developers/services/v1/analytics/totals/requests"
                },
                {
                    "method": "POST",
                    "templated": "true",
                    "rel": "register",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "unregister",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions/apiId"
                }
            ],
            "id": 100,
            "type": "application"
        },
        {
            "plans": [
                {
                    "name": "Mobile Device 18.1.1",
                    "registeredApis": [
                        {
                            "vanityName": "creditcheck",
                            "name": "Mobile Device",
                            "links": [
                                {
                                    "method": "GET",
                                    "templated": "false",
                                    "rel": "canonical",
                                    "href": "http://example.com:443/developers/services/v1/applications"
                                },
                                {
                                    "method": "GET",
                                    "templated": "true",
                                    "rel": "canonical",
                                    "href": "http://example.com:443/developers/services/v1/apis/creditcheck"
                                },
                                {
                                    "method": "DELETE",
                                    "templated": "true",
                                    "rel": "unregister",
                                    "href": "http://example.com:443/developers/services/v1/plans/102/subscriptions/102"
                                }
                            ],
                            "id": 102,
                            "version": "18.1.1"
                        }
                    ],
                    "registrationId": 100,
                    "description": "default",
                    "links": [
                        {
                            "method": "POST",
                            "templated": "true",
                            "rel": "register",
                            "href": "http://example.com:443/developers/services/v1/plans/102/subscriptions"
                        }
                    ],
                    "id": 102,
                    "state": "PUBLISHED",
                    "registrationState": "REGISTERED"
                }
            ],
            "name": "Portal",
            "links": [
                {
                    "method": "GET",
                    "templated": "false",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications/101"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "edit",
                    "href": "http://example.com:443/developers/services/v1/applications/101"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "delete",
                    "href": "http://example.com:443/developers/services/v1/applications/101"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "reissuekey",
                    "href": "http://example.com:443/developers/services/v1/applications/101/key"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "analytics",
                    "href": "http://example.com:443/developers/services/v1/analytics/totals/requests"
                },
                {
                    "method": "POST",
                    "templated": "true",
                    "rel": "register",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "unregister",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions/apiId"
                }
            ],
            "id": 101,
            "type": "application"
        },
        {
            "plans": [],
            "name": "Temperatur",
            "description": "Application for Temperature",
            "links": [
                {
                    "method": "GET",
                    "templated": "false",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications/106"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "edit",
                    "href": "http://example.com:443/developers/services/v1/applications/106"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "delete",
                    "href": "http://example.com:443/developers/services/v1/applications/106"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "reissuekey",
                    "href": "http://example.com:443/developers/services/v1/applications/106/key"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "analytics",
                    "href": "http://example.com:443/developers/services/v1/analytics/totals/requests"
                },
                {
                    "method": "POST",
                    "templated": "true",
                    "rel": "register",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "unregister",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions/apiId"
                }
            ],
            "id": 106,
            "type": "application"
        },
        {
            "plans": [],
            "name": "Temperature",
            "description": "Application for Temperature",
            "links": [
                {
                    "method": "GET",
                    "templated": "false",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications/102"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "edit",
                    "href": "http://example.com:443/developers/services/v1/applications/102"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "delete",
                    "href": "http://example.com:443/developers/services/v1/applications/102"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "reissuekey",
                    "href": "http://example.com:443/developers/services/v1/applications/102/key"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "analytics",
                    "href": "http://example.com:443/developers/services/v1/analytics/totals/requests"
                },
                {
                    "method": "POST",
                    "templated": "true",
                    "rel": "register",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "unregister",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions/apiId"
                }
            ],
            "id": 102,
            "type": "application"
        },
        {
            "plans": [],
            "name": "Temperature",
            "description": "Application for Temperature",
            "links": [
                {
                    "method": "GET",
                    "templated": "false",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications/103"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "edit",
                    "href": "http://example.com:443/developers/services/v1/applications/103"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "delete",
                    "href": "http://example.com:443/developers/services/v1/applications/103"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "reissuekey",
                    "href": "http://example.com:443/developers/services/v1/applications/103/key"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "analytics",
                    "href": "http://example.com:443/developers/services/v1/analytics/totals/requests"
                },
                {
                    "method": "POST",
                    "templated": "true",
                    "rel": "register",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "unregister",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions/apiId"
                }
            ],
            "id": 103,
            "type": "application"
        },
        {
            "plans": [],
            "name": "Temperature1",
            "description": "Application for Temperature",
            "links": [
                {
                    "method": "GET",
                    "templated": "false",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "canonical",
                    "href": "http://example.com:443/developers/services/v1/applications/104"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "edit",
                    "href": "http://example.com:443/developers/services/v1/applications/104"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "delete",
                    "href": "http://example.com:443/developers/services/v1/applications/104"
                },
                {
                    "method": "PUT",
                    "templated": "true",
                    "rel": "reissuekey",
                    "href": "http://example.com:443/developers/services/v1/applications/104/key"
                },
                {
                    "method": "GET",
                    "templated": "true",
                    "rel": "analytics",
                    "href": "http://example.com:443/developers/services/v1/analytics/totals/requests"
                },
                {
                    "method": "POST",
                    "templated": "true",
                    "rel": "register",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions"
                },
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "unregister",
                    "href": "http://example.com:443/developers/services/v1/plans/planId/subscriptions/apiId"
                }
            ],
            "id": 104,
            "type": "application"
        }
    ]
}

Back to Top