getPromotionFolder
get
/ccadmin/v1/promotionFolders/{id}
Get Promotion Folder. Get a promotion folder by id.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID corresponding to the promotion folder to get.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPromotionFolder_response
Type:
Show Source
object
-
name(optional):
string
The name of the promotion folder.
-
parentFolder(optional):
object parentFolder
Parent Folder object of the current folder.
-
path(optional):
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(optional):
string
The promotion folder id.
Nested Schema : parentFolder
Type:
object
Parent Folder object of the current folder.
Show Source
-
repositoryId(optional):
string
The promotion folder's repository id
Example Response (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|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code