class AlfrescoAPI::TagsApi
Attributes
Public Class Methods
# File lib/alfresco_api/api/tags_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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": { … } } ] } } “` @param node_id The identifier of a node. @param tag_body_create The new tag @param [Hash] opts the optional parameters @option opts [Array<String>] :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. @return [TagEntry]
# File lib/alfresco_api/api/tags_api.rb, line 30 def create_tag_for_node(node_id, tag_body_create, opts = {}) data, _status_code, _headers = create_tag_for_node_with_http_info(node_id, tag_body_create, opts) return data end
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": { … } } ] } } ``` @param node_id The identifier of a node. @param tag_body_create The new tag @param [Hash] opts the optional parameters @option opts [Array<String>] :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. @return [Array<(TagEntry
, Fixnum, Hash)>] TagEntry
data, response status code and response headers
# File lib/alfresco_api/api/tags_api.rb, line 42 def create_tag_for_node_with_http_info(node_id, tag_body_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TagsApi.create_tag_for_node ..." end # verify the required parameter 'node_id' is set if @api_client.config.client_side_validation && node_id.nil? fail ArgumentError, "Missing the required parameter 'node_id' when calling TagsApi.create_tag_for_node" end # verify the required parameter 'tag_body_create' is set if @api_client.config.client_side_validation && tag_body_create.nil? fail ArgumentError, "Missing the required parameter 'tag_body_create' when calling TagsApi.create_tag_for_node" end # resource path local_var_path = "/nodes/{nodeId}/tags".sub('{' + 'nodeId' + '}', node_id.to_s) # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(tag_body_create) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TagEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: TagsApi#create_tag_for_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a tag from a node Deletes tag tagId from node nodeId. @param node_id The identifier of a node. @param tag_id The identifier of a tag. @param [Hash] opts the optional parameters @return [nil]
# File lib/alfresco_api/api/tags_api.rb, line 93 def delete_tag_from_node(node_id, tag_id, opts = {}) delete_tag_from_node_with_http_info(node_id, tag_id, opts) return nil end
Delete a tag from a node Deletes tag tagId from node nodeId. @param node_id The identifier of a node. @param tag_id The identifier of a tag. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/alfresco_api/api/tags_api.rb, line 104 def delete_tag_from_node_with_http_info(node_id, tag_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TagsApi.delete_tag_from_node ..." end # verify the required parameter 'node_id' is set if @api_client.config.client_side_validation && node_id.nil? fail ArgumentError, "Missing the required parameter 'node_id' when calling TagsApi.delete_tag_from_node" end # verify the required parameter 'tag_id' is set if @api_client.config.client_side_validation && tag_id.nil? fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.delete_tag_from_node" end # resource path local_var_path = "/nodes/{nodeId}/tags/{tagId}".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TagsApi#delete_tag_from_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a tag Get a specific tag with tagId. @param tag_id The identifier of a tag. @param [Hash] opts the optional parameters @option opts [Array<String>] :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. @return [TagEntry]
# File lib/alfresco_api/api/tags_api.rb, line 153 def get_tag(tag_id, opts = {}) data, _status_code, _headers = get_tag_with_http_info(tag_id, opts) return data end
Get a tag Get a specific tag with tagId. @param tag_id The identifier of a tag. @param [Hash] opts the optional parameters @option opts [Array<String>] :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. @return [Array<(TagEntry
, Fixnum, Hash)>] TagEntry
data, response status code and response headers
# File lib/alfresco_api/api/tags_api.rb, line 164 def get_tag_with_http_info(tag_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TagsApi.get_tag ..." end # verify the required parameter 'tag_id' is set if @api_client.config.client_side_validation && tag_id.nil? fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.get_tag" end # resource path local_var_path = "/tags/{tagId}".sub('{' + 'tagId' + '}', tag_id.to_s) # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TagEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: TagsApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a tag Updates the tag tagId. @param tag_id The identifier of a tag. @param tag_body_update The updated tag @param [Hash] opts the optional parameters @option opts [Array<String>] :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. @return [TagEntry]
# File lib/alfresco_api/api/tags_api.rb, line 350 def update_tag(tag_id, tag_body_update, opts = {}) data, _status_code, _headers = update_tag_with_http_info(tag_id, tag_body_update, opts) return data end
Update a tag Updates the tag tagId. @param tag_id The identifier of a tag. @param tag_body_update The updated tag @param [Hash] opts the optional parameters @option opts [Array<String>] :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. @return [Array<(TagEntry
, Fixnum, Hash)>] TagEntry
data, response status code and response headers
# File lib/alfresco_api/api/tags_api.rb, line 362 def update_tag_with_http_info(tag_id, tag_body_update, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: TagsApi.update_tag ..." end # verify the required parameter 'tag_id' is set if @api_client.config.client_side_validation && tag_id.nil? fail ArgumentError, "Missing the required parameter 'tag_id' when calling TagsApi.update_tag" end # verify the required parameter 'tag_body_update' is set if @api_client.config.client_side_validation && tag_body_update.nil? fail ArgumentError, "Missing the required parameter 'tag_body_update' when calling TagsApi.update_tag" end # resource path local_var_path = "/tags/{tagId}".sub('{' + 'tagId' + '}', tag_id.to_s) # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(tag_body_update) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TagEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: TagsApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end