Get a role assigned to the person
get
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles/{publicSectorPersonRolesUniqID}
Request
Path Parameters
-
publicSectorPersonRolesUniqID: string
Identifier to Person Roles
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPersonRoles-item
Type:
Show Source
object
-
ActiveFlag(optional):
string
Maximum Length:
30
Indicates if the role assignment is available to be used. -
BusinessGroupId(optional):
integer(int64)
The enterprise identifier of the multi tenant group.
-
CreatedBy(optional):
string
Maximum Length:
64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
EndDate(optional):
string(date)
The date from which the role assignment will not be available for use.
-
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The name of the user who last updated the row. -
LastUpdateLogin(optional):
string
Maximum Length:
32
Indicates the session login detail of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
MethodCode(optional):
string
Maximum Length:
30
Indicates the method that was used to assign the role to the person. -
ObjectVersionNumber(optional):
integer(int32)
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(optional):
string
Title:
Role Code
Maximum Length:240
The identifier of the role. -
RoleDescription(optional):
string
Title:
Description
Maximum Length:240
The description of the role that is assigned. -
RoleGuid(optional):
string
Maximum Length:
64
The global unique identifier of the role. -
RoleGUIDInput(optional):
string
Maximum Length:
255
The unique global identifier of the role for LDAP. -
RoleId(optional):
integer(int64)
The identifier of the role.
-
RoleIdFk(optional):
integer(int64)
The foreign key identifier of the role definition table.
-
RoleName(optional):
string
Title:
Role Name
Maximum Length:240
The name of the role. -
RoleObjectVersionNumber(optional):
integer(int32)
The object version identifier of the role when there is a role change.
-
StartDate(optional):
string(date)
The date from which the role assignment is available to be used.
-
TerminatedFlag(optional):
string
Maximum Length:
30
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(optional):
string
Maximum Length:
64
The unique global identifier of the user. -
UserGUIDInput(optional):
string
Maximum Length:
255
The unique global identifier of the user for LDAP. -
UserId(optional):
integer(int64)
The identifier of the user to whom the row is assigned.
-
UserRoleId(optional):
integer(int64)
The unique identifier the role that is assigned to the user.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.