Update a role definition
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}
Request
Path Parameters
-
publicSectorRoleDefinitionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Role Definitions resource and used to uniquely identify an instance of Role Definitions. The client should not generate the hash key value. Instead, the client should query on the Role Definitions collection resource in order to navigate to a specific instance of Role Definitions to get the hash key.
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
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 : publicSectorRoleDefinitions-item-response
Type:
Show Source
object
-
AbstractRole: string
Title:
Abstract Role
Read Only:true
Maximum Length:30
Indicates if the role is of the type abstract. -
ActiveFlag: string
Title:
Status
Read Only:true
Maximum Length:30
Indicates if the role is available to be used in assignments. -
DataRole: string
Title:
Data Role
Read Only:true
Maximum Length:30
Indicates if the role is of the type role. -
DelegationAllowed: string
Title:
Delegation Allowed
Read Only:true
Maximum Length:30
Indicates if the role can be assigned through delegation. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the role. -
DutyRole: string
Read Only:
true
Maximum Length:30
Indicates if the role is of the type duty. -
ExternalId: string
Read Only:
true
Maximum Length:64
The identifier of the external role. -
ExternalRole: string
Read Only:
true
Maximum Length:30
Indicates if the role is of the type external. -
JobRole: string
Title:
Job Role
Read Only:true
Maximum Length:30
Indicates if the role is of the type job. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The identifier of the optimistic lock. The value is incremented each time the row is updated. The values at the beginning and at the end of the transaction are compared to determine if a session updated the row since it was queried. -
RoleCommonName: string
Title:
Role Code
Read Only:true
Maximum Length:240
The unique identifier of the role. -
RoleDistinguishedName: string
Title:
Role Distinguished Name
Read Only:true
Maximum Length:4000
The distinguished name defined within the LDAP. It contains the relevant group information to provide a unique name. -
RoleGuid: string
Title:
Role Globally Unique ID
Read Only:true
Maximum Length:64
The unique global identifier of the role. -
RoleId: integer
(int64)
Read Only:
true
The unique identifier of the role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:240
The name for the role.
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.