REST API for Oracle Commerce Cloud December 2017

createApplicationID

post

/ccadmin/v1/applicationIds

Create Application ID. Creates an Application ID of specified type

Request

Supported Media Types

application/json

Body Parameter

Root Schema : createApplicationID_request

Example

POST /ccadmin/v1/applicationIds

Properties

name: Type: string

Required: true

The name for the new Application ID.
type: Type: string

Required: true

The Application ID type: application or extension.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createApplicationID_response

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:17:02.399",
    "createdBy":{
        "lastName":"Admin",
        "firstName":"Amber",
        "repositoryId":"admin",
        "id":"admin"
    },
    "inUse":false,
    "name":"another application name",
    "repositoryId":"12c26908-6545-4947-a46c-9917236583c5",
    "id":"12c26908-6545-4947-a46c-9917236583c5",
    "type":"application",
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MDk4NTY1OTEsInN1YiI6ImFkbWluIiwiaXNzIjoiYWRtaW4iLCJpYXQiOjE0MDk3NzAxOTF9.T0kaE8Ib35R2XZzp0xk4FRP/266KD1cieZFpPijtniw="
}

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

POST /ccadmin/v1/applicationIds

Sample Response Payload returned by endpoint:

{
  "creationTime": "2014-05-08 17:17:02.399",
  "createdBy": {
    "lastName": "Admin",
    "firstName": "Amber",
    "repositoryId": "admin",
    "id": "admin"
  },
  "inUse": false,
  "name": "another application name",
  "repositoryId": "12c26908-6545-4947-a46c-9917236583c5",
  "id": "12c26908-6545-4947-a46c-9917236583c5",
  "type": "application",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MDk4NTY1OTEsInN1YiI6ImFkbWluIiwiaXNzIjoiYWRtaW4iLCJpYXQiOjE0MDk3NzAxOTF9.T0kaE8Ib35R2XZzp0xk4FRP/266KD1cieZFpPijtniw="
}