Get all roles assigned to the person
get
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey
Finder Variables:- UserRoleId
- PrimaryKey
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveFlag; string; Indicates if the role assignment is available to be used.
- BusinessGroupId; integer; The enterprise identifier of the multi tenant group.
- CreatedBy; string; The name of the user who created the row.
- CreationDate; string; The date and time when the row was created.
- EndDate; string; The date from which the role assignment will not be available for use.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdateLogin; string; Indicates the session login detail of the user who last updated the row.
- LastUpdatedBy; string; The name of the user who last updated the row.
- MethodCode; string; Indicates the method that was used to assign the role to the person.
- ObjectVersionNumber; integer; The identifier of the version, which is used for implementing optimistic locking. The value increments each time the row is updated. The value at the beginning of a transaction to determine if a session has updated the row since it was queried.
- RoleCommonName; string; The identifier of the role.
- RoleDescription; string; The description of the role that is assigned.
- RoleGUIDInput; string; The unique global identifier of the role for LDAP.
- RoleGuid; string; The global unique identifier of the role.
- RoleId; integer; The identifier of the role.
- RoleIdFk; integer; The foreign key identifier of the role definition table.
- RoleName; string; The name of the role.
- RoleObjectVersionNumber; integer; The object version identifier of the role when there is a role change.
- StartDate; string; The date from which the role assignment is available to be used.
- TerminatedFlag; string; Indicates that the role is assigned to the user that has their employment terminated. This is used when the system initiates the reverse termination process to re-provision roles.
- UserGUID; string; The unique global identifier of the user.
- UserGUIDInput; string; The unique global identifier of the user for LDAP.
- UserId; integer; The identifier of the user to whom the row is assigned.
- UserRoleId; integer; The unique identifier the role that is assigned to the user.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorPersonRoles
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPersonRoles-item-response
Type:
Show Source
object
-
ActiveFlag: string
Read Only:
true
Maximum Length:30
Indicates if the role assignment is available to be used. -
BusinessGroupId: integer
(int64)
Read Only:
true
The enterprise identifier of the multi tenant group. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
EndDate: string
(date)
Read Only:
true
The date from which the role assignment will not be available for use. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login detail of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MethodCode: string
Read Only:
true
Maximum Length:30
Indicates the method that was used to assign the role to the person. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The identifier of the version, which is used for implementing optimistic locking. The value increments each time the row is updated. The value at the beginning of a transaction to determine if a session has updated the row since it was queried. -
RoleCommonName: string
Title:
Role Code
Read Only:true
Maximum Length:240
The identifier of the role. -
RoleDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the role that is assigned. -
RoleGuid: string
Read Only:
true
Maximum Length:64
The global unique identifier of the role. -
RoleGUIDInput: string
Maximum Length:
255
The unique global identifier of the role for LDAP. -
RoleId: integer
(int64)
Read Only:
true
The identifier of the role. -
RoleIdFk: integer
(int64)
Read Only:
true
The foreign key identifier of the role definition table. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:240
The name of the role. -
RoleObjectVersionNumber: integer
(int32)
Read Only:
true
The object version identifier of the role when there is a role change. -
StartDate: string
(date)
Read Only:
true
The date from which the role assignment is available to be used. -
TerminatedFlag: string
Read Only:
true
Maximum Length:30
Default Value:N
Indicates that the role is assigned to the user that has their employment terminated. This is used when the system initiates the reverse termination process to re-provision roles. -
UserGUID: string
Read Only:
true
Maximum Length:64
The unique global identifier of the user. -
UserGUIDInput: string
Maximum Length:
255
The unique global identifier of the user for LDAP. -
UserId: integer
(int64)
Read Only:
true
The identifier of the user to whom the row is assigned. -
UserRoleId: integer
(int64)
Read Only:
true
The unique identifier the role that is assigned to the user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- perUserRoleAction
-
This action is used to process the person and the associated roles. The roles can be added or removed.