Constructor Detail

Method Detail

• createTagForNode

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/tags") abstract TagEntry createTagForNode(@Path(value = "nodeId") String nodeId, @Body() TagBody tagBodyCreate, @Query(value = "fields") List<String> fields)

  Create a tag for a node Creates a tag on the node nodeId. You specify the tag in a JSON body like this: ``JSON { \"tag\":\"test-tag-1\" } `` Note: You can create more than one tag by specifying a list of tags in the JSON body like this: ``JSON [ { \"tag\":\"test-tag-1\" }, { \"tag\":\"test-tag-2\" } ] `` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: ``JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } `` The endpoint is owned by defaultname service owner @param nodeId The identifier of a node. (required) @param tagBodyCreate The new tag (required) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. (optional)

• deleteTagFromNode

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/nodes/{nodeId}/tags/{tagId}") abstract Unit deleteTagFromNode(@Path(value = "nodeId") String nodeId, @Path(value = "tagId") String tagId)

  Delete a tag from a node Deletes tag tagId from node nodeId. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  tagId - The identifier of a tag.

• getTag

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/tags/{tagId}") abstract TagEntry getTag(@Path(value = "tagId") String tagId, @Query(value = "fields") List<String> fields)

  Get a tag Get a specific tag with tagId. The endpoint is owned by defaultname service owner

  Parameters:

  tagId - The identifier of a tag.

  fields - A list of field names.

• listTags

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/tags") abstract TagPaging listTags(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields, @Query(value = "include") List<String> include)

  List tags Gets a list of tags in this repository. You can use the include parameter to return additional values information. The endpoint is owned by defaultname service owner

  Parameters:

  skipCount - The number of entities that exist in the collection before those included in this list.

  maxItems - The maximum number of items to return in the list.

  fields - A list of field names.

  include - Returns additional information about the tag.

• listTagsForNode

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/tags") abstract TagPaging listTagsForNode(@Path(value = "nodeId") String nodeId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)

  List tags for a node Gets a list of tags for node nodeId. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  skipCount - The number of entities that exist in the collection before those included in this list.

  maxItems - The maximum number of items to return in the list.

  fields - A list of field names.

• updateTag

  @Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/tags/{tagId}") abstract TagEntry updateTag(@Path(value = "tagId") String tagId, @Body() TagBody tagBodyUpdate, @Query(value = "fields") List<String> fields)

  Update a tag Updates the tag tagId. The endpoint is owned by defaultname service owner

  Parameters:

  tagId - The identifier of a tag.

  tagBodyUpdate - The updated tag (required)

  fields - A list of field names.