Class RepositoryApiV1Client

Inheritance

object

RepositoryApiV1Client

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Algenta.Colectica.Repository.Client

Assembly: Algenta.Colectica.Repository.Client.dll

Syntax

public class RepositoryApiV1Client

Constructors

RepositoryApiV1Client(string, HttpClient)

Declaration

public RepositoryApiV1Client(string baseUrl, HttpClient httpClient)

Parameters

Type	Name	Description
string	baseUrl
HttpClient	httpClient

Properties

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
string

JsonSerializerSettings

Declaration

public JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
bool

colecticaClient

Declaration

public RestRepositoryClient colecticaClient { get; set; }

Property Value

Type	Description
RestRepositoryClient

Methods

Agency_Create(CreateAgencyRequest)

Marks the repository as authoritative for the specified agency.

Declaration

public virtual FileResponse Agency_Create(CreateAgencyRequest request)

Parameters

Type	Name	Description
CreateAgencyRequest	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Agency_CreateAsync(CreateAgencyRequest)

Marks the repository as authoritative for the specified agency.

Declaration

public virtual Task<FileResponse> Agency_CreateAsync(CreateAgencyRequest request)

Parameters

Type	Name	Description
CreateAgencyRequest	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Agency_CreateAsync(CreateAgencyRequest, CancellationToken)

Marks the repository as authoritative for the specified agency.

Declaration

public virtual Task<FileResponse> Agency_CreateAsync(CreateAgencyRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateAgencyRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Agency_Delete(string)

Marks the repository as no longer authoritative for the specified agency.

Declaration

public virtual FileResponse Agency_Delete(string agency)

Parameters

Type	Name	Description
string	agency

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Agency_DeleteAsync(string)

Marks the repository as no longer authoritative for the specified agency.

Declaration

public virtual Task<FileResponse> Agency_DeleteAsync(string agency)

Parameters

Type	Name	Description
string	agency

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Agency_DeleteAsync(string, CancellationToken)

Marks the repository as no longer authoritative for the specified agency.

Declaration

public virtual Task<FileResponse> Agency_DeleteAsync(string agency, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_CreateComments(string, Guid, long, CreateCommentRequest)

Adds a comment to the specified item.

Declaration

public virtual FileResponse Comment_CreateComments(string agency, Guid id, long version, CreateCommentRequest request)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CreateCommentRequest	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_CreateCommentsAsync(string, Guid, long, CreateCommentRequest)

Adds a comment to the specified item.

Declaration

public virtual Task<FileResponse> Comment_CreateCommentsAsync(string agency, Guid id, long version, CreateCommentRequest request)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CreateCommentRequest	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_CreateCommentsAsync(string, Guid, long, CreateCommentRequest, CancellationToken)

Adds a comment to the specified item.

Declaration

public virtual Task<FileResponse> Comment_CreateCommentsAsync(string agency, Guid id, long version, CreateCommentRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CreateCommentRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetComments(string, Guid)

Gets the comments for the specified item.

Declaration

public virtual Collection<UserComment> Comment_GetComments(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Collection<UserComment>	All comments applicable to the specified item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsAsync(string, Guid)

Gets the comments for the specified item.

Declaration

public virtual Task<Collection<UserComment>> Comment_GetCommentsAsync(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Task<Collection<UserComment>>	All comments applicable to the specified item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsAsync(string, Guid, CancellationToken)

Gets the comments for the specified item.

Declaration

public virtual Task<Collection<UserComment>> Comment_GetCommentsAsync(string agency, Guid id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<UserComment>>	All comments applicable to the specified item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsList(GetCommentsRequest)

Gets multiple comments from the repository.

Declaration

public virtual Collection<UserComment> Comment_GetCommentsList(GetCommentsRequest request)

Parameters

Type	Name	Description
GetCommentsRequest	request

Returns

Type	Description
Collection<UserComment>	A collection of UserComment items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsListAsync(GetCommentsRequest)

Gets multiple comments from the repository.

Declaration

public virtual Task<Collection<UserComment>> Comment_GetCommentsListAsync(GetCommentsRequest request)

Parameters

Type	Name	Description
GetCommentsRequest	request

Returns

Type	Description
Task<Collection<UserComment>>	A collection of UserComment items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsListAsync(GetCommentsRequest, CancellationToken)

Gets multiple comments from the repository.

Declaration

public virtual Task<Collection<UserComment>> Comment_GetCommentsListAsync(GetCommentsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetCommentsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<UserComment>>	A collection of UserComment items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Ddi(string, string)

Returns the item serialized in DDI XML as a DDI Fragment

Declaration

public virtual FileResponse Ddi_Ddi(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
FileResponse	DDI Fragment

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Ddi2(string, string, long?)

Returns the item serialized in DDI XML as a DDI Fragment

Declaration

public virtual FileResponse Ddi_Ddi2(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
FileResponse	DDI Fragment

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Ddi2Async(string, string, long?)

Returns the item serialized in DDI XML as a DDI Fragment

Declaration

public virtual Task<FileResponse> Ddi_Ddi2Async(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
Task<FileResponse>	DDI Fragment

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Ddi2Async(string, string, long?, CancellationToken)

Returns the item serialized in DDI XML as a DDI Fragment

Declaration

public virtual Task<FileResponse> Ddi_Ddi2Async(string agency, string identifier, long? version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	DDI Fragment

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiAsync(string, string)

Returns the item serialized in DDI XML as a DDI Fragment

Declaration

public virtual Task<FileResponse> Ddi_DdiAsync(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
Task<FileResponse>	DDI Fragment

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiAsync(string, string, CancellationToken)

Returns the item serialized in DDI XML as a DDI Fragment

Declaration

public virtual Task<FileResponse> Ddi_DdiAsync(string agency, string identifier, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	DDI Fragment

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiSet(string, string)

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Declaration

public virtual FileResponse Ddi_DdiSet(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
FileResponse	DDI FragmentInstance

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiSet2(string, string, long?)

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Declaration

public virtual FileResponse Ddi_DdiSet2(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
FileResponse	DDI FragmentInstance

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiSet2Async(string, string, long?)

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Declaration

public virtual Task<FileResponse> Ddi_DdiSet2Async(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
Task<FileResponse>	DDI FragmentInstance

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiSet2Async(string, string, long?, CancellationToken)

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Declaration

public virtual Task<FileResponse> Ddi_DdiSet2Async(string agency, string identifier, long? version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	DDI FragmentInstance

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiSetAsync(string, string)

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Declaration

public virtual Task<FileResponse> Ddi_DdiSetAsync(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
Task<FileResponse>	DDI FragmentInstance

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_DdiSetAsync(string, string, CancellationToken)

Returns the item and set of all children items serialized in DDI XML as a DDI FragmentInstance

Declaration

public virtual Task<FileResponse> Ddi_DdiSetAsync(string agency, string identifier, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	DDI FragmentInstance

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_FilteredJsonSet(FilteredSetRequest)

Returns the item and set of all children items serialized in nested JSON, and excludes specified item types

Declaration

public virtual FileResponse Ddi_FilteredJsonSet(FilteredSetRequest filteredRequest)

Parameters

Type	Name	Description
FilteredSetRequest	filteredRequest

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_FilteredJsonSetAsync(FilteredSetRequest)

Returns the item and set of all children items serialized in nested JSON, and excludes specified item types

Declaration

public virtual Task<FileResponse> Ddi_FilteredJsonSetAsync(FilteredSetRequest filteredRequest)

Parameters

Type	Name	Description
FilteredSetRequest	filteredRequest

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_FilteredJsonSetAsync(FilteredSetRequest, CancellationToken)

Returns the item and set of all children items serialized in nested JSON, and excludes specified item types

Declaration

public virtual Task<FileResponse> Ddi_FilteredJsonSetAsync(FilteredSetRequest filteredRequest, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FilteredSetRequest	filteredRequest
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Json(string, string)

Returns the item serialized in JSON

Declaration

public virtual FileResponse Ddi_Json(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
FileResponse	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Json2(string, string, long?)

Returns the item serialized in JSON

Declaration

public virtual FileResponse Ddi_Json2(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
FileResponse	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Json2Async(string, string, long?)

Returns the item serialized in JSON

Declaration

public virtual Task<FileResponse> Ddi_Json2Async(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_Json2Async(string, string, long?, CancellationToken)

Returns the item serialized in JSON

Declaration

public virtual Task<FileResponse> Ddi_Json2Async(string agency, string identifier, long? version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonAsync(string, string)

Returns the item serialized in JSON

Declaration

public virtual Task<FileResponse> Ddi_JsonAsync(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonAsync(string, string, CancellationToken)

Returns the item serialized in JSON

Declaration

public virtual Task<FileResponse> Ddi_JsonAsync(string agency, string identifier, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonSet(string, string)

Returns the item and set of all children items serialized in nested JSON

Declaration

public virtual FileResponse Ddi_JsonSet(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
FileResponse	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonSet2(string, string, long?)

Returns the item and set of all children items serialized in nested JSON

Declaration

public virtual FileResponse Ddi_JsonSet2(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
FileResponse	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonSet2Async(string, string, long?)

Returns the item and set of all children items serialized in nested JSON

Declaration

public virtual Task<FileResponse> Ddi_JsonSet2Async(string agency, string identifier, long? version)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonSet2Async(string, string, long?, CancellationToken)

Returns the item and set of all children items serialized in nested JSON

Declaration

public virtual Task<FileResponse> Ddi_JsonSet2Async(string agency, string identifier, long? version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
long?	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonSetAsync(string, string)

Returns the item and set of all children items serialized in nested JSON

Declaration

public virtual Task<FileResponse> Ddi_JsonSetAsync(string agency, string identifier)

Parameters

Type	Name	Description
string	agency
string	identifier

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Ddi_JsonSetAsync(string, string, CancellationToken)

Returns the item and set of all children items serialized in nested JSON

Declaration

public virtual Task<FileResponse> Ddi_JsonSetAsync(string agency, string identifier, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
string	identifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	JSON

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Event_LogEvent(LoggedEvent)

Store information about an event.

Declaration

public virtual FileResponse Event_LogEvent(LoggedEvent request)

Parameters

Type	Name	Description
LoggedEvent	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Event_LogEventAsync(LoggedEvent)

Store information about an event.

Declaration

public virtual Task<FileResponse> Event_LogEventAsync(LoggedEvent request)

Parameters

Type	Name	Description
LoggedEvent	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Event_LogEventAsync(LoggedEvent, CancellationToken)

Store information about an event.

Declaration

public virtual Task<FileResponse> Event_LogEventAsync(LoggedEvent request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
LoggedEvent	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

FileUploadAsync(Stream, string, string)

Upload a file to the repository

Declaration

public Task<FileInformation> FileUploadAsync(Stream stream, string filename, string contentType)

Parameters

Type	Name	Description
Stream	stream	Stream of bytes containing the file
string	filename	original file name
string	contentType	file content type

Returns

Type	Description
Task<FileInformation>	file information

FileUploadAsync(Stream, string, string, CancellationToken)

Upload a file to the repository

Declaration

public Task<FileInformation> FileUploadAsync(Stream stream, string filename, string contentType, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Stream	stream	Stream of bytes containing the file
string	filename	original file name
string	contentType	file content type
CancellationToken	cancellationToken

Returns

Type	Description
Task<FileInformation>	file information

Item_Delete(DeleteRequest)

Delete items from the Repository

Declaration

public virtual DeleteResult Item_Delete(DeleteRequest request)

Parameters

Type	Name	Description
DeleteRequest	request

Returns

Type	Description
DeleteResult

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_DeleteAsync(DeleteRequest)

Delete items from the Repository

Declaration

public virtual Task<DeleteResult> Item_DeleteAsync(DeleteRequest request)

Parameters

Type	Name	Description
DeleteRequest	request

Returns

Type	Description
Task<DeleteResult>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_DeleteAsync(DeleteRequest, CancellationToken)

Delete items from the Repository

Declaration

public virtual Task<DeleteResult> Item_DeleteAsync(DeleteRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
DeleteRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<DeleteResult>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItem(string, Guid, long)

Gets an item from the repository.

Declaration

public virtual RepositoryItem Item_GetItem(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
RepositoryItem

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemAsync(string, Guid, long)

Gets an item from the repository.

Declaration

public virtual Task<RepositoryItem> Item_GetItemAsync(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Task<RepositoryItem>

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemAsync(string, Guid, long, CancellationToken)

Gets an item from the repository.

Declaration

public virtual Task<RepositoryItem> Item_GetItemAsync(string agency, Guid id, long version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryItem>

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItems(GetItemsRequest)

Gets multiple items from the repository.

Declaration

public virtual Collection<RepositoryItem> Item_GetItems(GetItemsRequest request)

Parameters

Type	Name	Description
GetItemsRequest	request

Returns

Type	Description
Collection<RepositoryItem>	A collection of IVersionable items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemsAsync(GetItemsRequest)

Gets multiple items from the repository.

Declaration

public virtual Task<Collection<RepositoryItem>> Item_GetItemsAsync(GetItemsRequest request)

Parameters

Type	Name	Description
GetItemsRequest	request

Returns

Type	Description
Task<Collection<RepositoryItem>>	A collection of IVersionable items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemsAsync(GetItemsRequest, CancellationToken)

Gets multiple items from the repository.

Declaration

public virtual Task<Collection<RepositoryItem>> Item_GetItemsAsync(GetItemsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetItemsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryItem>>	A collection of IVersionable items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetLatestItem(string, Guid)

Gets the latest version of an item from the repository.

Declaration

public virtual RepositoryItem Item_GetLatestItem(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
RepositoryItem	The deserialized, IVersionable item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetLatestItemAsync(string, Guid)

Gets the latest version of an item from the repository.

Declaration

public virtual Task<RepositoryItem> Item_GetLatestItemAsync(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Task<RepositoryItem>	The deserialized, IVersionable item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetLatestItemAsync(string, Guid, CancellationToken)

Gets the latest version of an item from the repository.

Declaration

public virtual Task<RepositoryItem> Item_GetLatestItemAsync(string agency, Guid id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryItem>	The deserialized, IVersionable item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetLatestItems(GetLatestItemsRequest)

Gets a list of the latest versions of undeserialized items from the repository.
To retrieve deserialized

Declaration

public virtual Collection<RepositoryItem> Item_GetLatestItems(GetLatestItemsRequest request)

Parameters

Type	Name	Description
GetLatestItemsRequest	request

Returns

Type	Description
Collection<RepositoryItem>	A list of repository items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetLatestItemsAsync(GetLatestItemsRequest)

Gets a list of the latest versions of undeserialized items from the repository.
To retrieve deserialized

Declaration

public virtual Task<Collection<RepositoryItem>> Item_GetLatestItemsAsync(GetLatestItemsRequest request)

Parameters

Type	Name	Description
GetLatestItemsRequest	request

Returns

Type	Description
Task<Collection<RepositoryItem>>	A list of repository items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetLatestItemsAsync(GetLatestItemsRequest, CancellationToken)

Gets a list of the latest versions of undeserialized items from the repository.
To retrieve deserialized

Declaration

public virtual Task<Collection<RepositoryItem>> Item_GetLatestItemsAsync(GetLatestItemsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetLatestItemsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryItem>>	A list of repository items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescription(string, Guid, long)

Gets a description of a repository item. The description
contains identification, naming, and summary information, but not the entire contents of the item.

Declaration

public virtual RepositoryItemMetadata Item_GetRepositoryItemDescription(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
RepositoryItemMetadata	A description of the repository item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescriptionAsync(string, Guid, long)

Gets a description of a repository item. The description
contains identification, naming, and summary information, but not the entire contents of the item.

Declaration

public virtual Task<RepositoryItemMetadata> Item_GetRepositoryItemDescriptionAsync(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Task<RepositoryItemMetadata>	A description of the repository item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescriptionAsync(string, Guid, long, CancellationToken)

Gets a description of a repository item. The description
contains identification, naming, and summary information, but not the entire contents of the item.

Declaration

public virtual Task<RepositoryItemMetadata> Item_GetRepositoryItemDescriptionAsync(string agency, Guid id, long version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryItemMetadata>	A description of the repository item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescriptions(GetRepositoryItemDescriptionsRequest)

Gets descriptions of multiple repository items. The descriptions
contain identification, naming, and summary information, but not the entire contents of the item.

Declaration

public virtual Collection<RepositoryItemMetadata> Item_GetRepositoryItemDescriptions(GetRepositoryItemDescriptionsRequest request)

Parameters

Type	Name	Description
GetRepositoryItemDescriptionsRequest	request

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection of descriptions of the repository items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescriptionsAsync(GetRepositoryItemDescriptionsRequest)

Gets descriptions of multiple repository items. The descriptions
contain identification, naming, and summary information, but not the entire contents of the item.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Item_GetRepositoryItemDescriptionsAsync(GetRepositoryItemDescriptionsRequest request)

Parameters

Type	Name	Description
GetRepositoryItemDescriptionsRequest	request

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection of descriptions of the repository items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescriptionsAsync(GetRepositoryItemDescriptionsRequest, CancellationToken)

Gets descriptions of multiple repository items. The descriptions
contain identification, naming, and summary information, but not the entire contents of the item.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Item_GetRepositoryItemDescriptionsAsync(GetRepositoryItemDescriptionsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetRepositoryItemDescriptionsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection of descriptions of the repository items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetVersionHistory(string, Guid)

Gets the version history of an item.

Declaration

public virtual Collection<RepositoryItemMetadata> Item_GetVersionHistory(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection containing a description for each version of a repository item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetVersionHistoryAsync(string, Guid)

Gets the version history of an item.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Item_GetVersionHistoryAsync(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection containing a description for each version of a repository item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetVersionHistoryAsync(string, Guid, CancellationToken)

Gets the version history of an item.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Item_GetVersionHistoryAsync(string agency, Guid id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection containing a description for each version of a repository item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_RegisterItems(RegisterItemsRequest)

Registers the items in the repository.

Declaration

public virtual Collection<RepositoryConflict> Item_RegisterItems(RegisterItemsRequest request)

Parameters

Type	Name	Description
RegisterItemsRequest	request

Returns

Type	Description
Collection<RepositoryConflict>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_RegisterItemsAsync(RegisterItemsRequest)

Registers the items in the repository.

Declaration

public virtual Task<Collection<RepositoryConflict>> Item_RegisterItemsAsync(RegisterItemsRequest request)

Parameters

Type	Name	Description
RegisterItemsRequest	request

Returns

Type	Description
Task<Collection<RepositoryConflict>>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_RegisterItemsAsync(RegisterItemsRequest, CancellationToken)

Registers the items in the repository.

Declaration

public virtual Task<Collection<RepositoryConflict>> Item_RegisterItemsAsync(RegisterItemsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RegisterItemsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryConflict>>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_UpdateDeprecatedState(UpdateStateRequest)

Updates the Deprecated State of a set of items

Declaration

public virtual FileResponse Item_UpdateDeprecatedState(UpdateStateRequest request)

Parameters

Type	Name	Description
UpdateStateRequest	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_UpdateDeprecatedStateAsync(UpdateStateRequest)

Updates the Deprecated State of a set of items

Declaration

public virtual Task<FileResponse> Item_UpdateDeprecatedStateAsync(UpdateStateRequest request)

Parameters

Type	Name	Description
UpdateStateRequest	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_UpdateDeprecatedStateAsync(UpdateStateRequest, CancellationToken)

Updates the Deprecated State of a set of items

Declaration

public virtual Task<FileResponse> Item_UpdateDeprecatedStateAsync(UpdateStateRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
UpdateStateRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_AddPermissions(RepositorySecurityContext)

Adds the specified permissions to the repository.

Declaration

public virtual FileResponse Permission_AddPermissions(RepositorySecurityContext request)

Parameters

Type	Name	Description
RepositorySecurityContext	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_AddPermissionsAsync(RepositorySecurityContext)

Adds the specified permissions to the repository.

Declaration

public virtual Task<FileResponse> Permission_AddPermissionsAsync(RepositorySecurityContext request)

Parameters

Type	Name	Description
RepositorySecurityContext	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_AddPermissionsAsync(RepositorySecurityContext, CancellationToken)

Adds the specified permissions to the repository.

Declaration

public virtual Task<FileResponse> Permission_AddPermissionsAsync(RepositorySecurityContext request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RepositorySecurityContext	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_GetPermissions(GetPermissionsRequest)

Gets all permissions that apply to the specified items and item types.

Declaration

public virtual RepositorySecurityContext Permission_GetPermissions(GetPermissionsRequest request)

Parameters

Type	Name	Description
GetPermissionsRequest	request

Returns

Type	Description
RepositorySecurityContext	The permissions that apply to the requested items and types.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_GetPermissionsAsync(GetPermissionsRequest)

Gets all permissions that apply to the specified items and item types.

Declaration

public virtual Task<RepositorySecurityContext> Permission_GetPermissionsAsync(GetPermissionsRequest request)

Parameters

Type	Name	Description
GetPermissionsRequest	request

Returns

Type	Description
Task<RepositorySecurityContext>	The permissions that apply to the requested items and types.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_GetPermissionsAsync(GetPermissionsRequest, CancellationToken)

Gets all permissions that apply to the specified items and item types.

Declaration

public virtual Task<RepositorySecurityContext> Permission_GetPermissionsAsync(GetPermissionsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetPermissionsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositorySecurityContext>	The permissions that apply to the requested items and types.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_RemovePermissions(RemovePermissionsRequest)

Removes the specified permissions from the repository.

Declaration

public virtual FileResponse Permission_RemovePermissions(RemovePermissionsRequest request)

Parameters

Type	Name	Description
RemovePermissionsRequest	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_RemovePermissionsAsync(RemovePermissionsRequest)

Removes the specified permissions from the repository.

Declaration

public virtual Task<FileResponse> Permission_RemovePermissionsAsync(RemovePermissionsRequest request)

Parameters

Type	Name	Description
RemovePermissionsRequest	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_RemovePermissionsAsync(RemovePermissionsRequest, CancellationToken)

Removes the specified permissions from the repository.

Declaration

public virtual Task<FileResponse> Permission_RemovePermissionsAsync(RemovePermissionsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RemovePermissionsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_AdvancedRepositorySearch(AdvancedSearchRequest)

Searches the specified the repository for items, according to the provided search options.

Declaration

public virtual AdvancedSearchResponse Query_AdvancedRepositorySearch(AdvancedSearchRequest request)

Parameters

Type	Name	Description
AdvancedSearchRequest	request

Returns

Type	Description
AdvancedSearchResponse	A search response, which includes the matching results and summary information.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_AdvancedRepositorySearchAsync(AdvancedSearchRequest)

Searches the specified the repository for items, according to the provided search options.

Declaration

public virtual Task<AdvancedSearchResponse> Query_AdvancedRepositorySearchAsync(AdvancedSearchRequest request)

Parameters

Type	Name	Description
AdvancedSearchRequest	request

Returns

Type	Description
Task<AdvancedSearchResponse>	A search response, which includes the matching results and summary information.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_AdvancedRepositorySearchAsync(AdvancedSearchRequest, CancellationToken)

Searches the specified the repository for items, according to the provided search options.

Declaration

public virtual Task<AdvancedSearchResponse> Query_AdvancedRepositorySearchAsync(AdvancedSearchRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
AdvancedSearchRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<AdvancedSearchResponse>	A search response, which includes the matching results and summary information.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipByObject(GraphSearchRequest)

Gets a list of items that reference the specified item, according to the provided search options.

Declaration

public virtual Collection<TypedIdTriple> Query_GetRelationshipByObject(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Collection<TypedIdTriple>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipByObjectAsync(GraphSearchRequest)

Gets a list of items that reference the specified item, according to the provided search options.

Declaration

public virtual Task<Collection<TypedIdTriple>> Query_GetRelationshipByObjectAsync(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Task<Collection<TypedIdTriple>>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipByObjectAsync(GraphSearchRequest, CancellationToken)

Gets a list of items that reference the specified item, according to the provided search options.

Declaration

public virtual Task<Collection<TypedIdTriple>> Query_GetRelationshipByObjectAsync(GraphSearchRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GraphSearchRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<TypedIdTriple>>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipBySubject(GraphSearchRequest)

Gets a list of items referenced by the specified item, according to the provided search options.

Declaration

public virtual Collection<TypedIdTriple> Query_GetRelationshipBySubject(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Collection<TypedIdTriple>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipBySubjectAsync(GraphSearchRequest)

Gets a list of items referenced by the specified item, according to the provided search options.

Declaration

public virtual Task<Collection<TypedIdTriple>> Query_GetRelationshipBySubjectAsync(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Task<Collection<TypedIdTriple>>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipBySubjectAsync(GraphSearchRequest, CancellationToken)

Gets a list of items referenced by the specified item, according to the provided search options.

Declaration

public virtual Task<Collection<TypedIdTriple>> Query_GetRelationshipBySubjectAsync(GraphSearchRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GraphSearchRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<TypedIdTriple>>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationships(GetRelationshipsRequest)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public virtual AdjacencyMatrix Query_GetRelationships(GetRelationshipsRequest request)

Parameters

Type	Name	Description
GetRelationshipsRequest	request

Returns

Type	Description
AdjacencyMatrix	A matrix representing all items in the set and the relationships among those items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipsAsync(GetRelationshipsRequest)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public virtual Task<AdjacencyMatrix> Query_GetRelationshipsAsync(GetRelationshipsRequest request)

Parameters

Type	Name	Description
GetRelationshipsRequest	request

Returns

Type	Description
Task<AdjacencyMatrix>	A matrix representing all items in the set and the relationships among those items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRelationshipsAsync(GetRelationshipsRequest, CancellationToken)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public virtual Task<AdjacencyMatrix> Query_GetRelationshipsAsync(GetRelationshipsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetRelationshipsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<AdjacencyMatrix>	A matrix representing all items in the set and the relationships among those items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRepositoryItemDescriptionsByObject(GraphSearchRequest)

Gets the repository item descriptions for items that match the specified relationship search parameters.
The search will query for items that reference the target item specified in the search facet.

Declaration

public virtual Collection<RepositoryItemMetadata> Query_GetRepositoryItemDescriptionsByObject(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection of descriptions of the repository items that match the search parameters.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRepositoryItemDescriptionsByObjectAsync(GraphSearchRequest)

Gets the repository item descriptions for items that match the specified relationship search parameters.
The search will query for items that reference the target item specified in the search facet.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Query_GetRepositoryItemDescriptionsByObjectAsync(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection of descriptions of the repository items that match the search parameters.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRepositoryItemDescriptionsByObjectAsync(GraphSearchRequest, CancellationToken)

Gets the repository item descriptions for items that match the specified relationship search parameters.
The search will query for items that reference the target item specified in the search facet.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Query_GetRepositoryItemDescriptionsByObjectAsync(GraphSearchRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GraphSearchRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection of descriptions of the repository items that match the search parameters.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRepositoryItemDescriptionsBySubject(GraphSearchRequest)

Gets the repository item descriptions for items that match the specified relationship search parameters.
The search will query for items referenced by the target item specified in the search facet.

Declaration

public virtual Collection<RepositoryItemMetadata> Query_GetRepositoryItemDescriptionsBySubject(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Collection<RepositoryItemMetadata>	A collection of descriptions of the repository items that match the search parameters.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRepositoryItemDescriptionsBySubjectAsync(GraphSearchRequest)

Gets the repository item descriptions for items that match the specified relationship search parameters.
The search will query for items referenced by the target item specified in the search facet.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Query_GetRepositoryItemDescriptionsBySubjectAsync(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection of descriptions of the repository items that match the search parameters.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetRepositoryItemDescriptionsBySubjectAsync(GraphSearchRequest, CancellationToken)

Gets the repository item descriptions for items that match the specified relationship search parameters.
The search will query for items referenced by the target item specified in the search facet.

Declaration

public virtual Task<Collection<RepositoryItemMetadata>> Query_GetRepositoryItemDescriptionsBySubjectAsync(GraphSearchRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GraphSearchRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryItemMetadata>>	A collection of descriptions of the repository items that match the search parameters.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetTypedRelationships(GetTypedRelationshipsRequest)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public virtual TypedAdjacencyMatrix Query_GetTypedRelationships(GetTypedRelationshipsRequest request)

Parameters

Type	Name	Description
GetTypedRelationshipsRequest	request

Returns

Type	Description
TypedAdjacencyMatrix	A matrix representing all items in the set and the relationships among those items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetTypedRelationshipsAsync(GetTypedRelationshipsRequest)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public virtual Task<TypedAdjacencyMatrix> Query_GetTypedRelationshipsAsync(GetTypedRelationshipsRequest request)

Parameters

Type	Name	Description
GetTypedRelationshipsRequest	request

Returns

Type	Description
Task<TypedAdjacencyMatrix>	A matrix representing all items in the set and the relationships among those items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_GetTypedRelationshipsAsync(GetTypedRelationshipsRequest, CancellationToken)

Gets a matrix representing all items in a set and the relationships among those items.

Declaration

public virtual Task<TypedAdjacencyMatrix> Query_GetTypedRelationshipsAsync(GetTypedRelationshipsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetTypedRelationshipsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<TypedAdjacencyMatrix>	A matrix representing all items in the set and the relationships among those items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_RepositorySearch(SearchRequest)

Searches the specified the repository for items, according to the provided search options.

Declaration

public virtual SearchResponse Query_RepositorySearch(SearchRequest request)

Parameters

Type	Name	Description
SearchRequest	request

Returns

Type	Description
SearchResponse	A search response, which includes the matching results and summary information.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_RepositorySearchAsync(SearchRequest)

Searches the specified the repository for items, according to the provided search options.

Declaration

public virtual Task<SearchResponse> Query_RepositorySearchAsync(SearchRequest request)

Parameters

Type	Name	Description
SearchRequest	request

Returns

Type	Description
Task<SearchResponse>	A search response, which includes the matching results and summary information.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_RepositorySearchAsync(SearchRequest, CancellationToken)

Searches the specified the repository for items, according to the provided search options.

Declaration

public virtual Task<SearchResponse> Query_RepositorySearchAsync(SearchRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SearchRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<SearchResponse>	A search response, which includes the matching results and summary information.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_SearchTypedSet(SearchTypedSetRequest)

Searches the specified set of items according to the provided search options.

Declaration

public virtual Collection<TypedIdTriple> Query_SearchTypedSet(SearchTypedSetRequest request)

Parameters

Type	Name	Description
SearchTypedSetRequest	request

Returns

Type	Description
Collection<TypedIdTriple>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_SearchTypedSetAsync(SearchTypedSetRequest)

Searches the specified set of items according to the provided search options.

Declaration

public virtual Task<Collection<TypedIdTriple>> Query_SearchTypedSetAsync(SearchTypedSetRequest request)

Parameters

Type	Name	Description
SearchTypedSetRequest	request

Returns

Type	Description
Task<Collection<TypedIdTriple>>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Query_SearchTypedSetAsync(SearchTypedSetRequest, CancellationToken)

Searches the specified set of items according to the provided search options.

Declaration

public virtual Task<Collection<TypedIdTriple>> Query_SearchTypedSetAsync(SearchTypedSetRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SearchTypedSetRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<TypedIdTriple>>	A list of matching items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_CreateRating(string, Guid, long, int)

Adds a rating to the specified item.

Declaration

public virtual FileResponse Rating_CreateRating(string agency, Guid id, long version, int rating)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
int	rating

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_CreateRatingAsync(string, Guid, long, int)

Adds a rating to the specified item.

Declaration

public virtual Task<FileResponse> Rating_CreateRatingAsync(string agency, Guid id, long version, int rating)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
int	rating

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_CreateRatingAsync(string, Guid, long, int, CancellationToken)

Adds a rating to the specified item.

Declaration

public virtual Task<FileResponse> Rating_CreateRatingAsync(string agency, Guid id, long version, int rating, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
int	rating
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_GetRatings(string, Guid, string)

Gets the ratings for the specified item.

Declaration

public virtual Collection<UserRating> Rating_GetRatings(string agency, Guid id, string version)

Parameters

Type	Name	Description
string	agency
Guid	id
string	version

Returns

Type	Description
Collection<UserRating>

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_GetRatingsAsync(string, Guid, string)

Gets the ratings for the specified item.

Declaration

public virtual Task<Collection<UserRating>> Rating_GetRatingsAsync(string agency, Guid id, string version)

Parameters

Type	Name	Description
string	agency
Guid	id
string	version

Returns

Type	Description
Task<Collection<UserRating>>

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_GetRatingsAsync(string, Guid, string, CancellationToken)

Gets the ratings for the specified item.

Declaration

public virtual Task<Collection<UserRating>> Rating_GetRatingsAsync(string agency, Guid id, string version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
string	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<UserRating>>

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<RepositoryApiV1Client.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
HttpResponseMessage	response
IReadOnlyDictionary<string, IEnumerable<string>>	headers
CancellationToken	cancellationToken

Returns

Type	Description
Task<RepositoryApiV1Client.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

Replication_GetAllowedInitialStates()

Declaration

public virtual AllowedTargetStates Replication_GetAllowedInitialStates()

Returns

Type	Description
AllowedTargetStates

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetAllowedInitialStatesAsync()

Declaration

public virtual Task<AllowedTargetStates> Replication_GetAllowedInitialStatesAsync()

Returns

Type	Description
Task<AllowedTargetStates>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetAllowedInitialStatesAsync(CancellationToken)

Declaration

public virtual Task<AllowedTargetStates> Replication_GetAllowedInitialStatesAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<AllowedTargetStates>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetAllowedStateTransitions(IdentifierInRequest)

Gets the allowed target states that an item may transition to, based on its current state.

Declaration

public virtual AllowedTargetStates Replication_GetAllowedStateTransitions(IdentifierInRequest itemId)

Parameters

Type	Name	Description
IdentifierInRequest	itemId	The identifier of the item to have its state changed

Returns

Type	Description
AllowedTargetStates

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetAllowedStateTransitionsAsync(IdentifierInRequest)

Gets the allowed target states that an item may transition to, based on its current state.

Declaration

public virtual Task<AllowedTargetStates> Replication_GetAllowedStateTransitionsAsync(IdentifierInRequest itemId)

Parameters

Type	Name	Description
IdentifierInRequest	itemId	The identifier of the item to have its state changed

Returns

Type	Description
Task<AllowedTargetStates>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetAllowedStateTransitionsAsync(IdentifierInRequest, CancellationToken)

Gets the allowed target states that an item may transition to, based on its current state.

Declaration

public virtual Task<AllowedTargetStates> Replication_GetAllowedStateTransitionsAsync(IdentifierInRequest itemId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IdentifierInRequest	itemId	The identifier of the item to have its state changed
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<AllowedTargetStates>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetTargets()

Applies a tag to an item in the repository.

Declaration

public virtual Collection<Target> Replication_GetTargets()

Returns

Type	Description
Collection<Target>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetTargetsAsync()

Applies a tag to an item in the repository.

Declaration

public virtual Task<Collection<Target>> Replication_GetTargetsAsync()

Returns

Type	Description
Task<Collection<Target>>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_GetTargetsAsync(CancellationToken)

Applies a tag to an item in the repository.

Declaration

public virtual Task<Collection<Target>> Replication_GetTargetsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<Target>>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_RequestReplication(CreateReplicationRequest)

Request a replication from one repository to another

Declaration

public virtual FileResponse Replication_RequestReplication(CreateReplicationRequest request)

Parameters

Type	Name	Description
CreateReplicationRequest	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_RequestReplicationAsync(CreateReplicationRequest)

Request a replication from one repository to another

Declaration

public virtual Task<FileResponse> Replication_RequestReplicationAsync(CreateReplicationRequest request)

Parameters

Type	Name	Description
CreateReplicationRequest	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_RequestReplicationAsync(CreateReplicationRequest, CancellationToken)

Request a replication from one repository to another

Declaration

public virtual Task<FileResponse> Replication_RequestReplicationAsync(CreateReplicationRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateReplicationRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_RequestStateChange(CreateStateChangeRequest)

Requests a state change for an item on a repository.

Declaration

public virtual FileResponse Replication_RequestStateChange(CreateStateChangeRequest request)

Parameters

Type	Name	Description
CreateStateChangeRequest	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_RequestStateChangeAsync(CreateStateChangeRequest)

Requests a state change for an item on a repository.

Declaration

public virtual Task<FileResponse> Replication_RequestStateChangeAsync(CreateStateChangeRequest request)

Parameters

Type	Name	Description
CreateStateChangeRequest	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Replication_RequestStateChangeAsync(CreateStateChangeRequest, CancellationToken)

Requests a state change for an item on a repository.

Declaration

public virtual Task<FileResponse> Replication_RequestStateChangeAsync(CreateStateChangeRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateStateChangeRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetInfo()

Gets information about the repository and the items it contains.

Declaration

public virtual RepositoryInfo Repository_GetInfo()

Returns

Type	Description
RepositoryInfo	An object containing information about the repository and the items it contains.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetInfoAsync()

Gets information about the repository and the items it contains.

Declaration

public virtual Task<RepositoryInfo> Repository_GetInfoAsync()

Returns

Type	Description
Task<RepositoryInfo>	An object containing information about the repository and the items it contains.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetInfoAsync(CancellationToken)

Gets information about the repository and the items it contains.

Declaration

public virtual Task<RepositoryInfo> Repository_GetInfoAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryInfo>	An object containing information about the repository and the items it contains.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetStatistics()

Gets statistics about the content in the repository.

Declaration

public virtual RepositoryStatistics Repository_GetStatistics()

Returns

Type	Description
RepositoryStatistics	An object containing statistics about the content in the repository.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetStatisticsAsync()

Gets statistics about the content in the repository.

Declaration

public virtual Task<RepositoryStatistics> Repository_GetStatisticsAsync()

Returns

Type	Description
Task<RepositoryStatistics>	An object containing statistics about the content in the repository.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetStatisticsAsync(CancellationToken)

Gets statistics about the content in the repository.

Declaration

public virtual Task<RepositoryStatistics> Repository_GetStatisticsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryStatistics>	An object containing statistics about the content in the repository.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetLatestSet(string, Guid, long?)

Gets the set of items defined by the specified root. Each item in the set will
have the latest version number for that item.

Declaration

public virtual Collection<IdentifierTriple> Set_GetLatestSet(string agency, Guid id, long? version)

Parameters

Type	Name	Description
string	agency
Guid	id
long?	version

Returns

Type	Description
Collection<IdentifierTriple>	A list of identifiers of all items in the set.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetLatestSetAsync(string, Guid, long?)

Gets the set of items defined by the specified root. Each item in the set will
have the latest version number for that item.

Declaration

public virtual Task<Collection<IdentifierTriple>> Set_GetLatestSetAsync(string agency, Guid id, long? version)

Parameters

Type	Name	Description
string	agency
Guid	id
long?	version

Returns

Type	Description
Task<Collection<IdentifierTriple>>	A list of identifiers of all items in the set.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetLatestSetAsync(string, Guid, long?, CancellationToken)

Gets the set of items defined by the specified root. Each item in the set will
have the latest version number for that item.

Declaration

public virtual Task<Collection<IdentifierTriple>> Set_GetLatestSetAsync(string agency, Guid id, long? version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long?	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<IdentifierTriple>>	A list of identifiers of all items in the set.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetSet(string, Guid, long)

Gets the set of all items under the specified root.

Declaration

public virtual Collection<IdentifierTriple> Set_GetSet(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Collection<IdentifierTriple>	The set of all items under the specified root.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetSetAsync(string, Guid, long)

Gets the set of all items under the specified root.

Declaration

public virtual Task<Collection<IdentifierTriple>> Set_GetSetAsync(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Task<Collection<IdentifierTriple>>	The set of all items under the specified root.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetSetAsync(string, Guid, long, CancellationToken)

Gets the set of all items under the specified root.

Declaration

public virtual Task<Collection<IdentifierTriple>> Set_GetSetAsync(string agency, Guid id, long version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<IdentifierTriple>>	The set of all items under the specified root.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetTypedSet(string, Guid, long)

Gets the set of all items under the specified root. The returned
identifiers include the type of each item.

Declaration

public virtual Collection<TypedIdTriple> Set_GetTypedSet(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Collection<TypedIdTriple>	The set of all items under the specified root.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetTypedSetAsync(string, Guid, long)

Gets the set of all items under the specified root. The returned
identifiers include the type of each item.

Declaration

public virtual Task<Collection<TypedIdTriple>> Set_GetTypedSetAsync(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Task<Collection<TypedIdTriple>>	The set of all items under the specified root.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetTypedSetAsync(string, Guid, long, CancellationToken)

Gets the set of all items under the specified root. The returned
identifiers include the type of each item.

Declaration

public virtual Task<Collection<TypedIdTriple>> Set_GetTypedSetAsync(string agency, Guid id, long version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<TypedIdTriple>>	The set of all items under the specified root.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySetting(string)

Gets the repository setting with the specified name.

Declaration

public virtual RepositorySetting Setting_GetRepositorySetting(string setting)

Parameters

Type	Name	Description
string	setting

Returns

Type	Description
RepositorySetting	The repository setting.

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingAsync(string)

Gets the repository setting with the specified name.

Declaration

public virtual Task<RepositorySetting> Setting_GetRepositorySettingAsync(string setting)

Parameters

Type	Name	Description
string	setting

Returns

Type	Description
Task<RepositorySetting>	The repository setting.

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingAsync(string, CancellationToken)

Gets the repository setting with the specified name.

Declaration

public virtual Task<RepositorySetting> Setting_GetRepositorySettingAsync(string setting, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	setting
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositorySetting>	The repository setting.

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettings()

Gets all the repository settings.

Declaration

public virtual Collection<RepositorySetting> Setting_GetRepositorySettings()

Returns

Type	Description
Collection<RepositorySetting>	A list of all repository settings.

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingsAsync()

Gets all the repository settings.

Declaration

public virtual Task<Collection<RepositorySetting>> Setting_GetRepositorySettingsAsync()

Returns

Type	Description
Task<Collection<RepositorySetting>>	A list of all repository settings.

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingsAsync(CancellationToken)

Gets all the repository settings.

Declaration

public virtual Task<Collection<RepositorySetting>> Setting_GetRepositorySettingsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositorySetting>>	A list of all repository settings.

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_RemoveRepositorySetting(string)

Removes the repository setting with the specified name.

Declaration

public virtual FileResponse Setting_RemoveRepositorySetting(string setting)

Parameters

Type	Name	Description
string	setting

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_RemoveRepositorySettingAsync(string)

Removes the repository setting with the specified name.

Declaration

public virtual Task<FileResponse> Setting_RemoveRepositorySettingAsync(string setting)

Parameters

Type	Name	Description
string	setting

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_RemoveRepositorySettingAsync(string, CancellationToken)

Removes the repository setting with the specified name.

Declaration

public virtual Task<FileResponse> Setting_RemoveRepositorySettingAsync(string setting, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	setting
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_SetRepositorySetting(RepositorySetting)

Adds or updates a repository setting.

Declaration

public virtual FileResponse Setting_SetRepositorySetting(RepositorySetting request)

Parameters

Type	Name	Description
RepositorySetting	request

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_SetRepositorySettingAsync(RepositorySetting)

Adds or updates a repository setting.

Declaration

public virtual Task<FileResponse> Setting_SetRepositorySettingAsync(RepositorySetting request)

Parameters

Type	Name	Description
RepositorySetting	request

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_SetRepositorySettingAsync(RepositorySetting, CancellationToken)

Adds or updates a repository setting.

Declaration

public virtual Task<FileResponse> Setting_SetRepositorySettingAsync(RepositorySetting request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RepositorySetting	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_CreateTag(string, Guid, long, string)

Applies a tag to an item in the repository.

Declaration

public virtual FileResponse Tag_CreateTag(string agency, Guid id, long version, string tag)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
string	tag

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_CreateTagAsync(string, Guid, long, string)

Applies a tag to an item in the repository.

Declaration

public virtual Task<FileResponse> Tag_CreateTagAsync(string agency, Guid id, long version, string tag)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
string	tag

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_CreateTagAsync(string, Guid, long, string, CancellationToken)

Applies a tag to an item in the repository.

Declaration

public virtual Task<FileResponse> Tag_CreateTagAsync(string agency, Guid id, long version, string tag, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
string	tag
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_GetTags(string, Guid, long)

Gets the tags applied to the specified item in the repository.

Declaration

public virtual Collection<string> Tag_GetTags(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Collection<string>	A list of tags applied to the item in the repository.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_GetTagsAsync(string, Guid, long)

Gets the tags applied to the specified item in the repository.

Declaration

public virtual Task<Collection<string>> Tag_GetTagsAsync(string agency, Guid id, long version)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version

Returns

Type	Description
Task<Collection<string>>	A list of tags applied to the item in the repository.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_GetTagsAsync(string, Guid, long, CancellationToken)

Gets the tags applied to the specified item in the repository.

Declaration

public virtual Task<Collection<string>> Tag_GetTagsAsync(string agency, Guid id, long version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<string>>	A list of tags applied to the item in the repository.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_RemoveTag(string, Guid, long, string)

Removes a tag from an item in the repository.

Declaration

public virtual FileResponse Tag_RemoveTag(string agency, Guid id, long version, string tag)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
string	tag

Returns

Type	Description
FileResponse

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_RemoveTagAsync(string, Guid, long, string)

Removes a tag from an item in the repository.

Declaration

public virtual Task<FileResponse> Tag_RemoveTagAsync(string agency, Guid id, long version, string tag)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
string	tag

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_RemoveTagAsync(string, Guid, long, string, CancellationToken)

Removes a tag from an item in the repository.

Declaration

public virtual Task<FileResponse> Tag_RemoveTagAsync(string agency, Guid id, long version, string tag, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
long	version
string	tag
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateToken(TokenLoginModel)

Declaration

public virtual AccessTokenModel Token_CreateToken(TokenLoginModel login)

Parameters

Type	Name	Description
TokenLoginModel	login

Returns

Type	Description
AccessTokenModel

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateTokenAsync(TokenLoginModel)

Declaration

public virtual Task<AccessTokenModel> Token_CreateTokenAsync(TokenLoginModel login)

Parameters

Type	Name	Description
TokenLoginModel	login

Returns

Type	Description
Task<AccessTokenModel>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateTokenAsync(TokenLoginModel, CancellationToken)

Declaration

public virtual Task<AccessTokenModel> Token_CreateTokenAsync(TokenLoginModel login, CancellationToken cancellationToken)

Parameters

Type	Name	Description
TokenLoginModel	login
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<AccessTokenModel>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateWindowsToken()

Declaration

public virtual AccessTokenModel Token_CreateWindowsToken()

Returns

Type	Description
AccessTokenModel

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateWindowsTokenAsync()

Declaration

public virtual Task<AccessTokenModel> Token_CreateWindowsTokenAsync()

Returns

Type	Description
Task<AccessTokenModel>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateWindowsTokenAsync(CancellationToken)

Declaration

public virtual Task<AccessTokenModel> Token_CreateWindowsTokenAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<AccessTokenModel>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_AddItemsToTransaction(RepositoryTransactionAddItemsRequest)

Add items to a transaction to be registered

Declaration

public virtual RepositoryTransaction Transaction_AddItemsToTransaction(RepositoryTransactionAddItemsRequest request)

Parameters

Type	Name	Description
RepositoryTransactionAddItemsRequest	request

Returns

Type	Description
RepositoryTransaction	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest)

Add items to a transaction to be registered

Declaration

public virtual Task<RepositoryTransaction> Transaction_AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest request)

Parameters

Type	Name	Description
RepositoryTransactionAddItemsRequest	request

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest, CancellationToken)

Add items to a transaction to be registered

Declaration

public virtual Task<RepositoryTransaction> Transaction_AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RepositoryTransactionAddItemsRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CancelTransaction(RepositoryTransactionCancelOptions)

Cancel a transaction

Declaration

public virtual RepositoryTransaction Transaction_CancelTransaction(RepositoryTransactionCancelOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCancelOptions	options

Returns

Type	Description
RepositoryTransaction	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CancelTransactionAsync(RepositoryTransactionCancelOptions)

Cancel a transaction

Declaration

public virtual Task<RepositoryTransaction> Transaction_CancelTransactionAsync(RepositoryTransactionCancelOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCancelOptions	options

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CancelTransactionAsync(RepositoryTransactionCancelOptions, CancellationToken)

Cancel a transaction

Declaration

public virtual Task<RepositoryTransaction> Transaction_CancelTransactionAsync(RepositoryTransactionCancelOptions options, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RepositoryTransactionCancelOptions	options
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CommitTransaction(RepositoryTransactionCommitOptions)

Register the items in the transaction

Declaration

public virtual RepositoryTransactionResult Transaction_CommitTransaction(RepositoryTransactionCommitOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCommitOptions	options

Returns

Type	Description
RepositoryTransactionResult	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CommitTransactionAsync(RepositoryTransactionCommitOptions)

Register the items in the transaction

Declaration

public virtual Task<RepositoryTransactionResult> Transaction_CommitTransactionAsync(RepositoryTransactionCommitOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCommitOptions	options

Returns

Type	Description
Task<RepositoryTransactionResult>	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CommitTransactionAsync(RepositoryTransactionCommitOptions, CancellationToken)

Register the items in the transaction

Declaration

public virtual Task<RepositoryTransactionResult> Transaction_CommitTransactionAsync(RepositoryTransactionCommitOptions options, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RepositoryTransactionCommitOptions	options
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryTransactionResult>	Transaction metadata

Remarks

Required permissions: ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CreateTransaction()

Create a new Repository transaction

Declaration

public virtual RepositoryTransaction Transaction_CreateTransaction()

Returns

Type	Description
RepositoryTransaction	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CreateTransactionAsync()

Create a new Repository transaction

Declaration

public virtual Task<RepositoryTransaction> Transaction_CreateTransactionAsync()

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CreateTransactionAsync(CancellationToken)

Create a new Repository transaction

Declaration

public virtual Task<RepositoryTransaction> Transaction_CreateTransactionAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator or ColecticaUser.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetItemsInTransaction(long?)

Get Transaction metadata

Declaration

public virtual Collection<RepositoryItem> Transaction_GetItemsInTransaction(long? transactionId)

Parameters

Type	Name	Description
long?	transactionId

Returns

Type	Description
Collection<RepositoryItem>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetItemsInTransactionAsync(long?)

Get Transaction metadata

Declaration

public virtual Task<Collection<RepositoryItem>> Transaction_GetItemsInTransactionAsync(long? transactionId)

Parameters

Type	Name	Description
long?	transactionId

Returns

Type	Description
Task<Collection<RepositoryItem>>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetItemsInTransactionAsync(long?, CancellationToken)

Get Transaction metadata

Declaration

public virtual Task<Collection<RepositoryItem>> Transaction_GetItemsInTransactionAsync(long? transactionId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
long?	transactionId
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryItem>>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetTransactions(IEnumerable<long>)

Get Transaction metadata

Declaration

public virtual Collection<RepositoryTransaction> Transaction_GetTransactions(IEnumerable<long> transactionIds)

Parameters

Type	Name	Description
IEnumerable<long>	transactionIds

Returns

Type	Description
Collection<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetTransactionsAsync(IEnumerable<long>)

Get Transaction metadata

Declaration

public virtual Task<Collection<RepositoryTransaction>> Transaction_GetTransactionsAsync(IEnumerable<long> transactionIds)

Parameters

Type	Name	Description
IEnumerable<long>	transactionIds

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetTransactionsAsync(IEnumerable<long>, CancellationToken)

Get Transaction metadata

Declaration

public virtual Task<Collection<RepositoryTransaction>> Transaction_GetTransactionsAsync(IEnumerable<long> transactionIds, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IEnumerable<long>	transactionIds
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_ListTransactions(RepositoryTransactionListOptions)

Get Transaction metadata

Declaration

public virtual Collection<RepositoryTransaction> Transaction_ListTransactions(RepositoryTransactionListOptions options)

Parameters

Type	Name	Description
RepositoryTransactionListOptions	options

Returns

Type	Description
Collection<RepositoryTransaction>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_ListTransactionsAsync(RepositoryTransactionListOptions)

Get Transaction metadata

Declaration

public virtual Task<Collection<RepositoryTransaction>> Transaction_ListTransactionsAsync(RepositoryTransactionListOptions options)

Parameters

Type	Name	Description
RepositoryTransactionListOptions	options

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_ListTransactionsAsync(RepositoryTransactionListOptions, CancellationToken)

Get Transaction metadata

Declaration

public virtual Task<Collection<RepositoryTransaction>> Transaction_ListTransactionsAsync(RepositoryTransactionListOptions options, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RepositoryTransactionListOptions	options
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	Transaction metadata

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumber(string, Guid)

Gets the latest version number of a repository item.

Declaration

public virtual long VersionNumber_GetLatestVersionNumber(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
long	The latest version number of the item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumberAsync(string, Guid)

Gets the latest version number of a repository item.

Declaration

public virtual Task<long> VersionNumber_GetLatestVersionNumberAsync(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Task<long>	The latest version number of the item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumberAsync(string, Guid, CancellationToken)

Gets the latest version number of a repository item.

Declaration

public virtual Task<long> VersionNumber_GetLatestVersionNumberAsync(string agency, Guid id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<long>	The latest version number of the item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumberOfTag(string, Guid, string)

Gets the latest version number of the specified repository item that has the specified tag.

Declaration

public virtual long VersionNumber_GetLatestVersionNumberOfTag(string agency, Guid id, string tag)

Parameters

Type	Name	Description
string	agency
Guid	id
string	tag

Returns

Type	Description
long	The latest version number of the repository item with the tag.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumberOfTagAsync(string, Guid, string)

Gets the latest version number of the specified repository item that has the specified tag.

Declaration

public virtual Task<long> VersionNumber_GetLatestVersionNumberOfTagAsync(string agency, Guid id, string tag)

Parameters

Type	Name	Description
string	agency
Guid	id
string	tag

Returns

Type	Description
Task<long>	The latest version number of the repository item with the tag.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumberOfTagAsync(string, Guid, string, CancellationToken)

Gets the latest version number of the specified repository item that has the specified tag.

Declaration

public virtual Task<long> VersionNumber_GetLatestVersionNumberOfTagAsync(string agency, Guid id, string tag, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
string	tag
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<long>	The latest version number of the repository item with the tag.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumbers(GetLatestVersionNumbersRequest)

Gets the latest version numbers of multiple items.

Declaration

public virtual Collection<IdentifierTriple> VersionNumber_GetLatestVersionNumbers(GetLatestVersionNumbersRequest request)

Parameters

Type	Name	Description
GetLatestVersionNumbersRequest	request

Returns

Type	Description
Collection<IdentifierTriple>	A collection of identifiers containing the full identification, including latest version number, of the latest versions of the requested items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumbersAsync(GetLatestVersionNumbersRequest)

Gets the latest version numbers of multiple items.

Declaration

public virtual Task<Collection<IdentifierTriple>> VersionNumber_GetLatestVersionNumbersAsync(GetLatestVersionNumbersRequest request)

Parameters

Type	Name	Description
GetLatestVersionNumbersRequest	request

Returns

Type	Description
Task<Collection<IdentifierTriple>>	A collection of identifiers containing the full identification, including latest version number, of the latest versions of the requested items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumbersAsync(GetLatestVersionNumbersRequest, CancellationToken)

Gets the latest version numbers of multiple items.

Declaration

public virtual Task<Collection<IdentifierTriple>> VersionNumber_GetLatestVersionNumbersAsync(GetLatestVersionNumbersRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetLatestVersionNumbersRequest	request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<IdentifierTriple>>	A collection of identifiers containing the full identification, including latest version number, of the latest versions of the requested items.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetVersions(string, Guid)

Gets a list of all versions of the specified item.

Declaration

public virtual Collection<IdentifierTriple> VersionNumber_GetVersions(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Collection<IdentifierTriple>	A list of all versions of the specified item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetVersionsAsync(string, Guid)

Gets a list of all versions of the specified item.

Declaration

public virtual Task<Collection<IdentifierTriple>> VersionNumber_GetVersionsAsync(string agency, Guid id)

Parameters

Type	Name	Description
string	agency
Guid	id

Returns

Type	Description
Task<Collection<IdentifierTriple>>	A list of all versions of the specified item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetVersionsAsync(string, Guid, CancellationToken)

Gets a list of all versions of the specified item.

Declaration

public virtual Task<Collection<IdentifierTriple>> VersionNumber_GetVersionsAsync(string agency, Guid id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	agency
Guid	id
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<Collection<IdentifierTriple>>	A list of all versions of the specified item.

Remarks

Required permissions: ColecticaAdministrator, ColecticaUser, or ColecticaGuest.

Exceptions

Type	Condition
RestApiException	A server side error occurred.