Skip to content

API · cms ​

Trang sinh tự động

Parse từ schema.graphql (SDL backend export) bằng parser graphql. Mô tả và quyền lấy nguyên văn từ description trong SDL.

10 query · 7 mutation.

Query ​

cmsArticle ​

Requires cms.manage (MK-01). Deleted articles are not_found.

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
idID!

Trả về CmsArticle!

FieldKiểuMô tả
idID!
slugString!
localeString!
statusCmsArticleStatus!
visibilityCmsVisibility!
publishAtDateTime
publishedAtDateTime
publishedByID
unpublishedAtDateTime
draftCmsArticleVersion!Newest saved version (the draft head).
publishedCmsArticleVersionThe version the public sees when visible; never a newer draft.
hasUnpublishedChangesBoolean!
versions[CmsVersionSummary!]!
versionInt!
createdAtDateTime!
updatedAtDateTime!

cmsArticles ​

Requires cms.manage (MK-01). Admin list incl. drafts; newest change first.

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
searchString
statusCmsArticleStatus
categoryIdID
pageInt
pageSizeInt

Trả về CmsArticlePage!

FieldKiểuMô tả
items[CmsArticle!]!
pageInt!
pageSizeInt!
totalInt!
sourceStatusSourceStatus!

cmsBanner ​

Requires cms.manage (MK-01). GAP-API-CMS-OPS.

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
idID!

Trả về CmsBanner!

FieldKiểuMô tả
idID!
statusCmsBannerStatus!
visibilityCmsVisibility!
draftCmsBannerVersion!
publishedCmsBannerVersion
hasUnpublishedChangesBoolean!
versions[CmsVersionSummary!]!
publishedAtDateTime
publishedByID
hiddenAtDateTime
versionInt!
createdAtDateTime!
updatedAtDateTime!

cmsBanners ​

Requires cms.manage (MK-01). GAP-API-CMS-OPS.

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
appCmsBannerApp
statusCmsBannerStatus
pageInt
pageSizeInt

Trả về CmsBannerPage!

FieldKiểuMô tả
items[CmsBanner!]!
pageInt!
pageSizeInt!
totalInt!
sourceStatusSourceStatus!

cmsBannerScreens ​

Requires cms.manage (MK-01). Allowed SCREEN destinations, per app.

query · quyền: cms.manage

Không có tham số.

Trả về [CmsBannerScreen!]!

FieldKiểuMô tả
appCmsBannerApp!
screenString!

cmsCategories ​

Requires cms.manage (MK-01). Flat tree (parentId). GAP-API-CMS-OPS.

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
includeInactiveBoolean

Trả về [CmsCategory!]!

FieldKiểuMô tả
idID!
nameString!
slugString!
descriptionString
parentIdID
isActiveBoolean!
versionInt!
createdAtDateTime!
updatedAtDateTime!

cmsKeywords ​

Requires cms.manage (MK-01). Live keywords with usage. GAP-API-CMS-OPS.

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
searchString
pageInt
pageSizeInt

Trả về CmsKeywordPage!

FieldKiểuMô tả
items[CmsKeyword!]!
pageInt!
pageSizeInt!
totalInt!
sourceStatusSourceStatus!

cmsPage ​

Requires cms.manage (MK-01).

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
idID!

Trả về CmsPageContent!

FieldKiểuMô tả
idID!
slugString!
localeString!
statusCmsArticleStatus!
visibilityCmsVisibility!
publishAtDateTime
publishedAtDateTime
publishedByID
unpublishedAtDateTime
draftCmsPageContentVersion!Newest saved version (the draft head).
publishedCmsPageContentVersionThe version the public sees when visible; never a newer draft.
hasUnpublishedChangesBoolean!
versions[CmsVersionSummary!]!
versionInt!
createdAtDateTime!
updatedAtDateTime!

cmsPages ​

Requires cms.manage (MK-01). Admin list of content pages incl. drafts; newest change first.

query · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
searchString
statusCmsArticleStatus
pageInt
pageSizeInt

Trả về CmsPageContentPage!

FieldKiểuMô tả
items[CmsPageContent!]!
pageInt!
pageSizeInt!
totalInt!
sourceStatusSourceStatus!

cmsSeoPolicy ​

Requires cms.manage (MK-01).

query · quyền: cms.manage

Không có tham số.

Trả về CmsSeoPolicy!

FieldKiểuMô tả
canonicalHosts[String!]!Hosts a canonical URL may use (https only; subdomains match).
publicSiteHostString

Mutation ​

deleteCmsArticle ​

Requires cms.manage (MK-01). Soft delete of a non-published article. GAP-API-CMS-OPS.

mutation · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
inputDeleteCmsArticleInput!

Trả về CmsContentResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
contentTypeCmsContentType!
articleCmsArticleNull after deleteCmsArticle.
bannerCmsBanner
pageCmsPageContent
sanitizedBoolean!True when the server removed disallowed content from the submitted body.

deleteCmsKeyword ​

Requires cms.manage (MK-01). Only when unused. GAP-API-CMS-OPS.

mutation · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
inputDeleteCmsKeywordInput!

Trả về CmsKeywordResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
keywordCmsKeyword!

publishContent ​

Requires cms.publish (MK-02). Make the newest version public (article: now or scheduled).

mutation · quyền: cms.publish

Tham sốKiểuMặc địnhMô tả
inputPublishContentInput!

Trả về CmsContentResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
contentTypeCmsContentType!
articleCmsArticleNull after deleteCmsArticle.
bannerCmsBanner
pageCmsPageContent
sanitizedBoolean!True when the server removed disallowed content from the submitted body.

removeContent ​

Requires cms.publish (MK-02). Article -> UNPUBLISHED, banner -> HIDDEN; history kept.

mutation · quyền: cms.publish

Tham sốKiểuMặc địnhMô tả
inputRemoveContentInput!

Trả về CmsContentResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
contentTypeCmsContentType!
articleCmsArticleNull after deleteCmsArticle.
bannerCmsBanner
pageCmsPageContent
sanitizedBoolean!True when the server removed disallowed content from the submitted body.

renameCmsKeyword ​

Requires cms.manage (MK-01). GAP-API-CMS-OPS.

mutation · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
inputRenameCmsKeywordInput!

Trả về CmsKeywordResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
keywordCmsKeyword!

saveCmsCategory ​

Requires cms.manage (MK-01). GAP-API-CMS-OPS.

mutation · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
inputSaveCmsCategoryInput!

Trả về CmsCategoryResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
categoryCmsCategory!

saveCmsDraft ​

Requires cms.manage (MK-01). Create a draft or append a new version; the published version never changes.

mutation · quyền: cms.manage

Tham sốKiểuMặc địnhMô tả
inputSaveCmsDraftInput!

Trả về CmsContentResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
contentTypeCmsContentType!
articleCmsArticleNull after deleteCmsArticle.
bannerCmsBanner
pageCmsPageContent
sanitizedBoolean!True when the server removed disallowed content from the submitted body.

Sinh từ ad83b0aea · 820 migration · PostgreSQL 17