Content Classes

The content classes represent the various locations that content can exist, or be surfaced, using the "repository" designation as the primary differentiation for each content class.

DocCenter

Represents all content in a doccenter content profile

Field

Is Required?

Description

repository

Y

doccenter

id

Y

The id of the doccenter content.

name

Y

The name of the document.

type

Y

The content type.

libraryContent.teamsiteId

Y

The teamsiteId of the library content this doccenter item represents.

libraryContent.id

Y

The id of the library content this doccenter document represents .

libraryContent.versionId

Y

The versionId of the library content this doccenter item represents.

contentProfileId

Y

The content profile id that the content is located in (or the action took place from).

contentProfilePath

Y

An array of the path to the item, not including the item. An action on an item in the root folder would be represented by []. An action on an item in Folder A (which is in the root) would be represented as ["Folder A"].

quickAccessPath

N

If this file is accessed via a quick access path such as "recents" or "favorites" we would indicate that here.

pages

N

In cases where the pages of a document are interacted with this is the list of those pages.

{
    "content": [{
        "repository": "doccenter",
        "name": "sample file",
        "type": "file",
        "libraryContent": {
            "id": "a5d85988-17f4-4994-82db-1ea46886046a",
            "versionId": "c9d85988-17f4-4994-82db-1ea46886046a",
            "teamsiteId": "1"
        },
        "contentProfileId": "60839af0-ca44-495a-8112-ae31d560b2b9",
        "contentProfilePath": [
            "Folder A",
            "Folder B"
        ],
        "id": "YmFzZTY0IGZ1bGwgcGF0aA=="
    }]
}

NewsCenter

Represents all content in a newscenter content profile

Field

Is Required?

Description

repository

Y

newscenter

name

Y

The name of the document.

type

Y

The content type.

libraryContent.teamsiteId

Y

The teamsiteId of the library content this newscenter document represents.

libraryContent.id

Y

The id of the library content this newscenter document represents .

libraryContent.versionId

Y

The versionId of the library content this newscenter document represents.

contentProfileId

Y

The content profile id that the content is located in (or the action took place from).

pages

N

In cases where the pages of a document are interacted with this is the list of those pages.

{
    "content": [{
        "repository": "newscenter",
        "name": "sample file",
        "type": "file",
        "libraryContent": {
            "id": "a5d85988-17f4-4994-82db-1ea46886046a",
            "versionId": "c9d85988-17f4-4994-82db-1ea46886046a",
            "teamsiteId": "1"
        },
        "contentProfileId": "60839af0-ca44-495a-8112-ae31d560b2b9"
    }]
}

Library

Represents all content in the content manager or control center library

Field

Is Required?

Description

repository

Y

library

id

Y

The id of the library content.

name

Y

The name of the document.

type

Y

The content type.

teamsiteId

Y

The teamsiteId of the library content.

versionId

Y

The versionId of the library content. Not required for folder content.

pages

N

In cases where the pages of a document are interacted with this is the list of those pages.

{
    "content": [{
        "repository": "library",
        "name": "sample file",
        "type": "file",
        "id": "a5d85988-17f4-4994-82db-1ea46886046a",
        "versionId": "c9d85988-17f4-4994-82db-1ea46886046a",
        "teamsiteId": "1"
    }]
}

Workspace

Represents all content in workspace and document cart

Field

Is Required?

Description

repository

Y

workspace

id

Y

The id of the workspace content.

name

Y

The name of the document.

type

Y

The content type.

versionId

Y

The versionId of the workspace content. Not required for folder content.

quickAccessPath

N

If this file is accessed via a quick access path such as "recents".

pages

N

In cases where the pages of a document are interacted with this is the list of those pages.

{
    "content": [{
        "repository": "workspace",
        "name": "sample file",
        "type": "file",
        "id": "a5d85988-17f4-4994-82db-1ea46886046a",
        "versionId": "c9d85988-17f4-4994-82db-1ea46886046a"
    }]
}

Generated LiveDocs

Represents all generated livedocs (particularly those that have never been saved to cart or workspace)

Field

Is Required?

Description

repository

Y

generatedlivedocs

id

Y

The id of the generated livedoc.

name

Y

The name of the generated document (not the name of the original library document).

pages

N

In cases where the pages of a document are interacted with this is the list of those pages.

{
    "content": [{
        "repository": "generatedlivedocs",
        "name": "sample file",
        "id": "a5d85988-17f4-4994-82db-1ea46886046a"
    }]
}