OpenAPI3.0.2
API version3.0.0
BCMS
This is OpenAPI documentation for the BCMS REST API. If JavaScript code base is used to communicate with the BCMS API, it is recommended to use provided tools like @becomes/cms-client, but if custom implementation is required, this documentation will describe all REST routes.
Select a server to which requests will be sent.
In development mode, any string can be used as OTP code. In production, OTP code is not accessible because of predefined allowed callback URLs for specified instance. If in production, access and refresh tokens must be obtained directly from the BCMS UI after successful login.
{
otp: string
}
Response
{
accessToken: string
refreshToken: string
}
It is important to know that user ID and refresh token must be paired, which means that specified refresh token belongs to specified user.
Path parameters
User ID
Response
{
accessToken: string
}
After calling this method, specified refresh token will be invalidated (deleted) for specified user.
Path parameters
User ID
Response
{
ok: boolean
}
Which user will be returned is determent using access token.
Response
{
item: {
( BCMSProtectedUser )
_id: string
createdAt: number
updateAt?: number
username: string
email: string
roles: [
( JWTRole )
{
name: string [ADMIN | USER]
permissions: [
( JWTPermission )
{
name: string [READ | WRITE | DELETE | EXECUTE]
}
]
}
]
customPool: {
( BCMSUserCustomPool )
personal: {
( BCMSUserPersonal )
firstName: string
lastName: string
avatarUri: string
}
address: {
( BCMSUserAddress )
country?: string
city?: string
state?: string
zip?: string
street?: {
name?: string
number?: string
}
}
policy: {
( BCMSUserPolicy )
media: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
templates: [
allOf ((
{
_id: string
} and ( BCMSUserPolicyCRUD )
))
]
plugins?: [
allOf ((
{
name: string
} and ( BCMSUserPolicyCRUD )
))
]
}
}
}
}
Only user with an ADMIN role is able to call this endpoint.
{
( BCMSUserUpdateData )
_id: string
customPool?: {
policy?: {
media?: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
( BCMSUserPolicyCRUD )
templates?: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
webhooks?: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
plugins?: [
allOf ((
( BCMSUserPolicyCRUD ) and {
name: string
}
))
]
}
}
}
Response
{
item: {
( BCMSProtectedUser )
_id: string
createdAt: number
updateAt?: number
username: string
email: string
roles: [
( JWTRole )
{
name: string [ADMIN | USER]
permissions: [
( JWTPermission )
{
name: string [READ | WRITE | DELETE | EXECUTE]
}
]
}
]
customPool: {
( BCMSUserCustomPool )
personal: {
( BCMSUserPersonal )
firstName: string
lastName: string
avatarUri: string
}
address: {
( BCMSUserAddress )
country?: string
city?: string
state?: string
zip?: string
street?: {
name?: string
number?: string
}
}
policy: {
( BCMSUserPolicy )
media: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
templates: [
allOf ((
{
_id: string
} and ( BCMSUserPolicyCRUD )
))
]
plugins?: [
allOf ((
{
name: string
} and ( BCMSUserPolicyCRUD )
))
]
}
}
}
}
Response
{
items: [
( BCMSProtectedUser )
{
_id: string
createdAt: number
updateAt?: number
username: string
email: string
roles: [
( JWTRole )
{
name: string [ADMIN | USER]
permissions: [
( JWTPermission )
{
name: string [READ | WRITE | DELETE | EXECUTE]
}
]
}
]
customPool: {
( BCMSUserCustomPool )
personal: {
( BCMSUserPersonal )
firstName: string
lastName: string
avatarUri: string
}
address: {
( BCMSUserAddress )
country?: string
city?: string
state?: string
zip?: string
street?: {
name?: string
number?: string
}
}
policy: {
( BCMSUserPolicy )
media: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
templates: [
allOf ((
{
_id: string
} and ( BCMSUserPolicyCRUD )
))
]
plugins?: [
allOf ((
{
name: string
} and ( BCMSUserPolicyCRUD )
))
]
}
}
}
]
}
Path parameters
User ID
Response
{
item: {
( BCMSProtectedUser )
_id: string
createdAt: number
updateAt?: number
username: string
email: string
roles: [
( JWTRole )
{
name: string [ADMIN | USER]
permissions: [
( JWTPermission )
{
name: string [READ | WRITE | DELETE | EXECUTE]
}
]
}
]
customPool: {
( BCMSUserCustomPool )
personal: {
( BCMSUserPersonal )
firstName: string
lastName: string
avatarUri: string
}
address: {
( BCMSUserAddress )
country?: string
city?: string
state?: string
zip?: string
street?: {
name?: string
number?: string
}
}
policy: {
( BCMSUserPolicy )
media: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
templates: [
allOf ((
{
_id: string
} and ( BCMSUserPolicyCRUD )
))
]
plugins?: [
allOf ((
{
name: string
} and ( BCMSUserPolicyCRUD )
))
]
}
}
}
}
Response
{
count: number
}
{
label: string
desc: string
singleEntry: boolean
}
Response
{
item: {
( BCMSTemplate )
_id: string
createdAt: number
updatedAt: number
cid: string
name: string
label: string
desc: string
userId: string
singleEntry: boolean
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
{
( BCMSTemplateUpdateData )
_id: string
label?: string
desc?: string
singleEntry?: boolean
propChanges?: [
( BCMSPropChange )
{
add?: {
( BCMSPropChangeAdd )
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
remove?: string
update?: {
( BCMSPropChangeUpdate )
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
}
]
}
Response
{
item: {
( BCMSTemplate )
_id: string
createdAt: number
updatedAt: number
cid: string
name: string
label: string
desc: string
userId: string
singleEntry: boolean
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
Response
{
items: [
( BCMSTemplate )
{
_id: string
createdAt: number
updatedAt: number
cid: string
name: string
label: string
desc: string
userId: string
singleEntry: boolean
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
Headers
Get templates with specified IDs. IDs should be split by - character.
Response
{
items: [
( BCMSTemplate )
{
_id: string
createdAt: number
updatedAt: number
cid: string
name: string
label: string
desc: string
userId: string
singleEntry: boolean
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
Response
{
count: number
}
Path parameters
Template ID
Convert in type
Response
{
items: [
( BCMSTypeConverterResultItem )
{
outputFile: string
content: string
}
]
}
Path parameters
Template ID
Response
{
item: {
( BCMSTemplate )
_id: string
createdAt: number
updatedAt: number
cid: string
name: string
label: string
desc: string
userId: string
singleEntry: boolean
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
This route has side effect! When template is deleted, all entries which belong to specified template will also be deleted.
Path parameters
Template ID
Response
{
( BCMSSuccessResponse )
message: string [Success.]
}
{
( BCMSGroupAddData )
label: string
desc: string
}
Response
{
item: {
( BCMSGroup )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
{
( BCMSGroupUpdateData )
_id: string
label?: string
desc?: string
propChanges?: [
( BCMSPropChange )
{
add?: {
( BCMSPropChangeAdd )
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
remove?: string
update?: {
( BCMSPropChangeUpdate )
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
}
]
}
Response
{
item: {
( BCMSGroup )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
Path parameters
Group ID
Response
{
groupIds: [
( BCMSIdAndCidGroup )
{
_id: string
cid: string
}
]
templateIds: [
( BCMSIdAndCidGroup )
{
_id: string
cid: string
}
]
widgetIds: [
( BCMSIdAndCidGroup )
{
_id: string
cid: string
}
]
}
Response
{
items: [
( BCMSGroup )
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
Response
{
items: [
( BCMSGroupLite )
{
cid: string
name: string
label: string
desc: string
propsCount: number
}
]
}
Headers
IDs string. IDs should be split by - character.
Response
{
items: [
( BCMSGroup )
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
Response
{
count: number
}
Path parameters
Group ID
Convert in type
Response
{
items: [
( BCMSTypeConverterResultItem )
{
outputFile: string
content: string
}
]
}
Path parameters
Group ID
Response
{
item: {
( BCMSGroup )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
Response
{
items: [
( BCMSTypeConverterResultItem )
{
outputFile: string
content: string
}
]
}
{
( BCMSWidgetCreateData )
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
}
Response
{
item: {
( BCMSWidget )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
{
( BCMSWidgetUpdateData )
_id: string
label?: string
desc?: string
previewImage?: string
previewScript?: string
previewStyle?: string
propChanges?: [
( BCMSPropChange )
{
add?: {
( BCMSPropChangeAdd )
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
remove?: string
update?: {
( BCMSPropChangeUpdate )
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
}
]
}
Response
{
item: {
( BCMSWidget )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
Path parameters
Widget Id
Response
{
entryIds: [
allOf ((
( BCMSIdAndCidGroup ) and {
tid: string
}
))
]
}
Response
{
items: [
( BCMSWidget )
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
Headers
IDs string. IDs should be split by - character.
Response
{
items: [
( BCMSWidget )
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
Response
{
count: number
}
Path parameters
Widget ID
Convert in type
Response
{
items: [
( BCMSTypeConverterResultItem )
{
outputFile: string
content: string
}
]
}
Path parameters
Widget ID
Response
{
item: {
( BCMSWidget )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
Path parameters
ID of the template to which entry will be added.
{
( BCMSEntryCreateData )
templateId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
Response
{
item: {
( BCMSEntry )
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
}
Path parameters
ID of the template to which specified entry belongs.
{
( BCMSEntryUpdateData )
_id: string
templateId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
Response
{
item: {
( BCMSEntry )
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
}
Headers
IDs string. IDs should be split by - character.
Response
{
items: [
( BCMSEntry )
{
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
]
}
Path parameters
ID of the template for which entries will be returned.
Response
{
items: [
( BCMSEntry )
{
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
]
}
Path parameters
ID of the template for which entries will be returned.
Response
{
items: [
( BCMSEntryParsed )
{
_id: string
createdAt: number
updatedAt: number
templateId: string
userId: string
status: string
meta: [
( BCMSEntryParsedMeta )
{
<lng>: [
( BCMSPropParsed )
{
<name>: [
( BCMSPropDataParsed )
oneOf ((
string or [
string
] or boolean or [
boolean
] or number or [
number
] or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerDataParsed ) or [
( BCMSPropGroupPointerDataParsed )
] or ( BCMSPropWidgetDataParsed ) or ( BCMSPropMediaDataParsed ) or [
( BCMSPropMediaDataParsed )
] or {
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
( BCMSPropDataParsed )
}
))
]
}
]
}
]
}
]
}
Path parameters
ID of the template for which entries will be returned.
Response
{
items: [
( BCMSEntryLite )
{
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
]
}
Path parameters
ID of the template for which entry count will be returned.
Response
{
count: number
}
Path parameters
ID of the template to which entry belongs.
Entry ID
Response
{
item: {
( BCMSEntryParsed )
_id: string
createdAt: number
updatedAt: number
templateId: string
userId: string
status: string
meta: [
( BCMSEntryParsedMeta )
{
<lng>: [
( BCMSPropParsed )
{
<name>: [
( BCMSPropDataParsed )
oneOf ((
string or [
string
] or boolean or [
boolean
] or number or [
number
] or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerDataParsed ) or [
( BCMSPropGroupPointerDataParsed )
] or ( BCMSPropWidgetDataParsed ) or ( BCMSPropMediaDataParsed ) or [
( BCMSPropMediaDataParsed )
] or {
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
( BCMSPropDataParsed )
}
))
]
}
]
}
]
}
}
Path parameters
ID of the template to which entry belongs.
Entry ID
Response
{
item: {
( BCMSEntryLite )
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
}
Path parameters
Template ID
Entry ID
Convert in type
Response
{
items: [
( BCMSTypeConverterResultItem )
{
outputFile: string
content: string
}
]
}
Path parameters
ID of the template to which entry belongs.
Entry ID
Response
{
item: {
( BCMSEntry )
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
}
Path parameters
ID of the template to which entry belongs.
Entry ID
Response
{
( BCMSSuccessResponse )
message: string [Success.]
}
Directory is a special type of media which can have reference to child media.
{
( BCMSMediaAddDirData )
name: string
parentId?: string
}
Response
{
item: {
( BCMSMedia )
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
}
Queries
ID of the media with type DIR to which file will be added. If not provided, file will be added to the root.
{
media: string [binary]
}
Response
{
item: {
( BCMSMedia )
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
}
{
( BCMSMediaUpdateData )
_id: string
rename?: string
moveTo?: string
}
Response
{
updatedKey: {
( BCMSMedia )
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
}
Response
{
items: [
( BCMSMedia )
{
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
]
}
Response
{
items: [
( BCMSMediaAggregate )
{
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
path: string
isInRoot: boolean
( BCMSMediaAggregate )
}
]
}
Path parameters
ID of the parent media.
Response
{
items: [
( BCMSMedia )
{
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
]
}
Headers
IDs string. IDs should be split by - character.
Response
{
items: [
( BCMSMedia )
{
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
]
}
Response
{
count: number
}
If specified media is a directory, error will be thrown.
Path parameters
Media ID
Response
string [binary]
Path parameters
Media ID
Response
string [binary]
Path parameters
Media ID
Queries
Access token
Response
string [binary]
If specified media is not video, error will be thrown.
Path parameters
Media ID
Queries
Access token
Response
string [binary]
Path parameters
Media ID
Queries
Access token
Response
string [binary]
Path parameters
Media ID
Response
{
item: {
( BCMSMediaAggregate )
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
path: string
isInRoot: boolean
( BCMSMediaAggregate )
}
}
{
( BCMSMediaMoveData )
_id: string
moveTo: string
}
Response
{
item: {
( BCMSMedia )
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
}
{
( BCMSMediaDuplicateData )
_id: string
duplicateTo: string
}
Response
{
item: {
( BCMSMedia )
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
}
Path parameters
Media ID
Response
{
item: {
( BCMSMedia )
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
}
This route has side effects! If specified media is of type DIR, all child media will also be deleted.
Path parameters
Media ID
Response
{
( BCMSSuccessResponse )
message: string [Success.]
}
Response
{
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
{
( BCMSApiKeyAddData )
name: string
desc: string
blocked: boolean
access: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
Response
{
key: {
( BCMSApiKey )
_id: string
createdAt: number
updatedAt: number
userId: string
name: string
desc: string
blocked: boolean
secret: string
access: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
}
{
( BCMSApiKeyUpdateData )
_id: string
name?: string
desc?: string
blocked?: boolean
access?: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
Response
{
updatedKey: {
( BCMSApiKey )
_id: string
createdAt: number
updatedAt: number
userId: string
name: string
desc: string
blocked: boolean
secret: string
access: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
}
Response
[
( BCMSMedia )
{
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
]
Response
numberPath parameters
API key ID
Response
{
key: {
( BCMSApiKey )
_id: string
createdAt: number
updatedAt: number
userId: string
name: string
desc: string
blocked: boolean
secret: string
access: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
}
{
( BCMSLanguageAddData )
code: string
name: string
nativeName: string
}
Response
{
item: {
( BCMSLanguage )
_id: string
createdAt: number
updatedAt: number
userId: string
code: string
name: string
nativeName: string
def: boolean
}
}
Response
{
items: [
( BCMSLanguage )
{
_id: string
createdAt: number
updatedAt: number
userId: string
code: string
name: string
nativeName: string
def: boolean
}
]
}
Response
{
count: number
}
Path parameters
Language ID
Response
{
item: {
( BCMSLanguage )
_id: string
createdAt: number
updatedAt: number
userId: string
code: string
name: string
nativeName: string
def: boolean
}
}
Response
{
name: string
public: boolean
}
Path parameters
Name of the function to execute.
Response
{
success: boolean
result: {
}
}
{
( BCMSStatusCreateData )
label: string
color?: string
}
Response
{
item: {
( BCMSStatus )
_id: string
createdAt: number
updatedAt: number
label: string
name: string
color: string
}
}
{
( BCMSStatusUpdateData )
_id: string
label?: string
color?: string
}
Response
{
item: {
( BCMSStatus )
_id: string
createdAt: number
updatedAt: number
label: string
name: string
color: string
}
}
Response
{
items: [
( BCMSStatus )
{
_id: string
createdAt: number
updatedAt: number
label: string
name: string
color: string
}
]
}
Response
{
count: number
}
Path parameters
Status ID
Response
{
item: {
( BCMSStatus )
_id: string
createdAt: number
updatedAt: number
label: string
name: string
color: string
}
}
{
( BCMSTemplateOrganizerCreateData )
label: string
parentId?: string
templateIds: [
string
]
}
Response
{
item: {
( BCMSTemplateOrganizer )
_id: string
createdAt: number
updatedAt: number
parentId?: string
label: string
name: string
templateIds: [
string
]
}
}
{
( BCMSTemplateOrganizerUpdateData )
_id: string
parentId?: string
label?: string
templateIds?: [
string
]
}
Response
{
item: {
( BCMSTemplateOrganizer )
_id: string
createdAt: number
updatedAt: number
parentId?: string
label: string
name: string
templateIds: [
string
]
}
}
Response
{
items: [
( BCMSTemplateOrganizer )
{
_id: string
createdAt: number
updatedAt: number
parentId?: string
label: string
name: string
templateIds: [
string
]
}
]
}
Headers
IDs string. IDs should be split by - character.
Response
{
items: [
( BCMSTemplateOrganizer )
{
_id: string
createdAt: number
updatedAt: number
parentId?: string
label: string
name: string
templateIds: [
string
]
}
]
}
Path parameters
Template Organizer ID
Response
{
item: {
( BCMSTemplateOrganizer )
_id: string
createdAt: number
updatedAt: number
parentId?: string
label: string
name: string
templateIds: [
string
]
}
}
Path parameters
Template Organizer ID
Response
{
( BCMSSuccessResponse )
message: string [Success.]
}
{
( BCMSColorCreateData )
label: string
value: string
source: {
id?: string
type?: string
}
}
Response
{
item: {
( BCMSColor )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
value: string
userId: string
source: {
( BCMSColorSource )
_id?: string
type: string
}
}
}
{
( BCMSColorUpdateData )
_id: string
label?: string
value?: string
}
Response
{
item: {
( BCMSGroup )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
}
Response
{
items: [
( BCMSColor )
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
value: string
userId: string
source: {
( BCMSColorSource )
_id?: string
type: string
}
}
]
}
Headers
Get colors with specified IDs. IDs should be split by - character.
Response
{
items: [
( BCMSColor )
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
value: string
userId: string
source: {
( BCMSColorSource )
_id?: string
type: string
}
}
]
}
Response
{
count: number
}
Path parameters
Color ID
Response
{
item: {
( BCMSColor )
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
value: string
userId: string
source: {
( BCMSColorSource )
_id?: string
type: string
}
}
}
{
( BCMSTagCreateData )
value: string
}
Response
{
item: {
( BCMSTag )
_id: string
createdAt: number
updateAt?: number
cid: string
value: string
}
}
{
( BCMSTagUpdateData )
_id: string
value: string
}
Response
{
item: {
( BCMSTag )
_id: string
createdAt: number
updateAt?: number
cid: string
value: string
}
}
Response
{
items: [
( BCMSTag )
{
_id: string
createdAt: number
updateAt?: number
cid: string
value: string
}
]
}
Headers
Get colors with specified IDs. IDs should be split by - character.
Response
{
items: [
( BCMSTag )
{
_id: string
createdAt: number
updateAt?: number
cid: string
value: string
}
]
}
Path parameters
Set value tag
Response
{
item: {
( BCMSTag )
_id: string
createdAt: number
updateAt?: number
cid: string
value: string
}
}
Path parameters
Tag ID
Response
{
item: {
( BCMSTag )
_id: string
createdAt: number
updateAt?: number
cid: string
value: string
}
}
This event is triggered when something is changed with API keys. Event data will contain 2 properties:
t- Type of the event/change.a- Holds the ID of the API key which was changed.
{
t: string [UPDATE | REMOVE]
a: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Entries. Event data will contain 3 properties:
t- Type of the event/change.e- Holds the ID of the entry which was changed.tm- Holds the ID of the template to which entry belongs.
{
t: string [UPDATE | REMOVE]
e: string
tm: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Groups. Event data will contain 2 properties:
t- Type of the event/change.g- Holds the ID of the group which was changed.
{
t: string [UPDATE | REMOVE]
g: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Languages. Event data will contain 2 properties:
t- Type of the event/change.l- Holds the ID of the language which was changed.
{
t: string [UPDATE | REMOVE]
l: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Media. Event data will contain 2 properties:
t- Type of the event/change.m- Holds the ID of the media which was changed.
{
t: string [UPDATE | REMOVE]
m: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Statuses. Event data will contain 2 properties:
t- Type of the event/change.s- Holds the ID of the status which was changed.
{
t: string [UPDATE | REMOVE]
s: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Templates. Event data will contain 2 properties:
t- Type of the event/change.tm- Holds the ID of the template which was changed.
{
t: string [UPDATE | REMOVE]
tm: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Template organizers. Event data will contain 2 properties:
t- Type of the event/change.to- Holds the ID of the template organizer which was changed.
{
t: string [UPDATE | REMOVE]
to: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Users. Event data will contain 2 properties:
t- Type of the event/change.u- Holds the ID of the user which was changed.
{
t: string [UPDATE | REMOVE]
u: string
}
No logs yet... Logs will be available were when event is received.
This event is triggered when something is changed with Widgets. Event data will contain 2 properties:
t- Type of the event/change.w- Holds the ID of the widget which was changed.
{
t: string [UPDATE | REMOVE]
w: string
}
No logs yet... Logs will be available were when event is received.
{
_id: string
createdAt: number
updatedAt: number
userId: string
name: string
desc: string
blocked: boolean
secret: string
access: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
{
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
{
name: string
desc: string
blocked: boolean
access: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
{
payload: {
}
query: {
}
}
{
_id: string
name?: string
desc?: string
blocked?: boolean
access?: {
( BCMSApiKeyAccess )
templates: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
functions: [
{
name: string
}
]
}
}
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
value: string
userId: string
source: {
( BCMSColorSource )
_id?: string
type: string
}
}
{
label: string
value: string
source: {
id?: string
type?: string
}
}
{
_id?: string
type: string
}
{
_id: string
label?: string
value?: string
}
{
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
{
level: number
}
{
href: string
target: string
}
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
string [bold | italic | underline | stripe | link]
string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
{
templateId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
{
_id: string
createdAt: number
updatedAt: number
cid: string
templateId: string
userId: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
{
_id: string
createdAt: number
updatedAt: number
templateId: string
userId: string
status: string
meta: [
( BCMSEntryParsedMeta )
{
<lng>: [
( BCMSPropParsed )
{
<name>: [
( BCMSPropDataParsed )
oneOf ((
string or [
string
] or boolean or [
boolean
] or number or [
number
] or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerDataParsed ) or [
( BCMSPropGroupPointerDataParsed )
] or ( BCMSPropWidgetDataParsed ) or ( BCMSPropMediaDataParsed ) or [
( BCMSPropMediaDataParsed )
] or {
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
( BCMSPropDataParsed )
}
))
]
}
]
}
]
}
{
<lng>: [
( BCMSPropParsed )
{
<name>: [
( BCMSPropDataParsed )
oneOf ((
string or [
string
] or boolean or [
boolean
] or number or [
number
] or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerDataParsed ) or [
( BCMSPropGroupPointerDataParsed )
] or ( BCMSPropWidgetDataParsed ) or ( BCMSPropMediaDataParsed ) or [
( BCMSPropMediaDataParsed )
] or {
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
( BCMSPropDataParsed )
}
))
]
}
]
}
{
_id: string
templateId: string
status?: string
meta: [
( BCMSEntryMeta )
{
lng: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
content: [
( BCMSEntryContent )
{
lng: string
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
}
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
{
label: string
desc: string
}
{
cid: string
name: string
label: string
desc: string
propsCount: number
}
{
_id: string
label?: string
desc?: string
propChanges?: [
( BCMSPropChange )
{
add?: {
( BCMSPropChangeAdd )
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
remove?: string
update?: {
( BCMSPropChangeUpdate )
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
}
]
}
{
_id: string
cid: string
}
{
_id: string
createdAt: number
updatedAt: number
name: string
forId: string
count: number
}
{
_id: string
createdAt: number
updatedAt: number
userId: string
code: string
name: string
nativeName: string
def: boolean
}
{
code: string
name: string
nativeName: string
}
{
_id: string
def?: boolean
}
{
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
isInRoot: boolean
hasChildren: boolean
parentId: string
}
{
name: string
parentId?: string
}
{
_id: string
createdAt: number
updateAt?: number
userId: string
type: string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
mimetype: string
size: number
name: string
path: string
isInRoot: boolean
( BCMSMediaAggregate )
}
{
_id: string
duplicateTo: string
}
{
_id: string
moveTo: string
}
string [DIR | IMG | VID | TXT | GIF | OTH | PDF | JS | HTML | CSS | JAVA]
{
_id: string
rename?: string
moveTo?: string
}
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
{
add?: {
( BCMSPropChangeAdd )
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
remove?: string
update?: {
( BCMSPropChangeUpdate )
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
}
{
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
{
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
{
allowCustom: boolean
options: [
string
]
selected: [
string
]
}
{
<key>: [
oneOf ((
( BCMSPropDataParsed ) or [
( BCMSPropDataParsed )
]
))
]
}
oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
oneOf ((
string or [
string
] or boolean or [
boolean
] or number or [
number
] or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerDataParsed ) or [
( BCMSPropGroupPointerDataParsed )
] or ( BCMSPropWidgetDataParsed ) or ( BCMSPropMediaDataParsed ) or [
( BCMSPropMediaDataParsed )
] or {
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
( BCMSPropDataParsed )
}
))
[
number
]
{
templateId: string
entryIds: [
string
]
displayProp: string
}
{
<lng>: [
( BCMSPropData )
oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
]
}
{
items: [
string
]
selected?: string
}
{
_id: string
}
{
<key>: [
oneOf ((
( BCMSPropDataParsed ) or [
( BCMSPropDataParsed )
]
))
]
}
string{
_id: string
src: string
}
{
<name>: [
( BCMSPropDataParsed )
oneOf ((
string or [
string
] or boolean or [
boolean
] or number or [
number
] or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerDataParsed ) or [
( BCMSPropGroupPointerDataParsed )
] or ( BCMSPropWidgetDataParsed ) or ( BCMSPropMediaDataParsed ) or [
( BCMSPropMediaDataParsed )
] or {
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
( BCMSPropDataParsed )
}
))
]
}
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
[
string
]
oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
{
_id: string
items: [
{
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
]
}
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
{
_id: string
props: [
( BCMSPropValue )
{
id: string
data: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropValueGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropValueWidgetData ) or [
( BCMSPropValueRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
{
_id: string
}
{
<key>: [
( BCMSPropDataParsed )
oneOf ((
string or [
string
] or boolean or [
boolean
] or number or [
number
] or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerDataParsed ) or [
( BCMSPropGroupPointerDataParsed )
] or ( BCMSPropWidgetDataParsed ) or ( BCMSPropMediaDataParsed ) or [
( BCMSPropMediaDataParsed )
] or {
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
( BCMSPropDataParsed )
}
))
]
}
{
_id: string
createdAt: number
updateAt?: number
username: string
email: string
roles: [
( JWTRole )
{
name: string [ADMIN | USER]
permissions: [
( JWTPermission )
{
name: string [READ | WRITE | DELETE | EXECUTE]
}
]
}
]
customPool: {
( BCMSUserCustomPool )
personal: {
( BCMSUserPersonal )
firstName: string
lastName: string
avatarUri: string
}
address: {
( BCMSUserAddress )
country?: string
city?: string
state?: string
zip?: string
street?: {
name?: string
number?: string
}
}
policy: {
( BCMSUserPolicy )
media: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
templates: [
allOf ((
{
_id: string
} and ( BCMSUserPolicyCRUD )
))
]
plugins?: [
allOf ((
{
name: string
} and ( BCMSUserPolicyCRUD )
))
]
}
}
}
string [UPDATE | REMOVE]
{
_id: string
createdAt: number
updatedAt: number
label: string
name: string
color: string
}
{
label: string
color?: string
}
{
_id: string
label?: string
color?: string
}
{
message: string [Success.]
}
{
_id: string
createdAt: number
updateAt?: number
cid: string
value: string
}
{
value: string
}
{
_id: string
value: string
}
{
_id: string
createdAt: number
updatedAt: number
cid: string
name: string
label: string
desc: string
userId: string
singleEntry: boolean
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
{
label: string
desc: string
singleEntry: boolean
}
{
_id: string
createdAt: number
updatedAt: number
parentId?: string
label: string
name: string
templateIds: [
string
]
}
{
label: string
parentId?: string
templateIds: [
string
]
}
{
_id: string
parentId?: string
label?: string
templateIds?: [
string
]
}
{
_id: string
label?: string
desc?: string
singleEntry?: boolean
propChanges?: [
( BCMSPropChange )
{
add?: {
( BCMSPropChangeAdd )
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
remove?: string
update?: {
( BCMSPropChangeUpdate )
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
}
]
}
{
outputFile: string
content: string
}
{
country?: string
city?: string
state?: string
zip?: string
street?: {
name?: string
number?: string
}
}
{
personal: {
( BCMSUserPersonal )
firstName: string
lastName: string
avatarUri: string
}
address: {
( BCMSUserAddress )
country?: string
city?: string
state?: string
zip?: string
street?: {
name?: string
number?: string
}
}
policy: {
( BCMSUserPolicy )
media: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
templates: [
allOf ((
{
_id: string
} and ( BCMSUserPolicyCRUD )
))
]
plugins?: [
allOf ((
{
name: string
} and ( BCMSUserPolicyCRUD )
))
]
}
}
{
firstName: string
lastName: string
avatarUri: string
}
{
media: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
templates: [
allOf ((
{
_id: string
} and ( BCMSUserPolicyCRUD )
))
]
plugins?: [
allOf ((
{
name: string
} and ( BCMSUserPolicyCRUD )
))
]
}
{
get: boolean
post: boolean
put: boolean
delete: boolean
}
{
_id: string
customPool?: {
policy?: {
media?: {
( BCMSUserPolicyCRUD )
get: boolean
post: boolean
put: boolean
delete: boolean
}
( BCMSUserPolicyCRUD )
templates?: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
webhooks?: [
allOf ((
( BCMSUserPolicyCRUD ) and {
_id: string
}
))
]
plugins?: [
allOf ((
( BCMSUserPolicyCRUD ) and {
name: string
}
))
]
}
}
}
{
_id: string
createdAt: number
updateAt?: number
cid: string
name: string
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
props: [
( BCMSProp )
{
id: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
name: string
label: string
array: boolean
defaultData: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
]
}
{
label: string
desc: string
previewImage: string
previewScript: string
previewStyle: string
}
{
_id: string
label?: string
desc?: string
previewImage?: string
previewScript?: string
previewStyle?: string
propChanges?: [
( BCMSPropChange )
{
add?: {
( BCMSPropChangeAdd )
label: string
type: string [STRING | NUMBER | BOOLEAN | DATE | ENUMERATION | MEDIA | GROUP_POINTER | ENTRY_POINTER | WIDGET | RICH_TEXT]
required: boolean
array: boolean
defaultData?: oneOf ((
[
string
] or [
boolean
] or [
number
] or ( BCMSPropDateData ) or ( BCMSPropEnumData ) or ( BCMSPropEntryPointerData ) or ( BCMSPropGroupPointerData ) or [
( BCMSPropMediaData )
string
] or ( BCMSPropWidgetData ) or [
( BCMSPropRichTextData )
{
nodes: [
( BCMSEntryContentNode )
{
type: string [paragraph | heading | widget | bulletList | listItem | orderedList | text]
content?: [
( BCMSEntryContentNode )
]
attrs?: oneOf ((
( BCMSEntryContentNodeHeadingAttr ) or ( BCMSPropValueWidgetData ) or ( BCMSEntryContentNodeLinkAttr )
))
marks?: [
( BCMSEntryContentNodeMarker )
{
type: string [bold | italic | underline | stripe | link]
attrs: {
( BCMSEntryContentNodeLinkAttr )
href: string
target: string
}
}
]
text?: string
}
]
}
]
))
}
remove?: string
update?: {
( BCMSPropChangeUpdate )
id: string
label: string
move: number
required: boolean
enumItems?: [
string
]
}
}
]
}
{
name: string [READ | WRITE | DELETE | EXECUTE]
}
string [READ | WRITE | DELETE | EXECUTE]
{
name: string [ADMIN | USER]
permissions: [
( JWTPermission )
{
name: string [READ | WRITE | DELETE | EXECUTE]
}
]
}
string [ADMIN | USER]