Deprecated - Retrieve statistics of specific assignments within a given instance.

get https://{tenanturl}/v1.0/admin/instances/{instanceId}/assignments/resources

The api to get statistics of specific assignments within a given instance v1.0 (v1.0/admin/instances/{instanceId}/assignments/resources) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: GET /v2.0/instances/{instanceId}/assignments/resources
Get statistics about assignment resources, for a specific campaign instance, depending on the specified filter. If called by application owner, the API returns statistics for the instance, he created or at least has one application he owns.
Entitlements required: manageAccessCertification [Manage Access Certification].

Path Params

instanceId

string

required

Campaign Instance ID

Query Params

resourceType

string

Defaults to assignee

The filter for the resource type to query statistics: assignee, reviewer, application, assignmentType, assignmentName, assignmentSource, accountStatus, accountName, entitledAs.

reviewerId

string

The filter for the campaign reviewer.
For example,607000JX53

actions

array of strings

The filter for the reviewer action.

Possible values for reviewer actions are: none, approved, rejected, redirected, escalated, noMoreOnTarget.
Provide multiple values in new lines or separated by commas.

actions

filter

string

The generic filter for returning campaign assignment resources statistics:

Following is the list of resourceType and it's corresponding filter attribute that contains the passed string in one of the attribute:

assignee: assignee.name, assignee.email, assignee.fullName, assignee.firstName, assignee.lastName
reviewer: reviewer.name, reviewer.email, reviewer.fullName, reviewer.firstName, reviewer.lastName
application: application.name
assignmentType: entitlement.type
assignmentName: entitlement.name
accountStatus: account.finerStatus
accountName: account.userName
entitledAs: discretionaryGroup.name

sort

string

The attribute of the campaign assignment that is used to sort results.
Following is the list of resourceType and it's corresponding attribute respectively that is used to sort results:

assignee: When you provide,

- firstname: Assignee firstName is used for sorting.
- lastname: Assignee lastName is used for sorting.
- count: Assignee's assignments count is used for sorting.

reviewer: When you provide,

- reviewer: Reviewer firstName is used for sorting.
- numapproveditems: Reviewer approved items count is used for sorting.
- numrejecteditems: Reviewer rejected items count is used for sorting.
- numunproceseditems: Reviewer unprocessed items count is used for sorting.
- completion: Reviewer completed items count is used for sorting.
- count: Reviewer total items count is used for sorting.

application: When you provide,

- application: Application name is used for sorting.
- count: Application's assignments count is used for sorting.

assignmentType: By default entitlement type is used for sorting.
assignmentName: By default entitlement name is used for sorting.
accountStatus: By default account finerStatus is used for sorting.
accountName: By default account userName is used for sorting.
entitledAs: By default discretionary group name is used for sorting.

sortDesc

boolean

Defaults to true

Decides sort order.

limit

string

Defaults to 500

Specifies the maximum number of resources that the search returns for a page.

page

string

Defaults to 1

Page number.

Responses

500

Server error

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://tenant_url/v1.0/admin/instances/instanceId/assignments/resources?resourceType=assignee&sortDesc=true&limit=500&page=1' \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Success

400Generic application error status. The error code and description are available in the payload.