Skip to content

Article

idintegerrequired

article ID

Example:1
defaultSectionIdinteger

article section ID

Example:682
sectionIdsArray of integers or null

array of section IDs

titlestringrequired

article title

Example:"Test"
languagestring

Article language. Available only if module foreignLanguages is active and initialized.

Example:"cs"
indexNamestring or nullrequired

ending part of article URL

Example:"new-article"
urlstring

article URL

Example:"https://www.some-eshop-url.com/blog/new-article"
urlsArray of objects(articleUrls)

array of section IDs and their URLs

redirectUrlstring or nullrequired

canonical URL for redirecting

Example:"https://www.someurl.com"
contentstring or nullrequired

article content

Example:"<p>Content of the article</p>"
metaTitlestring or nullrequired

article meta title

Example:"Test article\""
metaDescriptionstring or nullrequired

article meta description

Example:"Test article"
publishDatestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

article date of publishing

Example:"2014-11-19T00:00:00+0100"
changeDatestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

article date of the last modification

Example:"2014-11-19T00:00:00+0100"
visiblebooleanrequired

flag whether the article is visible on web

Example:true
accessanyrequired

flag indicating, whether the article can be viewed by everyone (value of the flag is: all), by logged in users only ('logged-in'), or by logged out users only ('logged-out'), or by administrators only ('admin-only')

Enum:"all""logged-in""logged-out""admin-only"
Example:"logged-in"
imagestring or null

article image

Example:"https://www.some-eshop-url.com/image.jpg"
ogImagestring or null

article og:image

Example:"https://www.some-eshop-url.com/image.jpg"
metaKeywordsstring or nullrequireddeprecated

article keywords

Example:"test"
{ "id": 1, "defaultSectionId": 682, "sectionIds": [ 682 ], "title": "Test", "language": "cs", "indexName": "new-article", "url": "https://www.some-eshop-url.com/blog/new-article", "urls": [ { … } ], "redirectUrl": "https://www.someurl.com", "content": "<p>Content of the article</p>", "metaTitle": "Test article\"", "metaKeywords": "test", "metaDescription": "Test article", "publishDate": "2014-11-19T00:00:00+0100", "changeDate": "2014-11-19T00:00:00+0100", "visible": true, "access": "logged-in", "image": "https://www.some-eshop-url.com/image.jpg", "ogImage": "https://www.some-eshop-url.com/image.jpg" }