listOrganizationRoles
get
/ccapp/v1/organizations/{id}/organizationalRoles
List Organization roles. This operation is used to get the collection of customer organization roles 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 organization roles.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the requested Organization.
Query Parameters
-
limit(optional): string
This is the field to determine number of records to be fetched per REST call.
-
offset(optional): string
This field determines the offset/starting index from which data to be fetched.
-
q(optional): string
Query string built as per the SCIM standards that helps to search entered string across account properties like 'name'.
-
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.
Root Schema : listOrganizationRoles_response
Type:
Show Source
object
-
items(optional):
array items
list of organization roles
-
limit(optional):
integer
Number of records to be fetched.
-
offset(optional):
integer
The offset provided.
-
total(optional):
integer
Total number of records present in database matching the searched string.
-
totalResults(optional):
integer
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
Show Source
object
-
function(optional):
string
Function of the role which can be admin, buyer or approver and so on.
-
name(optional):
string
Name of the role
-
repositoryId(optional):
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 Commerce Cloud:
|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(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