Module alfresco

ballerinax/alfresco Ballerina library

2.0.0

Overview

Alfresco is a modern, open-source content management platform that enables organizations to manage enterprise documents, digital assets, and records with efficiency and control. Known for its scalability and compliance-ready architecture, Alfresco provides powerful capabilities such as document storage, versioning, collaboration, workflow automation, and access control. It is widely used across industries to centralize content operations, streamline business processes, and support digital transformation initiatives.

The ballerinax/alfresco connector offers APIs to connect and interact with the Alfresco endpoints, specifically based on the Alfresco REST API Version 1. This connector allows Ballerina applications to perform core content operations such as uploading and downloading files, managing nodes and folders, setting metadata, and handling permissions. By using the Ballerina Alfresco Connector, developers can easily integrate content services into their workflows and build automation solutions that leverage the full capabilities of the Alfresco platform.

Setup guide

Before using this connector in your Ballerina application, complete the following:

Create an Alfresco Account.
Once registered, you will receive an email with instructions to set up your Alfresco environment, including the default username and password. Use these credentials to access the Alfresco Content Services API.
Note: This connector only supports Basic Authentication (username/password) and does not require or support bearer tokens.

Quickstart

To use the Alfresco connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

First, import the ballerinax/alfresco module into the Ballerina project.


import ballerinax/alfresco;

Step 2: Create a new connector instance

Create a alfresco:ConnectionConfig using the Basic Authentication credentials (i.e: username and password), and initialize the connector with it.


configurable string username = ?;
configurable string password = ?;
configurable string serviceURL = ?;

alfresco:ConnectionConfig alfrescoConfig = {
    auth: {
        username,
        password
    }
};
alfresco:Client alfresco = check new (alfrescoConfig, serviceURL);

Step 3: Invoke connector operation

Now you can use the operations available within the connector. Note that they are in the form of remote operations.

Following is an example on how to get list of comments in a particular node.


public function main() returns error? {
    alfresco:CommentPaging response = check alfresco->listComments(nodeId);
    log:printInfo(response.toString());
}

Step 4: Run the Ballerina application

Use the command below to run the Ballerina application


bal run

Examples

The ballerinax/alfresco connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

Upload a Document - Create a new file in Alfresco and upload content to it under a specific folder or path.
Download a Document - Retrieve a document stored in Alfresco.

Clients

alfresco: Client

Isolated

Core API

Provides access to the core features of Alfresco Content Services.

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string - URL of the target service

listComments

Isolated FunctionRemote Function

function listComments(string nodeId, map<string|string[]> headers, *ListCommentsQueries queries) returns CommentPaging|error

List comments

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListCommentsQueries - Queries to be sent with the request

Return Type

CommentPaging|error - Successful response

createComment

Isolated FunctionRemote Function

function createComment(string nodeId, CommentBody payload, map<string|string[]> headers, *CreateCommentQueries queries) returns CommentEntry|error

Create a comment

Parameters

nodeId string - The identifier of a node

payload CommentBody - The comment text. Note that you can also provide a list of comments

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateCommentQueries - Queries to be sent with the request

Return Type

CommentEntry|error - Successful response

updateComment

Isolated FunctionRemote Function

function updateComment(string nodeId, string commentId, CommentBody payload, map<string|string[]> headers, *UpdateCommentQueries queries) returns CommentEntry|error

Update a comment

Parameters

nodeId string - The identifier of a node

commentId string - The identifier of a comment

payload CommentBody - The JSON representing the comment to be updated

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateCommentQueries - Queries to be sent with the request

Return Type

CommentEntry|error - Successful response

deleteComment

Isolated FunctionRemote Function

function deleteComment(string nodeId, string commentId, map<string|string[]> headers) returns error?

Delete a comment

Parameters

nodeId string - The identifier of a node

commentId string - The identifier of a comment

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listRatings

Isolated FunctionRemote Function

function listRatings(string nodeId, map<string|string[]> headers, *ListRatingsQueries queries) returns RatingPaging|error

List ratings

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListRatingsQueries - Queries to be sent with the request

Return Type

RatingPaging|error - Successful response

createRating

Isolated FunctionRemote Function

function createRating(string nodeId, RatingBody payload, map<string|string[]> headers, *CreateRatingQueries queries) returns RatingEntry|error

Create a rating

Parameters

nodeId string - The identifier of a node

payload RatingBody - For "myRating" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateRatingQueries - Queries to be sent with the request

Return Type

RatingEntry|error - Successful response

getRating

Isolated FunctionRemote Function

function getRating(string nodeId, string ratingId, map<string|string[]> headers, *GetRatingQueries queries) returns RatingEntry|error

Get a rating

Parameters

nodeId string - The identifier of a node

ratingId string - The identifier of a rating

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetRatingQueries - Queries to be sent with the request

Return Type

RatingEntry|error - Successful response

deleteRating

Isolated FunctionRemote Function

function deleteRating(string nodeId, string ratingId, map<string|string[]> headers) returns error?

Delete a rating

Parameters

nodeId string - The identifier of a node

ratingId string - The identifier of a rating

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listTagsForNode

Isolated FunctionRemote Function

function listTagsForNode(string nodeId, map<string|string[]> headers, *ListTagsForNodeQueries queries) returns TagPaging|error

List tags for a node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListTagsForNodeQueries - Queries to be sent with the request

Return Type

TagPaging|error - Successful response

createTagForNode

Isolated FunctionRemote Function

function createTagForNode(string nodeId, TagBody payload, map<string|string[]> headers, *CreateTagForNodeQueries queries) returns TagEntry|error

Create a tag for a node

Parameters

nodeId string - The identifier of a node

payload TagBody - The new tag

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateTagForNodeQueries - Queries to be sent with the request

Return Type

TagEntry|error - Successful response

deleteTagFromNode

Isolated FunctionRemote Function

function deleteTagFromNode(string nodeId, string tagId, map<string|string[]> headers) returns error?

Delete a tag from a node

Parameters

nodeId string - The identifier of a node

tagId string - The identifier of a tag

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

getNode

Isolated FunctionRemote Function

function getNode(string nodeId, map<string|string[]> headers, *GetNodeQueries queries) returns NodeEntry|error

Get a node

Parameters

nodeId string - The identifier of a node. You can also use one of these well-known aliases:
- -my-
- -shared-
- -root-

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

updateNode

Isolated FunctionRemote Function

function updateNode(string nodeId, NodeBodyUpdate payload, map<string|string[]> headers, *UpdateNodeQueries queries) returns NodeEntry|error

Update a node

Parameters

nodeId string - The identifier of a node

payload NodeBodyUpdate - The node information to update

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

deleteNode

Isolated FunctionRemote Function

function deleteNode(string nodeId, map<string|string[]> headers, *DeleteNodeQueries queries) returns error?

Delete a node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DeleteNodeQueries - Queries to be sent with the request

Return Type

error? - Successful response

listNodeChildren

Isolated FunctionRemote Function

function listNodeChildren(string nodeId, map<string|string[]> headers, *ListNodeChildrenQueries queries) returns NodeChildAssociationPaging|error

List node children

Parameters

nodeId string - The identifier of a node. You can also use one of these well-known aliases:
- -my-
- -shared-
- -root-

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListNodeChildrenQueries - Queries to be sent with the request

Return Type

NodeChildAssociationPaging|error - Successful response

createNode

Isolated FunctionRemote Function

function createNode(string nodeId, NodeBodyCreate payload, map<string|string[]> headers, *CreateNodeQueries queries) returns NodeEntry|error

Create a node

Parameters

nodeId string - The identifier of a node. You can also use one of these well-known aliases:
- -my-
- -shared-
- -root-

payload NodeBodyCreate - The node information to create

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

copyNode

Isolated FunctionRemote Function

function copyNode(string nodeId, NodeBodyCopy payload, map<string|string[]> headers, *CopyNodeQueries queries) returns NodeEntry|error

Copy a node

Parameters

nodeId string - The identifier of a node

payload NodeBodyCopy - The targetParentId and, optionally, a new name which should include the file extension

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CopyNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

lockNode

Isolated FunctionRemote Function

function lockNode(string nodeId, NodeBodyLock payload, map<string|string[]> headers, *LockNodeQueries queries) returns NodeEntry|error

Lock a node

Parameters

nodeId string - The identifier of a node

payload NodeBodyLock - Lock details

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *LockNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

unlockNode

Isolated FunctionRemote Function

function unlockNode(string nodeId, map<string|string[]> headers, *UnlockNodeQueries queries) returns NodeEntry|error

Unlock a node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UnlockNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

moveNode

Isolated FunctionRemote Function

function moveNode(string nodeId, NodeBodyMove payload, map<string|string[]> headers, *MoveNodeQueries queries) returns NodeEntry|error

Move a node

Parameters

nodeId string - The identifier of a node

payload NodeBodyMove - The targetParentId and, optionally, a new name which should include the file extension

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *MoveNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

getNodeContent

Isolated FunctionRemote Function

function getNodeContent(string nodeId, GetNodeContentHeaders headers, *GetNodeContentQueries queries) returns byte[]|error?

Get node content

Parameters

nodeId string - The identifier of a node

headers GetNodeContentHeaders (default {}) - Headers to be sent with the request

queries *GetNodeContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

updateNodeContent

Isolated FunctionRemote Function

function updateNodeContent(string nodeId, byte[] payload, map<string|string[]> headers, *UpdateNodeContentQueries queries) returns NodeEntry|error

Update node content

Parameters

nodeId string - The identifier of a node

payload byte[] - The binary content

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateNodeContentQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

listRenditions

Isolated FunctionRemote Function

function listRenditions(string nodeId, map<string|string[]> headers, *ListRenditionsQueries queries) returns RenditionPaging|error

List renditions

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListRenditionsQueries - Queries to be sent with the request

Return Type

RenditionPaging|error - Successful response

createRendition

Isolated FunctionRemote Function

function createRendition(string nodeId, RenditionBodyCreate payload, map<string|string[]> headers) returns error?

Create rendition

Parameters

nodeId string - The identifier of a node

payload RenditionBodyCreate - The rendition "id"

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Request accepted

getRendition

Isolated FunctionRemote Function

function getRendition(string nodeId, string renditionId, map<string|string[]> headers) returns RenditionEntry|error

Get rendition information

Parameters

nodeId string - The identifier of a node

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RenditionEntry|error - Successful response

getRenditionContent

Isolated FunctionRemote Function

function getRenditionContent(string nodeId, string renditionId, GetRenditionContentHeaders headers, *GetRenditionContentQueries queries) returns byte[]|error?

Get rendition content

Parameters

nodeId string - The identifier of a node

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers GetRenditionContentHeaders (default {}) - Headers to be sent with the request

queries *GetRenditionContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

listSecondaryChildren

Isolated FunctionRemote Function

function listSecondaryChildren(string nodeId, map<string|string[]> headers, *ListSecondaryChildrenQueries queries) returns NodeChildAssociationPaging|error

List secondary children

Parameters

nodeId string - The identifier of a parent node. You can also use one of these well-known aliases:
- -my-
- -shared-
- -root-

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSecondaryChildrenQueries - Queries to be sent with the request

Return Type

NodeChildAssociationPaging|error - Successful response

createSecondaryChildAssociation

Isolated FunctionRemote Function

function createSecondaryChildAssociation(string nodeId, ChildAssociationBody payload, map<string|string[]> headers, *CreateSecondaryChildAssociationQueries queries) returns ChildAssociationEntry|error

Create secondary child

Parameters

nodeId string - The identifier of a parent node

payload ChildAssociationBody - The child node id and assoc type

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateSecondaryChildAssociationQueries - Queries to be sent with the request

Return Type

ChildAssociationEntry|error - Successful response

deleteSecondaryChildAssociation

Isolated FunctionRemote Function

function deleteSecondaryChildAssociation(string nodeId, string childId, map<string|string[]> headers, *DeleteSecondaryChildAssociationQueries queries) returns error?

Delete secondary child or children

Parameters

nodeId string - The identifier of a parent node

childId string - The identifier of a child node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DeleteSecondaryChildAssociationQueries - Queries to be sent with the request

Return Type

error? - Successful response

listParents

Isolated FunctionRemote Function

function listParents(string nodeId, map<string|string[]> headers, *ListParentsQueries queries) returns NodeAssociationPaging|error

List parents

Parameters

nodeId string - The identifier of a child node. You can also use one of these well-known aliases:
- -my-
- -shared-
- -root-

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListParentsQueries - Queries to be sent with the request

Return Type

NodeAssociationPaging|error - Successful response

listTargetAssociations

Isolated FunctionRemote Function

function listTargetAssociations(string nodeId, map<string|string[]> headers, *ListTargetAssociationsQueries queries) returns NodeAssociationPaging|error

List target associations

Parameters

nodeId string - The identifier of a source node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListTargetAssociationsQueries - Queries to be sent with the request

Return Type

NodeAssociationPaging|error - Successful response

createAssociation

Isolated FunctionRemote Function

function createAssociation(string nodeId, AssociationBody payload, map<string|string[]> headers, *CreateAssociationQueries queries) returns AssociationEntry|error

Create node association

Parameters

nodeId string - The identifier of a source node

payload AssociationBody - The target node id and assoc type

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateAssociationQueries - Queries to be sent with the request

Return Type

AssociationEntry|error - Successful response

deleteAssociation

Isolated FunctionRemote Function

function deleteAssociation(string nodeId, string targetId, map<string|string[]> headers, *DeleteAssociationQueries queries) returns error?

Delete node association(s)

Parameters

nodeId string - The identifier of a source node

targetId string - The identifier of a target node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DeleteAssociationQueries - Queries to be sent with the request

Return Type

error? - Successful response

listSourceAssociations

Isolated FunctionRemote Function

function listSourceAssociations(string nodeId, map<string|string[]> headers, *ListSourceAssociationsQueries queries) returns NodeAssociationPaging|error

List source associations

Parameters

nodeId string - The identifier of a target node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSourceAssociationsQueries - Queries to be sent with the request

Return Type

NodeAssociationPaging|error - Successful response

listVersionHistory

Isolated FunctionRemote Function

function listVersionHistory(string nodeId, map<string|string[]> headers, *ListVersionHistoryQueries queries) returns VersionPaging|error

List version history

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListVersionHistoryQueries - Queries to be sent with the request

Return Type

VersionPaging|error - Successful response

getVersion

Isolated FunctionRemote Function

function getVersion(string nodeId, string versionId, map<string|string[]> headers) returns VersionEntry|error

Get version information

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

VersionEntry|error - Successful response

deleteVersion

Isolated FunctionRemote Function

function deleteVersion(string nodeId, string versionId, map<string|string[]> headers) returns error?

Delete a version

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

getVersionContent

Isolated FunctionRemote Function

function getVersionContent(string nodeId, string versionId, GetVersionContentHeaders headers, *GetVersionContentQueries queries) returns byte[]|error?

Get version content

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

headers GetVersionContentHeaders (default {}) - Headers to be sent with the request

queries *GetVersionContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

revertVersion

Isolated FunctionRemote Function

function revertVersion(string nodeId, string versionId, RevertBody payload, map<string|string[]> headers, *RevertVersionQueries queries) returns VersionEntry|error

Revert a version

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

payload RevertBody - Optionally, specify a version comment and whether this should be a major version, or not

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *RevertVersionQueries - Queries to be sent with the request

Return Type

VersionEntry|error - Successful response

listVersionRenditions

Isolated FunctionRemote Function

function listVersionRenditions(string nodeId, string versionId, map<string|string[]> headers, *ListVersionRenditionsQueries queries) returns RenditionPaging|error

List renditions for a file version

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListVersionRenditionsQueries - Queries to be sent with the request

Return Type

RenditionPaging|error - Successful response

createVersionRendition

Isolated FunctionRemote Function

function createVersionRendition(string nodeId, string versionId, RenditionBodyCreate payload, map<string|string[]> headers) returns error?

Create rendition for a file version

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

payload RenditionBodyCreate - The rendition "id"

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Request accepted

getVersionRendition

Isolated FunctionRemote Function

function getVersionRendition(string nodeId, string versionId, string renditionId, map<string|string[]> headers) returns RenditionEntry|error

Get rendition information for a file version

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RenditionEntry|error - Successful response

getVersionRenditionContent

Isolated FunctionRemote Function

function getVersionRenditionContent(string nodeId, string versionId, string renditionId, GetVersionRenditionContentHeaders headers, *GetVersionRenditionContentQueries queries) returns byte[]|error?

Get rendition content for a file version

Parameters

nodeId string - The identifier of a node

versionId string - The identifier of a version, ie. version label, within the version history of a node

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers GetVersionRenditionContentHeaders (default {}) - Headers to be sent with the request

queries *GetVersionRenditionContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

nodeActions

Isolated FunctionRemote Function

function nodeActions(string nodeId, map<string|string[]> headers, *NodeActionsQueries queries) returns ActionDefinitionList|error

Retrieve actions for a node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *NodeActionsQueries - Queries to be sent with the request

Return Type

ActionDefinitionList|error - Unexpected error

listDeletedNodes

Isolated FunctionRemote Function

function listDeletedNodes(map<string|string[]> headers, *ListDeletedNodesQueries queries) returns DeletedNodesPaging|error

List deleted nodes

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListDeletedNodesQueries - Queries to be sent with the request

Return Type

DeletedNodesPaging|error - Successful response

getDeletedNode

Isolated FunctionRemote Function

function getDeletedNode(string nodeId, map<string|string[]> headers, *GetDeletedNodeQueries queries) returns DeletedNodeEntry|error

Get a deleted node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDeletedNodeQueries - Queries to be sent with the request

Return Type

DeletedNodeEntry|error - Successful response

deleteDeletedNode

Isolated FunctionRemote Function

function deleteDeletedNode(string nodeId, map<string|string[]> headers) returns error?

Permanently delete a deleted node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

getDeletedNodeContent

Isolated FunctionRemote Function

function getDeletedNodeContent(string nodeId, GetDeletedNodeContentHeaders headers, *GetDeletedNodeContentQueries queries) returns byte[]|error?

Get deleted node content

Parameters

nodeId string - The identifier of a node

headers GetDeletedNodeContentHeaders (default {}) - Headers to be sent with the request

queries *GetDeletedNodeContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

restoreDeletedNode

Isolated FunctionRemote Function

function restoreDeletedNode(string nodeId, DeletedNodeBodyRestore payload, map<string|string[]> headers, *RestoreDeletedNodeQueries queries) returns NodeEntry|error

Restore a deleted node

Parameters

nodeId string - The identifier of a node

payload DeletedNodeBodyRestore - The targetParentId if the node is restored to a new location

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *RestoreDeletedNodeQueries - Queries to be sent with the request

Return Type

NodeEntry|error - Successful response

listDeletedNodeRenditions

Isolated FunctionRemote Function

function listDeletedNodeRenditions(string nodeId, map<string|string[]> headers, *ListDeletedNodeRenditionsQueries queries) returns RenditionPaging|error

List renditions for a deleted node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListDeletedNodeRenditionsQueries - Queries to be sent with the request

Return Type

RenditionPaging|error - Successful response

getArchivedNodeRendition

Isolated FunctionRemote Function

function getArchivedNodeRendition(string nodeId, string renditionId, map<string|string[]> headers) returns RenditionEntry|error

Get rendition information for a deleted node

Parameters

nodeId string - The identifier of a node

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RenditionEntry|error - Successful response

getArchivedNodeRenditionContent

Isolated FunctionRemote Function

function getArchivedNodeRenditionContent(string nodeId, string renditionId, GetArchivedNodeRenditionContentHeaders headers, *GetArchivedNodeRenditionContentQueries queries) returns byte[]|error?

Get rendition content of a deleted node

Parameters

nodeId string - The identifier of a node

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers GetArchivedNodeRenditionContentHeaders (default {}) - Headers to be sent with the request

queries *GetArchivedNodeRenditionContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

createDownload

Isolated FunctionRemote Function

function createDownload(DownloadBodyCreate payload, map<string|string[]> headers, *CreateDownloadQueries queries) returns DownloadEntry|error

Create a new download

Parameters

payload DownloadBodyCreate - The nodeIds the content of which will be zipped, which zip will be set as the content of our download node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDownloadQueries - Queries to be sent with the request

Return Type

DownloadEntry|error - The request to create a download node was accepted

getDownload

Isolated FunctionRemote Function

function getDownload(string downloadId, map<string|string[]> headers, *GetDownloadQueries queries) returns DownloadEntry|error

Get a download

Parameters

downloadId string - The identifier of a download node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetDownloadQueries - Queries to be sent with the request

Return Type

DownloadEntry|error - Download node information

cancelDownload

Isolated FunctionRemote Function

function cancelDownload(string downloadId, map<string|string[]> headers) returns error?

Cancel a download

Parameters

downloadId string - The identifier of a download node

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - The request to cancel a download was accepted

listPeople

Isolated FunctionRemote Function

function listPeople(map<string|string[]> headers, *ListPeopleQueries queries) returns PersonPaging|error

List people

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPeopleQueries - Queries to be sent with the request

Return Type

PersonPaging|error - Successful response

createPerson

Isolated FunctionRemote Function

function createPerson(PersonBodyCreate payload, map<string|string[]> headers, *CreatePersonQueries queries) returns PersonEntry|error

Create person

Parameters

payload PersonBodyCreate - The person details

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreatePersonQueries - Queries to be sent with the request

Return Type

PersonEntry|error - Successful response

getPerson

Isolated FunctionRemote Function

function getPerson(string personId, map<string|string[]> headers, *GetPersonQueries queries) returns PersonEntry|error

Get a person

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPersonQueries - Queries to be sent with the request

Return Type

PersonEntry|error - Successful response

updatePerson

Isolated FunctionRemote Function

function updatePerson(string personId, PersonBodyUpdate payload, map<string|string[]> headers, *UpdatePersonQueries queries) returns PersonEntry|error

Update person

Parameters

personId string - The identifier of a person

payload PersonBodyUpdate - The person details

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdatePersonQueries - Queries to be sent with the request

Return Type

PersonEntry|error - Successful response

listActivitiesForPerson

Isolated FunctionRemote Function

function listActivitiesForPerson(string personId, map<string|string[]> headers, *ListActivitiesForPersonQueries queries) returns ActivityPaging|error

List activities

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListActivitiesForPersonQueries - Queries to be sent with the request

Return Type

ActivityPaging|error - Successful response

listFavoriteSitesForPerson

DeprecatedIsolated FunctionRemote Function

function listFavoriteSitesForPerson(string personId, map<string|string[]> headers, *ListFavoriteSitesForPersonQueries queries) returns SitePaging|error

List favorite sites

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListFavoriteSitesForPersonQueries - Queries to be sent with the request

Return Type

SitePaging|error - Successful response

Deprecated

createSiteFavorite

DeprecatedIsolated FunctionRemote Function

function createSiteFavorite(string personId, FavoriteSiteBodyCreate payload, map<string|string[]> headers, *CreateSiteFavoriteQueries queries) returns FavoriteSiteEntry|error

Create a site favorite

Parameters

personId string - The identifier of a person

payload FavoriteSiteBodyCreate - The id of the site to favorite

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateSiteFavoriteQueries - Queries to be sent with the request

Return Type

FavoriteSiteEntry|error - Successful response

Deprecated

getFavoriteSite

DeprecatedIsolated FunctionRemote Function

function getFavoriteSite(string personId, string siteId, map<string|string[]> headers, *GetFavoriteSiteQueries queries) returns SiteEntry|error

Get a favorite site

Parameters

personId string - The identifier of a person

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetFavoriteSiteQueries - Queries to be sent with the request

Return Type

SiteEntry|error - Successful response

Deprecated

deleteSiteFavorite

DeprecatedIsolated FunctionRemote Function

function deleteSiteFavorite(string personId, string siteId, map<string|string[]> headers) returns error?

Delete a site favorite

Parameters

personId string - The identifier of a person

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

Deprecated

listFavorites

Isolated FunctionRemote Function

function listFavorites(string personId, map<string|string[]> headers, *ListFavoritesQueries queries) returns FavoritePaging|error

List favorites

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListFavoritesQueries - Queries to be sent with the request

Return Type

FavoritePaging|error - Successful response

createFavorite

Isolated FunctionRemote Function

function createFavorite(string personId, FavoriteBodyCreate payload, map<string|string[]> headers, *CreateFavoriteQueries queries) returns FavoriteEntry|error

Create a favorite

Parameters

personId string - The identifier of a person

payload FavoriteBodyCreate - An object identifying the entity to be favorited

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateFavoriteQueries - Queries to be sent with the request

Return Type

FavoriteEntry|error - Successful response

getFavorite

Isolated FunctionRemote Function

function getFavorite(string personId, string favoriteId, map<string|string[]> headers, *GetFavoriteQueries queries) returns FavoriteEntry|error

Get a favorite

Parameters

personId string - The identifier of a person

favoriteId string - The identifier of a favorite

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetFavoriteQueries - Queries to be sent with the request

Return Type

FavoriteEntry|error - Successful response

deleteFavorite

Isolated FunctionRemote Function

function deleteFavorite(string personId, string favoriteId, map<string|string[]> headers) returns error?

Delete a favorite

Parameters

personId string - The identifier of a person

favoriteId string - The identifier of a favorite

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listNetworksForPerson

Isolated FunctionRemote Function

function listNetworksForPerson(string personId, map<string|string[]> headers, *ListNetworksForPersonQueries queries) returns PersonNetworkPaging|error

List network membership

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListNetworksForPersonQueries - Queries to be sent with the request

Return Type

PersonNetworkPaging|error - Successful response

getNetworkForPerson

Isolated FunctionRemote Function

function getNetworkForPerson(string personId, string networkId, map<string|string[]> headers, *GetNetworkForPersonQueries queries) returns PersonNetworkEntry|error

Get network information

Parameters

personId string - The identifier of a person

networkId string - The identifier of a network

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetNetworkForPersonQueries - Queries to be sent with the request

Return Type

PersonNetworkEntry|error - Successful response

listPreferences

Isolated FunctionRemote Function

function listPreferences(string personId, map<string|string[]> headers, *ListPreferencesQueries queries) returns PreferencePaging|error

List preferences

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPreferencesQueries - Queries to be sent with the request

Return Type

PreferencePaging|error - Successful response

getPreference

Isolated FunctionRemote Function

function getPreference(string personId, string preferenceName, map<string|string[]> headers, *GetPreferenceQueries queries) returns PreferenceEntry|error

Get a preference

Parameters

personId string - The identifier of a person

preferenceName string - The name of the preference

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPreferenceQueries - Queries to be sent with the request

Return Type

PreferenceEntry|error - Successful response

listSiteMembershipRequestsForPerson

Isolated FunctionRemote Function

function listSiteMembershipRequestsForPerson(string personId, map<string|string[]> headers, *ListSiteMembershipRequestsForPersonQueries queries) returns SiteMembershipRequestPaging|error

List site membership requests

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSiteMembershipRequestsForPersonQueries - Queries to be sent with the request

Return Type

SiteMembershipRequestPaging|error - Successful response

createSiteMembershipRequestForPerson

Isolated FunctionRemote Function

function createSiteMembershipRequestForPerson(string personId, SiteMembershipRequestBodyCreate payload, map<string|string[]> headers, *CreateSiteMembershipRequestForPersonQueries queries) returns SiteMembershipRequestEntry|error

Create a site membership request

Parameters

personId string - The identifier of a person

payload SiteMembershipRequestBodyCreate - Site membership request details

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateSiteMembershipRequestForPersonQueries - Queries to be sent with the request

Return Type

SiteMembershipRequestEntry|error - Successful response

getSiteMembershipRequestForPerson

Isolated FunctionRemote Function

function getSiteMembershipRequestForPerson(string personId, string siteId, map<string|string[]> headers, *GetSiteMembershipRequestForPersonQueries queries) returns SiteMembershipRequestEntry|error

Get a site membership request

Parameters

personId string - The identifier of a person

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSiteMembershipRequestForPersonQueries - Queries to be sent with the request

Return Type

SiteMembershipRequestEntry|error - Successful response

updateSiteMembershipRequestForPerson

Isolated FunctionRemote Function

function updateSiteMembershipRequestForPerson(string personId, string siteId, SiteMembershipRequestBodyUpdate payload, map<string|string[]> headers, *UpdateSiteMembershipRequestForPersonQueries queries) returns SiteMembershipRequestEntry|error

Update a site membership request

Parameters

personId string - The identifier of a person

siteId string - The identifier of a site

payload SiteMembershipRequestBodyUpdate - The new message to display

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateSiteMembershipRequestForPersonQueries - Queries to be sent with the request

Return Type

SiteMembershipRequestEntry|error - Successful response

deleteSiteMembershipRequestForPerson

Isolated FunctionRemote Function

function deleteSiteMembershipRequestForPerson(string personId, string siteId, map<string|string[]> headers) returns error?

Delete a site membership request

Parameters

personId string - The identifier of a person

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listSiteMembershipsForPerson

Isolated FunctionRemote Function

function listSiteMembershipsForPerson(string personId, map<string|string[]> headers, *ListSiteMembershipsForPersonQueries queries) returns SiteRolePaging|error

List site memberships

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSiteMembershipsForPersonQueries - Queries to be sent with the request

Return Type

SiteRolePaging|error - Successful response

getSiteMembershipForPerson

Isolated FunctionRemote Function

function getSiteMembershipForPerson(string personId, string siteId, map<string|string[]> headers) returns SiteRoleEntry|error

Get a site membership

Parameters

personId string - The identifier of a person

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SiteRoleEntry|error - Successful response

deleteSiteMembershipForPerson

Isolated FunctionRemote Function

function deleteSiteMembershipForPerson(string personId, string siteId, map<string|string[]> headers) returns error?

Delete a site membership

Parameters

personId string - The identifier of a person

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listGroupMembershipsForPerson

Isolated FunctionRemote Function

function listGroupMembershipsForPerson(string personId, map<string|string[]> headers, *ListGroupMembershipsForPersonQueries queries) returns GroupPaging|error

List group memberships

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListGroupMembershipsForPersonQueries - Queries to be sent with the request

Return Type

GroupPaging|error - Successful response

requestPasswordReset

Isolated FunctionRemote Function

function requestPasswordReset(string personId, ClientBody payload, map<string|string[]> headers) returns error?

Request password reset

Parameters

personId string - The identifier of a person

payload ClientBody - The client name to send email with app-specific url

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response or even when the personId does not exist or the user is disabled by an Administrator

resetPassword

Isolated FunctionRemote Function

function resetPassword(string personId, PasswordResetBody payload, map<string|string[]> headers) returns error?

Reset password

Parameters

personId string - The identifier of a person

payload PasswordResetBody - The reset password details

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response or even when no workflow instance is found with the given id or the workflow instance is invalid (already been used or expired) or the given personId does not match the person's id requesting the password reset or the given workflow key does not match the recovered key

getAvatarImage

Isolated FunctionRemote Function

function getAvatarImage(string personId, GetAvatarImageHeaders headers, *GetAvatarImageQueries queries) returns byte[]|error

Get avatar image

Parameters

personId string - The identifier of a person

headers GetAvatarImageHeaders (default {}) - Headers to be sent with the request

queries *GetAvatarImageQueries - Queries to be sent with the request

Return Type

byte[]|error - Successful response

updateAvatarImage

Isolated FunctionRemote Function

function updateAvatarImage(string personId, byte[] payload, map<string|string[]> headers) returns error?

Update avatar image

Parameters

personId string - The identifier of a person

payload byte[] - The binary content

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

deleteAvatarImage

Isolated FunctionRemote Function

function deleteAvatarImage(string personId, map<string|string[]> headers) returns error?

Delete avatar image

Parameters

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listSites

Isolated FunctionRemote Function

function listSites(map<string|string[]> headers, *ListSitesQueries queries) returns SitePaging|error

List sites

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSitesQueries - Queries to be sent with the request

Return Type

SitePaging|error - Successful response

createSite

Isolated FunctionRemote Function

function createSite(SiteBodyCreate payload, map<string|string[]> headers, *CreateSiteQueries queries) returns SiteEntry|error

Create a site

Parameters

payload SiteBodyCreate - The site details

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateSiteQueries - Queries to be sent with the request

Return Type

SiteEntry|error - Successful response

getSite

Isolated FunctionRemote Function

function getSite(string siteId, map<string|string[]> headers, *GetSiteQueries queries) returns SiteEntry|error

Get a site

Parameters

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSiteQueries - Queries to be sent with the request

Return Type

SiteEntry|error - Successful response

updateSite

Isolated FunctionRemote Function

function updateSite(string siteId, SiteBodyUpdate payload, map<string|string[]> headers, *UpdateSiteQueries queries) returns SiteEntry|error

Update a site

Parameters

siteId string - The identifier of a site

payload SiteBodyUpdate - The site information to update

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateSiteQueries - Queries to be sent with the request

Return Type

SiteEntry|error - Successful response

deleteSite

Isolated FunctionRemote Function

function deleteSite(string siteId, map<string|string[]> headers, *DeleteSiteQueries queries) returns error?

Delete a site

Parameters

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DeleteSiteQueries - Queries to be sent with the request

Return Type

error? - Successful response

listSiteContainers

Isolated FunctionRemote Function

function listSiteContainers(string siteId, map<string|string[]> headers, *ListSiteContainersQueries queries) returns SiteContainerPaging|error

List site containers

Parameters

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSiteContainersQueries - Queries to be sent with the request

Return Type

SiteContainerPaging|error - Successful response

getSiteContainer

Isolated FunctionRemote Function

function getSiteContainer(string siteId, string containerId, map<string|string[]> headers, *GetSiteContainerQueries queries) returns SiteContainerEntry|error

Get a site container

Parameters

siteId string - The identifier of a site

containerId string - The unique identifier of a site container

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSiteContainerQueries - Queries to be sent with the request

Return Type

SiteContainerEntry|error - Successful response

getSiteMembershipRequests

Isolated FunctionRemote Function

function getSiteMembershipRequests(map<string|string[]> headers, *GetSiteMembershipRequestsQueries queries) returns SiteMembershipRequestWithPersonPaging|error

Get site membership requests

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSiteMembershipRequestsQueries - Queries to be sent with the request

Return Type

SiteMembershipRequestWithPersonPaging|error - Successful response

approveSiteMembershipRequest

Isolated FunctionRemote Function

function approveSiteMembershipRequest(string siteId, string inviteeId, SiteMembershipApprovalBody payload, map<string|string[]> headers) returns error?

Approve a site membership request

Parameters

siteId string - The identifier of a site

inviteeId string - The invitee user name

payload SiteMembershipApprovalBody - Accepting a request to join, optionally, allows assignment of a role to the user

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

rejectSiteMembershipRequest

Isolated FunctionRemote Function

function rejectSiteMembershipRequest(string siteId, string inviteeId, SiteMembershipRejectionBody payload, map<string|string[]> headers) returns error?

Reject a site membership request

Parameters

siteId string - The identifier of a site

inviteeId string - The invitee user name

payload SiteMembershipRejectionBody - Rejecting a request to join, optionally, allows the inclusion of comment

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listSiteMemberships

Isolated FunctionRemote Function

function listSiteMemberships(string siteId, map<string|string[]> headers, *ListSiteMembershipsQueries queries) returns SiteMemberPaging|error

List site memberships

Parameters

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSiteMembershipsQueries - Queries to be sent with the request

Return Type

SiteMemberPaging|error - Successful response

createSiteMembership

Isolated FunctionRemote Function

function createSiteMembership(string siteId, SiteMembershipBodyCreate payload, map<string|string[]> headers, *CreateSiteMembershipQueries queries) returns SiteMemberEntry|error

Create a site membership

Parameters

siteId string - The identifier of a site

payload SiteMembershipBodyCreate - The person to add and their role

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateSiteMembershipQueries - Queries to be sent with the request

Return Type

SiteMemberEntry|error - Successful response

getSiteMembership

Isolated FunctionRemote Function

function getSiteMembership(string siteId, string personId, map<string|string[]> headers, *GetSiteMembershipQueries queries) returns SiteMemberEntry|error

Get a site membership

Parameters

siteId string - The identifier of a site

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSiteMembershipQueries - Queries to be sent with the request

Return Type

SiteMemberEntry|error - Successful response

updateSiteMembership

Isolated FunctionRemote Function

function updateSiteMembership(string siteId, string personId, SiteMembershipBodyUpdate payload, map<string|string[]> headers, *UpdateSiteMembershipQueries queries) returns SiteMemberEntry|error

Update a site membership

Parameters

siteId string - The identifier of a site

personId string - The identifier of a person

payload SiteMembershipBodyUpdate - The persons new role

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateSiteMembershipQueries - Queries to be sent with the request

Return Type

SiteMemberEntry|error - Successful response

deleteSiteMembership

Isolated FunctionRemote Function

function deleteSiteMembership(string siteId, string personId, map<string|string[]> headers) returns error?

Delete a site membership

Parameters

siteId string - The identifier of a site

personId string - The identifier of a person

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listSiteGroups

Isolated FunctionRemote Function

function listSiteGroups(string siteId, map<string|string[]> headers, *ListSiteGroupsQueries queries) returns SiteGroupPaging|error

List group membership for site

Parameters

siteId string - The identifier of a site

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSiteGroupsQueries - Queries to be sent with the request

Return Type

SiteGroupPaging|error - Successful response

createSiteGroupMembership

Isolated FunctionRemote Function

function createSiteGroupMembership(string siteId, SiteMembershipBodyCreate payload, map<string|string[]> headers, *CreateSiteGroupMembershipQueries queries) returns SiteGroupEntry|error

Create a site membership for group

Parameters

siteId string - The identifier of a site

payload SiteMembershipBodyCreate - The group to add and their role

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateSiteGroupMembershipQueries - Queries to be sent with the request

Return Type

SiteGroupEntry|error - Successful response

getSiteGroupMembership

Isolated FunctionRemote Function

function getSiteGroupMembership(string siteId, string groupId, map<string|string[]> headers, *GetSiteGroupMembershipQueries queries) returns SiteGroupEntry|error

Get information about site membership of group

Parameters

siteId string - The identifier of a site

groupId string - The identifier of a group

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSiteGroupMembershipQueries - Queries to be sent with the request

Return Type

SiteGroupEntry|error - Successful response

updateSiteGroupMembership

Isolated FunctionRemote Function

function updateSiteGroupMembership(string siteId, string groupId, SiteMembershipBodyUpdate payload, map<string|string[]> headers, *UpdateSiteGroupMembershipQueries queries) returns SiteGroupEntry|error

Update site membership of group

Parameters

siteId string - The identifier of a site

groupId string - The identifier of a group

payload SiteMembershipBodyUpdate - The groupId new role

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateSiteGroupMembershipQueries - Queries to be sent with the request

Return Type

SiteGroupEntry|error - Successful response

deleteSiteGroupMembership

Isolated FunctionRemote Function

function deleteSiteGroupMembership(string siteId, string groupId, map<string|string[]> headers) returns error?

Delete a group membership for site

Parameters

siteId string - The identifier of a site

groupId string - The identifier of a group

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

Isolated FunctionRemote Function

function listTags(map<string|string[]> headers, *ListTagsQueries queries) returns TagPaging|error

List tags

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListTagsQueries - Queries to be sent with the request

Return Type

TagPaging|error - Successful response

getTag

Isolated FunctionRemote Function

function getTag(string tagId, map<string|string[]> headers, *GetTagQueries queries) returns TagEntry|error

Get a tag

Parameters

tagId string - The identifier of a tag

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetTagQueries - Queries to be sent with the request

Return Type

TagEntry|error - Successful response

updateTag

Isolated FunctionRemote Function

function updateTag(string tagId, TagBody payload, map<string|string[]> headers, *UpdateTagQueries queries) returns TagEntry|error

Update a tag

Parameters

tagId string - The identifier of a tag

payload TagBody - The updated tag

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateTagQueries - Queries to be sent with the request

Return Type

TagEntry|error - Successful response

getNetwork

Isolated FunctionRemote Function

function getNetwork(string networkId, map<string|string[]> headers, *GetNetworkQueries queries) returns PersonNetworkEntry|error

Get a network

Parameters

networkId string - The identifier of a network

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetNetworkQueries - Queries to be sent with the request

Return Type

PersonNetworkEntry|error - Successful response

listSharedLinks

Isolated FunctionRemote Function

function listSharedLinks(map<string|string[]> headers, *ListSharedLinksQueries queries) returns SharedLinkPaging|error

List shared links

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListSharedLinksQueries - Queries to be sent with the request

Return Type

SharedLinkPaging|error - Successful response

createSharedLink

Isolated FunctionRemote Function

function createSharedLink(SharedLinkBodyCreate payload, map<string|string[]> headers, *CreateSharedLinkQueries queries) returns SharedLinkEntry|error

Create a shared link to a file

Parameters

payload SharedLinkBodyCreate - The nodeId to create a shared link for

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateSharedLinkQueries - Queries to be sent with the request

Return Type

SharedLinkEntry|error - Successful response

getSharedLink

Isolated FunctionRemote Function

function getSharedLink(string sharedId, map<string|string[]> headers, *GetSharedLinkQueries queries) returns SharedLinkEntry|error

Get a shared link

Parameters

sharedId string - The identifier of a shared link to a file

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetSharedLinkQueries - Queries to be sent with the request

Return Type

SharedLinkEntry|error - Successful response

deleteSharedLink

Isolated FunctionRemote Function

function deleteSharedLink(string sharedId, map<string|string[]> headers) returns error?

Deletes a shared link

Parameters

sharedId string - The identifier of a shared link to a file

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

getSharedLinkContent

Isolated FunctionRemote Function

function getSharedLinkContent(string sharedId, GetSharedLinkContentHeaders headers, *GetSharedLinkContentQueries queries) returns byte[]|error?

Get shared link content

Parameters

sharedId string - The identifier of a shared link to a file

headers GetSharedLinkContentHeaders (default {}) - Headers to be sent with the request

queries *GetSharedLinkContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

listSharedLinkRenditions

Isolated FunctionRemote Function

function listSharedLinkRenditions(string sharedId, map<string|string[]> headers) returns RenditionPaging|error

List renditions for a shared link

Parameters

sharedId string - The identifier of a shared link to a file

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RenditionPaging|error - Successful response

getSharedLinkRendition

Isolated FunctionRemote Function

function getSharedLinkRendition(string sharedId, string renditionId, map<string|string[]> headers) returns RenditionEntry|error

Get shared link rendition information

Parameters

sharedId string - The identifier of a shared link to a file

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

RenditionEntry|error - Successful response

getSharedLinkRenditionContent

Isolated FunctionRemote Function

function getSharedLinkRenditionContent(string sharedId, string renditionId, GetSharedLinkRenditionContentHeaders headers, *GetSharedLinkRenditionContentQueries queries) returns byte[]|error?

Get shared link rendition content

Parameters

sharedId string - The identifier of a shared link to a file

renditionId string - The name of a thumbnail rendition, for example doclib, or pdf

headers GetSharedLinkRenditionContentHeaders (default {}) - Headers to be sent with the request

queries *GetSharedLinkRenditionContentQueries - Queries to be sent with the request

Return Type

byte[]|error? - Successful response

emailSharedLink

Isolated FunctionRemote Function

function emailSharedLink(string sharedId, SharedLinkBodyEmail payload, map<string|string[]> headers) returns error?

Email shared link

Parameters

sharedId string - The identifier of a shared link to a file

payload SharedLinkBodyEmail - The shared link email to send

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

getProbe

Isolated FunctionRemote Function

function getProbe(string probeId, map<string|string[]> headers) returns ProbeEntry|error

Check readiness and liveness of the repository

Parameters

probeId string - The name of the probe:
- -ready-
- -live-

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ProbeEntry|error - Successful response

findNodes

Isolated FunctionRemote Function

function findNodes(map<string|string[]> headers, *FindNodesQueries queries) returns NodePaging|error

Find nodes

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *FindNodesQueries - Queries to be sent with the request

Return Type

NodePaging|error - Successful response

findSites

Isolated FunctionRemote Function

function findSites(map<string|string[]> headers, *FindSitesQueries queries) returns SitePaging|error

Find sites

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *FindSitesQueries - Queries to be sent with the request

Return Type

SitePaging|error - Successful response

findPeople

Isolated FunctionRemote Function

function findPeople(map<string|string[]> headers, *FindPeopleQueries queries) returns PersonPaging|error

Find people

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *FindPeopleQueries - Queries to be sent with the request

Return Type

PersonPaging|error - Successful response

listGroups

Isolated FunctionRemote Function

function listGroups(map<string|string[]> headers, *ListGroupsQueries queries) returns GroupPaging|error

List groups

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListGroupsQueries - Queries to be sent with the request

Return Type

GroupPaging|error - Successful response

createGroup

Isolated FunctionRemote Function

function createGroup(GroupBodyCreate payload, map<string|string[]> headers, *CreateGroupQueries queries) returns GroupEntry|error

Create a group

Parameters

payload GroupBodyCreate - The group to create

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateGroupQueries - Queries to be sent with the request

Return Type

GroupEntry|error - Successful response

getGroup

Isolated FunctionRemote Function

function getGroup(string groupId, map<string|string[]> headers, *GetGroupQueries queries) returns GroupEntry|error

Get group details

Parameters

groupId string - The identifier of a group

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetGroupQueries - Queries to be sent with the request

Return Type

GroupEntry|error - Successful response

updateGroup

Isolated FunctionRemote Function

function updateGroup(string groupId, GroupBodyUpdate payload, map<string|string[]> headers, *UpdateGroupQueries queries) returns GroupEntry|error

Update group details

Parameters

groupId string - The identifier of a group

payload GroupBodyUpdate - The group information to update

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateGroupQueries - Queries to be sent with the request

Return Type

GroupEntry|error - Successful response

deleteGroup

Isolated FunctionRemote Function

function deleteGroup(string groupId, map<string|string[]> headers, *DeleteGroupQueries queries) returns error?

Delete a group

Parameters

groupId string - The identifier of a group

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DeleteGroupQueries - Queries to be sent with the request

Return Type

error? - Successful response

listGroupMemberships

Isolated FunctionRemote Function

function listGroupMemberships(string groupId, map<string|string[]> headers, *ListGroupMembershipsQueries queries) returns GroupMemberPaging|error

List memberships of a group

Parameters

groupId string - The identifier of a group

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListGroupMembershipsQueries - Queries to be sent with the request

Return Type

GroupMemberPaging|error - Successful response

createGroupMembership

Isolated FunctionRemote Function

function createGroupMembership(string groupId, GroupMembershipBodyCreate payload, map<string|string[]> headers, *CreateGroupMembershipQueries queries) returns GroupMemberEntry|error

Create a group membership

Parameters

groupId string - The identifier of a group

payload GroupMembershipBodyCreate - The group membership to add (person or sub-group)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateGroupMembershipQueries - Queries to be sent with the request

Return Type

GroupMemberEntry|error - Successful response

deleteGroupMembership

Isolated FunctionRemote Function

function deleteGroupMembership(string groupId, string groupMemberId, map<string|string[]> headers) returns error?

Delete a group membership

Parameters

groupId string - The identifier of a group

groupMemberId string - The identifier of a person or group

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listAuditApps

Isolated FunctionRemote Function

function listAuditApps(map<string|string[]> headers, *ListAuditAppsQueries queries) returns AuditAppPaging|error

List audit applications

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListAuditAppsQueries - Queries to be sent with the request

Return Type

AuditAppPaging|error - Successful response

getAuditApp

Isolated FunctionRemote Function

function getAuditApp(string auditApplicationId, map<string|string[]> headers, *GetAuditAppQueries queries) returns AuditApp|error

Get audit application info

Parameters

auditApplicationId string - The identifier of an audit application

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAuditAppQueries - Queries to be sent with the request

Return Type

AuditApp|error - Successful response

updateAuditApp

Isolated FunctionRemote Function

function updateAuditApp(string auditApplicationId, AuditBodyUpdate payload, map<string|string[]> headers, *UpdateAuditAppQueries queries) returns AuditApp|error

Update audit application info

Parameters

auditApplicationId string - The identifier of an audit application

payload AuditBodyUpdate - The audit application to update

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateAuditAppQueries - Queries to be sent with the request

Return Type

AuditApp|error - Successful response

listAuditEntriesForAuditApp

Isolated FunctionRemote Function

function listAuditEntriesForAuditApp(string auditApplicationId, map<string|string[]> headers, *ListAuditEntriesForAuditAppQueries queries) returns AuditEntryPaging|error

List audit entries for an audit application

Parameters

auditApplicationId string - The identifier of an audit application

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListAuditEntriesForAuditAppQueries - Queries to be sent with the request

Return Type

AuditEntryPaging|error - Successful response

deleteAuditEntriesForAuditApp

Isolated FunctionRemote Function

function deleteAuditEntriesForAuditApp(string auditApplicationId, map<string|string[]> headers, *DeleteAuditEntriesForAuditAppQueries queries) returns error?

Permanently delete audit entries for an audit application

Parameters

auditApplicationId string - The identifier of an audit application

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *DeleteAuditEntriesForAuditAppQueries - Queries to be sent with the request

Return Type

error? - Successful response

getAuditEntry

Isolated FunctionRemote Function

function getAuditEntry(string auditApplicationId, string auditEntryId, map<string|string[]> headers, *GetAuditEntryQueries queries) returns AuditEntryEntry|error

Get audit entry

Parameters

auditApplicationId string - The identifier of an audit application

auditEntryId string - The identifier of an audit entry

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetAuditEntryQueries - Queries to be sent with the request

Return Type

AuditEntryEntry|error - Successful response

deleteAuditEntry

Isolated FunctionRemote Function

function deleteAuditEntry(string auditApplicationId, string auditEntryId, map<string|string[]> headers) returns error?

Permanently delete an audit entry

Parameters

auditApplicationId string - The identifier of an audit application

auditEntryId string - The identifier of an audit entry

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successful response

listAuditEntriesForNode

Isolated FunctionRemote Function

function listAuditEntriesForNode(string nodeId, map<string|string[]> headers, *ListAuditEntriesForNodeQueries queries) returns AuditEntryPaging|error

List audit entries for a node

Parameters

nodeId string - The identifier of a node

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListAuditEntriesForNodeQueries - Queries to be sent with the request

Return Type

AuditEntryPaging|error - Successful response

listActions

Isolated FunctionRemote Function

function listActions(map<string|string[]> headers, *ListActionsQueries queries) returns ActionDefinitionList|error

Retrieve list of available actions

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListActionsQueries - Queries to be sent with the request

Return Type

ActionDefinitionList|error - Successful response

actionDetails

Isolated FunctionRemote Function

function actionDetails(string actionDefinitionId, map<string|string[]> headers) returns ActionDefinitionEntry|error

Retrieve the details of an action definition

Parameters

actionDefinitionId string - The identifier of an action definition

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ActionDefinitionEntry|error - Unexpected error

actionExec

Isolated FunctionRemote Function

function actionExec(ActionBodyExec payload, map<string|string[]> headers) returns ActionExecResultEntry|error

Execute an action

Parameters

payload ActionBodyExec - Action execution details

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ActionExecResultEntry|error - Unexpected error

Records

alfresco: ActionBodyExec

Fields

targetId? string - The entity upon which to execute the action, typically a node ID or similar

actionDefinitionId string -

params? record {} -

alfresco: ActionDefinition

Fields

applicableTypes string[] - QNames of the types this action applies to

parameterDefinitions? ActionParameterDefinition[] -

name? string - name of the action definition, e.g. "move"

trackStatus boolean - whether the basic action definition supports action tracking or not

description? string - describes the action definition, e.g. "This will move the matched item to another space."

id string - Identifier of the action definition — used for example when executing an action

title? string - title of the action definition, e.g. "Move"

alfresco: ActionDefinitionEntry

Fields

entry ActionDefinition -

alfresco: ActionDefinitionList

Fields

list? ActionDefinitionListList -

alfresco: ActionDefinitionListList

Fields

entries? ActionDefinition[] -

pagination? Pagination -

alfresco: ActionExecResult

Fields

id string - The unique identifier of the action pending execution

alfresco: ActionExecResultEntry

Fields

entry ActionExecResult -

alfresco: ActionParameterDefinition

Fields

displayLabel? string -

name? string -

'type? string -

multiValued? boolean -

mandatory? boolean -

alfresco: Activity

Activities describe any past activity in a site, for example creating an item of content, commenting on a node, liking an item of content

Fields

postedAt? string - The date time at which the activity was performed

feedPersonId string - The feed on which this activity was posted

postPersonId string - The id of the person who performed the activity

siteId? string - The unique id of the site on which the activity was performed

activitySummary? record { string... } - An object summarizing the activity

id int - The unique id of the activity

activityType string - The type of the activity posted

alfresco: ActivityEntry

Fields

entry Activity - Activities describe any past activity in a site, for example creating an item of content, commenting on a node, liking an item of content

alfresco: ActivityPaging

Fields

list ActivityPagingList -

alfresco: ActivityPagingList

Fields

entries ActivityEntry[] -

pagination Pagination -

alfresco: Association

Fields

targetId string -

assocType string -

alfresco: AssociationBody

Fields

targetId string -

assocType string -

alfresco: AssociationEntry

Fields

entry Association -

alfresco: AssociationInfo

Fields

assocType string -

alfresco: AuditApp

Fields

maxEntryId? int -

isEnabled boolean(default true) -

name? string -

minEntryId? int -

id string -

alfresco: AuditAppEntry

Fields

entry? AuditApp -

alfresco: AuditAppPaging

Fields

list? AuditAppPagingList -

alfresco: AuditAppPagingList

Fields

entries? AuditAppEntry[] -

pagination? Pagination -

alfresco: AuditBodyUpdate

Fields

isEnabled? boolean -

alfresco: AuditEntry

Fields

createdAt string -

createdByUser UserInfo -

values? record {} -

auditApplicationId string -

id string -

alfresco: AuditEntryEntry

Fields

entry? AuditEntry -

alfresco: AuditEntryPaging

Fields

list? AuditEntryPagingList -

alfresco: AuditEntryPagingList

Fields

entries? AuditEntryEntry[] -

pagination? Pagination -

alfresco: Capabilities

Fields

isMutable? boolean -

isGuest? boolean -

isAdmin? boolean -

alfresco: ChildAssociation

Fields

assocType string -

childId string -

alfresco: ChildAssociationBody

Fields

assocType string -

childId string -

alfresco: ChildAssociationEntry

Fields

entry ChildAssociation -

alfresco: ChildAssociationInfo

Fields

isPrimary boolean -

assocType string -

alfresco: ClientBody

Fields

'client string - the client name

alfresco: Comment

Fields

createdAt string -

createdBy Person -

edited boolean -

modifiedAt string -

canEdit boolean -

modifiedBy Person -

canDelete boolean -

id string -

title string -

content string -

alfresco: CommentBody

Fields

content string -

alfresco: CommentEntry

Fields

entry Comment -

alfresco: CommentPaging

Fields

list CommentPagingList -

alfresco: CommentPagingList

Fields

entries CommentEntry[] -

pagination Pagination -

alfresco: Company

Fields

address3? string -

address2? string -

address1? string -

organization? string -

postcode? string -

telephone? string -

fax? string -

email? string -

alfresco: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth CredentialsConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

alfresco: Constraint

Fields

description? string - the human-readable constraint description

id string -

'type? string - the type of the constraint

title? string - the human-readable constraint title

parameters? record { record {}... } -

alfresco: ContentInfo

Fields

sizeInBytes? int -

mimeTypeName? string -

mimeType string -

encoding? string -

alfresco: CopyNodeQueries

Represents the Queries record for the operation: copyNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateAssociationQueries

Represents the Queries record for the operation: createAssociation

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateCommentQueries

Represents the Queries record for the operation: createComment

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateDownloadQueries

Represents the Queries record for the operation: createDownload

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateFavoriteQueries

Represents the Queries record for the operation: createFavorite

Fields

include? string[] - Returns additional information about favorites, the following optional fields can be requested:
- path (note, this only applies to files and folders)
- properties

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateGroupMembershipQueries

Represents the Queries record for the operation: createGroupMembership

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateGroupQueries

Represents the Queries record for the operation: createGroup

Fields

include? string[] - Returns additional information about the group. The following optional fields can be requested:
- parentIds
- zones

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateNodeQueries

Represents the Queries record for the operation: createNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

versioningEnabled? boolean - If true, then created node will be versioned. If false, then created node will be unversioned and auto-versioning disabled

autoRename? boolean - If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix

majorVersion? boolean - If true, then created node will be version 1.0 MAJOR. If false, then created node will be version 0.1 MINOR

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreatePersonQueries

Represents the Queries record for the operation: createPerson

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateRatingQueries

Represents the Queries record for the operation: createRating

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateSecondaryChildAssociationQueries

Represents the Queries record for the operation: createSecondaryChildAssociation

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateSharedLinkQueries

Represents the Queries record for the operation: createSharedLink

Fields

include? string[] - Returns additional information about the shared link, the following optional fields can be requested:
- allowableOperations
- path
- properties
- isFavorite
- aspectNames

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateSiteFavoriteQueries

Represents the Queries record for the operation: createSiteFavorite

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateSiteGroupMembershipQueries

Represents the Queries record for the operation: createSiteGroupMembership

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateSiteMembershipQueries

Represents the Queries record for the operation: createSiteMembership

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateSiteMembershipRequestForPersonQueries

Represents the Queries record for the operation: createSiteMembershipRequestForPerson

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateSiteQueries

Represents the Queries record for the operation: createSite

Fields

skipAddToFavorites boolean(default false) - Flag to indicate whether the site should not be added to the user's site favorites

skipConfiguration boolean(default false) - Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: CreateTagForNodeQueries

Represents the Queries record for the operation: createTagForNode

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: Definition

Fields

properties? Property[] - List of property definitions effective for this node as the result of combining the type with all aspects

alfresco: DeleteAssociationQueries

Represents the Queries record for the operation: deleteAssociation

Fields

assocType? string - Only delete associations of this type

alfresco: DeleteAuditEntriesForAuditAppQueries

Represents the Queries record for the operation: deleteAuditEntriesForAuditApp

Fields

'where string - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example:
- where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
- where=(id BETWEEN ('1234', '4321')

alfresco: DeletedNode

Fields

Fields Included from *Node

isLink boolean
isFile boolean
createdByUser UserInfo
modifiedAt string
nodeType string
parentId string
content ContentInfo
aspectNames string[]
createdAt string
path PathInfo
isFolder boolean
permissions PermissionsInfo
isLocked boolean
modifiedByUser UserInfo
name string
definition Definition
id string
properties record { anydata... }
allowableOperations string[]
isFavorite boolean
anydata...

Fields Included from *DeletedNodeAllOf2

archivedAt string
archivedByUser UserInfo
anydata...

alfresco: DeletedNodeAllOf2

Fields

archivedAt string -

archivedByUser UserInfo -

alfresco: DeletedNodeBodyRestore

Fields

targetParentId? string -

assocType? string -

alfresco: DeletedNodeEntry

Fields

entry? DeletedNode -

alfresco: DeletedNodesPaging

Fields

list? DeletedNodesPagingList -

alfresco: DeletedNodesPagingList

Fields

entries? DeletedNodeEntry[] -

pagination? Pagination -

alfresco: DeleteGroupQueries

Represents the Queries record for the operation: deleteGroup

Fields

cascade boolean(default false) - If true then the delete will be applied in cascade to sub-groups

alfresco: DeleteNodeQueries

Represents the Queries record for the operation: deleteNode

Fields

permanent boolean(default false) - If true then the node is deleted permanently, without moving to the trashcan. Only the owner of the node or an admin can permanently delete the node

alfresco: DeleteSecondaryChildAssociationQueries

Represents the Queries record for the operation: deleteSecondaryChildAssociation

Fields

assocType? string - Only delete associations of this type

alfresco: DeleteSiteQueries

Represents the Queries record for the operation: deleteSite

Fields

permanent boolean(default false) - Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan

alfresco: Download

Fields

filesAdded? int - number of files added so far in the zip

bytesAdded? int - number of bytes added so far in the zip

totalBytes? int - the total number of bytes to be added in the zip

id? string - the id of the download node

totalFiles? int - the total number of files to be added in the zip

status "PENDING"|"CANCELLED"|"IN_PROGRESS"|"DONE"|"MAX_CONTENT_SIZE_EXCEEDED" (default "PENDING") - the current status of the download node creation

alfresco: DownloadBodyCreate

Fields

nodeIds string[] -

alfresco: DownloadEntry

Fields

entry Download -

alfresco: Favorite

A favorite describes an Alfresco entity that a person has marked as a favorite. The target can be a site, file or folder

Fields

targetGuid string - The guid of the object that is a favorite

createdAt? string - The time the object was made a favorite

properties? record {} - A subset of the target favorite properties, system properties and properties already available in the target are excluded

target record {} -

alfresco: FavoriteBodyCreate

Fields

target record {} -

alfresco: FavoriteEntry

Fields

entry Favorite - A favorite describes an Alfresco entity that a person has marked as a favorite. The target can be a site, file or folder

alfresco: FavoritePaging

Fields

list FavoritePagingList -

alfresco: FavoritePagingList

Fields

entries FavoriteEntry[] -

pagination Pagination -

alfresco: FavoriteSite

Fields

id string -

alfresco: FavoriteSiteBodyCreate

Fields

id string -

alfresco: FavoriteSiteEntry

Fields

entry FavoriteSite -

alfresco: FindNodesQueries

Represents the Queries record for the operation: findNodes

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- aspectNames
- isLink
- isFavorite
- isLocked
- path
- properties

rootNodeId? string - The id of the node to start the search from. Supports the aliases -my-, -root- and -shared-

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

term string - The term to search for

nodeType? string - Restrict the returned results to only those of the given node type and its sub-types

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: FindPeopleQueries

Represents the Queries record for the operation: findPeople

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

term string - The term to search for

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: FindSitesQueries

Represents the Queries record for the operation: findSites

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

term string - The term to search for

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: GetArchivedNodeRenditionContentHeaders

Represents the Headers record for the operation: getArchivedNodeRenditionContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetArchivedNodeRenditionContentQueries

Represents the Queries record for the operation: getArchivedNodeRenditionContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

placeholder boolean(default false) - If true and there is no rendition for this nodeId and renditionId, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response

alfresco: GetAuditAppQueries

Represents the Queries record for the operation: getAuditApp

Fields

include? string[] - Also include the current minimum and/or maximum audit entry ids for the application. The following optional fields can be requested:
- max
- min

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetAuditEntryQueries

Represents the Queries record for the operation: getAuditEntry

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetAvatarImageHeaders

Represents the Headers record for the operation: getAvatarImage

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

alfresco: GetAvatarImageQueries

Represents the Queries record for the operation: getAvatarImage

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

placeholder boolean(default true) - If true and there is no avatar for this personId then the placeholder image is returned, rather than a 404 response

alfresco: GetDeletedNodeContentHeaders

Represents the Headers record for the operation: getDeletedNodeContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetDeletedNodeContentQueries

Represents the Queries record for the operation: getDeletedNodeContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

alfresco: GetDeletedNodeQueries

Represents the Queries record for the operation: getDeletedNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

alfresco: GetDownloadQueries

Represents the Queries record for the operation: getDownload

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetFavoriteQueries

Represents the Queries record for the operation: getFavorite

Fields

include? string[] - Returns additional information about favorites, the following optional fields can be requested:
- path (note, this only applies to files and folders)
- properties

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetFavoriteSiteQueries

Represents the Queries record for the operation: getFavoriteSite

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetGroupQueries

Represents the Queries record for the operation: getGroup

Fields

include? string[] - Returns additional information about the group. The following optional fields can be requested:
- parentIds
- zones

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetNetworkForPersonQueries

Represents the Queries record for the operation: getNetworkForPerson

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetNetworkQueries

Represents the Queries record for the operation: getNetwork

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetNodeContentHeaders

Represents the Headers record for the operation: getNodeContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetNodeContentQueries

Represents the Queries record for the operation: getNodeContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

alfresco: GetNodeQueries

Represents the Queries record for the operation: getNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

relativePath? string - A path relative to the nodeId. If you set this, information is returned on the node resolved by this path

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetPersonQueries

Represents the Queries record for the operation: getPerson

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetPreferenceQueries

Represents the Queries record for the operation: getPreference

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetRatingQueries

Represents the Queries record for the operation: getRating

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetRenditionContentHeaders

Represents the Headers record for the operation: getRenditionContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetRenditionContentQueries

Represents the Queries record for the operation: getRenditionContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

placeholder boolean(default false) - If true and there is no rendition for this nodeId and renditionId, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response

alfresco: GetSharedLinkContentHeaders

Represents the Headers record for the operation: getSharedLinkContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetSharedLinkContentQueries

Represents the Queries record for the operation: getSharedLinkContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

alfresco: GetSharedLinkQueries

Represents the Queries record for the operation: getSharedLink

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetSharedLinkRenditionContentHeaders

Represents the Headers record for the operation: getSharedLinkRenditionContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetSharedLinkRenditionContentQueries

Represents the Queries record for the operation: getSharedLinkRenditionContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

alfresco: GetSiteContainerQueries

Represents the Queries record for the operation: getSiteContainer

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetSiteGroupMembershipQueries

Represents the Queries record for the operation: getSiteGroupMembership

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetSiteMembershipQueries

Represents the Queries record for the operation: getSiteMembership

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetSiteMembershipRequestForPersonQueries

Represents the Queries record for the operation: getSiteMembershipRequestForPerson

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetSiteMembershipRequestsQueries

Represents the Queries record for the operation: getSiteMembershipRequests

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

'where? string - A string to restrict the returned objects by using a predicate

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: GetSiteQueries

Represents the Queries record for the operation: getSite

Fields

relations? string[] - Use the relations parameter to include one or more related entities in a single response

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetTagQueries

Represents the Queries record for the operation: getTag

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: GetVersionContentHeaders

Represents the Headers record for the operation: getVersionContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetVersionContentQueries

Represents the Queries record for the operation: getVersionContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

alfresco: GetVersionRenditionContentHeaders

Represents the Headers record for the operation: getVersionRenditionContent

Fields

ifModifiedSince? string - Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT

range? string - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10

alfresco: GetVersionRenditionContentQueries

Represents the Queries record for the operation: getVersionRenditionContent

Fields

attachment boolean(default true) - true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response

placeholder boolean(default false) - If true and there is no rendition for this nodeId and renditionId, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response

alfresco: Group

Fields

isRoot boolean(default true) -

displayName string -

parentIds? string[] -

id string -

zones? string[] -

alfresco: GroupBodyCreate

Fields

displayName string -

parentIds? string[] -

id string -

alfresco: GroupBodyUpdate

Fields

displayName string -

alfresco: GroupEntry

Fields

entry Group -

alfresco: GroupMember

Fields

displayName string -

id string -

memberType "GROUP"|"PERSON" -

alfresco: GroupMemberEntry

Fields

entry GroupMember -

alfresco: GroupMemberPaging

Fields

list? GroupMemberPagingList -

alfresco: GroupMemberPagingList

Fields

entries? GroupMemberEntry[] -

pagination? Pagination -

alfresco: GroupMembershipBodyCreate

Fields

id string -

memberType "GROUP"|"PERSON" -

alfresco: GroupPaging

Fields

list? GroupPagingList -

alfresco: GroupPagingList

Fields

entries? GroupEntry[] -

pagination? Pagination -

alfresco: ListActionsQueries

Represents the Queries record for the operation: listActions

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListActivitiesForPersonQueries

Represents the Queries record for the operation: listActivitiesForPerson

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

siteId? string - Include only activity feed entries relating to this site

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

who? string - A filter to include the user's activities only me, other user's activities only others'

alfresco: ListAuditAppsQueries

Represents the Queries record for the operation: listAuditApps

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListAuditEntriesForAuditAppQueries

Represents the Queries record for the operation: listAuditEntriesForAuditApp

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the audit entry. The following optional fields can be requested:
- values

omitTotalItems boolean(default false) - A boolean to control if the response provides the total numbers of items in the collection. If not supplied then the default value is false

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - Optionally filter the list. Here are some examples:
- where=(createdByUser='jbloggs')
- where=(id BETWEEN ('1234', '4321')
- where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
- where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
- where=(valuesKey='/alfresco-access/login/user')
- where=(valuesKey='/alfresco-access/transaction/action' and valuesValue='DELETE')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListAuditEntriesForNodeQueries

Represents the Queries record for the operation: listAuditEntriesForNode

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the audit entry. The following optional fields can be requested:
- values

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - Optionally filter the list. Here are some examples:
- where=(createdByUser='-me-')
- where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
- where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListCommentsQueries

Represents the Queries record for the operation: listComments

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListDeletedNodeRenditionsQueries

Represents the Queries record for the operation: listDeletedNodeRenditions

Fields

'where? string - A string to restrict the returned objects by using a predicate

alfresco: ListDeletedNodesQueries

Represents the Queries record for the operation: listDeletedNodes

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- aspectNames
- association
- isLink
- isFavorite
- isLocked
- path
- properties
- permissions

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListFavoriteSitesForPersonQueries

Represents the Queries record for the operation: listFavoriteSitesForPerson

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListFavoritesQueries

Represents the Queries record for the operation: listFavorites

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about favorites, the following optional fields can be requested:
- path (note, this only applies to files and folders)
- properties

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - A string to restrict the returned objects by using a predicate

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListGroupMembershipsForPersonQueries

Represents the Queries record for the operation: listGroupMembershipsForPerson

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the group. The following optional fields can be requested:
- parentIds
- zones

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - A string to restrict the returned objects by using a predicate

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListGroupMembershipsQueries

Represents the Queries record for the operation: listGroupMemberships

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - A string to restrict the returned objects by using a predicate

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListGroupsQueries

Represents the Queries record for the operation: listGroups

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the group. The following optional fields can be requested:
- parentIds
- zones

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - A string to restrict the returned objects by using a predicate

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListNetworksForPersonQueries

Represents the Queries record for the operation: listNetworksForPerson

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListNodeChildrenQueries

Represents the Queries record for the operation: listNodeChildren

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- aspectNames
- association
- isLink
- isFavorite
- isLocked
- path
- properties
- permissions

includeSource? boolean - Also include source in addition to entries with folder information on the parent node – either the specified parent nodeId, or as resolved by relativePath

relativePath? string - Return information on children in the folder resolved by this path. The path is relative to nodeId

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - Optionally filter the list. Here are some examples:
- where=(isFolder=true)
- where=(isFile=true)
- where=(nodeType='my:specialNodeType')
- where=(nodeType='my:specialNodeType INCLUDESUBTYPES')
- where=(isPrimary=true)
- where=(assocType='my:specialAssocType')
- where=(isPrimary=false and assocType='my:specialAssocType')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListParentsQueries

Represents the Queries record for the operation: listParents

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- aspectNames
- isLink
- isFavorite
- isLocked
- path
- properties

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

includeSource? boolean - Also include source (in addition to entries) with folder information on nodeId

'where? string - Optionally filter the list by assocType and/or isPrimary. Here are some example filters:
- where=(assocType='my:specialAssocType')
- where=(isPrimary=true)
- where=(isPrimary=false and assocType='my:specialAssocType')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListPeopleQueries

Represents the Queries record for the operation: listPeople

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the person. The following optional fields can be requested:
- properties
- aspectNames
- capabilities

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListPreferencesQueries

Represents the Queries record for the operation: listPreferences

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListRatingsQueries

Represents the Queries record for the operation: listRatings

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListRenditionsQueries

Represents the Queries record for the operation: listRenditions

Fields

'where? string - A string to restrict the returned objects by using a predicate

alfresco: ListSecondaryChildrenQueries

Represents the Queries record for the operation: listSecondaryChildren

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- aspectNames
- isLink
- isFavorite
- isLocked
- path
- properties

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

includeSource? boolean - Also include source (in addition to entries) with folder information on nodeId

'where? string - Optionally filter the list by assocType. Here's an example:
- where=(assocType='my:specialAssocType')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSharedLinksQueries

Represents the Queries record for the operation: listSharedLinks

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the shared link, the following optional fields can be requested:
- allowableOperations
- path
- properties
- isFavorite
- aspectNames

'where? string - Optionally filter the list by "sharedByUser" userid of person who shared the link (can also use -me-)
- where=(sharedByUser='jbloggs')
- where=(sharedByUser='-me-')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSiteContainersQueries

Represents the Queries record for the operation: listSiteContainers

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSiteGroupsQueries

Represents the Queries record for the operation: listSiteGroups

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSiteMembershipRequestsForPersonQueries

Represents the Queries record for the operation: listSiteMembershipRequestsForPerson

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSiteMembershipsForPersonQueries

Represents the Queries record for the operation: listSiteMembershipsForPerson

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - A string to restrict the returned objects by using a predicate

relations? string[] - Use the relations parameter to include one or more related entities in a single response

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSiteMembershipsQueries

Represents the Queries record for the operation: listSiteMemberships

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

'where? string - Optionally filter the list.
- where=(isMemberOfGroup=false|true)

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSitesQueries

Represents the Queries record for the operation: listSites

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

'where? string - A string to restrict the returned objects by using a predicate

relations? string[] - Use the relations parameter to include one or more related entities in a single response

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListSourceAssociationsQueries

Represents the Queries record for the operation: listSourceAssociations

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- aspectNames
- isLink
- isFavorite
- isLocked
- path
- properties

'where? string - Optionally filter the list by assocType. Here's an example:
- where=(assocType='my:specialAssocType')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: ListTagsForNodeQueries

Represents the Queries record for the operation: listTagsForNode

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListTagsQueries

Represents the Queries record for the operation: listTags

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

include? string[] - Returns additional information about the tag. The following optional fields can be requested:
- count

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListTargetAssociationsQueries

Represents the Queries record for the operation: listTargetAssociations

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- aspectNames
- isLink
- isFavorite
- isLocked
- path
- properties

'where? string - Optionally filter the list by assocType. Here's an example:
- where=(assocType='my:specialAssocType')

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: ListVersionHistoryQueries

Represents the Queries record for the operation: listVersionHistory

Fields

include? string[] - Returns additional information about the version node. The following optional fields can be requested:
- properties
- aspectNames

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: ListVersionRenditionsQueries

Represents the Queries record for the operation: listVersionRenditions

Fields

'where? string - A string to restrict the returned objects by using a predicate

alfresco: LockNodeQueries

Represents the Queries record for the operation: lockNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: MoveNodeQueries

Represents the Queries record for the operation: moveNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: NetworkQuota

Limits and usage of each quota. A network will have quotas for File space, the number of sites in the network, the number of people in the network, and the number of network administrators

Fields

usage int -

'limit int -

id string -

alfresco: Node

Fields

isLink? boolean -

isFile boolean -

createdByUser UserInfo -

modifiedAt string -

nodeType string -

parentId? string -

content? ContentInfo -

aspectNames? string[] -

createdAt string -

path? PathInfo -

isFolder boolean -

permissions? PermissionsInfo -

isLocked boolean(default false) -

modifiedByUser UserInfo -

name string - The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

definition? Definition -

id string -

properties? record {} -

allowableOperations? string[] -

isFavorite? boolean -

alfresco: NodeActionsQueries

Represents the Queries record for the operation: nodeActions

Fields

maxItems int(default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100

orderBy? string[] - A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

skipCount int(default 0) - The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0

alfresco: NodeAssociation

Fields

Fields Included from *Node

isLink boolean
isFile boolean
createdByUser UserInfo
modifiedAt string
nodeType string
parentId string
content ContentInfo
aspectNames string[]
createdAt string
path PathInfo
isFolder boolean
permissions PermissionsInfo
isLocked boolean
modifiedByUser UserInfo
name string
definition Definition
id string
properties record { anydata... }
allowableOperations string[]
isFavorite boolean
anydata...

Fields Included from *NodeAssociationAllOf2

association AssociationInfo
anydata...

alfresco: NodeAssociationAllOf2

Fields

association? AssociationInfo -

alfresco: NodeAssociationEntry

Fields

entry NodeAssociation -

alfresco: NodeAssociationPaging

Fields

list? NodeAssociationPagingList -

alfresco: NodeAssociationPagingList

Fields

entries? NodeAssociationEntry[] -

pagination? Pagination -

'source? Node -

alfresco: NodeBodyCopy

Fields

targetParentId string -

name? string - The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

alfresco: NodeBodyCreate

Fields

aspectNames? string[] -

permissions? PermissionsBody -

relativePath? string -

name string - The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

association? NodeBodyCreateAssociation -

secondaryChildren? ChildAssociationBody[] -

definition? Definition -

nodeType string -

targets? AssociationBody[] -

properties? record {} -

alfresco: NodeBodyCreateAssociation

Fields

assocType? string -

alfresco: NodeBodyLock

Fields

timeToExpire? int -

lifetime "PERSISTENT"|"EPHEMERAL" (default "PERSISTENT") -

'type "ALLOW_OWNER_CHANGES"|"FULL" (default "ALLOW_OWNER_CHANGES") -

alfresco: NodeBodyMove

Fields

targetParentId string -

name? string - The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

alfresco: NodeBodyUpdate

Fields

aspectNames? string[] -

permissions? PermissionsBody -

name? string - The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

nodeType? string -

properties? record { string... } -

alfresco: NodeChildAssociation

Fields

Fields Included from *Node

isLink boolean
isFile boolean
createdByUser UserInfo
modifiedAt string
nodeType string
parentId string
content ContentInfo
aspectNames string[]
createdAt string
path PathInfo
isFolder boolean
permissions PermissionsInfo
isLocked boolean
modifiedByUser UserInfo
name string
definition Definition
id string
properties record { anydata... }
allowableOperations string[]
isFavorite boolean
anydata...

Fields Included from *NodeChildAssociationAllOf2

association ChildAssociationInfo
anydata...

alfresco: NodeChildAssociationAllOf2

Fields

association? ChildAssociationInfo -

alfresco: NodeChildAssociationEntry

Fields

entry NodeChildAssociation -

alfresco: NodeChildAssociationPaging

Fields

list? NodeChildAssociationPagingList -

alfresco: NodeChildAssociationPagingList

Fields

entries? NodeChildAssociationEntry[] -

pagination? Pagination -

'source? Node -

alfresco: NodeEntry

Fields

entry Node -

alfresco: NodePaging

Fields

list? NodePagingList -

alfresco: NodePagingList

Fields

entries? NodeEntry[] -

pagination? Pagination -

'source? Node -

Fields

maxItems? int - The value of the maxItems parameter used to generate this list. If there was no maxItems parameter then the default value is 100

hasMoreItems? boolean - A boolean value which is true if there are more entities in the collection beyond those in this response. A true value means a request with a larger value for the skipCount or the maxItems parameter will return more entities

totalItems? int - An integer describing the total number of entities in the collection. The API might not be able to determine this value, in which case this property will not be present

count? int - The number of objects in the entries array

skipCount? int - An integer describing how many entities exist in the collection before those included in this list. If there was no skipCount parameter then the default value is 0

alfresco: PasswordResetBody

Fields

password string - the new password

id string - the workflow id provided in the reset password email

'key string - the workflow key provided in the reset password email

alfresco: PathElement

Fields

aspectNames? string[] -

name? string -

id? string -

nodeType? string -

alfresco: PathInfo

Fields

elements? PathElement[] -

name? string -

isComplete? boolean -

alfresco: PermissionElement

Fields

authorityId? string -

name? string -

accessStatus "ALLOWED"|"DENIED" (default "ALLOWED") -

alfresco: PermissionsBody

Fields

isInheritanceEnabled? boolean -

locallySet? PermissionElement[] -

alfresco: PermissionsInfo

Fields

isInheritanceEnabled? boolean -

settable? string[] -

locallySet? PermissionElement[] -

inherited? PermissionElement[] -

alfresco: Person

Fields

googleId? string -

lastName? string -

userStatus? string -

capabilities? Capabilities -

displayName? string -

jobTitle? string -

statusUpdatedAt? string -

mobile? string -

emailNotificationsEnabled boolean(default true) -

description? string -

telephone? string -

enabled boolean(default true) -

aspectNames? string[] -

firstName string -

skypeId? string -

avatarId? string -

instantMessageId? string -

location? string -

company? Company -

id string -

email string -

properties? record {} -

alfresco: PersonBodyCreate

Fields

googleId? string -

lastName? string -

userStatus? string -

jobTitle? string -

mobile? string -

emailNotificationsEnabled boolean(default true) -

description? string -

telephone? string -

enabled boolean(default true) -

aspectNames? string[] -

firstName string -

skypeId? string -

password string -

instantMessageId? string -

location? string -

company? Company -

id string -

email string -

properties? record {} -

alfresco: PersonBodyUpdate

Fields

googleId? string -

lastName? string -

userStatus? string -

oldPassword? string -

jobTitle? string -

mobile? string -

emailNotificationsEnabled? boolean -

description? string -

telephone? string -

enabled? boolean -

aspectNames? string[] -

firstName? string -

skypeId? string -

password? string -

instantMessageId? string -

location? string -

company? Company -

email? string -

properties? record {} -

alfresco: PersonEntry

Fields

entry Person -

alfresco: PersonNetwork

A network is the group of users and sites that belong to an organization. Networks are organized by email domain. When a user signs up for an Alfresco account , their email domain becomes their Home Network

Fields

createdAt? string -

paidNetwork? boolean -

subscriptionLevel? "Free"|"Standard"|"Enterprise" -

quotas? NetworkQuota[] -

isEnabled boolean -

id string - This network's unique id

homeNetwork? boolean - Is this the home network?

alfresco: PersonNetworkEntry

Fields

entry PersonNetwork - A network is the group of users and sites that belong to an organization. Networks are organized by email domain. When a user signs up for an Alfresco account , their email domain becomes their Home Network

alfresco: PersonNetworkPaging

Fields

list PersonNetworkPagingList -

alfresco: PersonNetworkPagingList

Fields

entries PersonNetworkEntry[] -

pagination Pagination -

alfresco: PersonPaging

Fields

list? PersonPagingList -

alfresco: PersonPagingList

Fields

entries? PersonEntry[] -

pagination? Pagination -

alfresco: Preference

A specific preference

Fields

id string - The unique id of the preference

value? string - The value of the preference. Note that this can be of any JSON type

alfresco: PreferenceEntry

Fields

entry Preference - A specific preference

alfresco: PreferencePaging

Fields

list PreferencePagingList -

alfresco: PreferencePagingList

Fields

entries PreferenceEntry[] -

pagination Pagination -

alfresco: ProbeEntry

Fields

entry ProbeEntryEntry -

alfresco: ProbeEntryEntry

Fields

message string -

alfresco: Property

Fields

isProtected? boolean - define if the property is system maintained

defaultValue? string - the default value

dataType? string - the name of the property type (e.g. d:text)

isMultiValued? boolean - define if the property is multi-valued

description? string - the human-readable description

isMandatoryEnforced? boolean - define if the presence of mandatory properties is enforced

id string -

title? string - the human-readable title

constraints? Constraint[] - list of constraints defined for the property

isMandatory? boolean - define if the property is mandatory

alfresco: Rating

A person can rate an item of content by liking it. They can also remove their like of an item of content. API methods exist to get a list of ratings and to add a new rating

Fields

myRating? string - The rating. The type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar

ratedAt? string -

id string -

aggregate RatingAggregate -

alfresco: RatingAggregate

Fields

average? int -

numberOfRatings int -

alfresco: RatingBody

Fields

myRating string - The rating. The type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar

id "likes"|"fiveStar" (default "likes") - The rating scheme type. Possible values are likes and fiveStar

alfresco: RatingEntry

Fields

entry Rating - A person can rate an item of content by liking it. They can also remove their like of an item of content. API methods exist to get a list of ratings and to add a new rating

alfresco: RatingPaging

Fields

list RatingPagingList -

alfresco: RatingPagingList

Fields

entries RatingEntry[] -

pagination Pagination -

alfresco: Rendition

Fields

id? string -

content? ContentInfo -

status? "CREATED"|"NOT_CREATED" -

alfresco: RenditionBodyCreate

Fields

id string -

alfresco: RenditionEntry

Fields

entry Rendition -

alfresco: RenditionPaging

Fields

list? RenditionPagingList -

alfresco: RenditionPagingList

Fields

entries? RenditionEntry[] -

pagination? Pagination -

alfresco: RestoreDeletedNodeQueries

Represents the Queries record for the operation: restoreDeletedNode

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: RevertBody

Fields

comment? string -

majorVersion? boolean -

alfresco: RevertVersionQueries

Represents the Queries record for the operation: revertVersion

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: SharedLink

Fields

allowableOperationsOnTarget? string[] - The allowable operations for the content node being shared

modifiedAt? string -

description? string -

title? string -

expiresAt? string -

content? ContentInfo -

aspectNames? string[] -

path? PathInfo -

modifiedByUser? UserInfo -

name? string - The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

id? string -

nodeId? string -

sharedByUser? UserInfo -

allowableOperations? string[] - The allowable operations for the Quickshare link itself. See allowableOperationsOnTarget for the allowable operations pertaining to the linked content node

properties? record {} - A subset of the target node's properties, system properties and properties already available in the SharedLink are excluded

isFavorite? boolean -

alfresco: SharedLinkBodyCreate

Fields

nodeId string -

expiresAt? string -

alfresco: SharedLinkBodyEmail

Fields

'client? string -

recipientEmails? string[] -

message? string -

locale? string -

alfresco: SharedLinkEntry

Fields

entry SharedLink -

alfresco: SharedLinkPaging

Fields

list SharedLinkPagingList -

alfresco: SharedLinkPagingList

Fields

entries SharedLinkEntry[] -

pagination Pagination -

alfresco: Site

Fields

role? "SiteConsumer"|"SiteCollaborator"|"SiteContributor"|"SiteManager" -

visibility "PRIVATE"|"MODERATED"|"PUBLIC" -

guid string -

description? string -

id string -

preset? string -

title string -

alfresco: SiteBodyCreate

Fields

visibility "PUBLIC"|"PRIVATE"|"MODERATED" (default "PUBLIC") -

description? string -

id? string -

title string -

alfresco: SiteBodyUpdate

Fields

visibility? "PRIVATE"|"MODERATED"|"PUBLIC" -

description? string -

title? string -

alfresco: SiteContainer

Fields

id string -

folderId string -

alfresco: SiteContainerEntry

Fields

entry SiteContainer -

alfresco: SiteContainerPaging

Fields

list SiteContainerPagingList -

alfresco: SiteContainerPagingList

Fields

entries SiteContainerEntry[] -

pagination Pagination -

alfresco: SiteEntry

Fields

entry Site -

alfresco: SiteGroup

Fields

role "SiteConsumer"|"SiteCollaborator"|"SiteContributor"|"SiteManager" -

id string -

group GroupMember -

alfresco: SiteGroupEntry

Fields

entry SiteGroup -

alfresco: SiteGroupPaging

Fields

list SiteGroupPagingList -

alfresco: SiteGroupPagingList

Fields

entries SiteGroupEntry[] -

pagination Pagination -

alfresco: SiteMember

Fields

role "SiteConsumer"|"SiteCollaborator"|"SiteContributor"|"SiteManager" -

person Person -

id string -

isMemberOfGroup? boolean -

alfresco: SiteMemberEntry

Fields

entry SiteMember -

alfresco: SiteMemberPaging

Fields

list SiteMemberPagingList -

alfresco: SiteMemberPagingList

Fields

entries SiteMemberEntry[] -

pagination Pagination -

alfresco: SiteMembershipApprovalBody

Fields

role? string -

alfresco: SiteMembershipBodyCreate

Fields

role "SiteConsumer"|"SiteCollaborator"|"SiteContributor"|"SiteManager" -

id string -

alfresco: SiteMembershipBodyUpdate

Fields

role "SiteConsumer"|"SiteCollaborator"|"SiteContributor"|"SiteManager" -

alfresco: SiteMembershipRejectionBody

Fields

comment? string -

alfresco: SiteMembershipRequest

Fields

createdAt string -

site Site -

id string -

message? string -

alfresco: SiteMembershipRequestBodyCreate

Fields

'client? string - Optional client name used when sending an email to the end user, defaults to "share" if not provided. Note: The client must be registered before this API can send an email. Note: This is available in Alfresco 7.0.0 and newer versions

id string -

message? string -

title? string -

alfresco: SiteMembershipRequestBodyUpdate

Fields

message? string -

alfresco: SiteMembershipRequestEntry

Fields

entry SiteMembershipRequest -

alfresco: SiteMembershipRequestPaging

Fields

list SiteMembershipRequestPagingList -

alfresco: SiteMembershipRequestPagingList

Fields

entries SiteMembershipRequestEntry[] -

pagination Pagination -

alfresco: SiteMembershipRequestWithPerson

Fields

createdAt string -

site Site -

person Person -

id string -

message? string -

alfresco: SiteMembershipRequestWithPersonEntry

Fields

entry SiteMembershipRequestWithPerson -

alfresco: SiteMembershipRequestWithPersonPaging

Fields

list SiteMembershipRequestWithPersonPagingList -

alfresco: SiteMembershipRequestWithPersonPagingList

Fields

entries SiteMembershipRequestWithPersonEntry[] -

pagination Pagination -

alfresco: SitePaging

Fields

list SitePagingList -

alfresco: SitePagingList

Fields

entries SiteEntry[] -

pagination Pagination -

alfresco: SiteRole

Fields

site Site -

role "SiteConsumer"|"SiteCollaborator"|"SiteContributor"|"SiteManager" -

guid string -

id string -

alfresco: SiteRoleEntry

Fields

entry SiteRole -

alfresco: SiteRolePaging

Fields

list SiteRolePagingList -

alfresco: SiteRolePagingList

Fields

entries SiteRoleEntry[] -

pagination Pagination -

alfresco: Tag

Fields

count? decimal -

id string -

tag string -

alfresco: TagBody

Fields

tag string -

alfresco: TagEntry

Fields

entry Tag -

alfresco: TagPaging

Fields

list TagPagingList -

alfresco: TagPagingList

Fields

entries TagEntry[] -

pagination Pagination -

alfresco: UnlockNodeQueries

Represents the Queries record for the operation: unlockNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateAuditAppQueries

Represents the Queries record for the operation: updateAuditApp

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateCommentQueries

Represents the Queries record for the operation: updateComment

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateGroupQueries

Represents the Queries record for the operation: updateGroup

Fields

include? string[] - Returns additional information about the group. The following optional fields can be requested:
- parentIds
- zones

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateNodeContentQueries

Represents the Queries record for the operation: updateNodeContent

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

name? string - Optional new name. This should include the file extension. The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

comment? string - Add a version comment which will appear in version history. Setting this parameter also enables versioning of this node, if it is not already versioned

majorVersion boolean(default false) - If true, create a major version. Setting this parameter also enables versioning of this node, if it is not already versioned

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateNodeQueries

Represents the Queries record for the operation: updateNode

Fields

include? string[] - Returns additional information about the node. The following optional fields can be requested:
- allowableOperations
- association
- isLink
- isFavorite
- isLocked
- path
- permissions
- definition

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdatePersonQueries

Represents the Queries record for the operation: updatePerson

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateSiteGroupMembershipQueries

Represents the Queries record for the operation: updateSiteGroupMembership

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateSiteMembershipQueries

Represents the Queries record for the operation: updateSiteMembership

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateSiteMembershipRequestForPersonQueries

Represents the Queries record for the operation: updateSiteMembershipRequestForPerson

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateSiteQueries

Represents the Queries record for the operation: updateSite

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UpdateTagQueries

Represents the Queries record for the operation: updateTag

Fields

fields? string[] - A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter

alfresco: UserInfo

Fields

displayName string -

id string -

alfresco: Version

Fields

aspectNames? string[] -

isFolder boolean -

isFile boolean -

modifiedAt string -

modifiedByUser UserInfo -

versionComment? string -

name string - The name must not contain spaces or the following special characters: * " < > \ / ? : and |. The character . must not be used at the end of the name

id string -

nodeType string -

content? ContentInfo -

properties? record {} -

alfresco: VersionEntry

Fields

entry? Version -

alfresco: VersionPaging

Fields

list? VersionPagingList -

alfresco: VersionPagingList

Fields

entries? VersionEntry[] -

pagination? Pagination -

Import

import ballerinax/alfresco;

Metadata

Released date: 26 days ago

Version: 2.0.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.12.4

GraalVM compatible: Yes

Pull count

Total: 26

Current verison: 1

Weekly downloads

Source repository

Contributors

Other versions

2.0.0

1.4.0 1.3.1 1.3.0 1.2.0

Dependencies

ballerina/url/2.6.0 ballerina/constraint/1.7.0 ballerina/os/1.10.0

Cookie policy

Delete policy

clients

records

ballerinax/alfresco Ballerina library

Overview

Setup guide

Quickstart

Step 1: Import the module

Step 2: Create a new connector instance

Step 3: Invoke connector operation

Step 4: Run the Ballerina application

Examples

Clients

alfresco: Client

Constructor

listComments

Parameters

Return Type

createComment

Parameters

Return Type

updateComment

Parameters

Return Type

deleteComment

Parameters

Return Type

listRatings

Parameters

Return Type

createRating

Parameters

Return Type

getRating

Parameters

Return Type

deleteRating

Parameters

Return Type

listTagsForNode

Parameters

Return Type

createTagForNode

Parameters

Return Type

deleteTagFromNode

Parameters

Return Type

getNode

Parameters

Return Type

updateNode

Parameters

Return Type

deleteNode

Parameters

Return Type

listNodeChildren

Parameters

Return Type

createNode

Parameters

Return Type

copyNode

Parameters

Return Type

lockNode

Parameters

Return Type

unlockNode

Parameters

Return Type

moveNode

Parameters

Return Type

getNodeContent

Parameters

Return Type

updateNodeContent

Parameters

Return Type