Jump to

• Request
• Response

Update a role group page assignment

patch

/fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "PageCode",
        "PageId",
        "RoleGroupCode",
        "RoleGroupId"
    ],
    "type":"object",
    "properties":{
        "PageId":{
            "type":"integer",
            "description":"The unique identifier of the page.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RoleGroupId":{
            "type":"integer",
            "description":"The unique identifier of the role group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a page to role group assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PageCode":{
            "maxLength":100,
            "type":"string",
            "description":"The alternate identifier of the page.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "roleGroupPagePermissions":{
            "title":"Page Permissions to Role Group Assignments",
            "type":"array",
            "description":"The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.",
            "items":{
                "$ref":"#/components/schemas/hedPageRoleGroupAssignments-roleGroupPagePermissions-item-patch-request"
            }
        },
        "RoleGroupCode":{
            "maxLength":50,
            "type":"string",
            "description":"The alternate identifier of the role group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Page Permissions to Role Group Assignments",
    "type":"array",
    "description":"The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.",
    "items":{
        "$ref":"#/components/schemas/hedPageRoleGroupAssignments-roleGroupPagePermissions-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PagePermissionId":{
            "type":"integer",
            "description":"The unique identifier of the page element permission.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PermissionMappingId":{
            "type":"integer",
            "description":"The unique identifier of the page element permission mapping to the role group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : hedPageRoleGroupAssignments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the page to role group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageId":{
            "type":"integer",
            "description":"The unique identifier of the page.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleGroupId":{
            "type":"integer",
            "description":"The unique identifier of the role group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the page to role group assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the page to role group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleGroupName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the role group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleGroupCode":{
            "maxLength":50,
            "type":"string",
            "description":"The alternate identifier of the role group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PageCode":{
            "maxLength":100,
            "type":"string",
            "description":"The alternate identifier of the page.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a page to role group assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "roleGroupPagePermissions":{
            "title":"Page Permissions to Role Group Assignments",
            "type":"array",
            "description":"The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.",
            "items":{
                "$ref":"#/components/schemas/hedPageRoleGroupAssignments-roleGroupPagePermissions-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the page to role group assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object hedPageRoleGroupAssignments-roleGroupPagePermissions-item-response

{
    "title":"Page Permissions to Role Group Assignments",
    "type":"array",
    "description":"The page permissions to role group assignments resource is used to define the assignment of page permissions to a role group.",
    "items":{
        "$ref":"#/components/schemas/hedPageRoleGroupAssignments-roleGroupPagePermissions-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedPageRoleGroupAssignments-roleGroupPagePermissions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the page permission to role group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the page permission to role group assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the page permission to role group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermissionMappingId":{
            "type":"integer",
            "description":"The unique identifier of the page element permission mapping to the role group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PagePermissionId":{
            "type":"integer",
            "description":"The unique identifier of the page element permission.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PagePermissionCode":{
            "maxLength":50,
            "type":"string",
            "description":"The alternate identifier of the page element permission.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PagePermissionName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the action assigned to the page element permission.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PageElementCode":{
            "maxLength":100,
            "type":"string",
            "description":"The alternate identifier of the page element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the page permission to role group assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

roleGroupPagePermissions

Operation: /fscmRestApi/resources/11.13.18.05/hedPageRoleGroupAssignments/{AssignmentId}/child/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.

Back to Top