listShareSettings
get
/ccstore/v1/shareSettings
List ShareSettings. This operation is used to get the collection of share settings from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of share setting.
Request
Supported Media Types
- application/json
Query Parameters
-
q(optional): string
Query string built as per the SCIM standards that helps to search entered string across share settings properties like 'relativeTo'.
-
sort(optional): string
This field determines the sort order of the list to be fetched.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":1,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccstoreui/v1/shareSettings?q=sharedResourceType eq \"purchaseList\""
}
],
"items":[
{
"owner":{
"firstName":"Leota",
"lastName":"Dilliard",
"id":"bb-100006",
"email":"leota@example.com"
},
"organizationSharingEnabled":true,
"sharedEmailConfigs":[
{
"editEnabled":true,
"id":"gi10001",
"email":"newman@example.com"
}
],
"id":"100001",
"sharedResourceType":"purchaseList",
"defaultEditEnabled":false,
"account":{
"name":"National Discount Auto Parts",
"id":"or-100001"
}
}
]
}
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|
|------------------|------------------|
|00001000|The user is not authenticated.
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