Create a role group page assignment
post
/fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssignmentId: integer
(int64)
The unique identifier of a page to role group assignment.
-
PageCode(required): string
Maximum Length:
100
The alternate identifier of the page. -
PageId(required): integer
(int64)
The unique identifier of the page.
-
RoleGroupCode(required): string
Maximum Length:
50
The alternate identifier of the role group. -
RoleGroupId(required): integer
(int64)
The unique identifier of the role group.
-
roleGroupPagePermissions: array
Page Permissions to Role Group Assignments
Title:
Page Permissions to Role Group Assignments
The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.
Nested Schema : Page Permissions to Role Group Assignments
Type:
array
Title:
Page Permissions to Role Group Assignments
The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
PagePermissionId: integer
(int64)
The unique identifier of the page element permission.
-
PermissionMappingId: integer
(int64)
The unique identifier of the page element permission mapping to the role group.
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 : hedPageRoleGroupAssignments-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
The unique identifier of a page to role group assignment.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the page to role group assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the page to role group assignment was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the page to role group assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the page to role group assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageCode: string
Maximum Length:
100
The alternate identifier of the page. -
PageDescription: string
Read Only:
true
Maximum Length:1000
The description of the page. -
PageId: integer
(int64)
The unique identifier of the page.
-
PageName: string
Read Only:
true
Maximum Length:100
The name of the page. -
RoleGroupCode: string
Maximum Length:
50
The alternate identifier of the role group. -
RoleGroupId: integer
(int64)
The unique identifier of the role group.
-
RoleGroupName: string
Read Only:
true
Maximum Length:50
The name of the role group. -
roleGroupPagePermissions: array
Page Permissions to Role Group Assignments
Title:
Page Permissions to Role Group Assignments
The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Page Permissions to Role Group Assignments
Type:
array
Title:
Page Permissions to Role Group Assignments
The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.
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 : hedPageRoleGroupAssignments-roleGroupPagePermissions-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the page permission to role group assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the page permission to role group assignment was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the page permission to role group assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the page permission to role group assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageElementCode: string
Read Only:
true
Maximum Length:100
The alternate identifier of the page element. -
PagePermissionCode: string
Read Only:
true
Maximum Length:50
The alternate identifier of the page element permission. -
PagePermissionId: integer
(int64)
The unique identifier of the page element permission.
-
PagePermissionName: string
Read Only:
true
Maximum Length:50
The name of the action assigned to the page element permission. -
PermissionMappingId: integer
(int64)
The unique identifier of the page element permission mapping to the role group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- roleGroupPagePermissions
-
Parameters:
- AssignmentId:
$request.path.AssignmentId
The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group. - AssignmentId: