Class: AlfrescoAPI::TrashcanApi

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco_api/api/trashcan_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TrashcanApi

Returns a new instance of TrashcanApi.



19
20
21
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_deleted_node(node_id, opts = {}) ⇒ nil

Permanently delete a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Permanently deletes the deleted node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 28

def delete_deleted_node(node_id, opts = {})
  delete_deleted_node_with_http_info(node_id, opts)
  return nil
end

#delete_deleted_node_with_http_info(node_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Permanently delete a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Permanently deletes the deleted node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 38

def delete_deleted_node_with_http_info(node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.delete_deleted_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 TrashcanApi.delete_deleted_node"
  end
  # resource path
  local_var_path = "/deleted-nodes/{nodeId}".sub('{' + 'nodeId' + '}', node_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: TrashcanApi#delete_deleted_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_archived_node_rendition(node_id, rendition_id, opts = {}) ⇒ RenditionEntry

Get rendition information for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition information for renditionId of file nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rendition_id —

    The name of a thumbnail rendition, for example doclib, or pdf.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 83

def get_archived_node_rendition(node_id, rendition_id, opts = {})
  data, _status_code, _headers = get_archived_node_rendition_with_http_info(node_id, rendition_id, opts)
  return data
end

#get_archived_node_rendition_content(node_id, rendition_id, opts = {}) ⇒ nil

Get rendition content of a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for renditionId of file nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rendition_id —

    The name of a thumbnail rendition, for example doclib, or pdf.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :attachment (BOOLEAN) —

    true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response. (default to true)

  • :if_modified_since (DateTime) —

    Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, &#x60;Wed, 09 Mar 2016 16:56:34 GMT&#x60;.

  • :placeholder (BOOLEAN) —

    If true and there is no rendition for this nodeId and renditionId, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response. (default to false)

Returns:

  • (nil) 


147
148
149
150
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 147

def get_archived_node_rendition_content(node_id, rendition_id, opts = {})
  get_archived_node_rendition_content_with_http_info(node_id, rendition_id, opts)
  return nil
end

#get_archived_node_rendition_content_with_http_info(node_id, rendition_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get rendition content of a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for renditionId of file nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rendition_id —

    The name of a thumbnail rendition, for example doclib, or pdf.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :attachment (BOOLEAN) —

    true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response.

  • :if_modified_since (DateTime) —

    Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, &#x60;Wed, 09 Mar 2016 16:56:34 GMT&#x60;.

  • :placeholder (BOOLEAN) —

    If true and there is no rendition for this nodeId and renditionId, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 161

def get_archived_node_rendition_content_with_http_info(node_id, rendition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.get_archived_node_rendition_content ..."
  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 TrashcanApi.get_archived_node_rendition_content"
  end
  # verify the required parameter 'rendition_id' is set
  if @api_client.config.client_side_validation && rendition_id.nil?
    fail ArgumentError, "Missing the required parameter 'rendition_id' when calling TrashcanApi.get_archived_node_rendition_content"
  end
  # resource path
  local_var_path = "/deleted-nodes/{nodeId}/renditions/{renditionId}/content".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'renditionId' + '}', rendition_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'attachment'] = opts[:'attachment'] if !opts[:'attachment'].nil?
  query_params[:'placeholder'] = opts[:'placeholder'] if !opts[:'placeholder'].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'])
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrashcanApi#get_archived_node_rendition_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_archived_node_rendition_with_http_info(node_id, rendition_id, opts = {}) ⇒ Array<(RenditionEntry, Fixnum, Hash)>

Get rendition information for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition information for renditionId of file nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • rendition_id —

    The name of a thumbnail rendition, for example doclib, or pdf.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RenditionEntry, Fixnum, Hash)>) —

    RenditionEntry data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 94

def get_archived_node_rendition_with_http_info(node_id, rendition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.get_archived_node_rendition ..."
  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 TrashcanApi.get_archived_node_rendition"
  end
  # verify the required parameter 'rendition_id' is set
  if @api_client.config.client_side_validation && rendition_id.nil?
    fail ArgumentError, "Missing the required parameter 'rendition_id' when calling TrashcanApi.get_archived_node_rendition"
  end
  # resource path
  local_var_path = "/deleted-nodes/{nodeId}/renditions/{renditionId}".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'renditionId' + '}', rendition_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(: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 => 'RenditionEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrashcanApi#get_archived_node_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deleted_node(node_id, opts = {}) ⇒ DeletedNodeEntry

Get a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the specific deleted node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include (Array<String>) —

    Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions

Returns:



213
214
215
216
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 213

def get_deleted_node(node_id, opts = {})
  data, _status_code, _headers = get_deleted_node_with_http_info(node_id, opts)
  return data
end

#get_deleted_node_content(node_id, opts = {}) ⇒ nil

Get deleted node content Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the deleted node with identifier nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :attachment (BOOLEAN) —

    true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response. (default to true)

  • :if_modified_since (DateTime) —

    Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, &#x60;Wed, 09 Mar 2016 16:56:34 GMT&#x60;.

Returns:

  • (nil) 


272
273
274
275
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 272

def get_deleted_node_content(node_id, opts = {})
  get_deleted_node_content_with_http_info(node_id, opts)
  return nil
end

#get_deleted_node_content_with_http_info(node_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get deleted node content Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the deleted node with identifier nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :attachment (BOOLEAN) —

    true enables a web browser to download the file as an attachment. false means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to false if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of false is ignored, and the attachment will be returned in the response.

  • :if_modified_since (DateTime) —

    Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, &#x60;Wed, 09 Mar 2016 16:56:34 GMT&#x60;.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 284

def get_deleted_node_content_with_http_info(node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.get_deleted_node_content ..."
  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 TrashcanApi.get_deleted_node_content"
  end
  # resource path
  local_var_path = "/deleted-nodes/{nodeId}/content".sub('{' + 'nodeId' + '}', node_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'attachment'] = opts[:'attachment'] if !opts[:'attachment'].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'])
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrashcanApi#get_deleted_node_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deleted_node_with_http_info(node_id, opts = {}) ⇒ Array<(DeletedNodeEntry, Fixnum, Hash)>

Get a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the specific deleted node nodeId.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include (Array<String>) —

    Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions

Returns:

  • (Array<(DeletedNodeEntry, Fixnum, Hash)>) —

    DeletedNodeEntry data, response status code and response headers



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 224

def get_deleted_node_with_http_info(node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.get_deleted_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 TrashcanApi.get_deleted_node"
  end
  # resource path
  local_var_path = "/deleted-nodes/{nodeId}".sub('{' + 'nodeId' + '}', node_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].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 => 'DeletedNodeEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrashcanApi#get_deleted_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_deleted_node_renditions(node_id, opts = {}) ⇒ RenditionPaging

List renditions for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for each rendition of the file nodeId, including the rendition id. Each rendition returned has a status: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested. You can use the where parameter to filter the returned renditions by status. For example, the following where clause will return just the CREATED renditions: “‘ (status=’CREATED’) “‘

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    A string to restrict the returned objects by using a predicate.

Returns:



331
332
333
334
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 331

def list_deleted_node_renditions(node_id, opts = {})
  data, _status_code, _headers = list_deleted_node_renditions_with_http_info(node_id, opts)
  return data
end

#list_deleted_node_renditions_with_http_info(node_id, opts = {}) ⇒ Array<(RenditionPaging, Fixnum, Hash)>

List renditions for a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for each rendition of the file nodeId, including the rendition id. Each rendition returned has a status: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested. You can use the where parameter to filter the returned renditions by status. For example, the following where clause will return just the CREATED renditions: &#x60;&#x60;&#x60; (status&#x3D;&#39;CREATED&#39;) &#x60;&#x60;&#x60;

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    A string to restrict the returned objects by using a predicate.

Returns:

  • (Array<(RenditionPaging, Fixnum, Hash)>) —

    RenditionPaging data, response status code and response headers



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 342

def list_deleted_node_renditions_with_http_info(node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.list_deleted_node_renditions ..."
  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 TrashcanApi.list_deleted_node_renditions"
  end
  # resource path
  local_var_path = "/deleted-nodes/{nodeId}/renditions".sub('{' + 'nodeId' + '}', node_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].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 => 'RenditionPaging')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrashcanApi#list_deleted_node_renditions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_deleted_nodes(opts = {}) ⇒ DeletedNodesPaging

List deleted nodes Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of deleted nodes for the current user. If the current user is an administrator deleted nodes for all users will be returned. The list of deleted nodes will be ordered with the most recently deleted node at the top of the list.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :skip_count (Integer) —

    The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (default to 0)

  • :max_items (Integer) —

    The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)

  • :include (Array<String>) —

    Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isLocked * path * properties * permissions

Returns:



390
391
392
393
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 390

def list_deleted_nodes(opts = {})
  data, _status_code, _headers = list_deleted_nodes_with_http_info(opts)
  return data
end

#list_deleted_nodes_with_http_info(opts = {}) ⇒ Array<(DeletedNodesPaging, Fixnum, Hash)>

List deleted nodes Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of deleted nodes for the current user. If the current user is an administrator deleted nodes for all users will be returned. The list of deleted nodes will be ordered with the most recently deleted node at the top of the list.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :skip_count (Integer) —

    The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.

  • :max_items (Integer) —

    The maximum number of items to return in the list. If not supplied then the default value is 100.

  • :include (Array<String>) —

    Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isLocked * path * properties * permissions

Returns:

  • (Array<(DeletedNodesPaging, Fixnum, Hash)>) —

    DeletedNodesPaging data, response status code and response headers



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 402

def list_deleted_nodes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.list_deleted_nodes ..."
  end
  if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
    fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling TrashcanApi.list_deleted_nodes, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
    fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling TrashcanApi.list_deleted_nodes, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/deleted-nodes"

  # query parameters
  query_params = {}
  query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
  query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].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 => 'DeletedNodesPaging')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrashcanApi#list_deleted_nodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#restore_deleted_node(node_id, opts = {}) ⇒ NodeEntry

Restore a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Attempts to restore the deleted node nodeId to its original location. If the node is successfully restored to its former primary parent, then only the primary child association will be restored, including recursively for any primary children. It should be noted that no other secondary child associations or peer associations will be restored, for any of the nodes within the primary parent-child hierarchy of restored nodes, irrespective of whether these associations were to nodes within or outside of the restored hierarchy. Also, any previously shared link will not be restored since it is deleted at the time of delete of each node.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    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.

Returns:



455
456
457
458
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 455

def restore_deleted_node(node_id, opts = {})
  data, _status_code, _headers = restore_deleted_node_with_http_info(node_id, opts)
  return data
end

#restore_deleted_node_with_http_info(node_id, opts = {}) ⇒ Array<(NodeEntry, Fixnum, Hash)>

Restore a deleted node Note: this endpoint is available in Alfresco 5.2 and newer versions. Attempts to restore the deleted node nodeId to its original location. If the node is successfully restored to its former primary parent, then only the primary child association will be restored, including recursively for any primary children. It should be noted that no other secondary child associations or peer associations will be restored, for any of the nodes within the primary parent-child hierarchy of restored nodes, irrespective of whether these associations were to nodes within or outside of the restored hierarchy. Also, any previously shared link will not be restored since it is deleted at the time of delete of each node.

Parameters:

  • node_id —

    The identifier of a node.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    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.

Returns:

  • (Array<(NodeEntry, Fixnum, Hash)>) —

    NodeEntry data, response status code and response headers



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/alfresco_api/api/trashcan_api.rb', line 466

def restore_deleted_node_with_http_info(node_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TrashcanApi.restore_deleted_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 TrashcanApi.restore_deleted_node"
  end
  # resource path
  local_var_path = "/deleted-nodes/{nodeId}/restore".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 = nil
  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 => 'NodeEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrashcanApi#restore_deleted_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end