listOrganizationRoles
get
/ccapp/v1/organizations/{id}/organizationalRoles
List Organization roles. This operation is used to get the collection of customer organization roles from Oracle Retail Digital Commerce. It can also be used to return the list on a searched string and in a sorted order against various properties of organization roles.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of the requested Organization.
Query Parameters
-
limit: string
This is the field to determine number of records to be fetched per REST call.
-
offset: string
This field determines the offset/starting index from which data to be fetched.
-
q: string
Query string built as per the SCIM standards that helps to search entered string across account properties like 'name'.
-
sort: 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.
Root Schema : listOrganizationRoles_response
Type:
Show Source
object-
items:
array items
list of organization roles
-
limit:
integer
Number of records to be fetched.
-
offset:
integer
The offset provided.
-
total:
integer
Total number of records present in database matching the searched string.
-
totalResults:
integer
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
Show Source
object-
function:
string
Function of the role which can be admin, buyer or approver and so on.
-
name:
string
Name of the role
-
repositoryId:
string
Repository Id of the role.
Example Response (application/json)
{
"total":6,
"totalResults":6,
"offset":0,
"limit":6,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/organizations/or-100001/organizationalRoles"
}
],
"items":[
{
"function":"admin",
"repositoryId":"200004",
"name":"Administrator"
},
{
"function":"buyer",
"repositoryId":"200005",
"name":"Buyer"
},
{
"function":"approver",
"repositoryId":"200006",
"name":"Approver"
},
{
"function":"accountAddressManager",
"repositoryId":"200007",
"name":"Account Address Manager"
},
{
"function":"profileAddressManager",
"repositoryId":"200008",
"name":"Profile Address Manager"
},
{
"function":"custom",
"repositoryId":"customOrganizationalRole",
"name":"Custom Organizational Role"
}
],
"___etag___":"eyJoYXNoIjoiaS92RnVXRHZsakhtZW9DZDBMWnQvZTRDZUMxT3dnOUhZQWxtVGwxaTNsZz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZ2FuaXphdGlvbnMiLCJ2ZXJzaW9uIjowfQ=="
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Retail Digital Commerce:
|Error Code|Description|
|------------------|------------------|
|85000|Invalid Query Expression.|
|10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset' or 'sort'.|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code