Jump to

• Request
• Response
• Examples

Get application types

get

/apiplatform/management/v1/applications/types

Returns the available application types.

Users requesting this resource must be assigned the API Manager, Application Developer, or Plan Manager roles.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of application types.

Body ()

Root Schema : GetApplicationTypesResponse

Match All

Show Source

• object GetApplicationTypesResponse-allOf[0]

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

Nested Schema : GetApplicationTypesResponse-allOf[0]

Type: object

Show Source

• items(optional): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object Type

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

Nested Schema : Type

Type: object

Show Source

• description(optional): string
• id: string
  The grant type's ID.
• name(optional): string

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

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 available application types 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/applications/types

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 18:40:27 GMT
Content-length: 413
Content-type: application/json
X-oracle-dms-ecid: CafX61vnR00000000
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 details about all application types:

{
    "items": [
        {
            "name": {
                "localized": "Desktop App",
                "en": "Desktop App"
            },
            "id": "108"
        },
        {
            "name": {
                "localized": "Mobile - Windows",
                "en": "Mobile - Windows"
            },
            "id": "103"
        },
        {
            "name": {
                "localized": "Backend Service",
                "en": "Backend Service"
            },
            "id": "101"
        },
        {
            "name": {
                "localized": "Web Application",
                "en": "Web Application"
            },
            "id": "102"
        },
        {
            "name": {
                "localized": "Mobile - iOS",
                "en": "Mobile - iOS"
            },
            "id": "104"
        },
        {
            "name": {
                "localized": "Thing",
                "en": "Thing"
            },
            "id": "107"
        },
        {
            "name": {
                "localized": "Integration",
                "en": "Integration"
            },
            "id": "100"
        },
        {
            "name": {
                "localized": "Mobile - Android",
                "en": "Mobile - Android"
            },
            "id": "105"
        },
        {
            "name": {
                "localized": "Game",
                "en": "Game"
            },
            "id": "106"
        }
    ]
}

Back to Top