jellyfin.generated.api_10_11.ItemUpdateApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_metadata_editor_info	GET /Items/{itemId}/MetadataEditor	Gets metadata editor info for an item.
update_item	POST /Items/{itemId}	Updates an item.
update_item_content_type	POST /Items/{itemId}/ContentType	Updates an item's content type.

get_metadata_editor_info

MetadataEditorInfo get_metadata_editor_info(item_id)

Gets metadata editor info for an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.metadata_editor_info import MetadataEditorInfo
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.ItemUpdateApi(api_client)
    item_id = 'item_id_example' # str | The item id.

    try:
        # Gets metadata editor info for an item.
        api_response = api_instance.get_metadata_editor_info(item_id)
        print("The response of ItemUpdateApi->get_metadata_editor_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ItemUpdateApi->get_metadata_editor_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.

Return type

MetadataEditorInfo

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
200	Item metadata editor returned.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_item

update_item(item_id, base_item_dto)

Updates an item.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.base_item_dto import BaseItemDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.ItemUpdateApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    base_item_dto = jellyfin.generated.api_10_11.BaseItemDto() # BaseItemDto | The new item properties.

    try:
        # Updates an item.
        api_instance.update_item(item_id, base_item_dto)
    except Exception as e:
        print("Exception when calling ItemUpdateApi->update_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
base_item_dto	BaseItemDto	The new item properties.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
204	Item updated.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_item_content_type

update_item_content_type(item_id, content_type=content_type)

Updates an item's content type.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.ItemUpdateApi(api_client)
    item_id = 'item_id_example' # str | The item id.
    content_type = 'content_type_example' # str | The content type of the item. (optional)

    try:
        # Updates an item's content type.
        api_instance.update_item_content_type(item_id, content_type=content_type)
    except Exception as e:
        print("Exception when calling ItemUpdateApi->update_item_content_type: %s\n" % e)

Parameters

Name	Type	Description	Notes
item_id	str	The item id.
content_type	str	The content type of the item.	[optional]

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code	Description	Response headers
204	Item content type updated.	-
404	Item not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]