Guidelines
Guideline documents, pages, sections, and blocks — the structure behind a published brand portal.
guidelinePage
Retrieve a GuidelinePage by its id.
Beta
Returns
Arguments
- id:ID!RequiredBeta
- The id of the
GuidelinePageto retrieve. - locale:StringOptionalBeta
- The locale tag ("de", "de-DE") in which the GuidelinePage should be delivered. If the requested locale is unavailable, the default language will be used as a fallback.
- language:LanguageCodeOptionalBeta
- Specifies the language in which the GuidelinePage should be delivered. If the requested language is unavailable, the default language will be used as a fallback.
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- DateTime!
- GuidelinePageSectionItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageSection]
- ID!
- GuidelinePageSectionElementItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageSectionElement]
… on GuidelinePageHeading
- ID!
… on GuidelinePageBlock
- ID!
… on BrandEssentialsColorBlock
- ID!
… on GuidelinePageBlockReference
- ID!
- String!
- Url!
guidelinePageBlock
Retrieve a GuidelinePageBlock by its id.
Beta
Returns
Arguments
- id:ID!RequiredBeta
- The id of the
GuidelinePageBlockto retrieve. - locale:StringOptionalBeta
- The locale tag ("de", "de-DE") in which the GuidelinePageBlock should be delivered. If the requested locale is unavailable, the default language will be used as a fallback.
- language:LanguageCodeOptionalBeta
- Specifies the language in which the GuidelinePageBlock should be delivered. If the requested language is unavailable, the default language will be used as a fallback.
Response fields
1 selected
Toggle fields to tailor the query and response.
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- GuidelinePageBlockAssetItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAsset]!
- Url!
- String
- ID!
- DateTime!
- JsonObject
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
- Url!
changeDefaultColorScheme
Change the default color scheme of a guideline.
Beta
Returns
Arguments
- input:ChangeDefaultColorSchemeInput!RequiredBeta
ChangeDefaultColorSchemeInputTypeinput argument.- Required
colorSchemeId: ID!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineColorScheme!
- String!
- String!
- Boolean!
createColorScheme
Create a new Color Scheme.
Beta
Returns
Arguments
- input:CreateColorSchemeInput!RequiredBeta
CreateColorSchemeInputTypeinput argument.- Required
guidelineId: ID!,data: CreateColorSchemeDataInput!
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelineColorScheme!
- String!
- String!
- Boolean!
createGuidelineDocument
Beta
Returns
Arguments
- input:CreateGuidelineDocumentInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
createGuidelineDocumentGroup
Beta
Returns
Arguments
- input:CreateGuidelineDocumentGroupInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
createGuidelineDocumentLibrary
Beta
Returns
Arguments
- input:CreateGuidelineDocumentLibraryInput!RequiredBeta
- Required
parentId: ID!,title: String!,libraryId: ID! - Optional
heading: String,subheading: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- String!
- ID!
- String!
- String
createGuidelineDocumentLink
Beta
Returns
Arguments
- input:CreateGuidelineDocumentLinkInput!RequiredBeta
- Required
parentId: ID!,title: String!,url: String!,openNewTab: Boolean! - Optional
displayMode: GuidelineDocumentLinkDisplayMode,iconPosition: GuidelineDocumentLinkIconPosition,iconAssetId: ID,iconFileId: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- GuidelineDocumentLinkDisplayMode
- ID
- String
- GuidelineDocumentLinkIconPosition
- ID!
- Boolean!
- String!
- String!
createGuidelineDocumentPage
Beta
Returns
Arguments
- input:CreateGuidelineDocumentPageInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID
- ID!
- ID!
- String!
createGuidelineDocumentPageCategory
Beta
Returns
Arguments
- input:CreateGuidelineDocumentPageCategoryInput!RequiredBeta
- Required
parentId: ID!,title: String!
Response fields
1 selected
Toggle fields to tailor the query and response.
- ID!
- String
createGuidelineDocumentPageLink
Beta
Returns
Arguments
- input:CreateGuidelineDocumentPageLinkInput!RequiredBeta
- Required
parentId: ID!,title: String!,url: String! - Optional
openNewTab: Boolean,displayMode: GuidelineDocumentLinkDisplayMode,iconPosition: GuidelineDocumentLinkIconPosition,iconAssetId: ID,iconFileId: String
Response fields
1 selected
Toggle fields to tailor the query and response.
- GuidelineDocumentLinkDisplayMode
- ID
- String
- GuidelineDocumentLinkIconPosition
- ID!
- Boolean!
- String
- String
createGuidelinePageBlock
Creates a new GuidelinePageBlock. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:CreateGuidelinePageBlockInput!RequiredBeta
CreateGuidelinePageBlockinput argument.- Required
blockTypeId: ID!,settings: JsonObject!,sectionId: ID! - Optional
afterElementId: ID
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageBlock!
- ID!
- String
- DateTime!
- JsonObject
- Url!
- GuidelinePageBlockAssetSettingItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageBlockAssetSetting!]!
- String!
- GuidelinePageBlockType!
- String!
- ID!
- JsonObject
createGuidelinePageHeading
Creates a new GuidelinePageHeading. Requires basic:write scope to be accessible and Project permission level EDIT.
Beta
Returns
Arguments
- input:CreateGuidelinePageHeadingInput!RequiredBeta
CreateGuidelinePageHeadinginput argument.- Required
sectionId: ID! - Optional
title: String!,afterElementId: ID
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageHeading!
- String!
- ID!
- DateTime!
- Url!
createGuidelinePageSection
Creates a new GuidelinePageSection, either on top of a page or after a given section.
Beta
Returns
Arguments
- input:CreateGuidelinePageSectionInput!RequiredBeta
CreateGuidelinePageSectionInputinput argument.- Required
pageId: ID! - Optional
afterGuidelinePageSectionId: ID
Response fields
0 selected
Toggle fields to tailor the query and response.
- GuidelinePageSection!
- ID!
- GuidelinePageSectionElementItems
- Int!
- Int!
- Int!
- Boolean!
- [GuidelinePageSectionElement]
… on GuidelinePageHeading
- ID!
… on GuidelinePageBlock
- ID!
… on BrandEssentialsColorBlock
- ID!