Skip to content

Latest commit

 

History

History
100 lines (57 loc) · 3.21 KB

CollectionApi.md

File metadata and controls

100 lines (57 loc) · 3.21 KB

\CollectionApi

All URIs are relative to http://localhost

Method HTTP request Description
add_to_collection POST /Collections/{collectionId}/Items Adds items to a collection.
create_collection POST /Collections Creates a new collection.
remove_from_collection DELETE /Collections/{collectionId}/Items Removes items from a collection.

add_to_collection

add_to_collection(collection_id, ids) Adds items to a collection.

Parameters

Name Type Description Required Notes
collection_id uuid::Uuid The collection id. [required]
ids Vecuuid::Uuid Item ids, comma delimited. [required]

Return type

(empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

create_collection

crate::models::CollectionCreationResult create_collection(name, ids, parent_id, is_locked) Creates a new collection.

Parameters

Name Type Description Required Notes
name Option<String> The name of the collection.
ids Option<Vec> Item Ids to add to the collection.
parent_id Option<uuid::Uuid> Optional. Create the collection within a specific folder.
is_locked Option<bool> Whether or not to lock the new collection. [default to false]

Return type

crate::models::CollectionCreationResult

Authorization

CustomAuthentication

HTTP request headers

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

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

remove_from_collection

remove_from_collection(collection_id, ids) Removes items from a collection.

Parameters

Name Type Description Required Notes
collection_id uuid::Uuid The collection id. [required]
ids Vecuuid::Uuid Item ids, comma delimited. [required]

Return type

(empty response body)

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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