Jump to

• Request
• Response

Get a role page assignment

get

/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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : hedPageRoleAssignments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the page role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageId":{
            "title":"Page ID",
            "type":"integer",
            "description":"Identifier of the application page.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the page role assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the security role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the page role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "rolePagePermissions":{
            "title":"Page Permission Assignment to Role",
            "type":"array",
            "description":"The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page.",
            "items":{
                "$ref":"#/components/schemas/hedPageRoleAssignments-rolePagePermissions-item-response"
            }
        },
        "SeedDataLock":{
            "title":"Seed Data Lock",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Page Role Assignment ID",
            "type":"integer",
            "description":"Identifier of the assignment of page permissions to the security role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":128,
            "type":"string",
            "description":"The alternate identifier for the security role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the page role 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 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

• Array of: object hedPageRoleAssignments-rolePagePermissions-item-response

{
    "title":"Page Permission Assignment to Role",
    "type":"array",
    "description":"The role page permission resource is used to view, create, modify or delete permissions associated with role for a application page.",
    "items":{
        "$ref":"#/components/schemas/hedPageRoleAssignments-rolePagePermissions-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 : hedPageRoleAssignments-rolePagePermissions-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the role page permission.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the role page permission was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermissionMappingId":{
            "title":"Permission Mapping ID",
            "type":"integer",
            "description":"Identifier number of mapping the page element to the security role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the role page permission.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PagePermissionId":{
            "title":"Page Permission ID",
            "type":"integer",
            "description":"Identification number of application page permission set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PagePermissionCode":{
            "title":"Page Permission Code",
            "maxLength":50,
            "type":"string",
            "description":"The alternate identifiers for the permission sets.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "title":"Seed Data Lock",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "PagePermissionName":{
            "title":"Page Permission Name",
            "maxLength":50,
            "type":"string",
            "description":"Names of the security permission set.",
            "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":{
            "title":"Page Element Code",
            "maxLength":100,
            "type":"string",
            "description":"Unique identifier of the element on the application page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the role page permission 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

pagesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedPages

The list of values for the application pages.

roleCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedSecurityRoles

Parameters:

• finder: NonDataCustomRoleFinder

The list of values for the security roles.

rolePagePermissions

Operation: /fscmRestApi/resources/11.13.18.05/hedPageRoleAssignments/{AssignmentId}/child/rolePagePermissions

Parameters:

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

Back to Top