--- title: "Get a Page Template" method: GET path: "/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}" tags: ["Publisher Documents"] --- # Get a Page Template `GET /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}` ## Request - Base URL: `https://www.gooddata.ai` - URL: `https://www.gooddata.ai/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}` - Auth: none declared ## Path parameters - `workspaceId` string, required - `objectId` string, required ## Query parameters - `filter` string - `include` string[] - `metaInclude` string[]: Included meta objects ## Headers - `X-GDC-VALIDATE-RELATIONS` boolean ## Response `200` Request successfully processed - JsonApiPublisherDocumentPageTemplateOutDocument - `data` JsonApiPublisherDocumentPageTemplateOut, required: JSON:API representation of pageTemplate entity. - `attributes` object, required - `areRelationsValid` boolean - `content` object, required: One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters. - `filters` PublisherDocumentFilter[]: Page filters; stored, not applied. - union: A filter in the dashboard filter grammar, wrapped in an object keyed by its kind. - object: Filters an attribute display form by a list of elements. - … - object: Filters an attribute display form by arbitrary values. - … - object: Filters an attribute display form by a text pattern. - … - object: Filters a date dataset. A document filter always names its `dataSet`. - … - object: Filters by the value of a measure. - … - `kind` 'cover' | 'section' | 'content': Editor hint. - `layout` union, required: A layout node: a row or column container, or a widget. The shape is selected by `type`. - object: Lays its children out left to right. - `children` PublisherDocumentLayoutNode[], required: Child nodes from left to right, in reading order; an empty list is a spacer. - `id` string - `locked` boolean: Locks the container in the document editor; never checked on write. - `proportion` number, double: Share of the parent's main axis, greater than 0. Default 1. - `style` PublisherDocumentContainerStyle: Style of a row or column; its content inherits the text keys. Lengths are in canvas px. - … - `type` 'row', required - object: Lays its children out top to bottom. - `children` PublisherDocumentLayoutNode[], required: Child nodes from top to bottom, in reading order; an empty list is a spacer. - `id` string - `locked` boolean: Locks the container in the document editor; never checked on write. - `proportion` number, double: Share of the parent's main axis, greater than 0. Default 1. - `style` PublisherDocumentContainerStyle: Style of a row or column; its content inherits the text keys. Lengths are in canvas px. - … - `type` 'column', required - object: The page's title, at most one per page. - `id` string, required: Unique within the page. - `locked` boolean: Locks the widget in the document editor; never checked on write. - `markdown` string: Inline markdown. - `placeholder` PublisherDocumentWidgetPlaceholder: What the editor shows in an empty widget. - … - `proportion` number, double - `style` PublisherDocumentTextWidgetStyle: Style of a title, heading, text or takeaway widget. Lengths are in canvas px. - … - `type` 'title', required - object: A heading below the page title. - `id` string, required: Unique within the page. - `level` 1 | 2 | 3 | 4 | 5 | 6: Outline level below the page title. Default 1. - `locked` boolean: Locks the widget in the document editor; never checked on write. - `markdown` string: Inline markdown. - `placeholder` PublisherDocumentWidgetPlaceholder: What the editor shows in an empty widget. - … - `proportion` number, double - `style` PublisherDocumentTextWidgetStyle: Style of a title, heading, text or takeaway widget. Lengths are in canvas px. - … - `type` 'heading', required - object: A block of markdown text. - `decorative` boolean: Left out of the accessibility tree, PDF tags and the AI context. - `id` string, required: Unique within the page. - `locked` boolean: Locks the widget in the document editor; never checked on write. - `markdown` string: Full markdown. - `placeholder` PublisherDocumentWidgetPlaceholder: What the editor shows in an empty widget. - … - `proportion` number, double - `style` PublisherDocumentTextWidgetStyle: Style of a title, heading, text or takeaway widget. Lengths are in canvas px. - … - `type` 'text', required - object: An image from the theme or an https URL. - `altText` string - `decorative` boolean: Left out of the accessibility tree, PDF tags and the AI context; needs no alt text. - `id` string, required: Unique within the page. - `locked` boolean: Locks the widget in the document editor; never checked on write. - `placeholder` PublisherDocumentWidgetPlaceholder: What the editor shows in an empty widget. - … - `proportion` number, double - `source` string: A theme image reference such as `{theme.logo}`, or an `https://` URL. - `style` PublisherDocumentImageWidgetStyle: Style of an image widget. Lengths are in canvas px. - … - `type` 'image', required - object: A saved visualization. - `altText` string: Defaults to the visualization's description. - `dateDataSet` PublisherDocumentDataSetRef: A date dataset. - … - `display` PublisherDocumentVisualizationDisplay: Overrides of the saved visualization's own configuration; stored, not applied. - … - `filters` PublisherDocumentFilter[]: Widget filters; stored, not applied. - … - `id` string, required: Unique within the page. - `ignoreDocumentFilters` PublisherDocumentFilterReference[]: Document filters this widget ignores. - … - `ignoreDocumentPeriod` boolean - `locked` boolean: Locks the widget in the document editor; never checked on write. - `placeholder` PublisherDocumentWidgetPlaceholder: What the editor shows in an empty widget. - … - `proportion` number, double - `style` PublisherDocumentVisualizationStyle: Style of a visualization widget. Lengths are in canvas px. - … - `title` PublisherDocumentWidgetTitle: Title of a visualization or takeaway widget. - … - `type` 'visualization', required - `visualization` PublisherDocumentVisualizationRef: A saved visualization. - … - object: A generated takeaway, stored as markdown. - `generation` PublisherDocumentTakeawayGeneration: How the copilot writes a takeaway. - … - `id` string, required: Unique within the page. - `locked` boolean: Locks the widget in the document editor; never checked on write. - `markdown` string: The generated text. - `placeholder` PublisherDocumentWidgetPlaceholder: What the editor shows in an empty widget. - … - `proportion` number, double - `style` PublisherDocumentTextWidgetStyle: Style of a title, heading, text or takeaway widget. Lengths are in canvas px. - … - `title` PublisherDocumentWidgetTitle: Title of a visualization or takeaway widget. - … - `type` 'takeaway', required - `notes` string: Speaker notes in markdown, never drawn. - `pageSize` 'widescreen' - `style` PublisherDocumentPageStyle: Style of a page; containers inherit its gap and text keys. Lengths are in canvas px. - `backgroundColor` string - `backgroundFit` 'cover' | 'contain' | 'fill' | 'tile' - `backgroundHorizontalAlign` 'left' | 'center' | 'right' - `backgroundImage` string - `backgroundImageOpacity` number, double - `backgroundOffset` number, double - `backgroundOffsetBottom` number, double - `backgroundOffsetLeft` number, double - `backgroundOffsetRight` number, double - `backgroundOffsetTop` number, double - `backgroundOpacity` number, double - `backgroundVerticalAlign` 'top' | 'center' | 'bottom' - `fontSize` number, double - `fontStyle` 'normal' | 'italic' - `fontWeight` number, double - `gap` union: A length, or `{theme.spacing.gap.}`. - number, double - string - `horizontalAlign` 'left' | 'center' | 'right' | 'justify' - `letterSpacing` number, double - `lineHeight` number, double - `padding` union: A length, or `{theme.spacing.padding.}`. - number, double - string - `paddingBottom` union: A length, or `{theme.spacing.padding.}`. - number, double - string - `paddingLeft` union: A length, or `{theme.spacing.padding.}`. - number, double - string - `paddingRight` union: A length, or `{theme.spacing.padding.}`. - number, double - string - `paddingTop` union: A length, or `{theme.spacing.padding.}`. - number, double - string - `textColor` string - `textOverflow` 'shrink' | 'clip' | 'ellipsis' - `textStyle` 'title' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'largeText' | 'normalText' | 'smallText' - `textTransform` 'none' | 'uppercase' | 'lowercase' | 'capitalize' - `verticalAlign` 'top' | 'center' | 'bottom' - `createdAt` string, date-time, nullable: Time of the entity creation. - `description` string - `isDefault` boolean, required: Whether the backend ships this page template as a read-only default. - `modifiedAt` string, date-time, nullable: Time of the last entity modification. - `tags` string[] - `title` string, required - `version` string, required: Version of the content format. - `id` string, required: API identifier of an object - `meta` object - `origin` object - `originId` string, required: defines id of the workspace where the entity comes from - `originType` 'NATIVE' | 'PARENT', required: defines type of the origin of the entity - `relationships` object - `createdBy` object - `data` JsonApiUserIdentifierToOneLinkage, required: The \"type\" and \"id\" to non-empty members. - `id` string, required - `type` 'userIdentifier', required - `modifiedBy` object - `data` JsonApiUserIdentifierToOneLinkage, required: The \"type\" and \"id\" to non-empty members. - `id` string, required - `type` 'userIdentifier', required - `type` 'pageTemplate', required: Object type - `included` JsonApiUserIdentifierOutWithLinks[]: Included resources - `attributes` object - `email` string - `firstname` string - `lastname` string - `id` string, required: API identifier of an object - `type` 'userIdentifier', required: Object type - `links` ObjectLinks - `self` string, uri, required: A string containing the link's URL. - `links` ObjectLinks - `self` string, uri, required: A string containing the link's URL. - `meta` object - `restricted` RestrictedObject[]: References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request. - `id` string, required: Object identifier, unique within one workspace hierarchy. - `type` 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'computedAttribute' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'visualizationObject', required: JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`. --- [API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)