REST API for Oracle Commerce Cloud December 2017

getPromotionFolder

get

/ccadmin/v1/promotionFolders/{id}

Get Promotion Folder. Get a promotion folder by id.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID corresponding to the promotion folder to get.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPromotionFolder_response

Properties

name: Type: string

The name of the promotion folder.
parentFolder: Type: object parentFolder

Additional Properties Allowed:

Parent Folder object of the current folder.
path: Type: string

Promotion folder's absolute path, it is a concatenation of it's parent folder's names and it's own name separated by '/'
repositoryId: Type: string

The promotion folder id.

Nested Schema : parentFolder

Type: object

Parent Folder object of the current folder.

Properties

repositoryId: Type: string

The promotion folder's repository id

Example application/json


{
    "path":"Holiday Discount/Winter Discount",
    "parentFolder":{
        "repositoryId":"promoFolder100001"
    },
    "name":"Winter Discount",
    "repositoryId":"promoFolder10001"
}

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| |------------------|------------------| |21241|promotion folder not found for the given id : nonExistingId| |21240|Promotion folder id is blank|

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:

{
  "path": "Holiday Discount/Winter Discount",
  "parentFolder": {"repositoryId": "promoFolder100001"},
  "name": "Winter Discount",
  "repositoryId": "promoFolder10001"
}