Update a role page assignment
patch
/fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}
Request
Path Parameters
-
AssignmentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
rolePagePermissions: array
Page Permission Assignment to Role
Title:
Page Permission Assignment to Role
The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page.
Nested Schema : Page Permission Assignment to Role
Type:
array
Title:
Page Permission Assignment to Role
The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page.
Show Source
Nested Schema : hedPageRoleAssignments-rolePagePermissions-item-patch-request
Type:
Show Source
object
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 : hedPageRoleAssignments-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Page Role Assignment ID
Read Only:true
Identifier of the assignment of page permissions to the security role. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the page role assignment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the page role assignment was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the page role assignment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the page role assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageId: integer
(int64)
Title:
Page ID
Identifier of the application page. -
RoleCode: string
Title:
Role Code
Maximum Length:128
The alternate identifier for the security role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:240
The name of the security role. -
rolePagePermissions: array
Page Permission Assignment to Role
Title:
Page Permission Assignment to Role
The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page. -
SeedDataLock: integer
(int32)
Title:
Seed Data Lock
Read Only:true
Default Value:0
Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Page Permission Assignment to Role
Type:
array
Title:
Page Permission Assignment to Role
The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page.
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.
Nested Schema : hedPageRoleAssignments-rolePagePermissions-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the role page permission. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the role page permission was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the role page permission was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the role page permission. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageElementCode: string
Title:
Page Element Code
Read Only:true
Maximum Length:100
Unique identifier of the element on the application page. -
PagePermissionCode: string
Title:
Page Permission Code
Read Only:true
Maximum Length:50
The alternate identifiers for the permission sets. -
PagePermissionId: integer
(int64)
Title:
Page Permission ID
Identification number of application page permission set. -
PagePermissionName: string
Title:
Page Permission Name
Read Only:true
Maximum Length:50
Names of the security permission set. -
PermissionMappingId: integer
(int64)
Title:
Permission Mapping ID
Read Only:true
Identifier number of mapping the page element to the security role. -
SeedDataLock: integer
(int32)
Title:
Seed Data Lock
Read Only:true
Default Value:0
Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- pagesLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/hedPagesThe list of values for the application pages.
- roleCodesLOV
-
Parameters:
- finder:
NonDataCustomRoleFinder
The list of values for the security roles. - finder:
- rolePagePermissions
-
Operation: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}/child/rolePagePermissionsParameters:
- AssignmentId:
$request.path.AssignmentId
The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page. - AssignmentId: