Module alfresco
ballerinax/alfresco Ballerina library
1.3.1
Overview
This is a generated connector for Alfresco OpenAPI specification.
This Alfresco Content Services REST APIs enable you to access to the core features of Alfresco Content Services.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Alfresco Account.
- Obtain tokens by following this guide.
Quickstart
To use the Alfresco connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/alfresco module into the Ballerina project.
import ballerinax/alfresco;
Step 2: Create a new connector instance
Create a alfresco:ClientConfig with the Bearer_Token obtained, and initialize the connector with it.
alfresco:ClientConfig clientConfig = { auth: { token: <Bearer_Token> } }; alfresco:Client baseClient = check new (clientConfig, 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.
Retrieve list of comments in a particular node.
public function main() returns error? { alfresco:CommentPaging response = check baseClient->listComments(nodeId); log:printInfo(response.toString()); } -
Use
bal runcommand to compile and run the Ballerina program.
Clients
alfresco: Client
Isolated
This is a generated connector for Alfresco API OpenAPI Specification. The Alfresco REST API enable you to access to the core features of Alfresco Content Services.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Please create a Alfresco devoloper account and obtain tokens.
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, int skipCount, int maxItems, string[]? fields) returns CommentPaging|errorList comments
Parameters
- nodeId string - The identifier of a node.
- 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.
- 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[]? (default ()) - 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.
Return Type
- CommentPaging|error - Successful response
createComment
Isolated FunctionRemote Function
function createComment(string nodeId, CommentBody payload, string[]? fields) returns CommentEntry|errorCreate 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.
- fields string[]? (default ()) - 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.
Return Type
- CommentEntry|error - Successful response
updateComment
Isolated FunctionRemote Function
function updateComment(string nodeId, string commentId, CommentBody payload, string[]? fields) returns CommentEntry|errorUpdate 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.
- fields string[]? (default ()) - 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.
Return Type
- CommentEntry|error - Successful response
deleteComment
Isolated FunctionRemote Function
Delete a comment
listRatings
Isolated FunctionRemote Function
function listRatings(string nodeId, int skipCount, int maxItems, string[]? fields) returns RatingPaging|errorList ratings
Parameters
- nodeId string - The identifier of a node.
- 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.
- 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[]? (default ()) - 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.
Return Type
- RatingPaging|error - Successful response
createRating
Isolated FunctionRemote Function
function createRating(string nodeId, RatingBody payload, string[]? fields) returns RatingEntry|errorCreate 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.
- fields string[]? (default ()) - 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.
Return Type
- RatingEntry|error - Successful response
getRating
Isolated FunctionRemote Function
function getRating(string nodeId, string ratingId, string[]? fields) returns RatingEntry|errorGet a rating
Parameters
- nodeId string - The identifier of a node.
- ratingId string - The identifier of a rating.
- fields string[]? (default ()) - 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.
Return Type
- RatingEntry|error - Successful response
deleteRating
Isolated FunctionRemote Function
Delete a rating
listTagsForNode
Isolated FunctionRemote Function
function listTagsForNode(string nodeId, int skipCount, int maxItems, string[]? fields) returns TagPaging|errorList tags for a node
Parameters
- nodeId string - The identifier of a node.
- 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.
- 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[]? (default ()) - 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.
createTagForNode
Isolated FunctionRemote Function
Create a tag for a node
Parameters
- nodeId string - The identifier of a node.
- payload TagBody - The new tag
- fields string[]? (default ()) - 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.
deleteTagFromNode
Isolated FunctionRemote Function
Delete a tag from a node
getNode
Isolated FunctionRemote Function
function getNode(string nodeId, string[]? include, string? relativePath, string[]? fields) returns NodeEntry|errorGet a node
Parameters
- nodeId string - The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- relativePath string? (default ()) - A path relative to the nodeId. If you set this, information is returned on the node resolved by this path.
- fields string[]? (default ()) - 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.
updateNode
Isolated FunctionRemote Function
function updateNode(string nodeId, NodeBodyUpdate payload, string[]? include, string[]? fields) returns NodeEntry|errorUpdate a node
Parameters
- nodeId string - The identifier of a node.
- payload NodeBodyUpdate - The node information to update.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- fields string[]? (default ()) - 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.
deleteNode
Isolated FunctionRemote Function
Delete a node
Parameters
- nodeId string - The identifier of a node.
- 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.
listNodeChildren
Isolated FunctionRemote Function
function listNodeChildren(string nodeId, int skipCount, int maxItems, string[]? orderBy, string? 'where, string[]? include, string? relativePath, boolean? includeSource, string[]? fields) returns NodeChildAssociationPaging|errorList node children
Parameters
- nodeId string - The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
- 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.
- 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[]? (default ()) - 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? (default ()) - 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')
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isFavorite * isLocked * path * properties * permissions
- relativePath string? (default ()) - Return information on children in the folder resolved by this path. The path is relative to nodeId.
- includeSource boolean? (default ()) - Also include source in addition to entries with folder information on the parent node – either the specified parent nodeId, or as resolved by relativePath.
- fields string[]? (default ()) - 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.
Return Type
- NodeChildAssociationPaging|error - Successful response
createNode
Isolated FunctionRemote Function
function createNode(string nodeId, NodeBodyCreate payload, boolean? autoRename, boolean? majorVersion, boolean? versioningEnabled, string[]? include, string[]? fields) returns NodeEntry|errorCreate 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.
- autoRename boolean? (default ()) - If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
- majorVersion boolean? (default ()) - If true, then created node will be version 1.0 MAJOR. If false, then created node will be version 0.1 MINOR.
- versioningEnabled boolean? (default ()) - If true, then created node will be versioned. If false, then created node will be unversioned and auto-versioning disabled.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- fields string[]? (default ()) - 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.
copyNode
Isolated FunctionRemote Function
function copyNode(string nodeId, NodeBodyCopy payload, string[]? include, string[]? fields) returns NodeEntry|errorCopy 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.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- fields string[]? (default ()) - 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.
lockNode
Isolated FunctionRemote Function
function lockNode(string nodeId, NodeBodyLock payload, string[]? include, string[]? fields) returns NodeEntry|errorLock a node
Parameters
- nodeId string - The identifier of a node.
- payload NodeBodyLock - Lock details.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- fields string[]? (default ()) - 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.
unlockNode
Isolated FunctionRemote Function
Unlock a node
Parameters
- nodeId string - The identifier of a node.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- fields string[]? (default ()) - 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.
moveNode
Isolated FunctionRemote Function
function moveNode(string nodeId, NodeBodyMove payload, string[]? include, string[]? fields) returns NodeEntry|errorMove 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.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- fields string[]? (default ()) - 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.
getNodeContent
Isolated FunctionRemote Function
function getNodeContent(string nodeId, boolean attachment, string? ifModifiedSince, string? range) returns string|error?Get node content
Parameters
- nodeId string - The identifier of a node.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
updateNodeContent
Isolated FunctionRemote Function
function updateNodeContent(string nodeId, byte[] payload, boolean majorVersion, string? comment, string? name, string[]? include, string[]? fields) returns NodeEntry|errorUpdate node content
Parameters
- nodeId string - The identifier of a node.
- payload byte[] - The binary content
- 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.
- comment string? (default ()) - 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.
- name string? (default ()) - 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.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
- fields string[]? (default ()) - 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.
listRenditions
Isolated FunctionRemote Function
function listRenditions(string nodeId, string? 'where) returns RenditionPaging|errorList renditions
Parameters
- nodeId string - The identifier of a node.
- 'where string? (default ()) - A string to restrict the returned objects by using a predicate.
Return Type
- RenditionPaging|error - Successful response
createRendition
Isolated FunctionRemote Function
function createRendition(string nodeId, RenditionBodyCreate payload) returns Response|errorCreate rendition
Parameters
- nodeId string - The identifier of a node.
- payload RenditionBodyCreate - The rendition "id".
getRendition
Isolated FunctionRemote Function
function getRendition(string nodeId, string renditionId) returns RenditionEntry|errorGet rendition information
Parameters
- nodeId string - The identifier of a node.
- renditionId string - The name of a thumbnail rendition, for example doclib, or pdf.
Return Type
- RenditionEntry|error - Successful response
getRenditionContent
Isolated FunctionRemote Function
function getRenditionContent(string nodeId, string renditionId, boolean attachment, string? ifModifiedSince, string? range, boolean placeholder) returns string|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.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
- 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.
listSecondaryChildren
Isolated FunctionRemote Function
function listSecondaryChildren(string nodeId, string? 'where, string[]? include, int skipCount, int maxItems, boolean? includeSource, string[]? fields) returns NodeChildAssociationPaging|errorList secondary children
Parameters
- nodeId string - The identifier of a parent node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
- 'where string? (default ()) - Optionally filter the list by assocType. Here's an example: *
where=(assocType='my:specialAssocType')
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isLocked * path * properties
- 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.
- 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? (default ()) - Also include source (in addition to entries) with folder information on nodeId
- fields string[]? (default ()) - 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.
Return Type
- NodeChildAssociationPaging|error - Successful response
createSecondaryChildAssociation
Isolated FunctionRemote Function
function createSecondaryChildAssociation(string nodeId, ChildAssociationBody payload, string[]? fields) returns ChildAssociationEntry|errorCreate secondary child
Parameters
- nodeId string - The identifier of a parent node.
- payload ChildAssociationBody - The child node id and assoc type.
- fields string[]? (default ()) - 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.
Return Type
- ChildAssociationEntry|error - Successful response
deleteSecondaryChildAssociation
Isolated FunctionRemote Function
function deleteSecondaryChildAssociation(string nodeId, string childId, string? assocType) returns Response|errorDelete secondary child or children
Parameters
- nodeId string - The identifier of a parent node.
- childId string - The identifier of a child node.
- assocType string? (default ()) - Only delete associations of this type.
listParents
Isolated FunctionRemote Function
function listParents(string nodeId, string? 'where, string[]? include, int skipCount, int maxItems, boolean? includeSource, string[]? fields) returns NodeAssociationPaging|errorList parents
Parameters
- nodeId string - The identifier of a child node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
- 'where string? (default ()) - 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')
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isLocked * path * properties
- 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.
- 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? (default ()) - Also include source (in addition to entries) with folder information on nodeId
- fields string[]? (default ()) - 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.
Return Type
- NodeAssociationPaging|error - Successful response
listTargetAssociations
Isolated FunctionRemote Function
function listTargetAssociations(string nodeId, string? 'where, string[]? include, string[]? fields) returns NodeAssociationPaging|errorList target associations
Parameters
- nodeId string - The identifier of a source node.
- 'where string? (default ()) - Optionally filter the list by assocType. Here's an example: *
where=(assocType='my:specialAssocType')
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isLocked * path * properties
- fields string[]? (default ()) - 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.
Return Type
- NodeAssociationPaging|error - Successful response
createAssociation
Isolated FunctionRemote Function
function createAssociation(string nodeId, AssociationBody payload, string[]? fields) returns AssociationEntry|errorCreate node association
Parameters
- nodeId string - The identifier of a source node.
- payload AssociationBody - The target node id and assoc type.
- fields string[]? (default ()) - 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.
Return Type
- AssociationEntry|error - Successful response
deleteAssociation
Isolated FunctionRemote Function
function deleteAssociation(string nodeId, string targetId, string? assocType) returns Response|errorDelete node association(s)
Parameters
- nodeId string - The identifier of a source node.
- targetId string - The identifier of a target node.
- assocType string? (default ()) - Only delete associations of this type.
listSourceAssociations
Isolated FunctionRemote Function
function listSourceAssociations(string nodeId, string? 'where, string[]? include, string[]? fields) returns NodeAssociationPaging|errorList source associations
Parameters
- nodeId string - The identifier of a target node.
- 'where string? (default ()) - Optionally filter the list by assocType. Here's an example: *
where=(assocType='my:specialAssocType')
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isLocked * path * properties
- fields string[]? (default ()) - 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.
Return Type
- NodeAssociationPaging|error - Successful response
listVersionHistory
Isolated FunctionRemote Function
function listVersionHistory(string nodeId, string[]? include, string[]? fields, int skipCount, int maxItems) returns VersionPaging|errorList version history
Parameters
- nodeId string - The identifier of a node.
- include string[]? (default ()) - Returns additional information about the version node. The following optional fields can be requested: * properties * aspectNames
- fields string[]? (default ()) - 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.
- maxItems int (default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100.
Return Type
- VersionPaging|error - Successful response
getVersion
Isolated FunctionRemote Function
function getVersion(string nodeId, string versionId) returns VersionEntry|errorGet 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.
Return Type
- VersionEntry|error - Successful response
deleteVersion
Isolated FunctionRemote Function
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.
getVersionContent
Isolated FunctionRemote Function
function getVersionContent(string nodeId, string versionId, boolean attachment, string? ifModifiedSince, string? range) returns string|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.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
revertVersion
Isolated FunctionRemote Function
function revertVersion(string nodeId, string versionId, RevertBody payload, string[]? fields) returns VersionEntry|errorRevert 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.
- fields string[]? (default ()) - 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.
Return Type
- VersionEntry|error - Successful response
listVersionRenditions
Isolated FunctionRemote Function
function listVersionRenditions(string nodeId, string versionId, string? 'where) returns RenditionPaging|errorList 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.
- 'where string? (default ()) - A string to restrict the returned objects by using a predicate.
Return Type
- RenditionPaging|error - Successful response
createVersionRendition
Isolated FunctionRemote Function
function createVersionRendition(string nodeId, string versionId, RenditionBodyCreate payload) returns Response|errorCreate 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".
getVersionRendition
Isolated FunctionRemote Function
function getVersionRendition(string nodeId, string versionId, string renditionId) returns RenditionEntry|errorGet 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.
Return Type
- RenditionEntry|error - Successful response
getVersionRenditionContent
Isolated FunctionRemote Function
function getVersionRenditionContent(string nodeId, string versionId, string renditionId, boolean attachment, string? ifModifiedSince, string? range, boolean placeholder) returns string|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.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
- 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.
nodeActions
Isolated FunctionRemote Function
function nodeActions(string nodeId, int skipCount, int maxItems, string[]? orderBy, string[]? fields) returns ActionDefinitionList|errorRetrieve actions for a node
Parameters
- nodeId string - The identifier of a node.
- 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.
- 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[]? (default ()) - 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[]? (default ()) - 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.
Return Type
- ActionDefinitionList|error - Successful response
listDeletedNodes
Isolated FunctionRemote Function
function listDeletedNodes(int skipCount, int maxItems, string[]? include) returns DeletedNodesPaging|errorList deleted nodes
Parameters
- 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.
- 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[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isFavorite * isLocked * path * properties * permissions
Return Type
- DeletedNodesPaging|error - Successful response
getDeletedNode
Isolated FunctionRemote Function
function getDeletedNode(string nodeId, string[]? include) returns DeletedNodeEntry|errorGet a deleted node
Parameters
- nodeId string - The identifier of a node.
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition
Return Type
- DeletedNodeEntry|error - Successful response
deleteDeletedNode
Isolated FunctionRemote Function
Permanently delete a deleted node
Parameters
- nodeId string - The identifier of a node.
getDeletedNodeContent
Isolated FunctionRemote Function
function getDeletedNodeContent(string nodeId, boolean attachment, string? ifModifiedSince, string? range) returns string|error?Get deleted node content
Parameters
- nodeId string - The identifier of a node.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
restoreDeletedNode
Isolated FunctionRemote Function
function restoreDeletedNode(string nodeId, DeletedNodeBodyRestore payload, string[]? fields) returns NodeEntry|errorRestore a deleted node
Parameters
- nodeId string - The identifier of a node.
- payload DeletedNodeBodyRestore - The targetParentId if the node is restored to a new location.
- fields string[]? (default ()) - 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.
listDeletedNodeRenditions
Isolated FunctionRemote Function
function listDeletedNodeRenditions(string nodeId, string? 'where) returns RenditionPaging|errorList renditions for a deleted node
Parameters
- nodeId string - The identifier of a node.
- 'where string? (default ()) - A string to restrict the returned objects by using a predicate.
Return Type
- RenditionPaging|error - Successful response
getArchivedNodeRendition
Isolated FunctionRemote Function
function getArchivedNodeRendition(string nodeId, string renditionId) returns RenditionEntry|errorGet 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.
Return Type
- RenditionEntry|error - Successful response
getArchivedNodeRenditionContent
Isolated FunctionRemote Function
function getArchivedNodeRenditionContent(string nodeId, string renditionId, boolean attachment, string? ifModifiedSince, string? range, boolean placeholder) returns string|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.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
- 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.
createDownload
Isolated FunctionRemote Function
function createDownload(DownloadBodyCreate payload, string[]? fields) returns DownloadEntry|errorCreate 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.
- fields string[]? (default ()) - 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.
Return Type
- DownloadEntry|error - The request to create a download node was accepted
getDownload
Isolated FunctionRemote Function
function getDownload(string downloadId, string[]? fields) returns DownloadEntry|errorGet a download
Parameters
- downloadId string - The identifier of a download node.
- fields string[]? (default ()) - 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.
Return Type
- DownloadEntry|error - Download node information
cancelDownload
Isolated FunctionRemote Function
Cancel a download
Parameters
- downloadId string - The identifier of a download node.
listPeople
Isolated FunctionRemote Function
function listPeople(int skipCount, int maxItems, string[]? orderBy, string[]? include, string[]? fields) returns PersonPaging|errorList people
Parameters
- 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.
- 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[]? (default ()) - 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.
- include string[]? (default ()) - Returns additional information about the person. The following optional fields can be requested: * properties * aspectNames * capabilities
- fields string[]? (default ()) - 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.
Return Type
- PersonPaging|error - Successful response
createPerson
Isolated FunctionRemote Function
function createPerson(PersonBodyCreate payload, string[]? fields) returns PersonEntry|errorCreate person
Parameters
- payload PersonBodyCreate - The person details.
- fields string[]? (default ()) - 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.
Return Type
- PersonEntry|error - Successful response
getPerson
Isolated FunctionRemote Function
function getPerson(string personId, string[]? fields) returns PersonEntry|errorGet a person
Parameters
- personId string - The identifier of a person.
- fields string[]? (default ()) - 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.
Return Type
- PersonEntry|error - Successful response
updatePerson
Isolated FunctionRemote Function
function updatePerson(string personId, PersonBodyUpdate payload, string[]? fields) returns PersonEntry|errorUpdate person
Parameters
- personId string - The identifier of a person.
- payload PersonBodyUpdate - The person details.
- fields string[]? (default ()) - 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.
Return Type
- PersonEntry|error - Successful response
listActivitiesForPerson
Isolated FunctionRemote Function
function listActivitiesForPerson(string personId, int skipCount, int maxItems, string? who, string? siteId, string[]? fields) returns ActivityPaging|errorList activities
Parameters
- personId string - The identifier of a person.
- 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.
- maxItems int (default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100.
- who string? (default ()) - A filter to include the user's activities only
me, other user's activities onlyothers'
- siteId string? (default ()) - Include only activity feed entries relating to this site.
- fields string[]? (default ()) - 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.
Return Type
- ActivityPaging|error - Successful response
listFavoriteSitesForPerson
DeprecatedIsolated FunctionRemote Function
function listFavoriteSitesForPerson(string personId, int skipCount, int maxItems, string[]? fields) returns SitePaging|errorList favorite sites
Parameters
- personId string - The identifier of a person.
- 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.
- 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[]? (default ()) - 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.
Return Type
- SitePaging|error - Successful response
Deprecated
createSiteFavorite
DeprecatedIsolated FunctionRemote Function
function createSiteFavorite(string personId, FavoriteSiteBodyCreate payload, string[]? fields) returns FavoriteSiteEntry|errorCreate a site favorite
Parameters
- personId string - The identifier of a person.
- payload FavoriteSiteBodyCreate - The id of the site to favorite.
- fields string[]? (default ()) - 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.
Return Type
- FavoriteSiteEntry|error - Successful response
Deprecated
getFavoriteSite
DeprecatedIsolated FunctionRemote Function
Get a favorite site
Parameters
- personId string - The identifier of a person.
- siteId string - The identifier of a site.
- fields string[]? (default ()) - 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.
deleteSiteFavorite
DeprecatedIsolated FunctionRemote Function
Delete a site favorite
listFavorites
Isolated FunctionRemote Function
function listFavorites(string personId, int skipCount, int maxItems, string[]? orderBy, string? 'where, string[]? include, string[]? fields) returns FavoritePaging|errorList favorites
Parameters
- personId string - The identifier of a person.
- 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.
- 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[]? (default ()) - 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? (default ()) - A string to restrict the returned objects by using a predicate.
- include string[]? (default ()) - Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders) * properties
- fields string[]? (default ()) - 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.
Return Type
- FavoritePaging|error - Successful response
createFavorite
Isolated FunctionRemote Function
function createFavorite(string personId, FavoriteBodyCreate payload, string[]? include, string[]? fields) returns FavoriteEntry|errorCreate a favorite
Parameters
- personId string - The identifier of a person.
- payload FavoriteBodyCreate - An object identifying the entity to be favorited.
- include string[]? (default ()) - Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders) * properties
- fields string[]? (default ()) - 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.
Return Type
- FavoriteEntry|error - Successful response
getFavorite
Isolated FunctionRemote Function
function getFavorite(string personId, string favoriteId, string[]? include, string[]? fields) returns FavoriteEntry|errorGet a favorite
Parameters
- personId string - The identifier of a person.
- favoriteId string - The identifier of a favorite.
- include string[]? (default ()) - Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders) * properties
- fields string[]? (default ()) - 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.
Return Type
- FavoriteEntry|error - Successful response
deleteFavorite
Isolated FunctionRemote Function
Delete a favorite
Parameters
- personId string - The identifier of a person.
- favoriteId string - The identifier of a favorite.
listNetworksForPerson
Isolated FunctionRemote Function
function listNetworksForPerson(string personId, int skipCount, int maxItems, string[]? fields) returns PersonNetworkPaging|errorList network membership
Parameters
- personId string - The identifier of a person.
- 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.
- 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[]? (default ()) - 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.
Return Type
- PersonNetworkPaging|error - Successful response
getNetworkForPerson
Isolated FunctionRemote Function
function getNetworkForPerson(string personId, string networkId, string[]? fields) returns PersonNetworkEntry|errorGet network information
Parameters
- personId string - The identifier of a person.
- networkId string - The identifier of a network.
- fields string[]? (default ()) - 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.
Return Type
- PersonNetworkEntry|error - Successful response
listPreferences
Isolated FunctionRemote Function
function listPreferences(string personId, int skipCount, int maxItems, string[]? fields) returns PreferencePaging|errorList preferences
Parameters
- personId string - The identifier of a person.
- 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.
- 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[]? (default ()) - 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.
Return Type
- PreferencePaging|error - Successful response
getPreference
Isolated FunctionRemote Function
function getPreference(string personId, string preferenceName, string[]? fields) returns PreferenceEntry|errorGet a preference
Parameters
- personId string - The identifier of a person.
- preferenceName string - The name of the preference.
- fields string[]? (default ()) - 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.
Return Type
- PreferenceEntry|error - Successful response
listSiteMembershipRequestsForPerson
Isolated FunctionRemote Function
function listSiteMembershipRequestsForPerson(string personId, int skipCount, int maxItems, string[]? fields) returns SiteMembershipRequestPaging|errorList site membership requests
Parameters
- personId string - The identifier of a person.
- 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.
- 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[]? (default ()) - 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.
Return Type
- SiteMembershipRequestPaging|error - Successful response
getSiteMembershipRequestForPerson
Isolated FunctionRemote Function
function getSiteMembershipRequestForPerson(string personId, string siteId, string[]? fields) returns SiteMembershipRequestEntry|errorGet a site membership request
Parameters
- personId string - The identifier of a person.
- siteId string - The identifier of a site.
- fields string[]? (default ()) - 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.
Return Type
- SiteMembershipRequestEntry|error - Successful response
updateSiteMembershipRequestForPerson
Isolated FunctionRemote Function
function updateSiteMembershipRequestForPerson(string personId, string siteId, SiteMembershipRequestBodyUpdate payload, string[]? fields) returns SiteMembershipRequestEntry|errorUpdate 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
- fields string[]? (default ()) - 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.
Return Type
- SiteMembershipRequestEntry|error - Successful response
deleteSiteMembershipRequestForPerson
Isolated FunctionRemote Function
function deleteSiteMembershipRequestForPerson(string personId, string siteId) returns Response|errorDelete a site membership request
listSiteMembershipsForPerson
Isolated FunctionRemote Function
function listSiteMembershipsForPerson(string personId, int skipCount, int maxItems, string[]? orderBy, string[]? relations, string[]? fields, string? 'where) returns SiteRolePaging|errorList site memberships
Parameters
- personId string - The identifier of a person.
- 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.
- 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[]? (default ()) - 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.
- relations string[]? (default ()) - Use the relations parameter to include one or more related entities in a single response.
- fields string[]? (default ()) - 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.
- 'where string? (default ()) - A string to restrict the returned objects by using a predicate.
Return Type
- SiteRolePaging|error - Successful response
getSiteMembershipForPerson
Isolated FunctionRemote Function
function getSiteMembershipForPerson(string personId, string siteId) returns SiteRoleEntry|errorGet a site membership
Return Type
- SiteRoleEntry|error - Successful response
deleteSiteMembershipForPerson
Isolated FunctionRemote Function
Delete a site membership
listGroupMembershipsForPerson
Isolated FunctionRemote Function
function listGroupMembershipsForPerson(string personId, int skipCount, int maxItems, string[]? orderBy, string[]? include, string? 'where, string[]? fields) returns GroupPaging|errorList group memberships
Parameters
- personId string - The identifier of a person.
- 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.
- 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[]? (default ()) - 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.
- include string[]? (default ()) - Returns additional information about the group. The following optional fields can be requested: * parentIds * zones
- 'where string? (default ()) - A string to restrict the returned objects by using a predicate.
- fields string[]? (default ()) - 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.
Return Type
- GroupPaging|error - Successful response
requestPasswordReset
Isolated FunctionRemote Function
function requestPasswordReset(string personId, ClientBody payload) returns Response|errorRequest password reset
Parameters
- personId string - The identifier of a person.
- payload ClientBody - The client name to send email with app-specific url.
Return Type
resetPassword
Isolated FunctionRemote Function
function resetPassword(string personId, PasswordResetBody payload) returns Response|errorReset password
Parameters
- personId string - The identifier of a person.
- payload PasswordResetBody - The reset password details
Return Type
- Response|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, boolean attachment, string? ifModifiedSince, boolean placeholder) returns string|errorGet avatar image
Parameters
- personId string - The identifier of a person.
- 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.
- ifModifiedSince string? (default ()) - 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.
- 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.
updateAvatarImage
Isolated FunctionRemote Function
Update avatar image
deleteAvatarImage
Isolated FunctionRemote Function
Delete avatar image
Parameters
- personId string - The identifier of a person.
listSites
Isolated FunctionRemote Function
function listSites(int skipCount, int maxItems, string[]? orderBy, string[]? relations, string[]? fields, string? 'where) returns SitePaging|errorList sites
Parameters
- 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.
- 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[]? (default ()) - 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.
- relations string[]? (default ()) - Use the relations parameter to include one or more related entities in a single response.
- fields string[]? (default ()) - 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.
- 'where string? (default ()) - A string to restrict the returned objects by using a predicate.
Return Type
- SitePaging|error - Successful response
createSite
Isolated FunctionRemote Function
function createSite(SiteBodyCreate payload, boolean skipConfiguration, boolean skipAddToFavorites, string[]? fields) returns SiteEntry|errorCreate a site
Parameters
- payload SiteBodyCreate - The site details
- skipConfiguration boolean (default false) - Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created.
- skipAddToFavorites boolean (default false) - Flag to indicate whether the site should not be added to the user's site favorites.
- fields string[]? (default ()) - 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.
getSite
Isolated FunctionRemote Function
Get a site
Parameters
- siteId string - The identifier of a site.
- relations string[]? (default ()) - Use the relations parameter to include one or more related entities in a single response.
- fields string[]? (default ()) - 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.
updateSite
Isolated FunctionRemote Function
function updateSite(string siteId, SiteBodyUpdate payload, string[]? fields) returns SiteEntry|errorUpdate a site
Parameters
- siteId string - The identifier of a site.
- payload SiteBodyUpdate - The site information to update.
- fields string[]? (default ()) - 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.
deleteSite
Isolated FunctionRemote Function
Delete a site
Parameters
- siteId string - The identifier of a site.
- permanent boolean (default false) - Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan.
listSiteContainers
Isolated FunctionRemote Function
function listSiteContainers(string siteId, int skipCount, int maxItems, string[]? fields) returns SiteContainerPaging|errorList site containers
Parameters
- siteId string - The identifier of a site.
- 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.
- 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[]? (default ()) - 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.
Return Type
- SiteContainerPaging|error - Successful response
getSiteContainer
Isolated FunctionRemote Function
function getSiteContainer(string siteId, string containerId, string[]? fields) returns SiteContainerEntry|errorGet a site container
Parameters
- siteId string - The identifier of a site.
- containerId string - The unique identifier of a site container.
- fields string[]? (default ()) - 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.
Return Type
- SiteContainerEntry|error - Successful response
getSiteMembershipRequests
Isolated FunctionRemote Function
function getSiteMembershipRequests(int skipCount, int maxItems, string? 'where, string[]? fields) returns SiteMembershipRequestWithPersonPaging|errorGet site membership requests
Parameters
- 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.
- 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? (default ()) - A string to restrict the returned objects by using a predicate.
- fields string[]? (default ()) - 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.
Return Type
- SiteMembershipRequestWithPersonPaging|error - Successful response
approveSiteMembershipRequest
Isolated FunctionRemote Function
function approveSiteMembershipRequest(string siteId, string inviteeId, SiteMembershipApprovalBody payload) returns Response|errorApprove 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.
rejectSiteMembershipRequest
Isolated FunctionRemote Function
function rejectSiteMembershipRequest(string siteId, string inviteeId, SiteMembershipRejectionBody payload) returns Response|errorReject 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.
listSiteMemberships
Isolated FunctionRemote Function
function listSiteMemberships(string siteId, int skipCount, int maxItems, string[]? fields, string? 'where) returns SiteMemberPaging|errorList site memberships
Parameters
- siteId string - The identifier of a site.
- 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.
- 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[]? (default ()) - 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.
- 'where string? (default ()) - Optionally filter the list. *
where=(isMemberOfGroup=false|true)
Return Type
- SiteMemberPaging|error - Successful response
createSiteMembership
Isolated FunctionRemote Function
function createSiteMembership(string siteId, SiteMembershipBodyCreate payload, string[]? fields) returns SiteMemberEntry|errorCreate a site membership
Parameters
- siteId string - The identifier of a site.
- payload SiteMembershipBodyCreate - The person to add and their role
- fields string[]? (default ()) - 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.
Return Type
- SiteMemberEntry|error - Successful response
getSiteMembership
Isolated FunctionRemote Function
function getSiteMembership(string siteId, string personId, string[]? fields) returns SiteMemberEntry|errorGet a site membership
Parameters
- siteId string - The identifier of a site.
- personId string - The identifier of a person.
- fields string[]? (default ()) - 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.
Return Type
- SiteMemberEntry|error - Successful response
updateSiteMembership
Isolated FunctionRemote Function
function updateSiteMembership(string siteId, string personId, SiteMembershipBodyUpdate payload, string[]? fields) returns SiteMemberEntry|errorUpdate a site membership
Parameters
- siteId string - The identifier of a site.
- personId string - The identifier of a person.
- payload SiteMembershipBodyUpdate - The persons new role
- fields string[]? (default ()) - 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.
Return Type
- SiteMemberEntry|error - Successful response
deleteSiteMembership
Isolated FunctionRemote Function
Delete a site membership
listSiteGroups
Isolated FunctionRemote Function
function listSiteGroups(string siteId, int skipCount, int maxItems, string[]? fields) returns SiteGroupPaging|errorList group membership for site
Parameters
- siteId string - The identifier of a site.
- 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.
- 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[]? (default ()) - 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.
Return Type
- SiteGroupPaging|error - Successful response
createSiteGroupMembership
Isolated FunctionRemote Function
function createSiteGroupMembership(string siteId, SiteMembershipBodyCreate payload, string[]? fields) returns SiteGroupEntry|errorCreate a site membership for group
Parameters
- siteId string - The identifier of a site.
- payload SiteMembershipBodyCreate - The group to add and their role
- fields string[]? (default ()) - 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.
Return Type
- SiteGroupEntry|error - Successful response
getSiteGroupMembership
Isolated FunctionRemote Function
function getSiteGroupMembership(string siteId, string groupId, string[]? fields) returns SiteGroupEntry|errorGet information about site membership of group
Parameters
- siteId string - The identifier of a site.
- groupId string - The identifier of a group.
- fields string[]? (default ()) - 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.
Return Type
- SiteGroupEntry|error - Successful response
updateSiteGroupMembership
Isolated FunctionRemote Function
function updateSiteGroupMembership(string siteId, string groupId, SiteMembershipBodyUpdate payload, string[]? fields) returns SiteGroupEntry|errorUpdate 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
- fields string[]? (default ()) - 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.
Return Type
- SiteGroupEntry|error - Successful response
deleteSiteGroupMembership
Isolated FunctionRemote Function
Delete a group membership for site
listTags
Isolated FunctionRemote Function
function listTags(int skipCount, int maxItems, string[]? fields, string[]? include) returns TagPaging|errorList tags
Parameters
- 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.
- 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[]? (default ()) - 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.
- include string[]? (default ()) - Returns additional information about the tag. The following optional fields can be requested: * count
getTag
Isolated FunctionRemote Function
Get a tag
Parameters
- tagId string - The identifier of a tag.
- fields string[]? (default ()) - 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.
updateTag
Isolated FunctionRemote Function
Update a tag
Parameters
- tagId string - The identifier of a tag.
- payload TagBody - The updated tag
- fields string[]? (default ()) - 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.
getNetwork
Isolated FunctionRemote Function
function getNetwork(string networkId, string[]? fields) returns PersonNetworkEntry|errorGet a network
Parameters
- networkId string - The identifier of a network.
- fields string[]? (default ()) - 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.
Return Type
- PersonNetworkEntry|error - Successful response
listSharedLinks
Isolated FunctionRemote Function
function listSharedLinks(int skipCount, int maxItems, string? 'where, string[]? include, string[]? fields) returns SharedLinkPaging|errorList shared links
Parameters
- 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.
- 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? (default ()) - Optionally filter the list by "sharedByUser" userid of person who shared the link (can also use -me-) *
where=(sharedByUser='jbloggs')*where=(sharedByUser='-me-')
- include string[]? (default ()) - Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path * properties * isFavorite * aspectNames
- fields string[]? (default ()) - 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.
Return Type
- SharedLinkPaging|error - Successful response
createSharedLink
Isolated FunctionRemote Function
function createSharedLink(SharedLinkBodyCreate payload, string[]? include, string[]? fields) returns SharedLinkEntry|errorCreate a shared link to a file
Parameters
- payload SharedLinkBodyCreate - The nodeId to create a shared link for.
- include string[]? (default ()) - Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path * properties * isFavorite * aspectNames
- fields string[]? (default ()) - 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.
Return Type
- SharedLinkEntry|error - Successful response
getSharedLink
Isolated FunctionRemote Function
function getSharedLink(string sharedId, string[]? fields) returns SharedLinkEntry|errorGet a shared link
Parameters
- sharedId string - The identifier of a shared link to a file.
- fields string[]? (default ()) - 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.
Return Type
- SharedLinkEntry|error - Successful response
deleteSharedLink
Isolated FunctionRemote Function
Deletes a shared link
Parameters
- sharedId string - The identifier of a shared link to a file.
getSharedLinkContent
Isolated FunctionRemote Function
function getSharedLinkContent(string sharedId, boolean attachment, string? ifModifiedSince, string? range) returns string|error?Get shared link content
Parameters
- sharedId string - The identifier of a shared link to a file.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
listSharedLinkRenditions
Isolated FunctionRemote Function
function listSharedLinkRenditions(string sharedId) returns RenditionPaging|errorList renditions for a shared link
Parameters
- sharedId string - The identifier of a shared link to a file.
Return Type
- RenditionPaging|error - Successful response
getSharedLinkRendition
Isolated FunctionRemote Function
function getSharedLinkRendition(string sharedId, string renditionId) returns RenditionEntry|errorGet 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.
Return Type
- RenditionEntry|error - Successful response
getSharedLinkRenditionContent
Isolated FunctionRemote Function
function getSharedLinkRenditionContent(string sharedId, string renditionId, boolean attachment, string? ifModifiedSince, string? range) returns string|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.
- 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.
- ifModifiedSince string? (default ()) - 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? (default ()) - The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.
emailSharedLink
Isolated FunctionRemote Function
function emailSharedLink(string sharedId, SharedLinkBodyEmail payload) returns Response|errorEmail shared link
Parameters
- sharedId string - The identifier of a shared link to a file.
- payload SharedLinkBodyEmail - The shared link email to send.
getProbe
Isolated FunctionRemote Function
function getProbe(string probeId) returns ProbeEntry|errorCheck readiness and liveness of the repository
Parameters
- probeId string - The name of the probe: * -ready- * -live-
Return Type
- ProbeEntry|error - Successful response
findNodes
Isolated FunctionRemote Function
function findNodes(string term, string? rootNodeId, int skipCount, int maxItems, string? nodeType, string[]? include, string[]? orderBy, string[]? fields) returns NodePaging|errorFind nodes
Parameters
- term string - The term to search for.
- rootNodeId string? (default ()) - The id of the node to start the search from. Supports the aliases -my-, -root- and -shared-.
- 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.
- maxItems int (default 100) - The maximum number of items to return in the list. If not supplied then the default value is 100.
- nodeType string? (default ()) - Restrict the returned results to only those of the given node type and its sub-types
- include string[]? (default ()) - Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isLocked * path * properties
- orderBy string[]? (default ()) - 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[]? (default ()) - 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.
Return Type
- NodePaging|error - Successful response
findSites
Isolated FunctionRemote Function
function findSites(string term, int skipCount, int maxItems, string[]? orderBy, string[]? fields) returns SitePaging|errorFind sites
Parameters
- term string - The term to search for.
- 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.
- 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[]? (default ()) - 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[]? (default ()) - 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.
Return Type
- SitePaging|error - Successful response
findPeople
Isolated FunctionRemote Function
function findPeople(string term, int skipCount, int maxItems, string[]? fields, string[]? orderBy) returns PersonPaging|errorFind people
Parameters
- term string - The term to search for.
- 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.
- 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[]? (default ()) - 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.
- orderBy string[]? (default ()) - 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.
Return Type
- PersonPaging|error - Successful response
listGroups
Isolated FunctionRemote Function
function listGroups(int skipCount, int maxItems, string[]? orderBy, string[]? include, string? 'where, string[]? fields) returns GroupPaging|errorList groups
Parameters
- 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.
- 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[]? (default ()) - 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.
- include string[]? (default ()) - Returns additional information about the group. The following optional fields can be requested: * parentIds * zones
- 'where string? (default ()) - A string to restrict the returned objects by using a predicate.
- fields string[]? (default ()) - 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.
Return Type
- GroupPaging|error - Successful response
createGroup
Isolated FunctionRemote Function
function createGroup(GroupBodyCreate payload, string[]? include, string[]? fields) returns GroupEntry|errorCreate a group
Parameters
- payload GroupBodyCreate - The group to create.
- include string[]? (default ()) - Returns additional information about the group. The following optional fields can be requested: * parentIds * zones
- fields string[]? (default ()) - 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.
Return Type
- GroupEntry|error - Successful response
getGroup
Isolated FunctionRemote Function
function getGroup(string groupId, string[]? include, string[]? fields) returns GroupEntry|errorGet group details
Parameters
- groupId string - The identifier of a group.
- include string[]? (default ()) - Returns additional information about the group. The following optional fields can be requested: * parentIds * zones
- fields string[]? (default ()) - 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.
Return Type
- GroupEntry|error - Successful response
updateGroup
Isolated FunctionRemote Function
function updateGroup(string groupId, GroupBodyUpdate payload, string[]? include, string[]? fields) returns GroupEntry|errorUpdate group details
Parameters
- groupId string - The identifier of a group.
- payload GroupBodyUpdate - The group information to update.
- include string[]? (default ()) - Returns additional information about the group. The following optional fields can be requested: * parentIds * zones
- fields string[]? (default ()) - 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.
Return Type
- GroupEntry|error - Successful response
deleteGroup
Isolated FunctionRemote Function
Delete a group
Parameters
- groupId string - The identifier of a group.
- cascade boolean (default false) - If true then the delete will be applied in cascade to sub-groups.
listGroupMemberships
Isolated FunctionRemote Function
function listGroupMemberships(string groupId, int skipCount, int maxItems, string[]? orderBy, string? 'where, string[]? fields) returns GroupMemberPaging|errorList memberships of a group
Parameters
- groupId string - The identifier of a group.
- 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.
- 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[]? (default ()) - 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? (default ()) - A string to restrict the returned objects by using a predicate.
- fields string[]? (default ()) - 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.
Return Type
- GroupMemberPaging|error - Successful response
createGroupMembership
Isolated FunctionRemote Function
function createGroupMembership(string groupId, GroupMembershipBodyCreate payload, string[]? fields) returns GroupMemberEntry|errorCreate a group membership
Parameters
- groupId string - The identifier of a group.
- payload GroupMembershipBodyCreate - The group membership to add (person or sub-group).
- fields string[]? (default ()) - 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.
Return Type
- GroupMemberEntry|error - Successful response
deleteGroupMembership
Isolated FunctionRemote Function
Delete a group membership
Parameters
- groupId string - The identifier of a group.
- groupMemberId string - The identifier of a person or group.
listAuditApps
Isolated FunctionRemote Function
function listAuditApps(int skipCount, int maxItems, string[]? fields) returns AuditAppPaging|errorList audit applications
Parameters
- 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.
- 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[]? (default ()) - 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.
Return Type
- AuditAppPaging|error - Successful response
getAuditApp
Isolated FunctionRemote Function
function getAuditApp(string auditApplicationId, string[]? fields, string[]? include) returns AuditApp|errorGet audit application info
Parameters
- auditApplicationId string - The identifier of an audit application.
- fields string[]? (default ()) - 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.
- include string[]? (default ()) - Also include the current minimum and/or maximum audit entry ids for the application. The following optional fields can be requested: * max * min
updateAuditApp
Isolated FunctionRemote Function
function updateAuditApp(string auditApplicationId, AuditBodyUpdate payload, string[]? fields) returns AuditApp|errorUpdate audit application info
Parameters
- auditApplicationId string - The identifier of an audit application.
- payload AuditBodyUpdate - The audit application to update.
- fields string[]? (default ()) - 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.
listAuditEntriesForAuditApp
Isolated FunctionRemote Function
function listAuditEntriesForAuditApp(string auditApplicationId, int skipCount, boolean omitTotalItems, string[]? orderBy, int maxItems, string? 'where, string[]? include, string[]? fields) returns AuditEntryPaging|errorList audit entries for an audit application
Parameters
- auditApplicationId string - The identifier of an audit application.
- 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.
- 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[]? (default ()) - 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.
- 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? (default ()) - 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')
- include string[]? (default ()) - Returns additional information about the audit entry. The following optional fields can be requested: * values
- fields string[]? (default ()) - 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.
Return Type
- AuditEntryPaging|error - Successful response
deleteAuditEntriesForAuditApp
Isolated FunctionRemote Function
function deleteAuditEntriesForAuditApp(string auditApplicationId, string 'where) returns Response|errorPermanently delete audit entries for an audit application
Parameters
- auditApplicationId string - The identifier of an audit application.
- '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')
getAuditEntry
Isolated FunctionRemote Function
function getAuditEntry(string auditApplicationId, string auditEntryId, string[]? fields) returns AuditEntryEntry|errorGet audit entry
Parameters
- auditApplicationId string - The identifier of an audit application.
- auditEntryId string - The identifier of an audit entry.
- fields string[]? (default ()) - 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.
Return Type
- AuditEntryEntry|error - Successful response
deleteAuditEntry
Isolated FunctionRemote Function
Permanently delete an audit entry
Parameters
- auditApplicationId string - The identifier of an audit application.
- auditEntryId string - The identifier of an audit entry.
listAuditEntriesForNode
Isolated FunctionRemote Function
function listAuditEntriesForNode(string nodeId, int skipCount, string[]? orderBy, int maxItems, string? 'where, string[]? include, string[]? fields) returns AuditEntryPaging|errorList audit entries for a node
Parameters
- nodeId string - The identifier of a node.
- 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.
- orderBy string[]? (default ()) - 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.
- 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? (default ()) - 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')
- include string[]? (default ()) - Returns additional information about the audit entry. The following optional fields can be requested: * values
- fields string[]? (default ()) - 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.
Return Type
- AuditEntryPaging|error - Successful response
listActions
Isolated FunctionRemote Function
function listActions(int skipCount, int maxItems, string[]? orderBy, string[]? fields) returns ActionDefinitionList|errorRetrieve list of available actions
Parameters
- 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.
- 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[]? (default ()) - 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[]? (default ()) - 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.
Return Type
- ActionDefinitionList|error - Successful response
actionDetails
Isolated FunctionRemote Function
function actionDetails(string actionDefinitionId) returns ActionDefinitionEntry|errorRetrieve the details of an action definition
Parameters
- actionDefinitionId string - The identifier of an action definition.
Return Type
- ActionDefinitionEntry|error - Successful response
actionExec
Isolated FunctionRemote Function
function actionExec(ActionBodyExec payload) returns ActionExecResultEntry|errorExecute an action
Parameters
- payload ActionBodyExec - Action execution details
Return Type
- ActionExecResultEntry|error - Action execution request accepted and pending execution.
Records
alfresco: ActionBodyExec
Fields
- actionDefinitionId string -
- targetId string? - The entity upon which to execute the action, typically a node ID or similar.
- params record {}? -
alfresco: ActionDefinition
Fields
- id string - Identifier of the action definition — used for example when executing an action
- name string? - name of the action definition, e.g. "move"
- title string? - title of the action definition, e.g. "Move"
- description string? - describes the action definition, e.g. "This will move the matched item to another space."
- applicableTypes string[] - QNames of the types this action applies to
- trackStatus boolean - whether the basic action definition supports action tracking or not
- parameterDefinitions ActionParameterDefinition[]? -
alfresco: ActionDefinitionEntry
Fields
- entry ActionDefinition -
alfresco: ActionDefinitionList
Fields
- list ActiondefinitionlistList? -
alfresco: ActiondefinitionlistList
Fields
- pagination Pagination? -
- entries ActionDefinition[]? -
alfresco: ActionExecResult
Fields
- id string - The unique identifier of the action pending execution
alfresco: ActionExecResultEntry
Fields
- entry ActionExecResult -
alfresco: ActionParameterDefinition
Fields
- name string? -
- 'type string? -
- multiValued boolean? -
- mandatory boolean? -
- displayLabel string? -
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
- postPersonId string - The id of the person who performed the activity
- id int - The unique id of the activity
- siteId string? - The unique id of the site on which the activity was performed
- postedAt string? - The date time at which the activity was performed
- feedPersonId string - The feed on which this activity was posted
- activitySummary record {}? - An object summarizing 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
- pagination Pagination -
- entries ActivityEntry[] -
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
- id string -
- name string? -
- isEnabled boolean(default true) -
- maxEntryId int? -
- minEntryId int? -
alfresco: AuditAppEntry
Fields
- entry AuditApp? -
alfresco: AuditAppPaging
Fields
- list AuditapppagingList? -
alfresco: AuditapppagingList
Fields
- pagination Pagination? -
- entries AuditAppEntry[]? -
alfresco: AuditBodyUpdate
Fields
- isEnabled boolean? -
alfresco: AuditEntry
Fields
- id string -
- auditApplicationId string -
- createdByUser UserInfo -
- createdAt string -
- values record {}? -
alfresco: AuditEntryEntry
Fields
- entry AuditEntry? -
alfresco: AuditEntryPaging
Fields
- list AuditentrypagingList? -
alfresco: AuditentrypagingList
Fields
- pagination Pagination? -
- entries AuditEntryEntry[]? -
alfresco: Capabilities
Fields
- isAdmin boolean? -
- isGuest boolean? -
- isMutable boolean? -
alfresco: ChildAssociation
Fields
- childId string -
- assocType string -
alfresco: ChildAssociationBody
Fields
- childId string -
- assocType string -
alfresco: ChildAssociationEntry
Fields
- entry ChildAssociation -
alfresco: ChildAssociationInfo
Fields
- assocType string -
- isPrimary boolean -
alfresco: ClientBody
Fields
- 'client string - the client name
alfresco: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
alfresco: Comment
Fields
- id string -
- title string -
- content string -
- createdBy Person -
- createdAt string -
- edited boolean -
- modifiedBy Person -
- modifiedAt string -
- canEdit boolean -
- canDelete boolean -
alfresco: CommentBody
Fields
- content string -
alfresco: CommentEntry
Fields
- entry Comment -
alfresco: CommentPaging
Fields
- list CommentpagingList -
alfresco: CommentpagingList
Fields
- pagination Pagination -
- entries CommentEntry[] -
alfresco: Company
Fields
- organization string? -
- address1 string? -
- address2 string? -
- address3 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? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - 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
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
alfresco: Constraint
Fields
- id string -
- 'type string? - the type of the constraint
- title string? - the human-readable constraint title
- description string? - the human-readable constraint description
- parameters record {}? -
alfresco: ContentInfo
Fields
- mimeType string -
- mimeTypeName string? -
- sizeInBytes int? -
- encoding string? -
alfresco: Definition
Fields
- properties Property[]? - List of property definitions effective for this node as the result of combining the type with all aspects.
alfresco: DeletedNode
Fields
- Fields Included from * Node
- id string
- name string
- nodeType string
- isFolder boolean
- isFile boolean
- isLocked boolean
- modifiedAt string
- modifiedByUser UserInfo
- createdAt string
- createdByUser UserInfo
- parentId string
- isLink boolean
- isFavorite boolean
- content ContentInfo
- aspectNames string[]
- properties record { anydata... }
- allowableOperations string[]
- path PathInfo
- permissions PermissionsInfo
- definition Definition
- anydata...
- archivedByUser UserInfo -
- archivedAt string -
alfresco: DeletedNodeBodyRestore
Fields
- targetParentId string? -
- assocType string? -
alfresco: DeletedNodeEntry
Fields
- entry DeletedNode? -
alfresco: DeletedNodesPaging
Fields
- list DeletednodespagingList? -
alfresco: DeletednodespagingList
Fields
- pagination Pagination? -
- entries DeletedNodeEntry[]? -
alfresco: DirectAccessUrlBodyCreate
Fields
- expiresAt string? -
- validFor int? - The length of time in seconds that the url is valid for.
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
- id string? - the id of the download node
- totalFiles int? - the total number of files to be added in the zip
- totalBytes int? - the total number of bytes to be added in the zip
- status string? - the current status of the download node creation
alfresco: DownloadBodyCreate
Fields
- nodeIds string[] -
alfresco: DownloadEntry
Fields
- entry Download -
alfresco: Error
Fields
- 'error ErrorError -
alfresco: ErrorError
Fields
- errorKey string? -
- statusCode int -
- briefSummary string -
- stackTrace string -
- descriptionURL string -
- logId string? -
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.
- target record {} -
- properties record {}? - A subset of the target favorite properties, system properties and properties already available in the target are excluded.
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
- pagination Pagination -
- entries FavoriteEntry[] -
alfresco: FavoriteSite
Fields
- id string -
alfresco: FavoriteSiteBodyCreate
Fields
- id string -
alfresco: FavoriteSiteEntry
Fields
- entry FavoriteSite -
alfresco: Group
Fields
- id string -
- displayName string -
- isRoot boolean -
- parentIds string[]? -
- zones string[]? -
alfresco: GroupBodyCreate
Fields
- id string -
- displayName string -
- parentIds string[]? -
alfresco: GroupBodyUpdate
Fields
- displayName string -
alfresco: GroupEntry
Fields
- entry Group -
alfresco: GroupMember
Fields
- id string -
- displayName string -
- memberType string -
alfresco: GroupMemberEntry
Fields
- entry GroupMember -
alfresco: GroupMemberPaging
Fields
- list GroupmemberpagingList? -
alfresco: GroupmemberpagingList
Fields
- pagination Pagination? -
- entries GroupMemberEntry[]? -
alfresco: GroupMembershipBodyCreate
Fields
- id string -
- memberType string -
alfresco: GroupPaging
Fields
- list GrouppagingList? -
alfresco: GrouppagingList
Fields
- pagination Pagination? -
- entries GroupEntry[]? -
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
- id string -
- 'limit int -
- usage int -
alfresco: Node
Fields
- id 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.
- nodeType string -
- isFolder boolean -
- isFile boolean -
- isLocked boolean(default false) -
- modifiedAt string -
- modifiedByUser UserInfo -
- createdAt string -
- createdByUser UserInfo -
- parentId string? -
- isLink boolean? -
- isFavorite boolean? -
- content ContentInfo? -
- aspectNames string[]? -
- properties record {}? -
- allowableOperations string[]? -
- path PathInfo? -
- permissions PermissionsInfo? -
- definition Definition? -
alfresco: NodeAssociation
Fields
- Fields Included from * Node
- id string
- name string
- nodeType string
- isFolder boolean
- isFile boolean
- isLocked boolean
- modifiedAt string
- modifiedByUser UserInfo
- createdAt string
- createdByUser UserInfo
- parentId string
- isLink boolean
- isFavorite boolean
- content ContentInfo
- aspectNames string[]
- properties record { anydata... }
- allowableOperations string[]
- path PathInfo
- permissions PermissionsInfo
- definition Definition
- anydata...
- association AssociationInfo? -
alfresco: NodeAssociationEntry
Fields
- entry NodeAssociation -
alfresco: NodeAssociationPaging
Fields
- list NodeassociationpagingList? -
alfresco: NodeassociationpagingList
Fields
- pagination Pagination? -
- entries NodeAssociationEntry[]? -
- '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
- 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 -
- aspectNames string[]? -
- properties record {}? -
- permissions PermissionsBody? -
- definition Definition? -
- relativePath string? -
- association NodebodycreateAssociation? -
- secondaryChildren ChildAssociationBody[]? -
- targets AssociationBody[]? -
alfresco: NodebodycreateAssociation
Fields
- assocType string? -
alfresco: NodeBodyLock
Fields
- timeToExpire int? -
- 'type string? -
- lifetime string? -
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
- 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? -
- aspectNames string[]? -
- properties record {}? -
- permissions PermissionsBody? -
alfresco: NodeChildAssociation
Fields
- Fields Included from * Node
- id string
- name string
- nodeType string
- isFolder boolean
- isFile boolean
- isLocked boolean
- modifiedAt string
- modifiedByUser UserInfo
- createdAt string
- createdByUser UserInfo
- parentId string
- isLink boolean
- isFavorite boolean
- content ContentInfo
- aspectNames string[]
- properties record { anydata... }
- allowableOperations string[]
- path PathInfo
- permissions PermissionsInfo
- definition Definition
- anydata...
- association ChildAssociationInfo? -
alfresco: NodeChildAssociationEntry
Fields
- entry NodeChildAssociation -
alfresco: NodeChildAssociationPaging
Fields
- list NodechildassociationpagingList? -
alfresco: NodechildassociationpagingList
Fields
- pagination Pagination? -
- entries NodeChildAssociationEntry[]? -
- 'source Node? -
alfresco: NodeEntry
Fields
- entry Node -
alfresco: NodePaging
Fields
- list NodepagingList? -
alfresco: NodepagingList
Fields
- pagination Pagination? -
- entries NodeEntry[]? -
- 'source Node? -
alfresco: Pagination
Fields
- count int? - The number of objects in the entries array.
- 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.
- 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.
- 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.
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
- id string? -
- name string? -
- nodeType string? -
- aspectNames string[]? -
alfresco: PathInfo
Fields
- elements PathElement[]? -
- name string? -
- isComplete boolean? -
alfresco: PermissionElement
Fields
- name string? -
- accessStatus string? -
alfresco: PermissionsBody
Fields
- isInheritanceEnabled boolean? -
- locallySet PermissionElement[]? -
alfresco: PermissionsInfo
Fields
- isInheritanceEnabled boolean? -
- inherited PermissionElement[]? -
- locallySet PermissionElement[]? -
- settable string[]? -
alfresco: Person
Fields
- id string -
- firstName string -
- lastName string? -
- displayName string? -
- description string? -
- avatarId string? -
- email string -
- skypeId string? -
- googleId string? -
- instantMessageId string? -
- jobTitle string? -
- location string? -
- company Company? -
- mobile string? -
- telephone string? -
- statusUpdatedAt string? -
- userStatus string? -
- enabled boolean -
- emailNotificationsEnabled boolean(default true) -
- aspectNames string[]? -
- properties record {}? -
- capabilities Capabilities? -
alfresco: PersonBodyCreate
Fields
- id string -
- firstName string -
- lastName string? -
- description string? -
- email string -
- skypeId string? -
- googleId string? -
- instantMessageId string? -
- jobTitle string? -
- location string? -
- company Company? -
- mobile string? -
- telephone string? -
- userStatus string? -
- enabled boolean(default true) -
- emailNotificationsEnabled boolean(default true) -
- password string -
- aspectNames string[]? -
- properties record {}? -
alfresco: PersonBodyUpdate
Fields
- firstName string? -
- lastName string? -
- description string? -
- email string? -
- skypeId string? -
- googleId string? -
- instantMessageId string? -
- jobTitle string? -
- location string? -
- company Company? -
- mobile string? -
- telephone string? -
- userStatus string? -
- enabled boolean? -
- emailNotificationsEnabled boolean? -
- password string? -
- oldPassword string? -
- aspectNames 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
- id string - This network's unique id
- homeNetwork boolean? - Is this the home network?
- isEnabled boolean -
- createdAt string? -
- paidNetwork boolean? -
- subscriptionLevel string? -
- quotas NetworkQuota[]? -
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
- pagination Pagination -
- entries PersonNetworkEntry[] -
alfresco: PersonPaging
Fields
- list PersonpagingList? -
alfresco: PersonpagingList
Fields
- pagination Pagination? -
- entries PersonEntry[]? -
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
- pagination Pagination -
- entries PreferenceEntry[] -
alfresco: ProbeEntry
Fields
- entry ProbeentryEntry -
alfresco: ProbeentryEntry
Fields
- message string -
alfresco: Property
Fields
- id string -
- title string? - the human-readable title
- description string? - the human-readable description
- 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
- isMandatory boolean? - define if the property is mandatory
- isMandatoryEnforced boolean? - define if the presence of mandatory properties is enforced
- isProtected boolean? - define if the property is system maintained
- constraints Constraint[]? - list of constraints defined for the property
alfresco: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
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
- id string -
- aggregate RatingAggregate -
- ratedAt string? -
- myRating string? - The rating. The type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar.
alfresco: RatingAggregate
Fields
- numberOfRatings int -
- average int? -
alfresco: RatingBody
Fields
- id string - The rating scheme type. Possible values are likes and fiveStar.
- myRating string - The rating. The type is specific to the rating scheme, boolean for the likes and an integer for the 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
- pagination Pagination -
- entries RatingEntry[] -
alfresco: Rendition
Fields
- id string? -
- content ContentInfo? -
- status string? -
alfresco: RenditionBodyCreate
Fields
- id string -
alfresco: RenditionEntry
Fields
- entry Rendition -
alfresco: RenditionPaging
Fields
- list RenditionpagingList? -
alfresco: RenditionpagingList
Fields
- pagination Pagination? -
- entries RenditionEntry[]? -
alfresco: RevertBody
Fields
- majorVersion boolean? -
- comment string? -
alfresco: SharedLink
Fields
- id string? -
- expiresAt string? -
- nodeId 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.
- title string? -
- description string? -
- modifiedAt string? -
- modifiedByUser UserInfo? -
- content ContentInfo? -
- allowableOperations string[]? - The allowable operations for the Quickshare link itself. See allowableOperationsOnTarget for the allowable operations pertaining to the linked content node.
- allowableOperationsOnTarget string[]? - The allowable operations for the content node being shared.
- isFavorite boolean? -
- properties record {}? - A subset of the target node's properties, system properties and properties already available in the SharedLink are excluded.
- aspectNames string[]? -
- path PathInfo? -
alfresco: SharedLinkBodyCreate
Fields
- nodeId string -
- expiresAt string? -
alfresco: SharedLinkBodyEmail
Fields
- 'client string? -
- message string? -
- locale string? -
- recipientEmails string[]? -
alfresco: SharedLinkEntry
Fields
- entry SharedLink -
alfresco: SharedLinkPaging
Fields
- list SharedlinkpagingList -
alfresco: SharedlinkpagingList
Fields
- pagination Pagination -
- entries SharedLinkEntry[] -
alfresco: Site
Fields
- id string -
- guid string -
- title string -
- description string? -
- visibility string -
- preset string? -
- role string? -
alfresco: SiteBodyCreate
Fields
- id string? -
- title string -
- description string? -
- visibility string -
alfresco: SiteBodyUpdate
Fields
- title string? -
- description string? -
- visibility string? -
alfresco: SiteContainer
Fields
- id string -
- folderId string -
alfresco: SiteContainerEntry
Fields
- entry SiteContainer -
alfresco: SiteContainerPaging
Fields
- list SitecontainerpagingList -
alfresco: SitecontainerpagingList
Fields
- pagination Pagination -
- entries SiteContainerEntry[] -
alfresco: SiteEntry
Fields
- entry Site -
alfresco: SiteGroup
Fields
- id string -
- group GroupMember -
- role string -
alfresco: SiteGroupEntry
Fields
- entry SiteGroup -
alfresco: SiteGroupPaging
Fields
- list SitegrouppagingList -
alfresco: SitegrouppagingList
Fields
- pagination Pagination -
- entries SiteGroupEntry[] -
alfresco: SiteMember
Fields
- id string -
- person Person -
- role string -
- isMemberOfGroup boolean? -
alfresco: SiteMemberEntry
Fields
- entry SiteMember -
alfresco: SiteMemberPaging
Fields
- list SitememberpagingList -
alfresco: SitememberpagingList
Fields
- pagination Pagination -
- entries SiteMemberEntry[] -
alfresco: SiteMembershipApprovalBody
Fields
- role string? -
alfresco: SiteMembershipBodyCreate
Fields
- role string -
- id string -
alfresco: SiteMembershipBodyUpdate
Fields
- role string -
alfresco: SiteMembershipRejectionBody
Fields
- comment string? -
alfresco: SiteMembershipRequest
Fields
- id string -
- createdAt string -
- site Site -
- message string? -
alfresco: SiteMembershipRequestBodyUpdate
Fields
- message string? -
alfresco: SiteMembershipRequestEntry
Fields
- entry SiteMembershipRequest -
alfresco: SiteMembershipRequestPaging
Fields
alfresco: SitemembershiprequestpagingList
Fields
- pagination Pagination -
- entries SiteMembershipRequestEntry[] -
alfresco: SiteMembershipRequestWithPerson
Fields
- id string -
- createdAt string -
- site Site -
- person Person -
- message string? -
alfresco: SiteMembershipRequestWithPersonEntry
Fields
- entry SiteMembershipRequestWithPerson -
alfresco: SiteMembershipRequestWithPersonPaging
Fields
alfresco: SitemembershiprequestwithpersonpagingList
Fields
- pagination Pagination -
- entries SiteMembershipRequestWithPersonEntry[] -
alfresco: SitePaging
Fields
- list SitepagingList -
alfresco: SitepagingList
Fields
- pagination Pagination -
- entries SiteEntry[] -
alfresco: SiteRole
Fields
- site Site -
- id string -
- guid string -
- role string -
alfresco: SiteRoleEntry
Fields
- entry SiteRole -
alfresco: SiteRolePaging
Fields
- list SiterolepagingList -
alfresco: SiterolepagingList
Fields
- pagination Pagination -
- entries SiteRoleEntry[] -
alfresco: Tag
Fields
- id string -
- tag string -
- count decimal? -
alfresco: TagBody
Fields
- tag string -
alfresco: TagEntry
Fields
- entry Tag -
alfresco: TagPaging
Fields
- list TagpagingList -
alfresco: TagpagingList
Fields
- pagination Pagination -
- entries TagEntry[] -
alfresco: UserInfo
Fields
- displayName string -
- id string -
alfresco: Version
Fields
- id string -
- 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.
- nodeType string -
- isFolder boolean -
- isFile boolean -
- modifiedAt string -
- modifiedByUser UserInfo -
- content ContentInfo? -
- aspectNames string[]? -
- properties record {}? -
alfresco: VersionEntry
Fields
- entry Version? -
alfresco: VersionPaging
Fields
- list VersionpagingList? -
alfresco: VersionpagingList
Fields
- pagination Pagination? -
- entries VersionEntry[]? -