Features in support of tagging 

The Files CMIS API introduces the following features to support the ability to tag select resources, navigate by tag, or get a cloud of tags for a particular repository scope.

Feature key	Feature value
taggable	true or false
tagScope	true or false

This feature introduces the following service operation to the domain model:

getChildren

• Extends with the ability to filter child objects by tag.

• Optional inputs

  • <Array> tag: The set of tags to filter children by

getObject

• Extends with the ability to retrieve tags with an object.

• Optional inputs

  • Boolean includeTags: TRUE if tags applied to the object should be retrieved with resource

getTagCloudForScope

• Gets the history of download entries for the specified resource. This service must be supported by a repository for any resource type that has the tagScope feature enabled.

• Required inputs

  • ID repositoryId: The identifier for the repository.

  • ID objectId: The identifier for the object

• Optional inputs

  • String orderBy: Sorts cloud by tag name or weight

    • name: sorts by name

    • weight: sorts by number of times the tag is applied in scope

  • String tagPrefix: Filters a cloud based on a specified prefix for the tag

  • Integer maxItems: The number of entries to fetch

  • Integer skipCount: The number to skip ahead to

• Outputs

  • <Array> Tags: The list of tags

• Exceptions thrown and conditions

  • See CMIS section 2.2.1.4.1 General Exceptions
    

This feature introduces the following extensions to the RESTful Atompub Binding:

Document Entry

Atom elements:

• atom:category - Serializes an atom:category element for each tag applied to the resource. This element is read/write supported in the API.

Folder entry

Link relations:


• http://www.ibm.com/xmlns/prod/sn/cmis/tags: Points to the tag cloud for the current scope in the repository

  • GET

    • getTagCloudForScope

This feature introduces a reserved HTML form parameter in multipart form-data request to supply tags on a create or update operation.

• To apply tags on a resource, a form part with the name snx:tags should be supplied. The form value should be a space delimited set of tags to apply to the resource.
  

Parent topic

Files CMIS API features

   

 

});

+

Search Tips   |   Advanced Search