Jump to

• Request
• Response

Get a page element

get

/fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}

Request

Path Parameters

• PageElementId(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=
• PageId(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: string
  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: string
  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:
  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 : hedPages-pageElements-item-response

Type: object

Show Source

• associatedBusinessObjects: array Associated Business Objects
  Title: Associated Business Objects

  The associated business objects resource is used to view all the business objects associated with the page element.
• ElementCode: string
  Title: Element Code

  Read Only: true

  Maximum Length: 100

  Alternate unique identifier of the element on the application page.
• ElementDescription: string
  Title: Element Description

  Read Only: true

  Maximum Length: 1000

  Description of the element on the application page.
• ElementName: string
  Title: Element Name

  Read Only: true

  Maximum Length: 100

  Name of the element on the application page.
• ElementType: string
  Title: Element Type

  Read Only: true

  Maximum Length: 30

  Type of the element on the application page.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageElementId: integer (int64)
  Title: Page Element ID

  Read Only: true

  Unique identifier of the element on the application page.
• ParentElementCode: string
  Title: Parent Element Code

  Read Only: true

  Maximum Length: 100

  The element code of the parent element.
• permissions: array Application Page Element Permissions
  Title: Application Page Element Permissions

  The application page element permissions resource is used to view all the page element permissions.
• RequireParentUpdateFlag: boolean
  Title: Require Parent Update

  Read Only: true

  Maximum Length: 1

  Indicates whether granting a create, update, delete, or custom action permission for this page element needs an update to action permissions granted to the parent page element.

{
    "type":"object",
    "properties":{
        "ElementCode":{
            "title":"Element Code",
            "maxLength":100,
            "type":"string",
            "description":"Alternate unique identifier of the element on the application page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementDescription":{
            "title":"Element Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the element on the application page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementName":{
            "title":"Element Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the element on the application page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementType":{
            "title":"Element Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of the element on the application page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageElementId":{
            "title":"Page Element ID",
            "type":"integer",
            "description":"Unique identifier of the element on the application page.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParentElementCode":{
            "title":"Parent Element Code",
            "maxLength":100,
            "type":"string",
            "description":"The element code of the parent element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequireParentUpdateFlag":{
            "title":"Require Parent Update",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether granting a create, update, delete, or custom action permission for this page element needs an update to action permissions granted to the parent page element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "associatedBusinessObjects":{
            "title":"Associated Business Objects",
            "type":"array",
            "description":"The associated business objects resource is used to view all the business objects associated with the page element.",
            "items":{
                "$ref":"#/components/schemas/hedPages-pageElements-associatedBusinessObjects-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "permissions":{
            "title":"Application Page Element Permissions",
            "type":"array",
            "description":"The application page element permissions resource is used to view all the page element permissions.",
            "items":{
                "$ref":"#/components/schemas/hedPages-pageElements-permissions-item-response"
            }
        }
    }
}

Nested Schema : Associated Business Objects

Type: array

Title: Associated Business Objects

The associated business objects resource is used to view all the business objects associated with the page element.

Show Source

• Array of: object hedPages-pageElements-associatedBusinessObjects-item-response

{
    "title":"Associated Business Objects",
    "type":"array",
    "description":"The associated business objects resource is used to view all the business objects associated with the page element.",
    "items":{
        "$ref":"#/components/schemas/hedPages-pageElements-associatedBusinessObjects-item-response"
    }
}

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 : Application Page Element Permissions

Type: array

Title: Application Page Element Permissions

The application page element permissions resource is used to view all the page element permissions.

Show Source

• Array of: object hedPages-pageElements-permissions-item-response

{
    "title":"Application Page Element Permissions",
    "type":"array",
    "description":"The application page element permissions resource is used to view all the page element permissions.",
    "items":{
        "$ref":"#/components/schemas/hedPages-pageElements-permissions-item-response"
    }
}

Nested Schema : hedPages-pageElements-associatedBusinessObjects-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 2000

  The description of the business object associated with the page element.
• DisplayName: string
  Title: Business Object

  Read Only: true

  Maximum Length: 240

  The name of the business object associated with the page element.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingId: integer (int64)
  Read Only: true

  Unique identifier for the association of a business object to the page element.
• ObjectId: integer (int64)
  Read Only: true

  Unique identifier of a business object associated to the page element.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the business object associated with the page element.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Business Object",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business object associated with the page element.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MappingId":{
            "type":"integer",
            "description":"Unique identifier for the association of a business object to the page element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Unique identifier of a business object associated to the page element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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 : hedPages-pageElements-permissions-item-response

Type: object

Show Source

• ActionCode: string
  Title: Action Code

  Read Only: true

  Maximum Length: 50

  The code of the action permission granted to a page element.
• ActionDescription: string
  Title: Action Description

  Read Only: true

  Maximum Length: 1000

  The description of the action permission granted to a page element.
• ActionName: string
  Title: Action Name

  Read Only: true

  Maximum Length: 50

  The name of the action permission granted to a page element.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PermissionId: integer (int64)
  Title: Permission ID

  Read Only: true

  Unique identifier of the action permission granted to a page element.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "title":"Action Code",
            "maxLength":50,
            "type":"string",
            "description":"The code of the action permission granted to a page element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDescription":{
            "title":"Action Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action permission granted to a page element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionName":{
            "title":"Action Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the action permission granted to a page element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermissionId":{
            "title":"Permission ID",
            "type":"integer",
            "description":"Unique identifier of the action permission granted to a page element.",
            "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"
            }
        }
    }
}

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

associatedBusinessObjects

Operation: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}/child/associatedBusinessObjects

Parameters:

• PageElementId: $request.path.PageElementId
• PageId: $request.path.PageId

The associated business objects resource is used to view all the business objects associated with the page element.

permissions

Operation: /fscmRestApi/resources/11.13.18.05/hedPages/{PageId}/child/pageElements/{PageElementId}/child/permissions

Parameters:

• PageElementId: $request.path.PageElementId
• PageId: $request.path.PageId

The application page element permissions resource is used to view all the page element permissions.

Back to Top