Apache NiFi Registry REST API

REST API definition for Apache NiFi Registry web services

OpenAPI spec version: 2.6.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.items_api.ItemsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

__init__(api_client=None)

get_available_bucket_item_fields(**kwargs)

Get item fields.

Retrieves the item field names for searching or sorting on bucket items.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_available_bucket_item_fields_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

Fields

get_available_bucket_item_fields_with_http_info(**kwargs)

Get item fields.

Retrieves the item field names for searching or sorting on bucket items.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_available_bucket_item_fields() method instead.

Args:

Returns:

(Fields, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_items(**kwargs)

Get all items.

Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_items_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

list[BucketItem]

get_items1(bucket_id, **kwargs)

Get bucket items.

Gets the items located in the given bucket.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_items1_with_http_info() method instead.

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

The response data.

Return type:

list[BucketItem]

get_items1_with_http_info(bucket_id, **kwargs)

Get bucket items.

Gets the items located in the given bucket.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_items1() method instead.

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

(list[BucketItem], status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_items_with_http_info(**kwargs)

Get all items.

Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_items() method instead.

Args:

Returns:

(list[BucketItem], status_code, headers) - Response data with HTTP details.

Return type:

tuple