Version: 2026.04

V3Client

Quick-reference table

Method	Description
`create_resource()`	Upload a file and register it as a new resource.
`create_resource_revision()`	Upload a new file revision for an existing resource.
`create_comment()`	Upload a file and attach it as a comment on a resource.
`update_comment()`	Replace an existing comment's file.
`get_content()`	Download raw file bytes from a resource, revision, or comment.
`get_resource()`	Retrieve a resource by ID.
`get_resource_revision()`	Retrieve a specific revision of a resource.
`get_comment()`	Retrieve a comment by ID.
`list_resources()`	List resources with optional filters.
`list_resource_revisions()`	List revisions for a resource.
`list_comments()`	List comments on a resource.
`archive_resource()`	Archive a resource.
`restore_resource()`	Restore an archived resource.
`archive_comment()`	Archive a comment.
`restore_comment()`	Restore an archived comment.
`create_revision_relationship()`	Create a typed relationship between two revisions.
`list_revision_relationships()`	List relationships for a revision.
`list_revision_relationship_types()`	List available relationship types.
`create_receiving_remote()`	Create a receiving remote connection.
`create_sending_remote()`	Create a sending remote connection.
`get_receiving_remote()`	Retrieve a receiving remote by ID.
`get_sending_remote()`	Retrieve a sending remote by ID.
`list_receiving_remotes()`	List receiving remote connections.
`list_sending_remotes()`	List sending remote connections.
`update_receiving_remote()`	Update a receiving remote connection.
`update_sending_remote()`	Update a sending remote connection.

Upload

create_resource

V3Client.create_resource(
    path,
    resource_type,
    *,
    description=None,
    version_name=None,
    external_identifier=None,
    display_name=None,
) -> ResourceDto

Upload a local file and register it as a new resource. The resource_type determines how the resource is classified. V3Client handles file tokenisation and storage automatically — pass a plain filesystem path.

Required parameters

Name	Type	Description
`path`	`PathLike`	Filesystem path to the file to upload.
`resource_type`	`ResourceTypeDto`	Classification of the resource (e.g. `ResourceTypeDto.MODEL`).

Optional parameters

Name	Type	Default	Description
`description`	`str \| None`	`None`	Text describing the resource's purpose or contents.
`version_name`	`str \| None`	`None`	User-defined version label (e.g. `"v2.1.0"`).
`external_identifier`	`str \| None`	`None`	Identifier from an external system for cross-referencing.
`display_name`	`str \| None`	`None`	Human-readable name for the resource.

Returns: ResourceDto — the newly created resource.

Basic
Full example

from istari_digital_client.v3.models.resource_type_dto import ResourceTypeDto

resource = client.create_resource(
    path="model.onnx",
    resource_type=ResourceTypeDto.MODEL,
)
print(resource.id)

from istari_digital_client.v3.models.resource_type_dto import ResourceTypeDto

resource = client.create_resource(
    path="wing-stress-v3.stl",
    resource_type=ResourceTypeDto.MODEL,
    display_name="Wing Stress Analysis v3",
    description="FEA results for revised wing geometry",
    version_name="v3.0.0",
    external_identifier="WS-2024-003",
)
# Fetch and verify the uploaded content
data = client.get_content(resource)
print(f"Uploaded {len(data)} bytes as resource {resource.id}")

create_resource_revision

V3Client.create_resource_revision(
    resource_id,
    path,
    *,
    description=None,
    version_name=None,
    external_identifier=None,
    display_name=None,
) -> ResourceRevisionDto

Upload a new file and add it as a revision to an existing resource. Each call appends a new revision to the resource's history; previous revisions remain accessible.

Required parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the resource to add a revision to.
`path`	`PathLike`	Filesystem path to the new file.

Optional parameters

Name	Type	Default	Description
`description`	`str \| None`	`None`	Description for this revision.
`version_name`	`str \| None`	`None`	Version label for this revision.
`external_identifier`	`str \| None`	`None`	External system identifier.
`display_name`	`str \| None`	`None`	Human-readable name for this revision.

Returns: ResourceRevisionDto — the newly created revision.

Basic
Full example

revision = client.create_resource_revision( resource_id="550e8400-e29b-41d4-a716-446655440000", path="model-v2.onnx", ) print(revision.id)

revision = client.create_resource_revision( resource_id="550e8400-e29b-41d4-a716-446655440000", path="model-v2.onnx", version_name="v2.0.0", description="Retrained with extended dataset", ) # Confirm it appears in the revision list page = client.list_resource_revisions( resource_id="550e8400-e29b-41d4-a716-446655440000", version_name=["v2.0.0"], ) assert page.items[0].id == revision.id

create_comment

V3Client.create_comment(
    resource_id,
    path,
    parent_comment_id=None,
) -> CommentDto

Upload a local file and attach it as a comment on a resource. Supports threaded replies via parent_comment_id.

Required parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the resource to comment on.
`path`	`PathLike`	Filesystem path to the comment file.

Optional parameters

Name	Type	Default	Description
`parent_comment_id`	`str \| None`	`None`	ID of the parent comment to reply to.

Returns: CommentDto — the newly created comment.

Basic
Full example

comment = client.create_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", path="review-notes.pdf", ) print(comment.id)

# Top-level comment, then a threaded reply comment = client.create_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", path="initial-review.pdf", ) reply = client.create_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", path="follow-up.pdf", parent_comment_id=comment.id, ) print(reply.parent_comment_id == comment.id)

update_comment

V3Client.update_comment(
    resource_id,
    comment_id,
    path,
) -> CommentDto

Replace an existing comment's content by uploading a new file. The previous file is retained in history.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the parent resource.
`comment_id`	`str`	Unique identifier of the comment to update.
`path`	`PathLike`	Filesystem path to the replacement comment file.

Returns: CommentDto — the updated comment.

Basic
Full example

updated = client.update_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", comment_id="aabb1234-...", path="corrected-review.pdf", )

page = client.list_comments(resource_id="550e8400-e29b-41d4-a716-446655440000")
first_comment = page.items[0]
updated = client.update_comment(
    resource_id="550e8400-e29b-41d4-a716-446655440000",
    comment_id=first_comment.id,
    path="revised-notes.pdf",
)
data = client.get_content(updated)
print(f"Updated comment content: {len(data)} bytes")

Retrieve

get_content

V3Client.get_content(
    resource,
) -> bytes

Fetch and return the raw file content bytes for a resource, resource revision, or comment. The object must have a content_token attribute set.

tip

Pass the object returned by get_resource(), get_resource_revision(), or get_comment() directly — no need to extract the token manually.

Parameters

Name	Type	Description
`resource`	`ResourceDto \| ResourceRevisionDto \| CommentDto`	Object whose content to download. Must have a `content_token`.

Returns: bytes — raw file content.

Basic
Full example

resource = client.get_resource("550e8400-e29b-41d4-a716-446655440000") data = client.get_content(resource) with open("downloaded.onnx", "wb") as f: f.write(data)

page = client.list_resource_revisions(
    resource_id="550e8400-e29b-41d4-a716-446655440000",
    version_name=["v1.0.0"],
)
revision = client.get_resource_revision(
    resource_id="550e8400-e29b-41d4-a716-446655440000",
    revision_id=page.items[0].id,
)
data = client.get_content(revision)
print(f"Downloaded {len(data)} bytes for revision {revision.id}")

get_resource

V3Client.get_resource(
    resource_id,
) -> ResourceDto

Retrieve a resource by its unique identifier.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the resource to retrieve.

Returns: ResourceDto — the resource.

Basic
Full example

resource = client.get_resource("550e8400-e29b-41d4-a716-446655440000") print(resource.resource_type)

resource = client.get_resource("550e8400-e29b-41d4-a716-446655440000")
data = client.get_content(resource)
print(f"Resource {resource.id} ({resource.resource_type}): {len(data)} bytes")

get_resource_revision

V3Client.get_resource_revision(
    resource_id,
    revision_id,
) -> ResourceRevisionDto

Retrieve a specific revision of a resource.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the parent resource.
`revision_id`	`str`	Unique identifier of the revision to retrieve.

Returns: ResourceRevisionDto — the revision.

Basic
Full example

revision = client.get_resource_revision( resource_id="550e8400-e29b-41d4-a716-446655440000", revision_id="aabb1234-...", ) print(revision.version_name)

page = client.list_resource_revisions( resource_id="550e8400-e29b-41d4-a716-446655440000", version_name=["v1.0.0"], ) revision = client.get_resource_revision( resource_id="550e8400-e29b-41d4-a716-446655440000", revision_id=page.items[0].id, ) data = client.get_content(revision)

get_comment

V3Client.get_comment(
    resource_id,
    comment_id,
) -> CommentDto

Retrieve a comment by its ID.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the parent resource.
`comment_id`	`str`	Unique identifier of the comment to retrieve.

Returns: CommentDto — the comment.

Basic
Full example

comment = client.get_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", comment_id="aabb1234-...", ) data = client.get_content(comment)

comment = client.get_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", comment_id="aabb1234-...", ) content = client.get_content(comment) with open("comment-attachment.pdf", "wb") as f: f.write(content)

List

list_resources

V3Client.list_resources(
    *,
    cursor=None,
    size=None,
    include_total=None,
    resource_id=None,
    created_by_id=None,
    name=None,
    type_name=None,
    description=None,
    version_name=None,
    external_identifier=None,
    display_name=None,
    mime_type=None,
    archive_status=None,
) -> CursorPageResourceDto

List resources with optional filters. Results are cursor-paginated; pass the cursor field from the previous page to fetch the next.

tip

Most filter parameters accept a list and support a ! prefix for negation (e.g. type_name=["!artifact"] excludes artifacts).

Optional parameters

Name	Type	Default	Description
`cursor`	`str \| None`	`None`	Pagination cursor from the previous response.
`size`	`int \| None`	`None`	Page size (0–100, default 10).
`include_total`	`bool \| None`	`None`	Include total item count in the response.
`resource_id`	`list[str] \| None`	`None`	Filter by resource ID(s). Supports `!` negation.
`created_by_id`	`list[str] \| None`	`None`	Filter by creator user ID(s).
`name`	`list[str] \| None`	`None`	Filter by filename (exact match).
`type_name`	`list[str] \| None`	`None`	Filter by type: `model`, `artifact`, `file`.
`description`	`list[str] \| None`	`None`	Filter by description (exact match).
`version_name`	`list[str] \| None`	`None`	Filter by version label.
`external_identifier`	`list[str] \| None`	`None`	Filter by external identifier.
`display_name`	`list[str] \| None`	`None`	Filter by display name (exact match).
`mime_type`	`list[str] \| None`	`None`	Filter by MIME type (e.g. `model/stl`).
`archive_status`	`ArchiveStatus \| None`	`None`	`active` (default), `archived`, or `all`.

Returns: CursorPageResourceDto — paginated list of resources.

Basic
Full example

page = client.list_resources(type_name=["model"], size=20) for r in page.items: print(r.id, r.resource_type)

# Paginate through all non-archived models cursor = None while True: page = client.list_resources( type_name=["model"], size=50, cursor=cursor, ) for r in page.items: print(r.id) cursor = page.cursor if not cursor: break

list_resource_revisions

V3Client.list_resource_revisions(
    resource_id,
    *,
    cursor=None,
    size=None,
    include_total=None,
    file_revision_id=None,
    created_by_id=None,
    name=None,
    description=None,
    version_name=None,
    external_identifier=None,
    display_name=None,
    mime_type=None,
) -> CursorPageResourceRevisionDto

List revisions for a resource. Results are cursor-paginated.

Required parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the resource whose revisions to list.

Optional parameters

Name	Type	Default	Description
`cursor`	`str \| None`	`None`	Pagination cursor.
`size`	`int \| None`	`None`	Page size (0–100).
`include_total`	`bool \| None`	`None`	Include total count.
`file_revision_id`	`list[str] \| None`	`None`	Filter by revision ID(s).
`created_by_id`	`list[str] \| None`	`None`	Filter by creator user ID(s).
`name`	`list[str] \| None`	`None`	Filter by filename.
`description`	`list[str] \| None`	`None`	Filter by description.
`version_name`	`list[str] \| None`	`None`	Filter by version label.
`external_identifier`	`list[str] \| None`	`None`	Filter by external identifier.
`display_name`	`list[str] \| None`	`None`	Filter by display name.
`mime_type`	`list[str] \| None`	`None`	Filter by MIME type.

Returns: CursorPageResourceRevisionDto — paginated list of revisions.

Basic
Full example

page = client.list_resource_revisions( resource_id="550e8400-e29b-41d4-a716-446655440000", size=10, ) for rev in page.items: print(rev.id, rev.version_name)

page = client.list_resource_revisions(
    resource_id="550e8400-e29b-41d4-a716-446655440000",
    version_name=["v2.0.0"],
    include_total=True,
)
print(f"Found {page.total} revision(s) matching v2.0.0")
if page.items:
    rev = client.get_resource_revision(
        resource_id="550e8400-e29b-41d4-a716-446655440000",
        revision_id=page.items[0].id,
    )
    data = client.get_content(rev)

list_comments

V3Client.list_comments(
    resource_id,
    *,
    cursor=None,
    size=None,
    include_total=None,
    comment_id=None,
    created_by_id=None,
) -> CursorPageCommentDto

List comments on a resource. Results are cursor-paginated.

Required parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the resource whose comments to list.

Optional parameters

Name	Type	Default	Description
`cursor`	`str \| None`	`None`	Pagination cursor.
`size`	`int \| None`	`None`	Page size (0–100).
`include_total`	`bool \| None`	`None`	Include total count.
`comment_id`	`list[str] \| None`	`None`	Filter by comment ID(s). Supports `!` negation.
`created_by_id`	`list[str] \| None`	`None`	Filter by creator user ID(s).

Returns: CursorPageCommentDto — paginated list of comments.

Basic
Full example

page = client.list_comments( resource_id="550e8400-e29b-41d4-a716-446655440000", ) for c in page.items: print(c.id)

page = client.list_comments(
    resource_id="550e8400-e29b-41d4-a716-446655440000",
    include_total=True,
    size=50,
)
print(f"{page.total} comments total")
for c in page.items:
    data = client.get_content(c)
    print(f" comment {c.id}: {len(data)} bytes")

Archive & Restore

archive_resource

V3Client.archive_resource(
    resource_id,
) -> None

Archive a resource. Archived resources are excluded from default list queries unless archive_status="archived" or archive_status="all" is passed.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the resource to archive.

Returns: None

Basic
Full example

client.archive_resource("550e8400-e29b-41d4-a716-446655440000")

resource = client.get_resource("550e8400-e29b-41d4-a716-446655440000") client.archive_resource(resource.id) restored = client.restore_resource(resource.id) print(restored.id)

restore_resource

V3Client.restore_resource(
    resource_id,
) -> ResourceDto

Restore an archived resource, making it active again.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the resource to restore.

Returns: ResourceDto — the restored resource.

Basic
Full example

resource = client.restore_resource("550e8400-e29b-41d4-a716-446655440000") print(resource.id)

archived = client.list_resources(archive_status="archived", type_name=["model"])
for r in archived.items:
    client.restore_resource(r.id)
    print(f"Restored {r.id}")

archive_comment

V3Client.archive_comment(
    resource_id,
    comment_id,
) -> CommentDto

Archive a comment on a resource.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the parent resource.
`comment_id`	`str`	Unique identifier of the comment to archive.

Returns: CommentDto — the archived comment.

Basic

client.archive_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", comment_id="aabb1234-...", )

</TabItem>
<TabItem value="full" label="Full example">

```python
page = client.list_comments(resource_id="550e8400-e29b-41d4-a716-446655440000") for c in page.items: client.archive_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", comment_id=c.id, )

restore_comment

V3Client.restore_comment(
    resource_id,
    comment_id,
) -> CommentDto

Restore an archived comment.

Parameters

Name	Type	Description
`resource_id`	`str`	Unique identifier of the parent resource.
`comment_id`	`str`	Unique identifier of the comment to restore.

Returns: CommentDto — the restored comment.

Basic
Full example

comment = client.restore_comment( resource_id="550e8400-e29b-41d4-a716-446655440000", comment_id="aabb1234-...", )

comment = client.restore_comment(
    resource_id="550e8400-e29b-41d4-a716-446655440000",
    comment_id="aabb1234-...",
)
data = client.get_content(comment)
print(f"Restored comment: {len(data)} bytes")

Revision Relationships

create_revision_relationship

V3Client.create_revision_relationship(
    new_revision_relationship_dto,
) -> RevisionRelationshipDto

Create a typed relationship between two revisions. Relationships record provenance, dependency, or lineage links between resource versions.

Parameters

Name	Type	Description
`new_revision_relationship_dto`	`NewRevisionRelationshipDto`	DTO with the left revision, right revision, and relationship type IDs.

Returns: RevisionRelationshipDto — the created relationship.

Basic
Full example

from istari_digital_client.v3.models.new_revision_relationship_dto import NewRevisionRelationshipDto

rel = client.create_revision_relationship(
    new_revision_relationship_dto=NewRevisionRelationshipDto(
        left_revision_id="rev-aaa",
        right_revision_id="rev-bbb",
        relationship_type_id="type-ccc",
    )
)
print(rel.id)

from istari_digital_client.v3.models.new_revision_relationship_dto import NewRevisionRelationshipDto

# Look up an available relationship type
types = client.list_revision_relationship_types()
rel_type_id = types.items[0].id

rel = client.create_revision_relationship(
    new_revision_relationship_dto=NewRevisionRelationshipDto(
        left_revision_id="rev-aaa",
        right_revision_id="rev-bbb",
        relationship_type_id=rel_type_id,
    )
)
rels = client.list_revision_relationships(revision_id="rev-aaa")
print(f"{len(rels.items)} relationship(s) for rev-aaa")

list_revision_relationships

V3Client.list_revision_relationships(
    revision_id,
    *,
    cursor=None,
    size=None,
    include_total=None,
    left_revision_id=None,
    right_revision_id=None,
    owning_entity_type=None,
) -> CursorPageRevisionRelationshipDto

List relationships that the caller has access to for a given revision.

Required parameters

Name	Type	Description
`revision_id`	`str`	The revision ID to list relationships for.

Optional parameters

Name	Type	Default	Description
`cursor`	`str \| None`	`None`	Pagination cursor.
`size`	`int \| None`	`None`	Page size (0–100).
`include_total`	`bool \| None`	`None`	Include total count.
`left_revision_id`	`list[str] \| None`	`None`	Filter by left revision ID(s). Use `!uuid` to negate.
`right_revision_id`	`list[str] \| None`	`None`	Filter by right revision ID(s).
`owning_entity_type`	`list[str] \| None`	`None`	Filter by entity type (e.g. `model`, `artifact`, `file`).

Returns: CursorPageRevisionRelationshipDto — paginated list of relationships.

Basic
Full example

page = client.list_revision_relationships(revision_id="rev-aaa")
for r in page.items:
    print(r.left_revision_id, "->", r.right_revision_id)

page = client.list_revision_relationships(
    revision_id="rev-aaa",
    owning_entity_type=["model"],
    include_total=True,
)
print(f"{page.total} relationship(s) for this revision")

list_revision_relationship_types

V3Client.list_revision_relationship_types(
    *,
    cursor=None,
    size=None,
    include_total=None,
) -> CursorPageRevisionRelationshipTypeDto

List all available revision relationship types registered in the system.

Optional parameters

Name	Type	Default	Description
`cursor`	`str \| None`	`None`	Pagination cursor.
`size`	`int \| None`	`None`	Page size (0–100).
`include_total`	`bool \| None`	`None`	Include total count.

Returns: CursorPageRevisionRelationshipTypeDto — paginated list of relationship types.

Basic
Full example

types = client.list_revision_relationship_types() for t in types.items: print(t.id, t.name)

types = client.list_revision_relationship_types(include_total=True)
print(f"{types.total} relationship types available")
type_id = types.items[0].id

Remote Connections

create_receiving_remote

V3Client.create_receiving_remote(
    receiving_connection_create_dto,
) -> ReceivingConnectionDto

Create a receiving remote connection to accept resources pushed from another registry.

Parameters

Name	Type	Description
`receiving_connection_create_dto`	`ReceivingConnectionCreateDto`	DTO describing the new receiving connection.

Returns: ReceivingConnectionDto — the created receiving remote.

Basic
Full example

from istari_digital_client.v3.models.receiving_connection_create_dto import ReceivingConnectionCreateDto

remote = client.create_receiving_remote(
    receiving_connection_create_dto=ReceivingConnectionCreateDto(name="upstream-registry"),
)
print(remote.id)

from istari_digital_client.v3.models.receiving_connection_create_dto import ReceivingConnectionCreateDto

remote = client.create_receiving_remote(
    receiving_connection_create_dto=ReceivingConnectionCreateDto(name="partner-registry"),
)
retrieved = client.get_receiving_remote(remote.id)
print(retrieved.name)

create_sending_remote

V3Client.create_sending_remote(
    sending_connection_create_dto,
) -> SendingConnectionDto

Create a sending remote connection to push resources to another registry.

Parameters

Name	Type	Description
`sending_connection_create_dto`	`SendingConnectionCreateDto`	DTO describing the new sending connection.

Returns: SendingConnectionDto — the created sending remote.

Basic
Full example

from istari_digital_client.v3.models.sending_connection_create_dto import SendingConnectionCreateDto

remote = client.create_sending_remote(
    sending_connection_create_dto=SendingConnectionCreateDto(name="downstream-registry"),
)
print(remote.id)

from istari_digital_client.v3.models.sending_connection_create_dto import SendingConnectionCreateDto

remote = client.create_sending_remote(
    sending_connection_create_dto=SendingConnectionCreateDto(name="partner-registry"),
)
remotes = client.list_sending_remotes()
print(f"{len(remotes.items)} sending remote(s) configured")

get_receiving_remote

V3Client.get_receiving_remote(
    remote_id,
) -> ReceivingConnectionDto

Retrieve a receiving remote connection by ID.

Parameters

Name	Type	Description
`remote_id`	`str`	The ID of the receiving remote to get.

Returns: ReceivingConnectionDto — the receiving remote.

Basic
Full example

remote = client.get_receiving_remote("remote-id-here")
print(remote.name)

from istari_digital_client.v3.models.update_receiving_connection_dto import UpdateReceivingConnectionDto

remote = client.get_receiving_remote("remote-id-here")
updated = client.update_receiving_remote(
    remote_id=remote.id,
    update_receiving_connection_dto=UpdateReceivingConnectionDto(name="renamed"),
)

get_sending_remote

V3Client.get_sending_remote(
    remote_id,
) -> SendingConnectionDto

Retrieve a sending remote connection by ID.

Parameters

Name	Type	Description
`remote_id`	`str`	The ID of the sending remote to get.

Returns: SendingConnectionDto — the sending remote.

Basic
Full example

remote = client.get_sending_remote("remote-id-here")
print(remote.name)

from istari_digital_client.v3.models.update_sending_connection_dto import UpdateSendingConnectionDto

remote = client.get_sending_remote("remote-id-here")
updated = client.update_sending_remote(
    remote_id=remote.id,
    update_sending_connection_dto=UpdateSendingConnectionDto(name="renamed"),
)

list_receiving_remotes

V3Client.list_receiving_remotes(
    *,
    cursor=None,
    size=None,
    include_total=None,
    show_archived=None,
) -> CursorPageReceivingConnectionDto

List receiving remote connections.

Optional parameters

Name	Type	Default	Description
`cursor`	`str \| None`	`None`	Pagination cursor.
`size`	`int \| None`	`None`	Page size (0–100).
`include_total`	`bool \| None`	`None`	Include total count.
`show_archived`	`bool \| None`	`None`	Include archived remotes when `True`.

Returns: CursorPageReceivingConnectionDto — paginated list.

Basic
Full example

page = client.list_receiving_remotes() for r in page.items: print(r.id, r.name)

page = client.list_receiving_remotes(include_total=True, show_archived=True)
print(f"{page.total} receiving remote(s) (including archived)")

list_sending_remotes

V3Client.list_sending_remotes(
    *,
    cursor=None,
    size=None,
    include_total=None,
    show_archived=None,
) -> CursorPageSendingConnectionDto

List sending remote connections.

Optional parameters

Name	Type	Default	Description
`cursor`	`str \| None`	`None`	Pagination cursor.
`size`	`int \| None`	`None`	Page size (0–100).
`include_total`	`bool \| None`	`None`	Include total count.
`show_archived`	`bool \| None`	`None`	Include archived remotes when `True`.

Returns: CursorPageSendingConnectionDto — paginated list.

Basic
Full example

page = client.list_sending_remotes() for r in page.items: print(r.id, r.name)

page = client.list_sending_remotes(include_total=True)
print(f"{page.total} sending remote(s) configured")

update_receiving_remote

V3Client.update_receiving_remote(
    remote_id,
    update_receiving_connection_dto,
) -> ReceivingConnectionDto

Update a receiving remote connection.

Parameters

Name	Type	Description
`remote_id`	`str`	The ID of the receiving remote to update.
`update_receiving_connection_dto`	`UpdateReceivingConnectionDto`	DTO containing the fields to update.

Returns: ReceivingConnectionDto — the updated receiving remote.

Basic
Full example

from istari_digital_client.v3.models.update_receiving_connection_dto import UpdateReceivingConnectionDto

updated = client.update_receiving_remote(
    remote_id="remote-id-here",
    update_receiving_connection_dto=UpdateReceivingConnectionDto(name="new-name"),
)

from istari_digital_client.v3.models.update_receiving_connection_dto import UpdateReceivingConnectionDto

remote = client.get_receiving_remote("remote-id-here")
updated = client.update_receiving_remote(
    remote_id=remote.id,
    update_receiving_connection_dto=UpdateReceivingConnectionDto(name="renamed-remote"),
)
print(updated.name)

update_sending_remote

V3Client.update_sending_remote(
    remote_id,
    update_sending_connection_dto,
) -> SendingConnectionDto

Update a sending remote connection.

Parameters

Name	Type	Description
`remote_id`	`str`	The ID of the sending remote to update.
`update_sending_connection_dto`	`UpdateSendingConnectionDto`	DTO containing the fields to update.

Returns: SendingConnectionDto — the updated sending remote.

Basic
Full example

from istari_digital_client.v3.models.update_sending_connection_dto import UpdateSendingConnectionDto

updated = client.update_sending_remote(
    remote_id="remote-id-here",
    update_sending_connection_dto=UpdateSendingConnectionDto(name="new-name"),
)

from istari_digital_client.v3.models.update_sending_connection_dto import UpdateSendingConnectionDto

remote = client.get_sending_remote("remote-id-here")
updated = client.update_sending_remote(
    remote_id=remote.id,
    update_sending_connection_dto=UpdateSendingConnectionDto(name="renamed-remote"),
)
print(updated.name)

Quick-reference table​

Upload​

create_resource​

create_resource_revision​

create_comment​

update_comment​

Retrieve​

get_content​

get_resource​

get_resource_revision​

get_comment​

List​

list_resources​

list_resource_revisions​

list_comments​

Archive & Restore​

archive_resource​

restore_resource​

archive_comment​

restore_comment​

Revision Relationships​

create_revision_relationship​

list_revision_relationships​

list_revision_relationship_types​

Remote Connections​

create_receiving_remote​

create_sending_remote​

get_receiving_remote​

get_sending_remote​

list_receiving_remotes​

list_sending_remotes​

update_receiving_remote​

update_sending_remote​

Quick-reference table

Upload

create_resource

create_resource_revision

create_comment

update_comment

Retrieve

get_content

get_resource

get_resource_revision

get_comment

List

list_resources

list_resource_revisions

list_comments

Archive & Restore

archive_resource

restore_resource

archive_comment

restore_comment

Revision Relationships

create_revision_relationship

list_revision_relationships

list_revision_relationship_types

Remote Connections

create_receiving_remote

create_sending_remote

get_receiving_remote

get_sending_remote

list_receiving_remotes

list_sending_remotes

update_receiving_remote

update_sending_remote