Public Web API: Model of page’s metadata description instance (Get the metadata description of a page by ID)

Methods

GET — Get the metadata description of a page by ID

Resource

{
    "error": "string",
    "page": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__id": "uuid",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "code": "string",
        "hidden": "boolean",
        "icon": "string",
        "name": "string",
        "namespace": "string",
        "permissions": {
            "inheritParent": "boolean",
            "values": [
                {
                    "group": {
                        "id": "uuid",
                        "type": "string"
                    },
                    "inherited": "boolean",
                    "types": [
                        "string"
                    ]
                }
            ]
        },
        "sort": "int64",
        "type": "string"
    },
    "success": "boolean"
}

Properties

Name	Type	Description	Additional
error	string	Error message if `success == false`	Optional
page	object	Full metadata description of a page	Optional
page.__createdAt	date-time	Date created	Optional
page.__createdBy	uuid	Created by	Optional
page.__deletedAt	date-time	Deleted	Optional
page.__id	uuid	Identifier	Optional
page.__updatedAt	date-time	Editing date	Optional
page.__updatedBy	uuid	Edited by	Optional
page.code	string	Code	Optional
page.hidden	boolean	Visibility flag	Optional
page.icon	string	Icon	Optional
page.name	string	Name	Optional
page.namespace	string	Namespace.	Optional
page.permissions	object	List of access permissions	Optional
page.permissions.inheritParent	boolean		Optional
page.permissions.values[]	array		Optional
page.permissions.values[].group	object	User, group, or org chart item	Optional
page.permissions.values[].group.id	uuid		Optional
page.permissions.values[].group.type	string	Possible values are: `user` `group` `orgstruct` `role`	Optional
page.permissions.values[].inherited	boolean		Optional
page.permissions.values[].types[]	array of string		Optional
page.sort	int64	Sort	Optional
page.type	string	Type Possible values are: `PAGE` `NAMESPACE` `LINK` `APPLICATION` `SEPARATOR` `PORTAL_PAGE` `CONTRACT` `REPORT`	Optional
success	boolean	Successful request flag	Optional