ksapi.PathPartsApi

All URIs are relative to http://localhost:8000

Method	HTTP request	Description
bulk_add_path_part_tags	POST /v1/path-parts/{path_part_id}/tags	Bulk Add Path Part Tags Handler
bulk_remove_path_part_tags	DELETE /v1/path-parts/{path_part_id}/tags	Bulk Remove Path Part Tags Handler
get_path_part	GET /v1/path-parts/{path_part_id}	Get Path Part Handler
get_path_part_ancestry	GET /v1/path-parts/{path_part_id}/ancestry	Get Path Part Ancestry Handler
get_path_part_subtree_chunks	GET /v1/path-parts/{path_part_id}/subtree_chunks	Get Path Part Subtree Chunks Handler
get_path_part_tags	GET /v1/path-parts/{path_part_id}/tags	Get Path Part Tags Handler
list_path_parts	GET /v1/path-parts	List Path Parts Handler

bulk_add_path_part_tags

PathPartTagsResponse bulk_add_path_part_tags(path_part_id, bulk_tag_request, authorization=authorization, ks_uat=ks_uat)

Bulk Add Path Part Tags Handler

Bulk add tags to a path part.

Idempotent — already-attached tags are skipped. Returns 400 if any tag_id doesn't exist (FK violation). Requires write permission on the target path part.

Example

import ksapi
from ksapi.models.bulk_tag_request import BulkTagRequest
from ksapi.models.path_part_tags_response import PathPartTagsResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.PathPartsApi(api_client)
    path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    bulk_tag_request = ksapi.BulkTagRequest() # BulkTagRequest | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Bulk Add Path Part Tags Handler
        api_response = api_instance.bulk_add_path_part_tags(path_part_id, bulk_tag_request, authorization=authorization, ks_uat=ks_uat)
        print("The response of PathPartsApi->bulk_add_path_part_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PathPartsApi->bulk_add_path_part_tags: %s\n" % e)

Parameters

Name	Type	Notes
path_part_id	UUID
bulk_tag_request	BulkTagRequest
authorization	str	[optional]
ks_uat	str	[optional]

Return type

PathPartTagsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful Response	-
422	Validation Error	-

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

bulk_remove_path_part_tags

PathPartTagsResponse bulk_remove_path_part_tags(path_part_id, bulk_tag_request, authorization=authorization, ks_uat=ks_uat)

Bulk Remove Path Part Tags Handler

Bulk remove tags from a path part.

Silently ignores tags that aren't attached. Requires write permission on the target path part.

Example

import ksapi
from ksapi.models.bulk_tag_request import BulkTagRequest
from ksapi.models.path_part_tags_response import PathPartTagsResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.PathPartsApi(api_client)
    path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    bulk_tag_request = ksapi.BulkTagRequest() # BulkTagRequest | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Bulk Remove Path Part Tags Handler
        api_response = api_instance.bulk_remove_path_part_tags(path_part_id, bulk_tag_request, authorization=authorization, ks_uat=ks_uat)
        print("The response of PathPartsApi->bulk_remove_path_part_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PathPartsApi->bulk_remove_path_part_tags: %s\n" % e)

Parameters

Name	Type	Notes
path_part_id	UUID
bulk_tag_request	BulkTagRequest
authorization	str	[optional]
ks_uat	str	[optional]

Return type

PathPartTagsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_path_part

PathPartResponse get_path_part(path_part_id, authorization=authorization, ks_uat=ks_uat)

Get Path Part Handler

Get a path part by its ID.

Returns the path part with its attached tag IDs.

Example

import ksapi
from ksapi.models.path_part_response import PathPartResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.PathPartsApi(api_client)
    path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Get Path Part Handler
        api_response = api_instance.get_path_part(path_part_id, authorization=authorization, ks_uat=ks_uat)
        print("The response of PathPartsApi->get_path_part:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PathPartsApi->get_path_part: %s\n" % e)

Parameters

Name	Type	Notes
path_part_id	UUID
authorization	str	[optional]
ks_uat	str	[optional]

Return type

PathPartResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_path_part_ancestry

AncestryResponse get_path_part_ancestry(path_part_id, authorization=authorization, ks_uat=ks_uat)

Get Path Part Ancestry Handler

Get the full ancestry chain for a path part (root to leaf, inclusive).

Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.

Example

import ksapi
from ksapi.models.ancestry_response import AncestryResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.PathPartsApi(api_client)
    path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Get Path Part Ancestry Handler
        api_response = api_instance.get_path_part_ancestry(path_part_id, authorization=authorization, ks_uat=ks_uat)
        print("The response of PathPartsApi->get_path_part_ancestry:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PathPartsApi->get_path_part_ancestry: %s\n" % e)

Parameters

Name	Type	Notes
path_part_id	UUID
authorization	str	[optional]
ks_uat	str	[optional]

Return type

AncestryResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_path_part_subtree_chunks

SubtreeChunksResponse get_path_part_subtree_chunks(path_part_id, authorization=authorization, ks_uat=ks_uat)

Get Path Part Subtree Chunks Handler

Resolve all descendant chunks for a subtree root.

Returns chunks grouped by identical (path_part_ids, tag_ids) tuples.

Example

import ksapi
from ksapi.models.subtree_chunks_response import SubtreeChunksResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.PathPartsApi(api_client)
    path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Get Path Part Subtree Chunks Handler
        api_response = api_instance.get_path_part_subtree_chunks(path_part_id, authorization=authorization, ks_uat=ks_uat)
        print("The response of PathPartsApi->get_path_part_subtree_chunks:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PathPartsApi->get_path_part_subtree_chunks: %s\n" % e)

Parameters

Name	Type	Notes
path_part_id	UUID
authorization	str	[optional]
ks_uat	str	[optional]

Return type

SubtreeChunksResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_path_part_tags

PathPartTagsResponse get_path_part_tags(path_part_id, include_inherited=include_inherited, authorization=authorization, ks_uat=ks_uat)

Get Path Part Tags Handler

Get tags for a path part.

When include_inherited=False (default), returns only directly-attached tags. When include_inherited=True, walks the ancestor chain and returns the deduplicated union of tags from all ancestors (including the path part itself).

Example

import ksapi
from ksapi.models.path_part_tags_response import PathPartTagsResponse
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.PathPartsApi(api_client)
    path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    include_inherited = False # bool | Include tags inherited from ancestor path parts (optional) (default to False)
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Get Path Part Tags Handler
        api_response = api_instance.get_path_part_tags(path_part_id, include_inherited=include_inherited, authorization=authorization, ks_uat=ks_uat)
        print("The response of PathPartsApi->get_path_part_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PathPartsApi->get_path_part_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
path_part_id	UUID
include_inherited	bool	Include tags inherited from ancestor path parts	[optional] [default to False]
authorization	str		[optional]
ks_uat	str		[optional]

Return type

PathPartTagsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

list_path_parts

PaginatedResponsePathPartResponse list_path_parts(parent_path_id=parent_path_id, max_depth=max_depth, sort_order=sort_order, limit=limit, offset=offset, authorization=authorization, ks_uat=ks_uat)

List Path Parts Handler

List path parts (folders) under a parent with traversal.

This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts.

If parent_path_id is not provided, lists contents of the root folder.
max_depth controls how deep to traverse (1 = direct children only).
sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.

For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.

Example

import ksapi
from ksapi.models.paginated_response_path_part_response import PaginatedResponsePathPartResponse
from ksapi.models.path_order import PathOrder
from ksapi.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.PathPartsApi(api_client)
    parent_path_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Parent PathPart ID (defaults to root) (optional)
    max_depth = 1 # int | Maximum depth to traverse (1 = direct children, default: 1) (optional) (default to 1)
    sort_order = ksapi.PathOrder() # PathOrder | Sort order for results (default: LOGICAL) (optional)
    limit = 20 # int | Number of items per page (optional) (default to 20)
    offset = 0 # int | Number of items to skip (optional) (default to 0)
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # List Path Parts Handler
        api_response = api_instance.list_path_parts(parent_path_id=parent_path_id, max_depth=max_depth, sort_order=sort_order, limit=limit, offset=offset, authorization=authorization, ks_uat=ks_uat)
        print("The response of PathPartsApi->list_path_parts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PathPartsApi->list_path_parts: %s\n" % e)

Parameters

Name	Type	Description	Notes
parent_path_id	UUID	Parent PathPart ID (defaults to root)	[optional]
max_depth	int	Maximum depth to traverse (1 = direct children, default: 1)	[optional] [default to 1]
sort_order	PathOrder	Sort order for results (default: LOGICAL)	[optional]
limit	int	Number of items per page	[optional] [default to 20]
offset	int	Number of items to skip	[optional] [default to 0]
authorization	str		[optional]
ks_uat	str		[optional]

Return type

PaginatedResponsePathPartResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

FilesExpand file tree

PathPartsApi.md

Latest commit

History

PathPartsApi.md

File metadata and controls

ksapi.PathPartsApi

bulk_add_path_part_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

bulk_remove_path_part_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_path_part

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_path_part_ancestry

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_path_part_subtree_chunks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_path_part_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_path_parts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details