Returns a paginated list of the profiles registered in the system.
URL
{WSUrl}/api/profiles[?[[&]$filter=<filter>][[&]page=<Page>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]
REQUEST METHOD
GET
URL PARAMETERS
page: Number of the page to be displayed. Valid values: from 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.
page_size: Number of items displayed per page. Valid values: from 1 to 1,000. If omitted, the default value of 10 is used.
filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.
orderby: Orders the profiles listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" for each field. The supported fields are listed below.
FIELDS SUPPORTED BY FILTER
int Id;
string Name;
int Module/Id;
string Module/Name;
For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.
REQUEST EXAMPLES
The first ten profiles (by default, 10 profiles are listed at a time):
{RMUrl}/api/admin/profiles
Profiles 11 through 20 (second page):
{RMUrl}/api/admin/profiles?page=2
Filter by profile ID:
{RMUrl}/api/admin/profiles?$filter=Id eq 1
Filter by "Administrator" in the "Name" field:
{RMUrl}/api/admin/profiles?$filter=substringof('Administrator',Name)
SUCCESS RESPONSE
List of profiles according to the specified filters and page size.
Profile[].
The Profile object is in the following format:
Profile
{
int Id;
string Name;
object Module;
}
SUCCESS RESPONSE EXAMPLE
[
{
"Id" : 1,
"Name": "Administrators",
"Module" : { "Id": 1, "Name" : "Administration" }
},
{
"Id" : 3,
"Name": "Organization Managers",
"Module" : { "Id": 3, "Name" : "Organization" }
},
....
]