REST API for Oracle Commerce Cloud December 2017

listSSEFiles

get

/ccadmin/v1/serverExtensions

List SSEFiles. Get a list of uploaded files. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Query Parameters

filter: Type: string

Text string to apply to name field to filter results.
limit: Type: integer

Query limit.
offset: Type: integer

Query offset.
sort: Type: string

Required: true

A sort directive in the form: field:direction where direction is asc or desc.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listSSEFiles_response

Properties

items: Type: array items

Additional Properties Allowed:

Result items.
limit: Type: integer

Query limit.
links: Type: array links

Additional Properties Allowed:

List of navigation links.
offset: Type: integer

Query offset.
sort: Type: array sort

Additional Properties Allowed:

Sort directive.
total: Type: integer

Total items found by query. Deprecated.
totalResults: Type: integer

Total items found by query.

Nested Schema : items

Type: array

Result items.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : links

Type: array

List of navigation links.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: array

Sort directive.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

checksum: Type: integer

File checksum. Omitted for folders.
lastModified: Type: string

Last modified date and time. Omitted for folders.
name: Type: string

File name without path.
path: Type: string

Full path to file, including name.
repositoryId: Type: string

The repository id of the file.
size: Type: integer

File size in bytes. Omitted for folders.
type: Type: string

The item type; file. Omited for folders.

Nested Schema : items

Type: object

Properties

href: Type: string

The URL of the link.
rel: Type: string

The link's relation to the current page of results: next, prev or self.

Nested Schema : items

Type: object

Properties

order: Type: string

Sort order.
property: Type: string

Sort property.

Example application/json


{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/serverExtensions"
        }
    ],
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "path":"/serverExtensions/externalShippingCalculator.zip",
            "metadata":{
            },
            "size":1092820,
            "repositoryId":"f20001",
            "name":"externalShippingCalculator.zip",
            "checksum":-5.7900684961208023E18,
            "lastModified":"2017-05-09T17:23:56.000Z",
            "type":"file"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |33108|The "q" param is not allowed.|

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:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 250,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/serverExtensions"
  }],
  "sort": [{
    "property": "id",
    "order": "asc"
  }],
  "items": [{
    "path": "/serverExtensions/externalShippingCalculator.zip",
    "metadata": {},
    "size": 1092820,
    "repositoryId": "f20001",
    "name": "externalShippingCalculator.zip",
    "checksum": -5790068496120802000,
    "lastModified": "2017-05-09T17:23:56.000Z",
    "type": "file"
  }]
}