Skip to main content

ArticleOverviewResponse

id objectrequired
timestampinteger<int32>
datestring<date-time>
keystringrequired
createdAtstring<date-time>required
publishedAtstring<date-time>
updatedAtstring<date-time>required
pathstringrequired
statestringrequired

Possible values: [PUBLISHED, DRAFT, ARCHIVED]

titlestringrequired
colors objectrequired
textstring
backgroundstring
localestringrequired
summarystringrequired
image object
id objectrequired
timestampinteger<int32>
datestring<date-time>
keystringrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
access objectrequired
ownerId objectrequired
timestampinteger<int32>
datestring<date-time>
visibilitystringrequired

Possible values: [PRIVATE, PUBLIC, SHARED]

canEditbooleanrequired
canDeletebooleanrequired
renditions objectrequired
property name* FileRenditionResponse
keystringrequired
sizeinteger<int64>required
contentTypestringrequired
urlstringrequired
widthinteger<int32>
heightinteger<int32>
originalUrlstring
access objectrequired
ownerId objectrequired
timestampinteger<int32>
datestring<date-time>
visibilitystringrequired

Possible values: [PRIVATE, PUBLIC, SHARED]

canEditbooleanrequired
canDeletebooleanrequired
tags object[]required
  • Array [
    • keystringrequired
    localestringrequired
    namestringrequired
    descriptionstringrequired
  • ]
    • ArticleOverviewResponse
    {
      "id": {
        "timestamp": 0,
        "date": "2024-07-29T15:51:28.071Z"
      },
      "key": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "publishedAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "path": "string",
      "state": "PUBLISHED",
      "title": "string",
      "colors": {
        "text": "string",
        "background": "string"
      },
      "locale": "string",
      "summary": "string",
      "image": {
        "id": {
          "timestamp": 0,
          "date": "2024-07-29T15:51:28.071Z"
        },
        "key": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z",
        "access": {
          "ownerId": {
            "timestamp": 0,
            "date": "2024-07-29T15:51:28.071Z"
          },
          "visibility": "PRIVATE",
          "canEdit": true,
          "canDelete": true
        },
        "renditions": {},
        "originalUrl": "string"
      },
      "access": {
        "ownerId": {
          "timestamp": 0,
          "date": "2024-07-29T15:51:28.071Z"
        },
        "visibility": "PRIVATE",
        "canEdit": true,
        "canDelete": true
      },
      "tags": [
        {
          "key": "string",
          "locale": "string",
          "name": "string",
          "description": "string"
        }
      ]
    }