REST API for the Management Service in Oracle API Platform Cloud Service

Get Applications

get

/apiplatform/management/v1/applications

Retrieves a collection of applications the requesting user is authorized to view. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the API Manager, Application Developer, or Plan Manager role. Applications the user is issued the Manage Application or View All Details grants for 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

Response

Supported Media Types

application/json

200 Response

The collection of applications.

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.

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.

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"
    }
}

Examples

The following example shows how to retrieve the 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 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/applications

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:06:43 GMT
Content-type: application/json
X-oracle-dms-ecid: kKjMg1k4S00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Transfer-encoding: chunked

Example of Response Body

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

{
    "offset": 0,
    "count": 5,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/applications?offset=0=128"
        },
        {
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/applications"
        },
        {
            "method": "POST",
            "rel": "create",
            "href": "http://example.com:443/apiplatform/management/v1/applications"
        }
    ],
    "items": [
        {
            "createdAt": "2018-02-08T00:39:42-0800",
            "types": [
                "108"
            ],
            "updatedBy": "apicsadmin",
            "createdBy": "apicsadmin",
            "contact": {},
            "name": "Allied Mortgage Calculator",
            "description": "Fast and easy real estate mortgage payment calculator",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/104"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/104"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/104/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/104"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "issueKey",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/104/key"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "subscriptions",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/104/subscriptions"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/104/grants"
                }
            ],
            "id": "104",
            "key": "99b7f99c-9999-9db9-a009-f19ec9999ffa",
            "updatedAt": "2018-02-08T00:39:42-0800"
        },
        {
            "createdAt": "2018-02-06T22:19:15-0800",
            "types": [
                "108"
            ],
            "updatedBy": "apicsadmin",
            "createdBy": "apicsadmin",
            "contact": {},
            "name": "Sav Test",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "issueKey",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103/key"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "subscriptions",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103/subscriptions"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/103/grants"
                }
            ],
            "id": "103",
            "key": "g1e99abc-d99e-99cb-99e2-9999t299d49j",
            "updatedAt": "2018-02-06T22:19:15-0800"
        },
        {
            "createdAt": "2018-02-05T10:27:30-0800",
            "types": [],
            "updatedBy": "apicsadmin",
            "createdBy": "apicsadmin",
            "contact": {
                "firstName": "user",
                "lastName": "name",
                "phone": "(555) 555 5555",
                "company": "Example Co.",
                "email": "user.name@example.com"
            },
            "name": "World Weather",
            "description": "Weather reports and forecasts for the entire world",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "issueKey",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101/key"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "subscriptions",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101/subscriptions"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/101/grants"
                }
            ],
            "id": "101",
            "key": "69999-009e-9999-b190-a9e9e999cb9e",
            "updatedAt": "2018-02-05T11:30:46-0800"
        },
        {
            "createdAt": "2018-02-05T10:27:30-0800",
            "types": [],
            "updatedBy": "apicsadmin",
            "createdBy": "apicsadmin",
            "contact": {
                "firstName": "User",
                "lastName": "Name",
                "phone": "555 5555",
                "company": "Example Co.",
                "email": "user.name@example.com"
            },
            "name": "Western Real Estate",
            "description": "View Real Estate Trends, Analysis and Statistics",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/102"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/102"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/102/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/102"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "issueKey",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/102/key"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "subscriptions",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/102/subscriptions"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/102/grants"
                }
            ],
            "id": "102",
            "key": "20444t-5678-9a99-a9bb-abcfcbe99t9f",
            "updatedAt": "2018-02-05T11:30:20-0800"
        },
        {
            "createdAt": "2018-02-08T00:42:27-0800",
            "types": [
                "108"
            ],
            "updatedBy": "apicsadmin",
            "createdBy": "apicsadmin",
            "contact": {},
            "name": "GeoServices",
            "description": "Mapping, Routing & Navigation Services",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/105"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/105"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "history",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/105/history"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/105"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "issueKey",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/105/key"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "subscriptions",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/105/subscriptions"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "grants",
                    "href": "http://example.com:443/apiplatform/management/v1/applications/105/grants"
                }
            ],
            "id": "105",
            "key": "20t-5678-9a99-a9bb-abcfcbe99t9f",
            "updatedAt": "2018-02-08T00:42:27-0800"
        }
    ]
}