v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring content

List all content items in the database.

Use the /content endpoint to list all content items in the database. <br />User roles: admin, manager, editor, viewer

get/authoring/v1/content

Query parameters

offsetnumber

Use the offset parameter to specify the number of content items to skip from the beginning of the list and return the rest.

fieldsstring

Only the content items fields that are specified here are returned for each result. Any content item field is a valid value and can be specified as a comma-separated list. For example, to list the content item fields name and ID, provide the value ID, and name. All content item fields are returned by default.

limitnumber

Set the limit for the maximum number of content items to return in a single result. The default value is 50.

Response

Successfully lists a paged result view of all content items in the database.

limitinteger

The page size.

offsetinteger

The number of items to skip from the beginning of the list.

hrefstring

A link to the current page.

nextstring

A link to the next page. Only shown if a next page exists.

previousstring

A link to the previous page. Only shown if a previous page exists.

Example response

{
  "limit": 50,
  "href": "/authoring/v1/content?offset=50&limit=50",
  "next": "/authoring/v1/content?offset=100&limit=50",
  "previous": "/authoring/v1/content?offset=0&limit=50",
  "items": [
    {
      "id": "925d1454-167b-431b-a54c-6cbf0354398d",
      "rev": "25-2ba981d0661c3129c31cc4993e569e3f",
      "name": "Sample Content",
      "description": "An example description of the sample content",
      "typeId": "b0798e67-3da2-48b4-b044-016495fa3ead",
      "type": "Article",
      "kind": "email",
      "lastModified": "2016-11-02T06:28:47Z",
      "lastModifierId": "63b800fa-51a7-4602-8cbe-ab3b9cee28b9",
      "lastModifier": "Thomas Watson",
      "created": "2016-11-02T06:28:47Z",
      "creatorId": "8c622bbb-5f5b-45d4-89e1-fce1c054138f",
      "creator": "Thomas Watson",
      "linkedDocId": "b289c02e-2c61-4643-aba6-e6b4e94c76e3",
      "elements": {
        "videokey": {
          "elementType": "video",
          "asset": {
            "id": "a21b3718-a801-4343-8a73-6f94ee2763ba",
            "resourceUri": "/authoring/v1/resources/438259a6a8ac72817ee2b2a14078c4a1",
            "fileSize": 448338,
            "fileName": "testVideo.mp4",
            "mediaType": "video/mp4"
          },
          "thumbnail": {
            "resourceId": "ef2e1f5fa89f2f93dfba19520f629c84",
            "resourceUri": "/authoring/v1/resources/ef2e1f5fa89f2f93dfba19520f629c84",
            "fileName": "cap.jpg"
          }
        },
        "categorykey": {
          "elementType": "category",
          "categoryIds": [
            "ae607a10216249805ee0488d3e0f1e64"
          ]
        },
        "datekey": {
          "elementType": "datetime",
          "value": "2016-11-07T10:09:00Z"
        },
        "textkey": {
          "elementType": "text",
          "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"
        },
        "togglekey": {
          "elementType": "toggle",
          "value": true
        },
        "linkkey": {
          "elementType": "link",
          "linkURL": "http://acoustic.com",
          "linkText": "Acoustic"
        },
        "imagekey": {
          "elementType": "image",
          "renditions": {
            "default": {
              "renditionId": "61096914-e33a-4021-9a5d-be06337206fd",
              "source": "/authoring/v1/resources/c45c83a8-2738-48a2-89e1-35256ee16283.jpg"
            }
          },
          "asset": {
            "id": "400974f1-10d8-4db9-a711-a840e315fdef",
            "resourceUri": "/authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba4648d82",
            "fileName": "cap.jpg",
            "fileSize": 113730,
            "mediaType": "image/jpeg"
          }
        },
        "filekey": {
          "elementType": "file",
          "asset": {
            "id": "913099e2-3e53-497c-b264-77ed974b1694",
            "resourceUri": "/authoring/v1/resources/a9a19a26209fed0b96612d6263618d9b",
            "fileSize": 145592,
            "fileName": "news.pdf",
            "mediaType": "application/pdf"
          }
        },
        "numberkey": {
          "elementType": "number",
          "value": 42
        },
        "imagewithprofilekey": {
          "elementType": "image",
          "renditions": {
            "default": {
              "renditionId": "39a94d18-9063-4785-80f8-cc5520255afe",
              "source": "/authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg"
            },
            "mobile": {
              "renditionId": "583d4fa3-7b3f-4c31-8aca-f1a32e3f5d6b",
              "source": "/authoring/v1/resources/1decdf83-126a-4fc1-b9fc-d3d42297d576.jpg?resize=0.16286644951140064xw:0.16286644951140064xh&crop=200:200;56,0"
            }
          },
          "asset": {
            "id": "b4703646-2ae9-4ef3-8d2d-9f8a2d5f2545",
            "resourceUri": "/authoring/v1/resources/fd95f9a53edd5c2ae4ebdf2ba464a0f9",
            "fileName": "tree-738816_1920.jpg",
            "fileSize": 273419,
            "mediaType": "image/jpeg"
          }
        }
      },
      "tags": [
        "news",
        "sample"
      ],
      "links": {
        "self": {
          "href": "/authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d"
        },
        "linkedDoc": {
          "href": "/authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9"
        },
        "draft": {
          "href": "/authoring/v1/content/fd95f9a53edd5c2ae4ebdf2ba464a0f9"
        },
        "create-draft": {
          "href": "/authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/create-draft"
        },
        "ready": {
          "href": "/authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/ready"
        },
        "retire": {
          "href": "/authoring/v1/content/925d1454-167b-431b-a54c-6cbf0354398d/retire"
        },
        "type": {
          "href": "/authoring/v1/types/b0798e67-3da2-48b4-b044-016495fa3ead"
        }
      },
      "thumbnail": {
        "id": "6c622bbb-5f5b-45d4-89e1-fce1c054138f",
        "path": "/sales/images/hub.png",
        "url": "/authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8"
      }
    }
  ]
}