listWorksets
get
/ccadmin/v1/worksets
Lists worksets.
Request
Supported Media Types
- application/json
Query Parameters
-
includeScheduledWorksets(optional): boolean
Whether to list scheduled worksets.
-
q(optional): string
Query string that filters the access rights to be returned from this request using SCIM filtering syntax.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listWorksets_response
Type:
Show Source
object
-
items(optional):
array items
List of worksets
-
limit(optional):
string
Number of records to be fetched.
-
offset(optional):
string
The offset provided.
-
sort(optional):
array sort
Sorting criteria.
-
total(optional):
string
Total number of records present in database matching the searched string.
-
totalResults(optional):
string
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
Workset name.
-
repositoryId(optional):
string
Workset ID.
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Sort order: asc or desc.
-
property(optional):
string
The property the listing is sorted by.
Example Response (application/json)
{
"total":2,
"totalResults":2,
"offset":0,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/worksets"
}
],
"sort":[
{
"property":"name",
"order":"asc"
}
],
"items":[
{
"name":"default",
"repositoryId":"default"
},
{
"name":"summer_sales",
"repositoryId":"ws10001"
}
]
}
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|
|------------------|------------------|
|31303|Internal server error.|
|85000|q query param is not valid SCIM filter format|
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