Create a set of role assignments to the person
post
/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
RoleGUIDInput: string
Maximum Length:
255
The unique global identifier of the role for LDAP. -
UserGUIDInput: string
Maximum Length:
255
The unique global identifier of the user for LDAP.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-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.