REST API for Oracle Commerce Cloud December 2017

getApplicationIDs

get

/ccadmin/v1/applicationIds

Get Application IDs. Returns Application IDs of the specified type or all IDs if type is not specified.

Request

Supported Media Types

application/json

Query Parameters

type: Type: string

Required: true

The type of Application to retrieve.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getApplicationIDs_response

Properties

items: Type: array items

Additional Properties Allowed:

the list of Application IDs.

Nested Schema : items

Type: array

the list of Application IDs.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

createdBy: Type: object createdBy

Additional Properties Allowed:

information about the user who created the application.
creationTime: Type: string

time application was creating in ISO 8601 format.
inUse: Type: boolean

true if the application ID is currently being used.
name: Type: string

the name of the application.
repositoryId: Type: string

the id of the application ID item.
token: Type: string

The auth token for the application, if of type application.
type: Type: string

the type of application; can be application or extension.

Nested Schema : createdBy

Type: object

information about the user who created the application.

Properties

firstName: Type: string

first name of the user.
lastName: Type: string

last name of user.
repositoryId: Type: string

the repository id of the user

Example application/json


[
    {
        "creationTime":"2014-05-08 17:15:43.143",
        "createdBy":{
            "lastName":"Admin",
            "firstName":"Amber",
            "repositoryId":"admin",
            "id":"admin"
        },
        "inUse":true,
        "name":"another extension name",
        "repositoryId":"1036cd9a-844d-4c4a-9dc2-22be5a84ced4",
        "id":"1036cd9a-844d-4c4a-9dc2-22be5a84ced4",
        "type":"extension"
    },
    {
        "creationTime":"2014-05-08 17:15:26.328",
        "createdBy":{
            "lastName":"Admin",
            "firstName":"Amber",
            "repositoryId":"admin",
            "id":"admin"
        },
        "name":"new extension name",
        "repositoryId":"d5be81d5-79fb-44af-8281-b5afa81d8fef",
        "id":"d5be81d5-79fb-44af-8281-b5afa81d8fef",
        "type":"extension"
    }
]

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

[
  {
    "creationTime": "2014-05-08 17:15:43.143",
    "createdBy": {
      "lastName": "Admin",
      "firstName": "Amber",
      "repositoryId": "admin",
      "id": "admin"
    },
    "inUse": true,
    "name": "another extension name",
    "repositoryId": "1036cd9a-844d-4c4a-9dc2-22be5a84ced4",
    "id": "1036cd9a-844d-4c4a-9dc2-22be5a84ced4",
    "type": "extension"
  },
  {
    "creationTime": "2014-05-08 17:15:26.328",
    "createdBy": {
      "lastName": "Admin",
      "firstName": "Amber",
      "repositoryId": "admin",
      "id": "admin"
    },
    "name": "new extension name",
    "repositoryId": "d5be81d5-79fb-44af-8281-b5afa81d8fef",
    "id": "d5be81d5-79fb-44af-8281-b5afa81d8fef",
    "type": "extension"
  }
]