listAccessRights
get
/ccstore/v1/accessRights
List Access Rights. Get all access rights for shoppers.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): string
The maximum number of access rights to be returned from this request.
-
offset(optional): string
The starting offset/index to be returned from this request.
-
q(optional): string
Query string that filters the access rights to be returned from this request using SCIM filtering syntax.
-
sort(optional): string
The sort order of the list to be returned from this request.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listAccessRights_response
Type:
Show Source
object
-
items(optional):
array items
All access rights for shoppers
Nested Schema : getAccessRight_response
Type:
Show Source
object
-
description(optional):
string
Description of access right
-
displayName(optional):
string
Display name of access right
-
id(optional):
string
ID of access right
-
name(optional):
string
Name of access right
-
repositoryId(optional):
string
Repository ID of access right
-
type(optional):
string
Type of access right
Example Response (application/json)
{
"total":3,
"totalResults":3,
"offset":0,
"limit":250,
"sort":[
{
"property":"id",
"order":"asc"
}
],
"items":[
{
"displayName":"Custom Access Right 1",
"name":"Custom Access Right 1",
"repositoryId":"customAccessRight1",
"description":"Custom Access Right 1",
"id":"customAccessRight1",
"type":"generic"
},
{
"displayName":"Custom Access Right 2",
"name":"Custom Access Right 2",
"repositoryId":"customAccessRight2",
"description":"Custom Access Right 2",
"id":"customAccessRight2",
"type":"generic"
},
{
"displayName":"Custom Access Right 3",
"name":"Custom Access Right 3",
"repositoryId":"customAccessRight3",
"description":"Custom Access Right 3",
"id":"customAccessRight3",
"type":"generic"
}
]
}
Default Response
The error response
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