REST API for Oracle Commerce Cloud December 2017

getAllExtensions

get

/ccadmin/v1/extensions

Get All Extensions. Get summary information on all Extensions currently loaded on the system.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getAllExtensions_response

Properties

items: Type: array items

Additional Properties Allowed:

list of extensions

Nested Schema : items

Type: array

list of extensions

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

creationTime: Type: string

time the Extension was created.
creator: Type: string

name of the creator of the Extension.
description: Type: string

summary description of the Extension.
developerId: Type: string

ID of developer who created the Extension.
enabled: Type: boolean

true if Extension is currently enabled.
installedBy: Type: string

user who installed the Extension.
installedByUserName: Type: string

user who installed the Extension.
installedTime: Type: string

date and time the Extension was installed.
items: Type: array items

Additional Properties Allowed:

list of elements or widgets
lastModifiedBy: Type: string

user who last modified the Extension.
modificationTime: Type: string

last time the Extension was modified in any way.
name: Type: string

name of the Extension.
origin: Type: string

where the zip file came from - will always be 'upload' for now.
readme: Type: string

contents of the README file - if any.
repositoryId: Type: string

ID the Extension is stored against in the Repository.
version: Type: string

version number of the Extension.
zipPath: Type: string

path of the zip file on the server that contains the Extension.

Nested Schema : items

Type: array

list of elements or widgets

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

ID of item (Element or Widget) contained in the Extension.

Example application/json


{
    "items":[
        {
            "installedTime":"2014-06-20T09:28:31.562Z",
            "creator":"Oracle Corp.",
            "creationTime":"2014-01-01",
            "origin":"upload",
            "lastModifiedBy":"admin",
            "description":"Delivering New Widget with Element",
            "readme":null,
            "version":"1",
            "enabled":true,
            "developerId":"999999",
            "zipPath":"extensions/2014520102830313_workingUnderElements.zip",
            "modificationTime":"2014-06-20T09:28:31.562Z",
            "repositoryId":"4ab03536-9c6f-41ce-84d8-45934bed0693",
            "name":"Widget with Element",
            "installedBy":"admin",
            "installedByUserName":"Amber Admin",
            "items":[
                {
                    "repositoryId":"100001"
                },
                {
                    "repositoryId":"100002"
                }
            ]
        }
    ]
}

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:

{"items": [{
  "installedTime": "2014-06-20T09:28:31.562Z",
  "creator": "Oracle Corp.",
  "creationTime": "2014-01-01",
  "origin": "upload",
  "lastModifiedBy": "admin",
  "description": "Delivering New Widget with Element",
  "readme": null,
  "version": "1",
  "enabled": true,
  "developerId": "999999",
  "zipPath": "extensions/2014520102830313_workingUnderElements.zip",
  "modificationTime": "2014-06-20T09:28:31.562Z",
  "repositoryId": "4ab03536-9c6f-41ce-84d8-45934bed0693",
  "name": "Widget with Element",
  "installedBy": "admin",
  "installedByUserName": "Amber Admin",
  "items": [
    {"repositoryId": "100001"},
    {"repositoryId": "100002"}
  ]
}]}