Otecmconnector v1

/v1/apiinfo

Provides the GET, POST, PUT and DELETE methods for the given resource.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Resource`	The REST API url to get information on (ex. api/v1/nodes/2000/nodes)
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/auth

Authenticates user with the given credentials, returning an OTCS ticket if authorized.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Username`	Login name
`Password`	Login password
`Domain`	Login domain

/v1/auth

Gets information on the currently authenticated user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Perspective`	Determines if the perspective for the node will be included in the response.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/bulkactions

Gets the list of actions that can be performed on multiple nodes. NOTE: This call only lists the actions and does not perform them. Bulk actions (ie. deleting multiple nodes, copying multiple nodes, reserving multiple nodes) are not yet supported in REST API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/categories

Applies an existing category to a node. Only one category (and its values) may be applied at a time

The following examples will assume that there is a category (ID 9830) that has the following attributes:TextField (Attribute ID 2)Set (Attribute ID 3) with two rows. The Set has a multi-value Textfield (Set Attribute ID 4) that can have a maximum of 3 values
Apply the category and use the default values for its attributes:
{"category_id":9830}

Apply the category and change the value of the Textfield:
{"category_id":9830,"9830_2":"new value"}

Apply the category and change the value of the Set's Textfield in the second row, for the Set Textfield's third value:
{"category_id":9830,"9830_3_2_4":["","","new value"]}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (2)

Option Name	Description
`Category Id`	Category ID
`{attribute Key}`	Attribute key in the format {category_id}_[{set_id}_{set_row}]_{attribute_id}. See the [IMPLEMENTATION NOTES] for a more detailed explanation.

/v2/nodes/{id}/categories

Applies an existing category to a node. Only one category (and its values) may be applied at a time

The following examples will assume that there is a category (ID 9830) that has the following attributes:TextField (Attribute ID 2)Set (Attribute ID 3) with two rows. The Set has a multi-value Textfield (Set Attribute ID 4) that can have a maximum of 3 values
Apply the category and use the default values for its attributes:
{"category_id":9830}

Apply the category and change the value of the Textfield:
{"category_id":9830,"9830_2":"new value"}

Apply the category and change the value of the Set's Textfield in the second row, for the Set Textfield's third value:
{"category_id":9830,"9830_3_2_4":["","","new value"]}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (2)

Option Name	Description
`Category Id`	Category ID
`{attribute Key}`	Attribute key in the format {category_id}_[{set_id}_{set_row}]_{attribute_id}. See the [IMPLEMENTATION NOTES] for a more detailed explanation.

/v2/nodes/{id}/categories/{category_id}/inheritance

Disable inheritance of the given category (which is on the node) by the node's children. When child nodes are added under the node, this category will not be inherited.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Response Type`	N/A

/v2/nodes/{id}/categories/{category_id}/inheritance

Enable inheritance of the given category (which is on the node) by the node's children. When child nodes are added under the node, this category will be inherited.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Response Type`	N/A

/v1/nodes/{id}/categories/{category_id}/

Get details for the given category applied to the specified node

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/categories/{category_id}/

Get details for the given category applied to the specified node

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/categories/{category_id}/actions

Get the available category-related actions for a category on a node

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/categories/actions

Get the available category-related actions for a node

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/categories

Get the categories applied to the specified node

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/categories

Get the categories applied to the specified node

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/categories/{category_id}/

Removes the given category from the specified node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Response Type`	N/A

/v2/nodes/{id}/categories/{category_id}/

Removes the given category from the specified node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Response Type`	N/A

/v1/nodes/{id}/categories/{category_id}/

Updates an existing category on a node. Only one category (and its values) may be updated at a time.

The optional 'metadata_token' parameter may be specified if there is a need to avoid edit conflicts. There are two ways to retrieve the current metadata_token(s):Pass in the current metadata_token when updating the category (see the example below). If the update is successful, metadata_token(s) will be generated and returned under state.categories and these will be valid for the next category update call.If you want the current metadata_tokens before performing a category update, use the call 'GET /v2/nodes/{id}?state'. The current metadata_token(s) will be displayed under results.state.categories
The following examples will assume that there is a category (ID 9830) that has the following attributes:TextField (Attribute ID 2)Set (Attribute ID 3) with two rows. The Set has a multi-value Textfield (Set Attribute ID 4) that can have a maximum of 3 values
Change the value of the Textfield:
{"9830_2":"new value"}

Change the value of the Textfield while using the metadata_token to avoid edit conflicts:
{"9830_1":{"metadata_token":"9ec9bcab09f9963db044ff6749e5c5c2"},"9830_2":"new value"}

Change the value of the Set's Textfield in the second row, for the Set Textfield's third value:
{"9830_3_2_4":["","","new value"]}

Remove the Set's second row:
{"9830_3_2":""}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Response Type`	N/A

Options (2)

Option Name	Description
`{category Id} 1`	The JSON object containing the metadata state token (for edit conflict resolution), See the [IMPLEMENTATION NOTES] for a more detailed explanation. NOTE: if this is specified and the call is successful, the most recent metadata token will be returned in the result.
`Metadata Token`	The metadata state token. It is used to resolve edit conflicts where two users are updating the node at the same time.NOTE: If this is specified and the call is successful, the most recent metadata token will be returned in the result.

/v2/nodes/{id}/categories/{category_id}/

Updates an existing category on a node. Only one category (and its values) may be updated at a time.

The optional 'metadata_token' parameter may be specified if there is a need to avoid edit conflicts. There are two ways to retrieve the current metadata_token(s):Pass in the current metadata_token when updating the category (see the example below). If the update is successful, metadata_token(s) will be generated and returned under results.state.categories and these will be valid for the next category update call.If you want the current metadata_tokens before performing a category update, use the call 'GET /v2/nodes/{id}?state'. The current metadata_token(s) will be displayed under results.state.categories
The following examples will assume that there is a category (ID 9830) that has the following attributes:TextField (Attribute ID 2)Set (Attribute ID 3) with two rows. The Set has a multi-value Textfield (Set Attribute ID 4) that can have a maximum of 3 values
Change the value of the Textfield:
{"9830_2":"new value"}

Change the value of the Textfield while using the metadata_token to avoid edit conflicts:
{"9830_1":{"metadata_token":"9ec9bcab09f9963db044ff6749e5c5c2"},"9830_2":"new value"}

Change the value of the Set's Textfield in the second row, for the Set Textfield's third value:
{"9830_3_2_4":["","","new value"]}

Remove the Set's second row:
{"9830_3_2":""}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Category Id`	Category ID
`Response Type`	N/A

Options (2)

Option Name	Description
`{category Id} 1`	The JSON object containing the metadata state token (for edit conflict resolution), See the [IMPLEMENTATION NOTES] for a more detailed explanation. NOTE: if this is specified and the call is successful, the most recent metadata token will be returned in the result.
`Metadata Token`	The metadata state token. It is used to resolve edit conflicts where two users are updating the node at the same time.NOTE: If this is specified and the call is successful, the most recent metadata token will be returned in the result.

/v2/nodes/{id}/categories/upgrade

Upgrade categories on a node to the latest category definitions. If the upgrade operation fails (because of insufficient permissions, or a category is already the latest version, etc) then nothing will happen to any of the categories on the node (ie. none of them will be upgraded).

NOTE: This can only be done using the 'body' parameter (see the [IMPLEMENTATION NOTES]).

Examples:

Upgrade the category 8479 on the node:
body = { "category_id":[8479] }

Upgrade the categories 8479 and 7534 on the node:
body = { "category_id":[8479,7534] }

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Category Id`	The list of category IDs to upgrade on the node, separated by commas (see the examples above).

/v2/doctemplates

Creates a Instance for selected Document Template. The body must contain information about the parent_id and the template_id. You can provide information about the name, name_multilingual, description, description_multilingual, roles.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Body`	The body. Example: {"template_id":139327,"parent_id":15082,"name":"Name","type":144,"description":"","roles":{"categories":{},"classifications":{"create_id":[7052,7053],"id":[]}}}
`Response Type`	N/A

/v1/documentproperties/insertableproperties/{id}

Gets list of Insertable Properties and the associated value.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The data ID of the document
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/draftprocesses

Creates a draft process and optional custom data can be set.

When request has only workflow_id ,it creates temporary workflow based on the workflow_id .
If request is having optional form param doc_ids ,api sets the custom data to process created by workflow_id .

The following examples will assume that there is a workflow_id 6686 and doc_ids 384,9684 Creating the process with workflow_id
{"workflow_id":6686}

Creating the process with workflow_id and setting custom data via doc_ids ( Note : Multiple doc ids to be separated with coma)
{"workflow_id":6686,"doc_ids":"384,9684"}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Workflow Id`	Integer .See the [IMPLEMENTATION NOTES] for a more detailed explanation.
`Doc Ids`	To set any custom data to the workflow its JSON string.See the [IMPLEMENTATION NOTES] for a more detailed explanation.

/v2/draftprocesses/{draftprocess_id}

Initiates or updates a workflow based on the provided action.

If action is initiate ,workflow intance will be created based on the draftprocess_id passed in the path with comment as optional filed .
if action is formupate , data passed via values body parameters will be set to form data prior initiating the workflow .

Examples To initiating the workflow with comment as optional.
body:{"action":"Initiate","comment":"start"}
To prepare the workflow with empty values before initiating the workflow
body : {"action":"formUpdate","values":{"WorkflowForm":{}}}

To update the form of workflow before initiating the workflow
body : {"action":"formUpdate","values":{"WorkflowForm_1x4x1x2":"ABC"}}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Draftprocess Id`	Draft process id.
`Response Type`	N/A

Options (3)

Option Name	Description
`Action`	Standard action to be executed.Allowed actions 'initiate','formupdate'.
`Comment`	Workflow comment.
`Values`	The JSON object containing the WorkflowForm values {"WorkflowForm_1x4x1x2":"ABC"} . See the [IMPLEMENTATION NOTES] for a more detailed explanation.

/v2/export/system/settings

Export System Settings to a report file

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includedefaults`	Indicates report should include default values
`Fileformat`	Extension of report format
`Response Type`	N/A

/v2/facets/{id}

Gets facet information for the specified node ID.

NOTE: If the node is a Virtual Folder the facets used to generate this object will be returned by default.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Where Facet`	Specify facets that will alter the available facets for this node using the following syntax: {facetID}:{value1}\|{value2} For example: &where_facet=2100:re09&where_facet=2095:0\|144&where_facet=2100:dy20160504
`Top Values Limit`	Limit the number of available facet values to the top values only (ie. maximum values to display). If specified with a value (ie. top_values_limit=5), the number of returned facet values will be set to that. If specified without a value (ie. top_values_limit), then the default maximum values to display (as configured on Content Server) will be used.NOTE: Relative date facets such as 'Modified Date' are not affected by this parameter at all, also selected facets are similarly unaffected
`Facet Id`	Limit the output of the available facets and their values to the specified facet ID(s). This can be specified multiple times (ex. ?facet_id=5880&facet_id=5885)NOTE: results.data.facets will always show the selected facet(s) (if any).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/forms/doctemplates/create

Fetches the meta data for document templates to render the create form while creating an instance to a selected template

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Parent Id`	Parent ID
`Template Id`	Template ID
`Response Type`	N/A

/v1/forms/nodes/properties/general

Gets the Alpaca form detailing the general properties of a node. The metadata state token (for edit conflict resolution) will be under data.metadata_token

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/versions/properties/general

Gets the Alpaca form detailing the general properties of a version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Version Number`	The version number of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/properties/specific

Gets the Alpaca form detailing the specific properties of a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/versions/properties/specific

Gets the Alpaca form detailing the specific properties of a version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Version Number`	The version number of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/users/{user_id}/view

Gets the Alpaca form for a user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The id of the user
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/copy

Gets the Alpaca form for copying a node. If adding categories, the following must be specified: 'parent_id', 'id' (only one id - adding categories during a bulk copy is not supported), 'inheritance', 'category_id' (can be specified multiple times). Example: ?parent_id=2000&id=1234&inheritance=0&category_id=4444&category_id=5555. See the [IMPLEMENTATION NOTES] for a more detailed explanation.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Parent Id`	The ID of the destination node
`Inheritance`	The requested category inheritance model. 0 = 'Original' (the original node's categories), 1 = 'Destination' (the destination node's categories), 2 = 'Merged' (a merge of the original and destination nodes' categories)
`Category Id`	The ID of the category to be added (can be specified multiple times, ex. category_id=4321&category_id=7878). In order to use this parameter we need to specify 'parent_id', 'id', and 'inheritance' (ex. ?parent_id=2000&id=1111&inheritance=0&category_id=3948)
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/categories/create

Gets the Alpaca form for creating a category on a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Category Id`	The ID of the category to create on the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/create

Gets the Alpaca form for creating a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	The subtype of the node to be created
`Parent Id`	The ID of the parent node for the node that will be created
`Category Id`	The ID of the category to add to the node (this parameter can be called multiple times, ex. category_id=111&category_id=222)
`{attribute Name}`	Value for the Additional Node Attribute
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/versions/create

Gets the Alpaca form for creating a version on a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/versions/categories

Gets the Alpaca form for displaying the categories on a version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Version Number`	The version number of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/file

Gets the Alpaca form for filing a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/move

Gets the Alpaca form for moving a node. If adding categories, the following must be specified: 'parent_id', 'id' (only one id - adding categories during a bulk move is not supported), 'inheritance', 'category_id' (can be specified multiple times). Example: ?parent_id=2000&id=1234&inheritance=0&category_id=4444&category_id=5555

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Parent Id`	The ID of the destination node
`Inheritance`	The requested category inheritance model. 0 = 'Original' (the original node's categories), 1 = 'Destination' (the destination node's categories), 2 = 'Merged' (a merge of the original and destination nodes' categories)
`Category Id`	The ID of the category to be added (can be specified multiple times, ex. category_id=4321&category_id=7878). This parameter requires 'parent_id', only one of 'id', and 'inheritance' (ex. ?parent_id=2000&id=1111&inheritance=0&category_id=...)
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/rename

Gets the Alpaca form for renaming a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/run

Returns the Alpaca form for running a WebReport. (*) against a field name denotes that the field supports tag replacement.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/categories/update

Gets the Alpaca form for updating a single category applied to a node. The metadata state tokens (for edit conflict resolution) will be under data.{category ID}_1.metadata_token

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Category Id`	The ID of the category
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/versions/update

Gets the Alpaca form for updating a version on a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Version Number`	The version number to update
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/nodes/update

Gets the Alpaca form(s) for updating a node. The metadata state token (for edit conflict resolution) on the node data will be under data.metadata_token. The category-specific metadata state tokens will be on the categories form (role_name: categories) under data.{category ID}.{category ID}_1.metadata_token

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node that will be updated
`Role`	If roles are specified then only forms for these roles are returned (e.g. role=categories&role=versionscontrol).
`{attribute Name}`	Value for the Additional Node Attribute
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/processes/tasks/update

Gets the Alpaca forms for displaying a workflow item.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Process Id`	The ID of the workflow
`Subprocess Id`	The ID of the sub workflow
`Task Id`	The ID of the task in the workflow
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/forms/draftprocesses

Gets the Alpaca forms for displaying a draft workflow item.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Draftprocess Id`	The ID of the draft workflow
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/intelligentfiling/{id}

Files a document from an Intelligent Filing Folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the document
`Filing Destination Id`	The Business Workspace instance to add the document to
`Filing Classification Id`	The classification ID for the Document Type to use to choose the sub-folder
`Parent Id`	The parent container to add the document to
`Response Type`	N/A

/v2/members/favorites/{id}

Adds a Favorite for the current user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the favorite to add
`Response Type`	N/A

/v2/members/favorites/tabs

Adds a Favorites Tab for the current user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	The Name of the tab
`Order`	The Order of the tab

/v2/members/{id}/members

Add members to a group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The group ID.
`Response Type`	N/A

Options (1)

Option Name	Description
`Member Id`	The IDs of the users and/or groups to add.

/v1/members

Creates a user or group.

NOTE: The 'body' parameter must be used. This 'body' parameter contains a JSON string, and must be specified in the Body as a key-value pair where the key is 'body' and the value is the JSON string. See the [IMPLEMENTATION NOTES] for more details.

Example to create a user:

body : { "type": 0, "name": "new_user", "group_id": 1001 }

Example to create a group:

body : { "type": 1, "name": "new_group" }

The parameters for creating a user or group are listed below:

Create user

required fields: type, name, group_id
defaults: type = 0

Create group

required fields: type, name
defaults: type = 1

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (20)

Option Name	Description
`Type`	The type of member to create (e.g. 0 for a user, and 1 for a group).
`Name`	Name of the user or group
`Group Id`	The group ID of the user's base group. This is a required field if type is set to 0 (user)
`First Name`	First name of the user
`Last Name`	Last name of the user
`Middle Name`	Middle name of the user
`Title`	The user's title
`Business Email`	The user's business email address
`Business Phone`	The user's business phone number
`Business Fax`	The user's business fax number
`Office Location`	The user's office location
`Time Zone`	The time zone the user is in
`Display Language`	The language code of the user's preferred display language
`Privilege Login`	N/A
`Privilege Public Access`	N/A
`Privilege Modify Users`	N/A
`Privilege Modify Groups`	N/A
`Privilege User Admin Rights`	N/A
`Privilege Grant Discovery`	N/A
`Privilege System Admin Rights`	N/A

/v2/members

Creates a user or group.

NOTE: The 'body' parameter must be used. This 'body' parameter contains a JSON string, and must be specified in the Body as a key-value pair where the key is 'body' and the value is the JSON string. See the [IMPLEMENTATION NOTES] for more details.

Example to create a user:

body : { "type": 0, "name": "new_user", "group_id": 1001 }

Example to create a group:

body : { "type": 1, "name": "new_group" }

The parameters for creating a user or group are listed below:

Create user

required fields: type, name, group_id
defaults: type = 0

Create group

required fields: type, name
defaults: type = 1

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (37)

Option Name	Description
`Type`	The type of member to create
`Name`	Name of the group
`Group Id`	The group ID of the user's base group (if creating a group, this parameter is not required).
`Password`	The user's password
`First Name`	First name of the user
`Last Name`	Last name of the user
`Middle Name`	Middle name of the user
`Title`	The user's title
`Business Email`	The user's business email address
`Business Phone`	The user's business phone number
`Business Fax`	The user's business fax number
`Office Location`	The user's office location
`Time Zone`	The time zone the user is in
`Birth Date`	The user's birthday
`Cell Phone`	The user's personal mobile phone number
`Personal Url 1`	The user's bookmarked url link 1
`Personal Url 2`	The user's bookmarked url link 2
`Personal Url 3`	The user's bookmarked url link 3
`Personal Email`	The user's personal email address
`Personal Interests`	The user's personal interests and hobbies
`Personal Website`	The user's personal home page
`Home Address 1`	The user's home address 1
`Home Address 2`	The user's home address 2
`Home Address 3`	The user's home address 3
`Home Fax`	The user's personal fax number
`Home Phone`	The user's personal home phone number
`Gender`	The user's gender
`Pager`	The user's office mobile phone number
`Photo Id`	The ID of the node for the user's profile photo
`Display Language`	The language code of the user's preferred display language
`Privilege Login`	N/A
`Privilege Public Access`	N/A
`Privilege Modify Users`	N/A
`Privilege Modify Groups`	N/A
`Privilege User Admin Rights`	N/A
`Privilege Grant Discovery`	N/A
`Privilege System Admin Rights`	N/A

/v1/members/{id}

Delete user or group.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group
`Response Type`	N/A

/v2/members/{id}

Delete user or group.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group to delete.
`Response Type`	N/A

/v2/members/favorites

Gets a user's Favorites.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Limit`	Page size
`Page`	Page number
`Sort`	Order by named column (name, order, tab_id). Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed. Up to two columns can be specified.
`Where Name`	Filters the results, returning the favorites with the specified filter string in their name
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/favorites/tabs

Gets a user's Favorites Tabs.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sort`	Order by named column (name, order). Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/favorites/tabs/{id}/nodes

Gets a user's Favorites in a Tab.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the tab for the favorites to list
`Limit`	Page size
`Page`	Page number
`Sort`	Order by named column (name, order). Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.
`Where Name`	Filters the results, returning the favorites with the specified filter string in their name
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/reserved

Get the objects reserved by the authenticated user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Limit`	Page size
`Page`	Page number
`Sort`	Order by named column. Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.
`Where Name`	Filters the results, returning the objects with the specified filter string in their name
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/assignments

Gets a user's Assignments.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/members/{id}/photo

Gets the specified member's profile photo. If the user does not have permission to the profile photo no content and a status code of 500 will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/targets

Get the current user's list of recently targeted containers. This call will return a maximum of 15 items.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/accessed

Gets a member's recently accessed list. This call will return a maximum of 25 items.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Class Mask`	View class to filter on.
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Where Type`	Specify subtype(s) which should be returned (144 for document, 749 for email and so on). Multiple where_type parameters can be specified.
`Where Parent Id`	Specify container ID (parent ID) which the recent items belong to.
`Response Type`	N/A

/v2/members/favorites/tabs/unsorted/nodes

Gets a user's Unsorted Favorites.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Limit`	Page size
`Page`	Page number
`Sort`	Order by named column (name, order). Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.
`Where Name`	Filters the results, returning the favorites with the specified filter string in their name
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/members/{id}

Gets user's information | Gets group's information

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/{id}

Gets a user's information | Gets a group's information

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Response Type`	N/A

/v2/members/{id}/members

Lists the members of a group and returns their information.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group
`Limit`	Page size
`Page`	Page number
`Sort`	Ascending order by named column. Format can be sort=name or sort=first_name or sort=last_name or sort=mailaddress.
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/favorites/{id}

Removes a Favorite for the current user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the favorite to remove
`Response Type`	N/A

/v2/members/favorites/tabs/{id}

Remove a Favorites Tab and the Favorites associated with it for the current user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the tab to remove
`Response Type`	N/A

/v2/members/{id}/members

Remove members from a group.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The group ID.
`Member Id`	The IDs of the users and/or groups to remove.
`Response Type`	N/A

/v2/members/memberof

Get list of groups where currently logged in user is a member.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Limit`	Page size
`Page`	Page number
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/members

Search for a user or group

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Where Type`	Specify 0 for a user, and 1 for a group
`Limit`	Page size
`Page`	Page number
`Sort`	Order by named column (Using prefixes such as sort=asc_name or sort=desc_name ). Format can be sort = id, sort = name, sort = first_name, sort = last_name, sort = group_id, sort = mailaddress. If the prefix of asc or desc is not used then asc will be assumed.
`Query`	Filters the results, returning the users with the specified query string in their log-in name, lastname or firstname
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members

Search for a user or group

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Where Type`	Specify 0 for a user, and 1 for a group
`Where Business Email`	Filters the results, returning the users where the business email matches the specified string
`Where Name`	Filters the results, returning the users where the login name matches the specified string
`Where First Name`	Filters the results, returning the users where the first name matches the specified string
`Where Last Name`	Filters the results, returning the users where the last name matches the specified string
`Limit`	Page size
`Page`	Page number
`Sort`	Order by named column (Using prefixes such as sort=asc_name or sort=desc_name ). Format can be sort = id, sort = name, sort = first_name, sort = last_name, sort = group_id, sort = mailaddress. If the prefix of asc or desc is not used then asc will be assumed.
`Query`	Filters the results, returning the users with the specified query string in any of the following fields: name, first_name, last_name, business_email. NOTE: query cannot be used together with any combination of: where_name, where_first_name, where_last_name, where_business_email.
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/members/favorites/{id}

Updates a favorite

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the favorite to update
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	The favorite's new name
`Order`	The favorite's new order
`Tab Id`	The favorite's new tab id (NOTE: Enter 0 (zero) to untab the favorite)

/v2/members/favorites/tabs/{id}

Updates a favorites tab

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the tab to update
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	The tab's new name
`Order`	The tab's new order

/v1/members/{id}

Updates user's information | Updates group's information

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group
`Response Type`	N/A

Options (37)

Option Name	Description
`Name`	Name of the user
`Group Id`	The group ID of the user's base group
`Fields`	Exclude all fields except the one that is specified
`Expand`	Expand all fields that belong to the specified person
`Expand Fields`	Expand specified field (ex. 'id'). Note: field must belong to a persona
`Password`	User's password
`First Name`	User's first name
`Middle Name`	User's middle name
`Last Name`	User's last name
`Title`	User's title
`Business Email`	User's business email
`Business Phone`	User's business phone number
`Business Fax`	User's business fax number
`Office Location`	User's office location
`Time Zone`	User's time zone
`Birth Date`	The user's birthday
`Cell Phone`	The user's personal mobile phone number
`Gender`	The user's gender
`Home Address 1`	The user's home address 1
`Home Address 2`	The user's home address 2
`Home Fax`	The user's personal fax number
`Home Phone`	The user's personal home phone number
`Pager`	The user's office mobile phone number
`Personal Email`	The user's personal email address
`Personal Interests`	The user's personal interests and hobbies
`Personal Url 1`	The user's bookmarked url link 1
`Personal Url 2`	The user's bookmarked url link 2
`Personal Url 3`	The user's bookmarked url link 3
`Personal Website`	The user's personal home page
`Photo Id`	The ID of the node for the user's profile photo
`Display Language`	The language code of the user's preferred display language
`Privilege Login`	TRUE if the user log-in is enabled, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege Public Access`	TRUE means the user can access any item in the system for which the Public Access permission is activated, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege Modify Users`	TRUE if the user can create users and modify or delete the users that he or she creates, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege Modify Groups`	TRUE if the user can create groups and modify or delete the groups that he or she creates, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege User Admin Rights`	TRUE if the user can create, modify, and delete any user or group, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege System Admin Rights`	TRUE means the user has full access to Content Server's administration functionality, if the user knows the administration password. This privilege also provides access to all items in the system, without filtering for permissions. This privilege does not include the ability to administer users or groups. FALSE otherwise. This information is only available to Administrators or User Administrators

/v2/members/{id}

Updates a user's information | Updates a group's information

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the user or group
`Response Type`	N/A

Options (39)

Option Name	Description
`Name`	Name of the user or group
`Group Id`	The group ID of the user's base group
`Leader Id`	[Group only] The user ID of the group leader
`Password`	[User only] User's password
`First Name`	[User only] User's first name
`Middle Name`	[User only] User's middle name
`Last Name`	[User only] User's last name
`Title`	[User only] User's title
`Business Email`	[User only] User's business email
`Business Phone`	[User only] User's business phone number
`Business Fax`	[User only] User's business fax number
`Office Location`	[User only] User's office location
`Time Zone`	[User only] User's time zone
`Birth Date`	[User only] The user's birthday
`Cell Phone`	[User only] The user's personal mobile phone number
`Personal Url 1`	[User only] The user's bookmarked url link 1
`Personal Url 2`	[User only] The user's bookmarked url link 2
`Personal Url 3`	[User only] The user's bookmarked url link 3
`Personal Email`	[User only] The user's personal email address
`Personal Interests`	[User only] The user's personal interests and hobbies
`Personal Website`	[User only] The user's personal home page
`Home Address 1`	[User only] The user's home address 1
`Home Address 2`	[User only] The user's home address 2
`Home Address 3`	[User only] The user's home address 3
`Home Fax`	[User only] The user's personal fax number
`Home Phone`	[User only] The user's personal home phone number
`Gender`	[User only] The user's gender
`Pager`	[User only] The user's office mobile phone number
`Photo Id`	[User only] The ID of the node for the user's profile photo
`Display Language`	The language code of the user's preferred display language
`Privilege Login`	[User only] TRUE if the user log-in is enabled, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege Public Access`	[User only] TRUE means the user can access any item in the system for which the Public Access permission is activated, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege Modify Users`	[User only] TRUE if the user can create users and modify or delete the users that he or she creates, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege Modify Groups`	[User only] TRUE if the user can create groups and modify or delete the groups that he or she creates, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege User Admin Rights`	[User only] TRUE if the user can create, modify, and delete any user or group, FALSE otherwise. This information is only available to Administrators or User Administrators
`Privilege System Admin Rights`	[User only] TRUE means the user has full access to Content Server's administration functionality, if the user knows the administration password. This privilege also provides access to all items in the system, without filtering for permissions. This privilege does not include the ability to administer users or groups. FALSE otherwise. This information is only available to Administrators or User Administrators
`Fields`	Exclude all fields except the one that is specified
`Expand`	Expand all fields that belong to the specified person
`Expand Fields`	Expand specified field (ex. 'id'). Note: field must belong to a persona

/v2/multipart/{upload_key}

Cancel and remove a Large File Upload session.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Key`	The key to identify the Large File Upload session.
`Response Type`	N/A

/v2/multipart/{upload_key}

Complete and close a Large File Upload session.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Key`	The key to identify the Large File Upload session.
`Response Type`	N/A

/v2/multipart/settings

Gets the current settings for Large File Upload.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

/v2/multipart

Starts a Large File Upload session.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`File Name`	Name of file being uploaded (non-empty)
`File Size`	Size of file being uploaded (in bytes)
`Mime Type`	MIME type of file being uploaded (non-empty)

/v2/multipart/{upload_key}/{part_number}

Upload a file part to a Large File Upload session.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Key`	The key to identify the Large File Upload session.
`Part Number`	The number of the part being uploaded.
`Response Type`	N/A

Options (1)

Option Name	Description
`Part Content`	The part being uploaded

/v2/nicknames/{nickname}/nodes

Gets the data about a node's properties for the node with the specified nickname.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Nickname`	Nickname of the node.
`Response Type`	N/A

/v2/nodes/{id}/nicknames

Updates a node's nickname.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Nickname`	The updated nickname of the node.The nickname cannot be emptyThe nickname cannot be the same as another node's nicknameThe nickname cannot be a number unless it is the ID of the nodeThe nickname cannot contain a space or any of the following characters: !%()-{}[]";'<>?,./\#The nickname cannot exceed 248 characters in length

/v1/nodes

Creates a node OR Copies a node.

NOTE: The 'body' parameter must be used. This 'body' parameter contains a JSON string, and must be specified in the Body as a key-value pair where the key is 'body' and the value is the JSON string. See the [IMPLEMENTATION NOTES] for more details.

The following examples will assume that there is are two categories available:

Category1 (ID 9830)TextField (Attribute ID 2)Set (Attribute ID 3) with two rows. The Set has a multi-value Textfield (Set Attribute ID 4) that can have a maximum of 3 valuesCategory2 (ID 6228)TextField (Attribute ID 2)
Create a Folder:

{"type":0, "parent_id":2000, "name":"New Folder"}

Create a Folder with Category1 and Category2 and use the default attribute values for both categories:

{"type":0, "parent_id":2000, "name":"New Folder", "roles":{"categories":{"9830":{"9830_1":{}}, "6228":{"6228_1":{}}}}}

Create a Folder with Category1 and Category2. Category1's Set Textfield on the second row has 'aaa' in the Set Textfield's third value; Category2's Textfield is 'bbb':

{"type":0, "parent_id":2000, "name":"New Folder", "roles":{"categories":{"9830":{"9830_3_2_4":["","","aaa"]}, "6228":{"6228_2":"bbb"}}}}

Copy a node 12345 to a folder 5678 (which doesn't have any categories):

{"original_id":12345, "parent_id":5678}

Copy a node 12345 to a folder 5678 (which doesn't have any categories) while applying Category2 with default values:

{"original_id":12345, "parent_id":5678, "roles":{"categories":{"6228":{"6228_1":{}}}}}

Create a node

required fields: type, name, parent_id

Copy a node

required fields: original_id, parent_id
NOTE: original_id is the ID of the node to copy, parent_id is the ID of the node to copy original_id to

The parameters for creating nodes of a specific subtype are listed below:

Create category

required fields: type, parent_id, name
defaults: type = 131

Create channel

required fields: type, parent_id, name
defaults: type = 207

Create document

required fields: type, parent_id, name, file
defaults: type = 144

Create compound document

required fields: type, parent_id, name
defaults: type = 136

Create folder

required fields: type, parent_id, name
defaults: type = 0

Create news

required fields: type, parent_id, name
defaults: type = 208

Create project

required fields: type, parent_id, name
defaults: type = 202

Create shortcut

required fields: type, parent_id, name
defaults: type = 1

Create generation

required fields: type, parent_id, name
defaults: type = 2

Create task

required fields: type, parent_id, name
defaults: type = 206

Create task group

required fields: type, parent_id, name
defaults: type = 205

Create task list

required fields: type, parent_id, name
defaults: type = 204

Create task milestone

required fields: type, parent_id, name
defaults: type = 212

Create URL

required fields: type, parent_id, name
defaults: type = 140

Create virtual folder

required fields: type, parent_id, name
defaults: type = 899

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (10)

Option Name	Description
`Type`	Subtype of the node. This is not required when copying a node.
`Parent Id`	The parent ID of the new node
`Name`	The name of the new node
`Description`	Description of the node
`External Create Date`	External create date
`External Modify Date`	External modify date
`External Source`	External source
`External Identity`	External identity
`External Identity Type`	External identity type
`Original Id`	Node ID

/v2/nodes

Creates a node OR Copies a node.

NOTE: The 'body' parameter must be used. This 'body' parameter contains a JSON string, and must be specified in the Body as a key-value pair where the key is 'body' and the value is the JSON string. See the [IMPLEMENTATION NOTES] for more details.

The following examples will assume that there is are two categories available:

Category1 (ID 9830)
TextField (Attribute ID 2)
Set (Attribute ID 3) with two rows. The Set has a multi-value Textfield (Set Attribute ID 4) that can have a maximum of 3 values
Category2 (ID 6228)
TextField (Attribute ID 2)

Create a Folder:

{\"type\":0, \"parent_id\":2000, \"name\":\"New Folder\"}

Create a Folder with Category1 and Category2 and use the default attribute values for both categories:

{\"type\":0, \"parent_id\":2000, \"name\":\"New Folder\", \"roles\":{\"categories\":{\"9830_1\":{}, \"6228_1\":{}}}}

Create a Folder with Category1 and Category2. Category1's Set Textfield on the second row has 'aaa' in the Set Textfield's third value; Category2's Textfield is 'bbb':

{\"type\":0, \"parent_id\":2000, \"name\":\"New Folder\", \"roles\":{\"categories\":{\"9830_3_2_4\":[\"\",\"\",\"aaa\"], \"6228_2\":\"bbb\"}}}

Copy a node 12345 to a folder 5678 (which doesn't have any categories):

{\"original_id\":12345, \"parent_id\":5678}

Copy a node 12345 to a folder 5678 (which doesn't have any categories) while applying Category2 with default values:

{\"original_id\":12345, \"parent_id\":5678, \"roles\":{\"categories\":{\"6228_1\":{}}}}

Create a node

required fields: type, name, parent_id
Copy a node

required fields: original_id, parent_id
NOTE: original_id is the ID of the node to copy, parent_id is the ID of the node to copy original_id to

The parameters for creating nodes of a specific subtype are listed below:
Create category

required fields: type, parent_id, name
defaults: type = 131
Create channel

required fields: type, parent_id, name
defaults: type = 207
Create document

required fields: type, parent_id, name, (file or upload_key)
defaults: type = 144
Create compound document

required fields: type, parent_id, name
defaults: type = 136
Create folder

required fields: type, parent_id, name
defaults: type = 0
Create news

required fields: type, parent_id, name
defaults: type = 208
Create project

required fields: type, parent_id, name
defaults: type = 202
Create shortcut

required fields: type, parent_id, name
defaults: type = 1
Create generation

required fields: type, parent_id, name
defaults: type = 2
Create task

required fields: type, parent_id, name
defaults: type = 206
Create task group

required fields: type, parent_id, name
defaults: type = 205
Create task list

required fields: type, parent_id, name
defaults: type = 204
Create task milestone

required fields: type, parent_id, name
defaults: type = 212
Create URL

required fields: type, parent_id, name
defaults: type = 140
Create virtual folder

required fields: type, parent_id, name
defaults: type = 899
Create search query

required fields: type, parent_id, name
defaults: type = 258

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (42)

Option Name	Description
`Type`	Subtype of the node. This is not required when copying a node.
`Parent Id`	The parent ID of the new node
`Name`	The name of the new node
`Description`	Description of the node
`External Create Date`	External create date
`External Modify Date`	External modify date
`External Source`	External source
`External Identity`	External identity
`External Identity Type`	External identity type
`Image Id`	Data ID of the image to be displayed in the news item
`Image Alt Text`	The alt text for the above image
`File`	The file to be added as an attachment
`Upload Key`	The key to identify a Large File Upload session.
`Advanced Versioning`	Allow advanced versioning (standard versioning by default)
`Effective Date`	(Can be time-zone aware) The effective date for this news item (e.g. 2015-10-16T13:00:00)
`Expiration Date`	(Can be time-zone aware) The expiration date for this news item
`Headline`	The headline for this news item
`Highlights`	The highlights for this news item
`Story`	The story for this news item
`Attachments`	The data ID of the object to attach to this news item
`Status`	The status of the task
`Due Date`	(Can be time-zone aware) Due date of the milestone (e.g. 2015-10-16T13:00:00)
`Start Date`	(Can be time-zone aware) Start date of the milestone
`Mission`	The project mission
`Goals`	The project goals
`Objectives`	The project objectives
`Initiatives`	The project initiatives
`Original Id`	Node ID
`Version Number`	The Version Number of the node to create the generation to
`Assigned Member Id`	The assigned member ID
`Priority`	The priority for the task
`Milestone Id`	The milestone for the task group
`Instructions`	The instructions for the task
`Attachment Id`	The data ID for the item to attach to the task
`Complete Date`	(Can be time-zone aware) Date the milestone was completed
`Url`	URL
`Location Id`	Location ID. This value can only be set during create.
`Selected Facets`	Facets that make up the virtual folder. Each facet is a 2-element List where the first element is the facet ID (String) and the second element is a List of values (String) for that facet. For example: [['2100',['re09']],['2095',['0','144']]]
`Location Column Visible`	Show location column
`Selected Facets Visible`	Show selected facets
`Selected Location Visible`	Show selected location
`Search Cache Id`	Search cache ID to be used to create the Search Query item.

/v2/nodes/{id}/releases

Creates a release for the node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	Name of the release

/v2/nodes/{id}/revisions

Creates a revision for the node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	Name of the revision

/v1/nodes/{id}

Deletes the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

/v2/nodes/{id}

Deletes the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

/v1/nodes/{id}

Gets info on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Perspective`	Determines if the perspective for the node will be included in the response.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}

Gets information about a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Actions`	Retrieve actions for the node. This is similar to 'commands' for v1 (E.g. actions=delete&actions=open). Note: For best performance minimize the number of actions requested.Example to get the delete and open actions?actions=delete&actions=open
`Perspective`	Determines if the perspective for the node will be included in the response.
`Fields`	The 'fields' parameter can be used to filter the results even further, if necessary.Show the 'properties' field (which contains node information such as name, description, parent_id, etc.)?fields=propertiesShow the 'properties' and 'categories' fields (node and category information, respectively)?fields=properties&fields=categoriesShow the 'properties' and 'categories' fields (node and category information, respectively) but only the parent_id and description from 'properties'?fields=properties{parent_id,description}&fields=categoriesShow the 'versions' field (version information) but only the latest version?fields=versions.element(0)Show the 'permissions' field (node permissions) but only the first 5 permissions (includes Default Access and ACLs)?fields=permissions.limit(5)
`Expand`	Resolve individual fieldsExpand the id and parent_id of 'properties' (resolving the id to extra node information, and resolving the parent_id to extra node information about the parent)?expand=properties{id,parent_id}
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data, which will be returned under results.metadata / metadata_map / metadata_order. This is an empty parameter, thus no value is required (e.g. ?metadata).Example to get metadata?metadata
`State`	Returns the metadata state token for data (used for edit conflict resolution), which will be returned under results.state. This is an empty parameter, thus no value is required (e.g. ?state).Example to get the metadata state token?state
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Reference Id`	Reference node ID
`Response Type`	N/A

/v1/nodes/{id}/actions

Gets available actions on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/actions

Gets the actions for the specified node IDs (up to 100 items) that the current user is able to perform. To get more than 100 items, use the POST api/v2/nodes/actions call below.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	One or more node IDs.
`Actions`	Retrieve actions for the node. If not specified, all actions that the current user can perform will be returned.
`Reference Id`	Reference node ID
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/actions

Gets the actions for the specified node IDs (unlimited items) that the current user is able to perform. The parameters can be packaged into a single body parameter. See the [IMPLEMENTATION NOTES] at the top for details.

Get the actions for delete and copy for the nodes with IDs 5348 and 5569
body : { "ids":[5348,5569], "actions":["delete","copy"] }

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Ids`	One or more node IDs.
`Actions`	Retrieve actions for the node. If not specified, all actions that the current user can perform will be returned.
`Reference Id`	Reference node ID
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).

/v2/nodes/{id}/nodes/all

Returns information on all the children of the node*.

* Only Compound Documents are currently supported

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Sort`	Order by named column. Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.Example to sort by order (ascending by default)?sort=orderSort by order descending?sort=desc_order
`Fields`	The 'fields' parameter can be used to filter the results even further, if necessary.Show the 'properties' field (which contains node information such as name, description, order, mime_type etc.)?fields=propertiesShow the 'properties' field but only include the id, name, mime_type, and order?fields=properties{id, name, mime_type, order}
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data, which will be returned under results.metadata / properties. This is an empty parameter, thus no value is required (e.g. ?metadata).Example to get metadata?metadata
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/ancestors

Gets the ancestors of the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/audit

Gets node audit info.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Sort`	Sort order of audit results. Format can be sort=desc_audit_date or sort=asc_audit_date. Results are sorted in descending order by default.
`Page`	Page number
`Limit`	Page size
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/audit

Gets node audit info.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data, which will be returned under results.metadata / metadata_map / metadata_order. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Sort`	Sort order of audit results. Format can be sort=desc_audit_date or sort=asc_audit_date. Results are sorted in descending order by default.
`Page`	Page number
`Limit`	Page size
`Where Type`	Filter by the event type.
`Where Audit Date Start`	Filter events so that the results occurred after the supplied date. Can be used with where_audit_date_end.
`Where Audit Date End`	Filter events so that the results occurred before the supplied date. Can be used with where_audit_date_start.
`Where User Id`	Filter by User ID.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/columns

Gets the columns for the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/content

Downloads the content (latest published version) on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Action`	Change the MIME type to 'application/octet-stream' by specifying 'download'. Ignoring this parameter or specifying 'open' will preserve the MIME type.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/content

Downloads the content (latest published version) on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/content/{filename}

Downloads the content (latest published version) for the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Filename`	Name to give downloaded file
`Action`	Change the MIME type to 'application/octet-stream' by specifying 'download'. Ignoring this parameter or specifying 'open' will preserve the MIME type.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/content/{filename}

Downloads the content (latest published version) for the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Filename`	Name to give downloaded file
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/facets

Gets facets for the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Where Facet`	Specify selected facets using the following template '{facet id}:{value1}\|{value2}\|...' e.g. where_facet=2100:23\|9\|17\|20&where_facet=2101:331
`Response Type`	N/A

/v1/nodes/{id}/addablenodetypes

Gets info on the types of child nodes which can be added to this node, if the node is a container (ie. a Folder). The info will be returned as a set of (relative) REST API links which can be used to retrieve forms detailing how to create the desired node within the node container.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/properties

Gets basic information about the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data, which will be returned under results.metadata / metadata_map / metadata_order. This is an empty parameter, thus no value is required (e.g. ?metadata).
`State`	Returns the metadata state token for data (used for edit conflict resolution), which will be returned under results.state. This is an empty parameter, thus no value is required (e.g. ?state).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/nodes

Browses the node, returning info on its child nodes.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Where Type`	Filter on node type. Use -1 to get all containers. Use -2 to get all searchable objects. Use -3 to get all non-containers.
`Where Name`	Filter on node name
`Where Facet`	Filter on facet values. There will be one instance of this parameter for each facet selected. The values are combined using \| character. E.g. where_facet=2095:144\|0\|-1 (note that -1 is a special value that denotes containers).
`Commands`	Retrieve commands for nodes. There will be multiple instances of this parameter for each command requested. E.g. commands=delete&commands=default.
`Sort`	Order by named column. Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.
`Page`	Page number
`Limit`	Page size
`Show Hidden`	Show hidden objects (default False)
`Extra`	Return additional data for each item (default True). Disabling this will improve performance.
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/nodes

Browses the node, returning info on its child nodes.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Where Type`	Filter on node type. -1 : get all containers-2 : get all searchable objects-3 : get all non-containersExample to get all non-containers?where_type=-3
`Where Name`	Filter on node nameExample to filter on 'abc' name?where_name=abc
`Where Facet`	Filter on facet values. Can be specified multiple times in the query string using the '&' separator (?where_facet=....&where_facet=...)Example to apply the Content Type facet with ID 2095, for documents (144), folders (0) and all containers (-1)?where_facet=2095:144\|0\|-1
`Where Status`	Filter on status of the node.
`Actions`	Retrieve actions for the node. This is similar to 'commands' for v1 (E.g. actions=delete&actions=open). Note: For best performance minimize the number of actions requested.Example to get the delete and open actions?actions=delete&actions=open
`Sort`	Order by named column. Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.Example to sort by name (ascending by default)?sort=nameSort by name descending?sort=desc_name
`Page`	Page numberExample to get page 2?page=2
`Limit`	Page sizeExample to get a page size of 5 results?limit=5
`Show Hidden`	Show hidden objects (default False)Example to show hidden objects?show_hidden=true
`Fields`	The 'fields' parameter can be used to filter the results even further, if necessary.Show the 'properties' field (which contains node information such as name, description, parent_id, etc.)?fields=propertiesShow the 'properties' and 'categories' fields (node and category information, respectively)?fields=properties&fields=categoriesShow the 'properties' and 'categories' fields (node and category information, respectively) but only the parent_id and description from 'properties'?fields=properties{parent_id,description}&fields=categoriesShow the 'versions' field (version information) but only the latest version?fields=versions.element(0)Show the 'permissions' field (node permissions) but only the first 5 permissions (includes Default Access and ACLs)?fields=permissions.limit(5)
`Expand`	Resolve individual fieldsExpand the id and parent_id of 'properties' (resolving the id to extra node information, and resolving the parent_id to extra node information about the parent)?expand=properties{id,parent_id}
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data, which will be returned under results.metadata / metadata_map / metadata_order. This is an empty parameter, thus no value is required (e.g. ?metadata).Example to get metadata?metadata
`State`	Returns the metadata state token for data (used for edit conflict resolution), which will be returned under results.state. This is an empty parameter, thus no value is required (e.g. ?state).Example to get the metadata state token?state
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/thumbnails/{size}/content

Gets thumbnail content for the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Size`	The size of the requested thumbnail (small, medium or large)
`Version Number`	Version number of the node
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/thumbnails

Gets thumbnails for the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number of the node
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/thumbnails/{size}

Gets thumbnails in the specified size for the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Size`	The size of the requested thumbnail (small, medium or large)
`Version Number`	Version number of the node
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/releases

List all releases and revisions of the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

/v2/nodes/{id}/doctemplates

Fetches the list of templates to create an item/instance in the specified folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Folder ID
`Subtypes`	The subtypes list, where the templates of these subtypes are to be showcased in add item menu, e.g. {0}
`Sidepanel Subtypes`	The subtypes list, where the templates of these subtypes are to be showcased in side panel, e.g. {144}
`Group By`	grouped by classification e.g. group_by=classification ( only works with side-panel subtype templates )
`Recent Templates`	Recently used templates required or not. (Default false) e.g. recent_templates=true ( only works with side-panel subtype templates )
`Recent History Days`	Recently used templates prior to no of days. (Default 180) e.g. recent_history_days=180 ( only works with side-panel subtype templates )
`Recent Templates Limit`	Limit the recently used templates fetching. (Default 4) e.g. recent_templates_limit=4 ( only works with side-panel subtype templates )
`Response Type`	N/A

/v2/nodes/{id}/order

Reorganizes the children of the node*.

* Only Compound Documents are currently supported

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID.
`Response Type`	N/A

Options (1)

Option Name	Description
`Compact`	Sets if subnodes have to be renumbered sequentially (defaults to false).Example to maintain relative order but renumber sequentially:body: { "order": [], "compact": true }

/v2/nodes/{id}/systemattributes

Update System Attributes of a given node

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (1)

Option Name	Description
`{attribute Key}`	Value of the attribute

/v1/nodes/{id}

Updates a node's info
Moves a node
Changes the Versions Control setting for a folder.

NOTE: The 'body' parameter must be used. This 'body' parameter contains a JSON string, and must be specified in the Body as a key-value pair where the key is 'body' and the value is the JSON string. See the [IMPLEMENTATION NOTES] for more details.

Update a Folder's name and description:

body : { "name":"New Name", "description":"New Description" }

Update a Folder's name and description while passing in a metadata token:

body : { "name":"New Name", "description":"New Description", "metadata_token":"f0c0701a58c2cb03a955deb1ab2af306" }

Move a node to a folder with ID 5678

body : { "parent_id":5678 }

Change the Versions Control setting for a folder

body : { "versions_control_advanced":true }

Change the Versions Control setting for a folder and apply to its Sub-Items

body : { "versions_control_advanced":true, "apply_to":2 }

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID.
`Response Type`	N/A

Options (8)

Option Name	Description
`Description`	The updated description of the node.
`Description Multilingual`	The multilingual descriptions of the node in key-value pairs (see example below). The parameter 'description' must also be specified in the body parameter, but the value in 'description' will be ignored and the values in 'description_multilingual' will be used.Example to update the English (en), German (de) and French (fr) descriptions of a node where the preferred language is English (en)body : { "description":"newEnglishDescription", "description_multilingual":{"de":"newGermanDescription","en":"newEnglishDescription","fr":"newFrenchDescription"} }
`Name`	The updated name of the node.
`Name Multilingual`	The multilingual names of the node in key-value pairs (see example below). The parameter 'name' must also be specified in the body parameter, but the value in 'name' will be ignored and the values in 'name_multilingual' will be used.Example to update the English (en), German (de) and French (fr) names of a node where the preferred language is English (en)body : { "name":"newEnglishName", "name_multilingual":{"de":"newGermanName","en":"newEnglishName","fr":"newFrenchName"} }
`Versions Control Advanced`	If set to TRUE then the objects added to the folder will use Advanced Versioning by default. If set to FALSE then the objects added to the folder will use Standard Versioning by default.
`Apply To`	Apply version control settings to: This ItemSub-ItemsThis Item and Sub-Items
`Parent Id`	The updated parent ID of the node.
`Metadata Token`	The metadata state token. It is used to resolve edit conflicts where two users are updating the node at the same time.NOTE: If this is specified and the call is successful, the most recent metadata token will be returned in the result.

/v2/nodes/{id}

Updates a node's info
Moves a node
Changes the Versions Control setting for a folder
Reserves/Unreserves a node
Collects/Uncollects a node

NOTE: The 'body' parameter must be used. This 'body' parameter contains a JSON string, and must be specified in the Body as a key-value pair where the key is 'body' and the value is the JSON string. See the [IMPLEMENTATION NOTES] for more details.

Update a Folder's name and description:

body : { "name":"New Name", "description":"New Description" }

Update a Folder's name and description while passing in a metadata token:

body : { "name":"New Name", "description":"New Description", "metadata_token":"f0c0701a58c2cb03a955deb1ab2af306" }

Move a node to a folder with ID 5678

body : { "parent_id":5678 }

Change the Versions Control setting for a folder

body : { "versions_control_advanced":true }

Change the Versions Control setting for a folder and apply to its Sub-Items

body : { "versions_control_advanced":true, "apply_to":2 }

Reserve a document

body : { "reserved_user_id":1000 }

Unreserve a document

body : { "reserved_user_id":"null" }

Collect a node to a Collection with ID 5678

body : { "collection_id":5678 }

Uncollect a node from the Collection with ID 5678

body : { "collection_id":5678, "operation":"remove" }

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID.
`Response Type`	N/A

Options (12)

Option Name	Description
`Description`	The updated description of the node.
`Description Multilingual`	The multilingual descriptions of the node in key-value pairs (see example below). The parameter 'description' must also be specified in the body parameter, but the value in 'description' will be ignored and the values in 'description_multilingual' will be used.Example to update the English (en), German (de) and French (fr) descriptions of a node where the preferred language is English (en)body : { "description":"newEnglishDescription", "description_multilingual":{"de":"newGermanDescription","en":"newEnglishDescription","fr":"newFrenchDescription"} }
`Name`	The updated name of the node.
`Name Multilingual`	The multilingual names of the node in key-value pairs (see example below). The parameter 'name' must also be specified in the body parameter, but the value in 'name' will be ignored and the values in 'name_multilingual' will be used.Example to update the English (en), German (de) and French (fr) names of a node where the preferred language is English (en)body : { "name":"newEnglishName", "name_multilingual":{"de":"newGermanName","en":"newEnglishName","fr":"newFrenchName"} }
`Versions Control Advanced`	If set to TRUE then the objects added to the folder will use Advanced Versioning by default. If set to FALSE then the objects added to the folder will use Standard Versioning by default.
`Apply To`	apply version control settings to, 0 - This Item, 1-Sub Items, 2- This Item and Sub Items
`Reserved User Id`	The id of the user the node is being reserved to (null to unreserve)
`Parent Id`	The updated parent ID of the node.
`Collection Id`	ID of Collection node
`Operation`	Keyword remove will remove item from collection
`Metadata Token`	The metadata state token (for edit conflict resolution). NOTE: if this is specified and the call is successful, the most recent metadata token will be returned in the result.
`Search Cache Id`	Search cache ID to be used to update the Search Query item.

/v2/nodes/{id}/collection

Add or Remove items from a collection.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID of a collection node
`Response Type`	N/A

Options (2)

Option Name	Description
`Ids`	The id(s) of the nodes to add to the collection. This parameter can be specified multiple times up to a limit of 30 node IDs.
`Operation`	Specify 'add' or 'remove' to update items in the collection.

/v2/notifications/interests/nodes/{id}

Get the notification interest settings for a particular node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

/v2/notifications/interests/nodes/{id}

Set the notification interest settings for a particular node. Any interests not specified will have their report value set to 0.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v2/nodes/{id}/permissions/custom

Add an Assigned Access permission on the node.

NOTE: This can only be done using the 'body' parameter (see the [IMPLEMENTATION NOTES]).

Examples:

Add permissions for the user/group 15234, with 'see' and 'see contents' permissions:
body = {"permissions":["see","see_contents"],"right_id":15234}

Add permissions for the user/group 15234, with 'see' and 'see contents' permissions and apply to 'This Item':
body = {"permissions":["see","see_contents"],"right_id":15234,"apply_to":0}

Add permissions for the user/group 15234, with 'see' and 'see contents' permissions and apply to 'This Item and Sub-Items' where the Sub-Items are Task List and Channel:
body = {"permissions":["see","see_contents"],"right_id":15234,"apply_to":2,"include_sub_types":[204,207]}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

Options (4)

Option Name	Description
`Permissions`	The permissions (see the examples above)The allowable values are"see""see_contents""modify""edit_attributes""add_items""reserve""add_major_version""delete_versions""delete""edit_permissions"
`Right Id`	The ID of the user/group (see the examples above)
`Apply To`	Apply permissions to:This ItemSub-ItemsThis Item and Sub-ItemsThis Item And Immediate Sub-Items(see the examples above)NOTE: The default value is 0. Specifying a value of anything other than 0 for a non container (ex. a Document) will result in an error message.
`Include Sub Types`	Special node types to be included when 'apply_to' is used (see the examples above). NOTE: These nodes have a simplified permission model of None, Read, Write, Administer.

/v2/nodes/{id}/permissions

Gets all of the permissions on the node (Default Access and any Assigned Access). The results can be paginated if the request specifies parameters 'page' and 'limit' (e.g. ?page=2&limit=5).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Page`	Page number
`Limit`	Page size
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/permissions/group

Get owner group permissions

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/permissions/owner

Get owner permissions

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/permissions/public

Get public access permissions

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/permissions/effective/{right_id}

Get the effective permissions for the specified user/group on the node.

The effective permissions are an aggregation of the user's permissions on the node, as well as the permissions of any of the user's groups that have permissions on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Right Id`	The ID of the user/group
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/permissions/custom

Update an Assigned Access permission for the specified user/group.

NOTE: This can only be done using the 'body' parameter (see the [IMPLEMENTATION NOTES]).

Examples:

Update permissions for the user/group to 'see' and 'see contents' permissions:
body = {"permissions":["see","see_contents"]}

Update permissions for the user/group to no permissions (NOTE: this is not the same as deleting the user/group's permissions from the Assigned Access):
body = {"permissions":[]}

Update the user/group's permissions on a Folder to 'see' and 'see contents' and apply to 'This Item':
body = {"permissions":["see","see_contents"],"apply_to":0}

Update the user/group's permissions on a Folder to 'see' and 'see contents' and apply to 'This Item and Sub-Items' where the Sub-Items are Task List and Channel:
body = {"permissions":["see","see_contents"],"apply_to":2,"include_sub_types":[204,207]}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

Options (3)

Option Name	Description
`Permissions`	The permissions (see the examples above)The allowable values are"see""see_contents""modify""edit_attributes""add_items""reserve""add_major_version""delete_versions""delete""edit_permissions"
`Apply To`	Apply permissions to:This ItemSub-ItemsThis Item and Sub-ItemsThis Item And Immediate Sub-Items(see the examples above)NOTE: The default value is 0. Specifying a value of anything other than 0 for a non container (ex. a Document) will result in an error message.
`Include Sub Types`	Special node types to be included when 'apply_to' is used (see the examples above). NOTE: These nodes have a simplified permission model of None, Read, Write, Administer.

/v2/nodes/{id}/permissions/group

Update or Restore the owner group permissions.

NOTE: This can only be done using the 'body' parameter (see the [IMPLEMENTATION NOTES]).

Examples:

Update permissions to 'see' and 'see contents':
body = {"permissions":["see","see_contents"]}

Restore permissions for the owner group 12111, with 'see' and 'see contents' permissions:
body = {"permissions":["see","see_contents"],"right_id":12111}

Change the owner group to 12111 and set its permissions to none (NOTE: this is not the same as removing owner group permissions):
body = {"permissions":[],"right_id":12111}

Update a Folder's permissions to 'see' and 'see contents' and apply to 'This Item':
body = {"permissions":["see","see_contents"],"apply_to":0}

Update a Folder's permissions to 'see' and 'see contents' and apply to 'This Item and Sub-Items' where the Sub-Items are Task List and Channel:
body = {"permissions":["see","see_contents"],"apply_to":2,"include_sub_types":[204,207]}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

Options (4)

Option Name	Description
`Permissions`	The permissions (see the examples above)The allowable values are"see""see_contents""modify""edit_attributes""add_items""reserve""add_major_version""delete_versions""delete""edit_permissions"
`Right Id`	The ID of the node's owner group (see the examples above)
`Apply To`	Apply permissions to:This ItemSub-ItemsThis Item and Sub-ItemsThis Item And Immediate Sub-Items(see the examples above)NOTE: The default value is 0. Specifying a value of anything other than 0 for a non container (ex. a Document) will result in an error message.
`Include Sub Types`	Special node types to be included when 'apply_to' is used (see the examples above). NOTE: These nodes have a simplified permission model of None, Read, Write, Administer.

/v2/nodes/{id}/permissions/owner

Update or Restore the owner permissions.

NOTE: This can only be done using the 'body' parameter (see the [IMPLEMENTATION NOTES]).

Examples:

Update permissions to 'see' and 'see contents':
body = {"permissions":["see","see_contents"]}

Restore permissions for the user 15234, with 'see' and 'see contents' permissions:
body = {"permissions":["see","see_contents"],"right_id":15234}

Change the owner to the user 15234 and set their permissions to none (NOTE: this is not the same as removing owner permissions):
body = {"permissions":[],"right_id":15234}

Update a Folder's permissions to 'see' and 'see contents' and apply to 'This Item':
body = {"permissions":["see","see_contents"],"apply_to":0}

Update a Folder's permissions to 'see' and 'see contents' and apply to 'This Item and Sub-Items' where the Sub-Items are Task List and Channel:
body = {"permissions":["see","see_contents"],"apply_to":2,"include_sub_types":[204,207]}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

Options (4)

Option Name	Description
`Permissions`	The permissions (see the examples above)The allowable values are"see""see_contents""modify""edit_attributes""add_items""reserve""add_major_version""delete_versions""delete""edit_permissions"
`Right Id`	The ID of the node's owner (see the examples above)
`Apply To`	Apply permissions to:This ItemSub-ItemsThis Item and Sub-ItemsThis Item And Immediate Sub-Items(see the examples above)NOTE: The default value is 0. Specifying a value of anything other than 0 for a non container (ex. a Document) will result in an error message.
`Include Sub Types`	Special node types to be included when 'apply_to' is used (see the examples above). NOTE: These nodes have a simplified permission model of None, Read, Write, Administer.

/v2/nodes/{id}/permissions/public

Update the public access permissions.

NOTE: This can only be done using the 'body' parameter (see the [IMPLEMENTATION NOTES]).

Examples:

Update permissions to 'see' and 'see contents':
body = {"permissions":["see","see_contents"]}

Set public access permissions to none (NOTE: this is not the same as removing public access permissions):
body = {"permissions":[]}

Update a Folder's permissions to 'see' and 'see contents' and apply to 'This Item':
body = {"permissions":["see","see_contents"],"apply_to":0}

Update a Folder's permissions to 'see' and 'see contents' and apply to 'This Item and Sub-Items' where the Sub-Items are Task List and Channel:
body = {"permissions":["see","see_contents"],"apply_to":2,"include_sub_types":[204,207]}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

Options (3)

Option Name	Description
`Permissions`	The permissions (see the examples above)The allowable values are"see""see_contents""modify""edit_attributes""add_items""reserve""add_major_version""delete_versions""delete""edit_permissions"
`Apply To`	Apply permissions to:This ItemSub-ItemsThis Item and Sub-ItemsThis Item And Immediate Sub-Items(see the examples above)NOTE: The default value is 0. Specifying a value of anything other than 0 for a non container (ex. a Document) will result in an error message.
`Include Sub Types`	Special node types to be included when 'apply_to' is used (see the examples above). NOTE: These nodes have a simplified permission model of None, Read, Write, Administer.

/v2/perspectives/{perspective_id}/personalization

Personalize particular perspective for specific user

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Perspective Id`	The perspective id of the container for which personalization should be done
`Response Type`	N/A

Options (2)

Option Name	Description
`Perspective Version`	The perspective version of the perspective
`Personalizations`	The personalize Data of the perspective

/v1/ping

Provides basic information about Content Server and the REST API. This call does not require authentication.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

/v2/processes/{process_id}/status

Changes the process status

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Process Id`	Process ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Status`	New process status. Possible values depending on the current state are suspend, resume, stop, archive.

/v2/processes/{process_id}

Deletes the process

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Process Id`	Process ID
`Response Type`	N/A

/v2/processes

Initiates a workflow.

NOTE: The 'body' parameter must be used. This 'body' parameter contains a JSON string, and must be specified in the Body as a key-value pair where the key is 'body' and the value is the JSON string. See the [IMPLEMENTATION NOTES] for more details.

The following examples will provide Json Input format:

{"definition":{"workflow_id":30568,"role_info": {"Role1": 1000, "Role2": 1000}}}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v2/processes/{map_id}/definition

Loads the workflow map definition

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Map Id`	Workflow map ID to load
`Response Type`	N/A

/v2/processes/{process_id}/subprocesses/{subprocess_id}/activities

Reads all available workflow activities based on the provided ids

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Process Id`	Workflow ID to read activities from
`Subprocess Id`	Sub workflow ID to read activities from
`Client`	client parameter is used to recognize from where the rest api is triggered, for mobile client = 1
`Limit`	limit parameter represents, the number of activities to be fetched from the available activities
`Response Type`	N/A

/v2/processes/{process_id}/subprocesses/{subprocess_id}/tasks/{task_id}

Sends on a process based on the provided action / custom_action. The provided comment is added to the current task.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Process Id`	Workflow ID.
`Subprocess Id`	Sub workflow ID.
`Task Id`	Workflow task ID.
`Response Type`	N/A

Options (4)

Option Name	Description
`Action`	Standard action to be executed. This parameter must not be send with the custom_action parameter.
`Custom Action`	Custom action (disposition) to be executed. This parameter must not be sent with the action parameter.
`Comment`	Comment which should be set for the action.
`Authentication Info`	The data required to create a perspective

/v1/forms/nodes/{nodeid}/reminder/view

Gets the Alpaca form for viewing a reminder details on a node

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Nodeid`	Data ID
`Id`	Followup ID
`Response Type`	N/A

/v1/forms/nodes/reminder/create

Gets the Alpaca form to create a reminder for a node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Id`	Client ID
`Id`	Reminder Client Type ID
`Response Type`	N/A

/v2/nodes/{id}/followups/{followup_id}

This will change status of reminder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Data ID
`Followup Id`	FollowupID
`Response Type`	N/A

Options (1)

Option Name	Description
`Status`	status to be updated

/v2/resubmission/{id}/addreminder

This will create a reminder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Data ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Data`	contains all the required properties in JSON format to create a new reminder

/v2/nodes/{id}/followups

Get all followups for a given node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Data ID
`Actions`	Actions
`Response Type`	N/A

/v2/nodes/{id}/followups/{followup_id}

This will give followups for a given node and followup id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Data ID
`Followup Id`	FollowupID
`Actions`	Actions
`Response Type`	N/A

/v1/forms/nodes/followup/getClientTypes

This will give followup client types information.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Id`	Reminder Client ID
`Id`	Reminder Client Type ID
`Response Type`	N/A

/v2/nodes/{id}/updatereminder

This will update reminder information.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Data ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Data`	contains all the required properties in JSON format to update a reminder

/v1/regions

Returns a list of regions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Queryable`	Filter the results to show regions based on their queryable setting value
`Displayable`	Filter the results to show regions based on their displayable setting value
`Search By Default`	Filter the results to show regions based on their search_by_default setting value
`Facet`	Filter the results to show regions based on their facet setting value
`Sortable`	Filter the results to show regions based on their sortable setting value
`User Login`	Login name of the user to impersonate (available to users with system administration rights only)
`User Domain`	Domain of the user to impersonate (available to users with system administration rights only)
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/slices

Returns a list of slices.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Login`	Login name of the user to impersonate (available to users with system administration rights only)
`User Domain`	Domain of the user to impersonate (available to users with system administration rights only)
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/search/template/settings/display

Returns the display options from the default template of the user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/search/members/info

Returns lists of Slices, Personal Search Forms, Recent Search Forms, Search Bar Full Text settings, and System Search Forms

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Location`	ID of container node for from here searches.
`Enterprise Slices`	Flag to return only certain slice types.
`Response Type`	N/A

/v2/search

Returns search results. This call is fully supported and functional, however it is recommended to use the POST method as it supports larger search queries and it is more secure.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

/v2/search

Returns search results.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (16)

Option Name	Description
`Where`	LQL where clause (complex query mode) e.g. 'test or OTSubType: 189'.
`Slice`	ID of slice or list of slices.
`Sort`	Sort region and direction ( e.g. 'desc_OTObjectSize'. Ascending is default if not specified ).
`Page`	Which page to start returning results from.
`Limit`	Maximum number of items returned per page.
`Select`	List of regions to return, e.g. { 'OTName','OTFileSize', ... } Adding a value in the above list will add a 'regions' section in the return response. NOTE: The response structure under 'regions' will change depending on the regions used in the query. When not specified the list of regions returned will be those defined in the template or query that was used to run the query. If no template or query is specified, the user's default template is used.
`Options`	List of options for extra data to return. Available options are: { 'featured', 'facets', 'facets_raw', and 'highlight_summaries' }. If 'facets' or 'facets_raw' are included in the option list, a facet section will be added to the return response.
`Query Id`	ID of a saved search query.
`User Login`	Login name of the user to impersonate (available to users with system administration rights only).
`User Domain`	Domain of the user to impersonate (available to users with system administration rights only).
`Template Id`	ID of a saved search template.
`Metadata`	To be included if metadata/definitions are required (includes display names, etc.), else to be omitted.
`Lookfor`	Search Mode options. Available options are: { 'allwords', 'anywords', 'exactphrase', and 'complexquery' }. If not specified, it defaults to 'complexQuery'.
`Modifier`	Specify the kind of related terms included in the search. Available options are: { 'synonymsof', 'relatedto', 'soundslike', 'wordbeginswith', and 'wordendswith' }. If not specified or specify any value other than the available options, it will be ignored.
`Within`	Narrow the search by specifying whether search within the content or metadata of items, or both. Available options are: { 'content', 'metadata', and 'all' }. If not specified, it defaults to 'all'.
`Boolean`	Specify the boolean operator between multiple query clauses (such as between a saved search query and a specified where parameter). Valid values are: 'or', 'and', 'not'. Defaults to 'or' if not specified or an invalid entry is used.

/v2/search/template/settings/display

Sets the display options for the user's default template

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Page Size`	The number of results for each search results page.
`Show Keywords`	A flag indicating if keywords are on.
`Show Location Path`	A flag indicating if the location path should be shown.
`Style Id`	Specifies the layout style of the search results.
`Summary Description`	Specifies how summaries and desctiptions are shown.
`Sort Regions`	List of sort key strings specifying the regions sort order. Keys are valid regions retrieved from the available list of sortable regions.
`Display Regions`	List of region key strings specifying the display regions order. Keys are valid regions retrieved from the available list of displayable regions.
`Facet Regions`	List of region key strings specifying the display regions order. Keys are valid regions retrieved from the available list of facet regions.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).

/v2/search/template/{id}/settings/display

Sets the display options for the specified template ID

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	ID of the template to update.
`Response Type`	N/A

Options (9)

Option Name	Description
`Page Size`	The number of results for each search results page.
`Show Keywords`	A flag indicating if keywords are on.
`Show Location Path`	A flag indicating if the location path should be shown.
`Style Id`	Specifies the layout style of the search results.
`Summary Description`	Specifies how summaries and desctiptions are shown.
`Sort Regions`	List of sort key strings specifying the regions sort order. Keys are valid regions retrieved from the available list of sortable regions.
`Display Regions`	List of region key strings specifying the display regions order. Keys are valid regions retrieved from the available list of displayable regions.
`Facet Regions`	List of region key strings specifying the display regions order. Keys are valid regions retrieved from the available list of facet regions.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).

/v1/serverinfo

Returns information related to Content Server and its configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

/v2/signaturerequests/{request_id}/cancel

Cancel the signature request by request id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Request Id`	Signature request id
`Response Type`	N/A

/v2/signaturerequests

Create the signature request.

To create the signature request we need to pass doc_id , signer information and provider_id .

Examples we need to pass signer information in below format.
signer:{"full_name":"name","email_id":"test@opentext.com"}

To create the signature request use below format
{"doc_id":1234,"signer":{"full_name":"name","email_id":"test@opentext.com"},"provider_id":"docusign"}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Doc Id`	Document Id (non-empty) .List of documents to be sent for signing
`Signer`	Signer information. (non-empty). Signer information should contain full_name and email_id
`Provider Id`	Non empty text that can be either docusign or coresignature

/v2/signaturerequests

Get signature request details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Where Provider Name`	Specify docusign or coresignature
`Where Status`	Filters the results based on status. Valid values are 'created', 'sent', signed', 'voided'
`Limit`	Page size
`Page`	Page number
`Sort`	Order by named column (Using prefixes such as sort=asc_created or sort=desc_created ). Format can be sort = provider_name, sort = status. If the prefix of asc or desc is not used then asc will be assumed.
`Response Type`	N/A

/v2/signaturerequests/{request_id}

Get signature request details by request id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Request Id`	Signature request id
`Include Activities`	Activities
`Response Type`	N/A

/v2/signaturerequests/{request_id}/reminder/

Send reminder notification to signers by request id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Request Id`	Signature request id
`Response Type`	N/A

/v1/tabs/nodes/categories

Gets the necessary data to render the contents of the Categories tab.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The ID of the node
`Category Id`	The ID of the category that is being added to the node
`Fields`	Exclude all fields except the one that is specified
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/tklattribute/defaultvalues

List of all child attribute values if the length of valid values is 1, depending on the parent attribute value

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	Node ID For which the category is applied. If the version_number parameter is specified, then this parameter is not required.In workflow scenario draftprocess id.
`Attribute Key`	attribute key for which list of valid values are required
`Is Search`	The possible values are TRUE/FALSE, Default Value is FALSE. If it is called from custom view search widget then value is TRUE else FALSE
`Version Number`	Category version number. If the id parameter is specified then this parameter is not needed. Category ID will be obtained from attribute_key parameter.
`Attribute Values`	List of key value pairs of attributes
`Subwork Id`	Sub Workflow ID. If subwork_id parameter is specified then the values of sub workflow will be fetched.

/v1/tklattribute/validvalues

List of Valid Values for a TKL Attribute based on the dependent attribute values if provided

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Id`	Node ID For which the category is applied. If the version_number parameter is specified, then this parameter is not required.In workflow scenario draftprocess id.
`Attribute Key`	attribute key for which list of valid values are required
`Version Number`	Category version number. If the id parameter is specified then this parameter is not needed. Category ID will be obtained from attribute_key parameter.
`Attribute Values`	List of key value pairs of attributes
`Subwork Id`	Sub Workflow ID. If subwork_id parameter is specified then the values of sub workflow will be fetched.
`Typeaheadsearch`	Type ahead search. If typeAheadSearch parameter is specified then the tkl values searched with option like startwith, contains or none.
`Filterdata`	Filter data is a search data, which is entered by you. If typeAheadSearch parameter is specified then the tkl values searched with typeaheadsearch option like startwith or contains.For none option it won't be considered
`Pageindex`	Page index. it is used to retrieve specific page number values by considering global page size configuration value.

/v1/validation/nodes

For a list of names and a given parent node, check to see if there are name collisions (subject to database collation) between the list of names and the nodes in the parent node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v1/validation/nodes/categories/enforcement

Check if the given node IDs enforce required attributes.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v1/validation/nodes/names

Check for name collisions in the specified node (container). NOTE: The output of this call will contain ONLY the items with name collisions. If there are no name collisions, the output will be empty.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v2/nodes/{id}/versions/renditions

Adds a new rendition to the current version of a node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (2)

Option Name	Description
`Rendition Type`	Rendition type (non-empty)
`File`	The file

/v1/nodes/{id}/versions

Adds a new version on the node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (8)

Option Name	Description
`File`	The file
`Description`	Version description
`Add Major Version`	Indicates whether the added version is a major version
`External Create Date`	External create date
`External Modify Date`	External modify date
`External Source`	External source
`External Identity`	External identity
`External Identity Type`	External identity type

/v2/nodes/{id}/versions

Adds a new version on the node. Must use file _or_ upload_key arguments.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

Options (9)

Option Name	Description
`File`	The file
`Upload Key`	The key to identify a Large File Upload session
`Description`	Version description
`Add Major Version`	Indicates whether the added version is a major version
`External Create Date`	External create date
`External Modify Date`	External modify date
`External Source`	External source
`External Identity`	External identity
`External Identity Type`	External identity type

/v2/nodes/{id}/versions/{version_number}/renditions

Deletes the specified rendition of a version on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Rendition Type`	Rendition type
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}

Deletes the specified version on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}

Deletes the specified version on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}/renditions/content

Download contents of the specified rendition of the specified version of the node. The name of the downloaded file will be that of the node or the node with the rendition type and the extension of the rendition if they are of different types.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Rendition Type`	Rendition type
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}/content

Downloads contents of the specified version on the node. The name of the downloaded file will be that of the version's file name.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}/content/{document_name}

Downloads contents of the specified version on the node. The name of the downloaded file will be set to the value in {document_name}.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Document Name`	The name of the downloaded version
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}/thumbnails/{thumbnail_type}/content

Downloads the specified size of version thumbnail on the node (available in Content Server 10.5).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Thumbnail Type`	Thumbnail size, e.g medium
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}/actions

Gets the available actions on the specified version on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}/categories

Gets info on the categories on the specified version on the node. If the specified version does not have categories, the return data structure(s) will be empty.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}/categories

Gets info on the categories on the specified version on the node. Use the metadata flag to get the category attribute ordering.
If the specified version does not have categories, the 'results' list will be empty.
If there are multiple categories on that version, they will be returned under the 'results' list in the order they were applied to that version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number. Use 0 to get the latest version.
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}/thumbnails

Gets info on the version thumbnails on the node (available in Content Server 10.5).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}/thumbnails/{thumbnail_type}

Gets info on the specified size of version thumbnail on the node (available in Content Server 10.5).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Thumbnail Type`	Thumbnail size, e.g medium
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/latest

Gets info on the latest version on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}

Gets info on the specified version on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}

Gets info on the versions on the node.

NOTE: if results.data.versions is an empty object (ie. results.data.version = []), the node has no versions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/versions/renditions

Lists all renditions for all available versions indexed by ****.

NOTE: if results.data[ **** ] is an empty list, the version has no renditions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Response Type`	N/A

/v1/nodes/{id}/versions

Gets info on the versions on the node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/versions

Gets info on the versions on the node.

NOTE: if results.data.versions is an empty object (ie. results.data.version = []), the node has no versions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Page`	Page number
`Limit`	Page size
`Order`	Order of the results.asc = ascending order (from the earliest to latest version)desc = descending order (from the latest to the earliest version)
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}/renditions

List/Get rendition(s) for a specified version depending on specified parameters."rendition_type" not specified:
List available renditions for the specified version. If no renditions are available, results.data will be an empty list."rendition_type" specified:
Get the specified rendition of the version. If no such rendition exists, will return an error. results.data will be an object with the rendition information.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Rendition Type`	Rendition type
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}/lock

Locks the specified version on the node, preventing it from being modified or deleted.

NOTE:This is not the same as reserving a node, which prevents the document and its versions from being modified. Locking a version only prevents that version from being modified - the rest of the node can still be modified by other users (ie. a user can lock a version, while another user can change the node's name or description at the same time).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	The version_number of the version to lock
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}/promote

Promotes a version to the next Major version on the node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	The version_number of the version to promote
`Response Type`	N/A

Options (1)

Option Name	Description
`Description`	The description of the newly promoted version

/v2/nodes/{id}/versions

Purges the versions on the node. If the node is using advanced versioning, then it will only purge minor versions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Number To Keep`	Specifies the number of versions to keep ( must be a positive integer ). If the node is using advanced versioning, this parameter specifies the number of minor versions to keep. If this is not specified, the default value of 1 will be used.
`Response Type`	N/A

/v2/nodes/{id}/versions/{version_number}/renditions

Replaces the specified rendition of a version on the node

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Response Type`	N/A

Options (2)

Option Name	Description
`File`	The file
`Rendition Type`	Rendition type (non-empty)

/v2/nodes/{id}/versions/{version_number}/unlock

Unlocks the specified version on the node.

NOTE: This is not the same as unreserving a node. Unlocking a version is specific to that version alone.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	The version_number of the version to unlock
`Response Type`	N/A

/v1/nodes/{id}/versions/{version_number}

Updates the specified version on the node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Response Type`	N/A

Options (1)

Option Name	Description
`Description`	The version description

/v2/nodes/{id}/versions/{version_number}

Updates the specified version on the node.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Version Number`	Version number
`Response Type`	N/A

Options (1)

Option Name	Description
`Description`	The version description

/v1/volumes

Gets info on available system volumes.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/volumes

Gets info on available system volumes.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Actions`	Retrieve actions for the volume. This is similar to 'commands' for v1 (E.g. actions=delete&actions=open). Note: For best performance minimize the number of actions requested.
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/volumes/{type}/nodes

Browses the volume, returning info on its child nodes.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	Subtype of the volume
`Where Type`	Filter on node type
`Where Name`	Filter on node name
`Where Facet`	Filter on facet values. There will be one instance of this parameter for each facet selected. The values are combined using \| character. E.g. where_facet=2095:144\|0\|-1 (note that -1 is a special value that denotes containers).
`Sort`	Order by named column. Format can be sort=name, or sort=asc_name, or sort=desc_name.
`Page`	Page number
`Limit`	Page size
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/volumes/{id}/nodes

Browses the volume, returning info on its child nodes.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID
`Where Type`	Filter on node type
`Where Name`	Filter on node name
`Where Facet`	Filter on facet values. There will be one instance of this parameter for each facet selected. The values are combined using \| character. E.g. where_facet=2095:144\|0\|-1 (note that -1 is a special value that denotes containers).
`Actions`	Retrieve actions for the node. This is similar to 'commands' for v1 (E.g. actions=delete&actions=open). Note: For best performance minimize the number of actions requested.
`Sort`	Order by named column. Format can be sort=name or sort=asc_name or sort=desc_name. If the prefix of asc or desc is not used then asc will be assumed.
`Page`	Page number
`Limit`	Page size
`Fields`	Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)).
`Expand`	Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/volumes/{type}

Gets info about the specified volume.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	Subtype of the volume
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Expand Fields`	Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/volumes/{type}

Gets info about the specified volume.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	Subtype of the volume
`Fields`	Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions).
`Expand`	Expand all fields that belong to the specified persona (e.g. expand=node&expand=member).
`Metadata`	Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata).
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/destination

Returns the destination data from a WebReport node. (*) against a field name denotes that the field supports tag replacement.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID of a WebReport node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/output

Returns the output from the execution of a WebReport node. This API only supports the 'browser' and 'desktop' WebReport destination types. Any content-type is supported for the response. The content-type of the response is user-defined according to the 'Export Mime Type' specified for the WebReport node destination. All dynamic parameters and those defined by the output of the 'api/v1/nodes/{id}/parameters' or 'api/v1/webreports/{nickname}/parameters' APIs are supported when passed in as part of the query string.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID of a WebReport node
`Format`	Specifies the emitter used to format the WebReport output. If this parameter isn't defined the default will be 'json'. If 'webreport' is used then no additional processing will be performed on the output, if 'json' is used then json processing including escaping will be performed. If your WebReport returns a content-type which isn't json or if it returns json which has already been escaped, 'webreport' should be used.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/webreports/{nickname}

Returns the output from the execution of a WebReport node. This API only supports the 'browser' and 'desktop' WebReport destination types. Any content-type is supported for the response. The content-type of the response is user-defined according to the 'Export Mime Type' specified for the WebReport node destination. All dynamic parameters and those defined by the output of the 'api/v1/nodes/{id}/parameters' or 'api/v1/webreports/{nickname}/parameters' APIs are supported when passed in as part of the query string.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Nickname`	Nickname of a WebReport node
`Format`	Specifies the emitter used to format the WebReport output. If this parameter isn't defined the default will be 'json'. If 'webreport' is used then no additional processing will be performed on the output, if 'json' is used then json processing including escaping will be performed. If your WebReport returns a content-type which isn't json or if it returns json which has already been escaped, 'webreport' should be used.
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/webreports/{nickname}/parameters

Returns the definition of all parameters defined for a WebReport node.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Nickname`	Nickname of a WebReport node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/nodes/{id}/output

Runs a WebReport. This API supports all destination types other than 'browser' and 'desktop' WebReport destination types, for which the GET method should be used instead.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Node ID of a WebReport node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v1/webreports/{nickname}

Runs a WebReport. This API supports all destination types other than 'browser' and 'desktop' WebReport destination types, for which the GET method should be used instead.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Nickname`	Nickname of a WebReport node
`Suppress Response Codes`	Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).NOTE: This parameter does not require a value, so it should be specified as [Query String]:?suppress_response_codes[Form Body (where the value is an empty string)]: suppress_response_codes =
`Response Type`	N/A

/v2/import/settings/admin

Import admin settings from an XML file

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The XML file containing the admin settings to be imported

Apiinfo

Auth (2)

Bulkactions

Categories (15)

Doctemplates

Documentproperties

Draftprocesses (2)

Export

Facets

Forms (20)

Intelligentfiling

Members (29)

Multipart (5)

Nicknames (2)

Nodes (35)

Notifications (2)

Permissions (10)

Perspectives

Ping

Processes (6)

Resubmission (8)

Search (8)

Serverinfo

Signaturerequests (5)

Tabs

Tklattribute (2)

Validation (3)

Versions (29)

Volumes (6)

Webreports (6)

Xmlimport