Giao diện
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ểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về CmsArticle!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
slug | String! | |
locale | String! | |
status | CmsArticleStatus! | |
visibility | CmsVisibility! | |
publishAt | DateTime | |
publishedAt | DateTime | |
publishedBy | ID | |
unpublishedAt | DateTime | |
draft | CmsArticleVersion! | Newest saved version (the draft head). |
published | CmsArticleVersion | The version the public sees when visible; never a newer draft. |
hasUnpublishedChanges | Boolean! | |
versions | [CmsVersionSummary!]! | |
version | Int! | |
createdAt | DateTime! | |
updatedAt | DateTime! |
cmsArticles
Requires cms.manage (MK-01). Admin list incl. drafts; newest change first.
query · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
search | String | ||
status | CmsArticleStatus | ||
categoryId | ID | ||
page | Int | ||
pageSize | Int |
Trả về CmsArticlePage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [CmsArticle!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! | |
sourceStatus | SourceStatus! |
cmsBanner
Requires cms.manage (MK-01). GAP-API-CMS-OPS.
query · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về CmsBanner!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
status | CmsBannerStatus! | |
visibility | CmsVisibility! | |
draft | CmsBannerVersion! | |
published | CmsBannerVersion | |
hasUnpublishedChanges | Boolean! | |
versions | [CmsVersionSummary!]! | |
publishedAt | DateTime | |
publishedBy | ID | |
hiddenAt | DateTime | |
version | Int! | |
createdAt | DateTime! | |
updatedAt | DateTime! |
cmsBanners
Requires cms.manage (MK-01). GAP-API-CMS-OPS.
query · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
app | CmsBannerApp | ||
status | CmsBannerStatus | ||
page | Int | ||
pageSize | Int |
Trả về CmsBannerPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [CmsBanner!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! | |
sourceStatus | SourceStatus! |
cmsBannerScreens
Requires cms.manage (MK-01). Allowed SCREEN destinations, per app.
query · quyền: cms.manage
Không có tham số.
Trả về [CmsBannerScreen!]!
| Field | Kiểu | Mô tả |
|---|---|---|
app | CmsBannerApp! | |
screen | String! |
cmsCategories
Requires cms.manage (MK-01). Flat tree (parentId). GAP-API-CMS-OPS.
query · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
includeInactive | Boolean |
Trả về [CmsCategory!]!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
name | String! | |
slug | String! | |
description | String | |
parentId | ID | |
isActive | Boolean! | |
version | Int! | |
createdAt | DateTime! | |
updatedAt | DateTime! |
cmsKeywords
Requires cms.manage (MK-01). Live keywords with usage. GAP-API-CMS-OPS.
query · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
search | String | ||
page | Int | ||
pageSize | Int |
Trả về CmsKeywordPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [CmsKeyword!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! | |
sourceStatus | SourceStatus! |
cmsPage
Requires cms.manage (MK-01).
query · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về CmsPageContent!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
slug | String! | |
locale | String! | |
status | CmsArticleStatus! | |
visibility | CmsVisibility! | |
publishAt | DateTime | |
publishedAt | DateTime | |
publishedBy | ID | |
unpublishedAt | DateTime | |
draft | CmsPageContentVersion! | Newest saved version (the draft head). |
published | CmsPageContentVersion | The version the public sees when visible; never a newer draft. |
hasUnpublishedChanges | Boolean! | |
versions | [CmsVersionSummary!]! | |
version | Int! | |
createdAt | DateTime! | |
updatedAt | DateTime! |
cmsPages
Requires cms.manage (MK-01). Admin list of content pages incl. drafts; newest change first.
query · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
search | String | ||
status | CmsArticleStatus | ||
page | Int | ||
pageSize | Int |
Trả về CmsPageContentPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [CmsPageContent!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! | |
sourceStatus | SourceStatus! |
cmsSeoPolicy
Requires cms.manage (MK-01).
query · quyền: cms.manage
Không có tham số.
Trả về CmsSeoPolicy!
| Field | Kiểu | Mô tả |
|---|---|---|
canonicalHosts | [String!]! | Hosts a canonical URL may use (https only; subdomains match). |
publicSiteHost | String |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | DeleteCmsArticleInput! |
Trả về CmsContentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
contentType | CmsContentType! | |
article | CmsArticle | Null after deleteCmsArticle. |
banner | CmsBanner | |
page | CmsPageContent | |
sanitized | Boolean! | 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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | DeleteCmsKeywordInput! |
Trả về CmsKeywordResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
keyword | CmsKeyword! |
publishContent
Requires cms.publish (MK-02). Make the newest version public (article: now or scheduled).
mutation · quyền: cms.publish
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | PublishContentInput! |
Trả về CmsContentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
contentType | CmsContentType! | |
article | CmsArticle | Null after deleteCmsArticle. |
banner | CmsBanner | |
page | CmsPageContent | |
sanitized | Boolean! | 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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | RemoveContentInput! |
Trả về CmsContentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
contentType | CmsContentType! | |
article | CmsArticle | Null after deleteCmsArticle. |
banner | CmsBanner | |
page | CmsPageContent | |
sanitized | Boolean! | 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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | RenameCmsKeywordInput! |
Trả về CmsKeywordResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
keyword | CmsKeyword! |
saveCmsCategory
Requires cms.manage (MK-01). GAP-API-CMS-OPS.
mutation · quyền: cms.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | SaveCmsCategoryInput! |
Trả về CmsCategoryResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
category | CmsCategory! |
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ểu | Mặc định | Mô tả |
|---|---|---|---|
input | SaveCmsDraftInput! |
Trả về CmsContentResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
contentType | CmsContentType! | |
article | CmsArticle | Null after deleteCmsArticle. |
banner | CmsBanner | |
page | CmsPageContent | |
sanitized | Boolean! | True when the server removed disallowed content from the submitted body. |