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

colecticaClient

Declaration

public RestRepositoryClient colecticaClient { get; set; }

Property Value

Type	Description
RestRepositoryClient

JsonSerializerSettings

Declaration

public JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
Boolean

Methods

Agency_Create(CreateAgencyRequest)

Marks the repository as authoritative for the specified agency.

Declaration

public FileResponse Agency_Create(CreateAgencyRequest request)

Parameters

Type	Name	Description
CreateAgencyRequest	request

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Agency_CreateAsync(CreateAgencyRequest)

Marks the repository as authoritative for the specified agency.

Declaration

public Task<FileResponse> Agency_CreateAsync(CreateAgencyRequest request)

Parameters

Type	Name	Description
CreateAgencyRequest	request

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Agency_CreateAsync(CreateAgencyRequest, CancellationToken)

Marks the repository as authoritative for the specified agency.

Declaration

public 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>

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 FileResponse Agency_Delete(string agency)

Parameters

Type	Name	Description
String	agency

Returns

Type	Description
FileResponse

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 Task<FileResponse> Agency_DeleteAsync(string agency)

Parameters

Type	Name	Description
String	agency

Returns

Type	Description
Task<FileResponse>

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 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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_CreateComments(String, Guid, Int64, CreateCommentRequest)

Adds a comment to the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
CreateCommentRequest	request

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_CreateCommentsAsync(String, Guid, Int64, CreateCommentRequest)

Adds a comment to the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
CreateCommentRequest	request

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_CreateCommentsAsync(String, Guid, Int64, CreateCommentRequest, CancellationToken)

Adds a comment to the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetComments(String, Guid)

Gets the comments for the specified item.

Declaration

public 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. or All comments applicable to the specified item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsAsync(String, Guid)

Gets the comments for the specified item.

Declaration

public 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. or All comments applicable to the specified item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsAsync(String, Guid, CancellationToken)

Gets the comments for the specified item.

Declaration

public 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. or All comments applicable to the specified item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsList(GetCommentsRequest)

Gets multiple comments from the repository.

Declaration

public Collection<UserComment> Comment_GetCommentsList(GetCommentsRequest request)

Parameters

Type	Name	Description
GetCommentsRequest	request

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsListAsync(GetCommentsRequest)

Gets multiple comments from the repository.

Declaration

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

Parameters

Type	Name	Description
GetCommentsRequest	request

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Comment_GetCommentsListAsync(GetCommentsRequest, CancellationToken)

Gets multiple comments from the repository.

Declaration

public 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. or A collection of UserComment items.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Event_LogEvent(LoggedEvent)

Store information about an event.

Declaration

public FileResponse Event_LogEvent(LoggedEvent request)

Parameters

Type	Name	Description
LoggedEvent	request

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Event_LogEventAsync(LoggedEvent)

Store information about an event.

Declaration

public Task<FileResponse> Event_LogEventAsync(LoggedEvent request)

Parameters

Type	Name	Description
LoggedEvent	request

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Event_LogEventAsync(LoggedEvent, CancellationToken)

Store information about an event.

Declaration

public 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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItem(String, Guid, Int64)

Gets an item from the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

Type	Description
RepositoryItem	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemAsync(String, Guid, Int64)

Gets an item from the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

Type	Description
Task<RepositoryItem>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemAsync(String, Guid, Int64, CancellationToken)

Gets an item from the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItems(GetItemsRequest)

Gets multiple items from the repository.

Declaration

public Collection<RepositoryItem> Item_GetItems(GetItemsRequest request)

Parameters

Type	Name	Description
GetItemsRequest	request

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemsAsync(GetItemsRequest)

Gets multiple items from the repository.

Declaration

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

Parameters

Type	Name	Description
GetItemsRequest	request

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetItemsAsync(GetItemsRequest, CancellationToken)

Gets multiple items from the repository.

Declaration

public 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. or A collection of IVersionable items.

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 RepositoryItem Item_GetLatestItem(string agency, Guid id)

Parameters

Type	Name	Description
String	agency
Guid	id

Returns

Type	Description
RepositoryItem	The deserialized, IVersionable item. or The deserialized, IVersionable item.

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 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. or The deserialized, IVersionable item.

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 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. or The deserialized, IVersionable item.

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 Collection<RepositoryItem> Item_GetLatestItems(GetLatestItemsRequest request)

Parameters

Type	Name	Description
GetLatestItemsRequest	request

Returns

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

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 Task<Collection<RepositoryItem>> Item_GetLatestItemsAsync(GetLatestItemsRequest request)

Parameters

Type	Name	Description
GetLatestItemsRequest	request

Returns

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

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 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. or A list of repository items.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescription(String, Guid, Int64)

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 RepositoryItemMetadata Item_GetRepositoryItemDescription(string agency, Guid id, long version)

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

Type	Description
RepositoryItemMetadata	A description of the repository item. or A description of the repository item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescriptionAsync(String, Guid, Int64)

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 Task<RepositoryItemMetadata> Item_GetRepositoryItemDescriptionAsync(string agency, Guid id, long version)

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetRepositoryItemDescriptionAsync(String, Guid, Int64, 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 Task<RepositoryItemMetadata> Item_GetRepositoryItemDescriptionAsync(string agency, Guid id, long version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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. or A description of the repository item.

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 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. or A collection of descriptions of the repository items.

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 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. or A collection of descriptions of the repository items.

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 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. or A collection of descriptions of the repository items.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetVersionHistory(String, Guid)

Gets the version history of an item.

Declaration

public 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. or A collection containing a description for each version of a repository item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetVersionHistoryAsync(String, Guid)

Gets the version history of an item.

Declaration

public 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. or A collection containing a description for each version of a repository item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_GetVersionHistoryAsync(String, Guid, CancellationToken)

Gets the version history of an item.

Declaration

public 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. or A collection containing a description for each version of a repository item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_RegisterItems(RegisterItemsRequest)

Registers the items in the repository.

Declaration

public Collection<RepositoryConflict> Item_RegisterItems(RegisterItemsRequest request)

Parameters

Type	Name	Description
RegisterItemsRequest	request

Returns

Type	Description
Collection<RepositoryConflict>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_RegisterItemsAsync(RegisterItemsRequest)

Registers the items in the repository.

Declaration

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

Parameters

Type	Name	Description
RegisterItemsRequest	request

Returns

Type	Description
Task<Collection<RepositoryConflict>>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_RegisterItemsAsync(RegisterItemsRequest, CancellationToken)

Registers the items in the repository.

Declaration

public 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>>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_UpdateDeprecatedState(UpdateStateRequest)

Updates the Deprecated State of a set of items

Declaration

public FileResponse Item_UpdateDeprecatedState(UpdateStateRequest request)

Parameters

Type	Name	Description
UpdateStateRequest	request

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_UpdateDeprecatedStateAsync(UpdateStateRequest)

Updates the Deprecated State of a set of items

Declaration

public Task<FileResponse> Item_UpdateDeprecatedStateAsync(UpdateStateRequest request)

Parameters

Type	Name	Description
UpdateStateRequest	request

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Item_UpdateDeprecatedStateAsync(UpdateStateRequest, CancellationToken)

Updates the Deprecated State of a set of items

Declaration

public 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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_AddPermissions(RepositorySecurityContext)

Adds the specified permissions to the repository.

Declaration

public FileResponse Permission_AddPermissions(RepositorySecurityContext request)

Parameters

Type	Name	Description
RepositorySecurityContext	request

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_AddPermissionsAsync(RepositorySecurityContext)

Adds the specified permissions to the repository.

Declaration

public Task<FileResponse> Permission_AddPermissionsAsync(RepositorySecurityContext request)

Parameters

Type	Name	Description
RepositorySecurityContext	request

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_AddPermissionsAsync(RepositorySecurityContext, CancellationToken)

Adds the specified permissions to the repository.

Declaration

public 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>

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 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. or The permissions that apply to the requested items and types.

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 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. or The permissions that apply to the requested items and types.

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 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. or The permissions that apply to the requested items and types.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_RemovePermissions(RemovePermissionsRequest)

Removes the specified permissions from the repository.

Declaration

public FileResponse Permission_RemovePermissions(RemovePermissionsRequest request)

Parameters

Type	Name	Description
RemovePermissionsRequest	request

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_RemovePermissionsAsync(RemovePermissionsRequest)

Removes the specified permissions from the repository.

Declaration

public Task<FileResponse> Permission_RemovePermissionsAsync(RemovePermissionsRequest request)

Parameters

Type	Name	Description
RemovePermissionsRequest	request

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Permission_RemovePermissionsAsync(RemovePermissionsRequest, CancellationToken)

Removes the specified permissions from the repository.

Declaration

public 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>

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 Collection<TypedIdTriple> Query_GetRelationshipByObject(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

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

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 Task<Collection<TypedIdTriple>> Query_GetRelationshipByObjectAsync(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

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

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 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. or A list of matching items.

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 Collection<TypedIdTriple> Query_GetRelationshipBySubject(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

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

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 Task<Collection<TypedIdTriple>> Query_GetRelationshipBySubjectAsync(GraphSearchRequest request)

Parameters

Type	Name	Description
GraphSearchRequest	request

Returns

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

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 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. or A list of matching items.

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 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. or A matrix representing all items in the set and the relationships among those items.

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 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. or A matrix representing all items in the set and the relationships among those items.

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 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. or A matrix representing all items in the set and the relationships among those items.

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 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. or A collection of descriptions of the repository items that match the search parameters.

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 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. or A collection of descriptions of the repository items that match the search parameters.

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 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. or A collection of descriptions of the repository items that match the search parameters.

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 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. or A collection of descriptions of the repository items that match the search parameters.

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 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. or A collection of descriptions of the repository items that match the search parameters.

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 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. or A collection of descriptions of the repository items that match the search parameters.

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 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. or A matrix representing all items in the set and the relationships among those items.

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 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. or A matrix representing all items in the set and the relationships among those items.

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 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. or A matrix representing all items in the set and the relationships among those items.

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 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. or A search response, which includes the matching results and summary information.

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 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. or A search response, which includes the matching results and summary information.

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 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. or A search response, which includes the matching results and summary information.

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 Collection<TypedIdTriple> Query_SearchTypedSet(SearchTypedSetRequest request)

Parameters

Type	Name	Description
SearchTypedSetRequest	request

Returns

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

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 Task<Collection<TypedIdTriple>> Query_SearchTypedSetAsync(SearchTypedSetRequest request)

Parameters

Type	Name	Description
SearchTypedSetRequest	request

Returns

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

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 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. or A list of matching items.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_CreateRating(String, Guid, Int64, Nullable<Int32>)

Adds a rating to the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
Nullable<Int32>	rating

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_CreateRatingAsync(String, Guid, Int64, Nullable<Int32>)

Adds a rating to the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
Nullable<Int32>	rating

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_CreateRatingAsync(String, Guid, Int64, Nullable<Int32>, CancellationToken)

Adds a rating to the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
Nullable<Int32>	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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_GetRatings(String, Guid)

Gets the ratings for the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id

Returns

Type	Description
Collection<UserRating>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_GetRatingsAsync(String, Guid)

Gets the ratings for the specified item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id

Returns

Type	Description
Task<Collection<UserRating>>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Rating_GetRatingsAsync(String, Guid, CancellationToken)

Gets the ratings for the specified item.

Declaration

public Task<Collection<UserRating>> Rating_GetRatingsAsync(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<UserRating>>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>)

Declaration

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

Parameters

Type	Name	Description
HttpResponseMessage	response
IReadOnlyDictionary<String, IEnumerable<String>>	headers

Returns

Type	Description
Task<RepositoryApiV1Client.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

Repository_GetInfo()

Gets information about the repository and the items it contains.

Declaration

public RepositoryInfo Repository_GetInfo()

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetInfoAsync()

Gets information about the repository and the items it contains.

Declaration

public Task<RepositoryInfo> Repository_GetInfoAsync()

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetInfoAsync(CancellationToken)

Gets information about the repository and the items it contains.

Declaration

public 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. or An object containing information about the repository and the items it contains.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetStatistics()

Gets statistics about the content in the repository.

Declaration

public RepositoryStatistics Repository_GetStatistics()

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetStatisticsAsync()

Gets statistics about the content in the repository.

Declaration

public Task<RepositoryStatistics> Repository_GetStatisticsAsync()

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Repository_GetStatisticsAsync(CancellationToken)

Gets statistics about the content in the repository.

Declaration

public 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. or An object containing statistics about the content in the repository.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetLatestSet(String, Guid, Int64)

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 Collection<IdentifierTriple> Set_GetLatestSet(string agency, Guid id, long version)

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetLatestSetAsync(String, Guid, Int64)

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 Task<Collection<IdentifierTriple>> Set_GetLatestSetAsync(string agency, Guid id, long version)

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetLatestSetAsync(String, Guid, Int64, 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 Task<Collection<IdentifierTriple>> Set_GetLatestSetAsync(string agency, Guid id, long version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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. or A list of identifiers of all items in the set.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetSet(String, Guid, Int64)

Gets the set of all items under the specified root.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetSetAsync(String, Guid, Int64)

Gets the set of all items under the specified root.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetSetAsync(String, Guid, Int64, CancellationToken)

Gets the set of all items under the specified root.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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. or The set of all items under the specified root.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetTypedSet(String, Guid, Int64)

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

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetTypedSetAsync(String, Guid, Int64)

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

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Set_GetTypedSetAsync(String, Guid, Int64, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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. or The set of all items under the specified root.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySetting(String)

Gets the repository setting with the specified name.

Declaration

public RepositorySetting Setting_GetRepositorySetting(string setting)

Parameters

Type	Name	Description
String	setting

Returns

Type	Description
RepositorySetting	The repository setting. or The repository setting.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingAsync(String)

Gets the repository setting with the specified name.

Declaration

public Task<RepositorySetting> Setting_GetRepositorySettingAsync(string setting)

Parameters

Type	Name	Description
String	setting

Returns

Type	Description
Task<RepositorySetting>	The repository setting. or The repository setting.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingAsync(String, CancellationToken)

Gets the repository setting with the specified name.

Declaration

public 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. or The repository setting.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettings()

Gets all the repository settings.

Declaration

public Collection<RepositorySetting> Setting_GetRepositorySettings()

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingsAsync()

Gets all the repository settings.

Declaration

public Task<Collection<RepositorySetting>> Setting_GetRepositorySettingsAsync()

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_GetRepositorySettingsAsync(CancellationToken)

Gets all the repository settings.

Declaration

public 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. or A list of all repository settings.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_RemoveRepositorySetting(String)

Removes the repository setting with the specified name.

Declaration

public FileResponse Setting_RemoveRepositorySetting(string setting)

Parameters

Type	Name	Description
String	setting

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_RemoveRepositorySettingAsync(String)

Removes the repository setting with the specified name.

Declaration

public Task<FileResponse> Setting_RemoveRepositorySettingAsync(string setting)

Parameters

Type	Name	Description
String	setting

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_RemoveRepositorySettingAsync(String, CancellationToken)

Removes the repository setting with the specified name.

Declaration

public 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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_SetRepositorySetting(RepositorySetting)

Adds or updates a repository setting.

Declaration

public FileResponse Setting_SetRepositorySetting(RepositorySetting request)

Parameters

Type	Name	Description
RepositorySetting	request

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_SetRepositorySettingAsync(RepositorySetting)

Adds or updates a repository setting.

Declaration

public Task<FileResponse> Setting_SetRepositorySettingAsync(RepositorySetting request)

Parameters

Type	Name	Description
RepositorySetting	request

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Setting_SetRepositorySettingAsync(RepositorySetting, CancellationToken)

Adds or updates a repository setting.

Declaration

public 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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_CreateTag(String, Guid, Int64, String)

Applies a tag to an item in the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
String	tag

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_CreateTagAsync(String, Guid, Int64, String)

Applies a tag to an item in the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
String	tag

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_CreateTagAsync(String, Guid, Int64, String, CancellationToken)

Applies a tag to an item in the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_GetTags(String, Guid, Int64)

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

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_GetTagsAsync(String, Guid, Int64)

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

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version

Returns

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

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_GetTagsAsync(String, Guid, Int64, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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. or A list of tags applied to the item in the repository.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_RemoveTag(String, Guid, Int64, String)

Removes a tag from an item in the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
String	tag

Returns

Type	Description
FileResponse

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_RemoveTagAsync(String, Guid, Int64, String)

Removes a tag from an item in the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	version
String	tag

Returns

Type	Description
Task<FileResponse>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Tag_RemoveTagAsync(String, Guid, Int64, String, CancellationToken)

Removes a tag from an item in the repository.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id
Int64	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>

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateToken(TokenLoginModel)

Declaration

public AccessTokenModel Token_CreateToken(TokenLoginModel login)

Parameters

Type	Name	Description
TokenLoginModel	login

Returns

Type	Description
AccessTokenModel	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateTokenAsync(TokenLoginModel)

Declaration

public Task<AccessTokenModel> Token_CreateTokenAsync(TokenLoginModel login)

Parameters

Type	Name	Description
TokenLoginModel	login

Returns

Type	Description
Task<AccessTokenModel>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateTokenAsync(TokenLoginModel, CancellationToken)

Declaration

public 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>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateWindowsToken()

Declaration

public AccessTokenModel Token_CreateWindowsToken()

Returns

Type	Description
AccessTokenModel	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateWindowsTokenAsync()

Declaration

public Task<AccessTokenModel> Token_CreateWindowsTokenAsync()

Returns

Type	Description
Task<AccessTokenModel>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Token_CreateWindowsTokenAsync(CancellationToken)

Declaration

public 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>	or

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_AddItemsToTransaction(RepositoryTransactionAddItemsRequest)

Add items to a transaction to be registered

Declaration

public RepositoryTransaction Transaction_AddItemsToTransaction(RepositoryTransactionAddItemsRequest request)

Parameters

Type	Name	Description
RepositoryTransactionAddItemsRequest	request

Returns

Type	Description
RepositoryTransaction	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest)

Add items to a transaction to be registered

Declaration

public Task<RepositoryTransaction> Transaction_AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest request)

Parameters

Type	Name	Description
RepositoryTransactionAddItemsRequest	request

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest, CancellationToken)

Add items to a transaction to be registered

Declaration

public 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 or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CancelTransaction(RepositoryTransactionCancelOptions)

Cancel a transaction

Declaration

public RepositoryTransaction Transaction_CancelTransaction(RepositoryTransactionCancelOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCancelOptions	options

Returns

Type	Description
RepositoryTransaction	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CancelTransactionAsync(RepositoryTransactionCancelOptions)

Cancel a transaction

Declaration

public Task<RepositoryTransaction> Transaction_CancelTransactionAsync(RepositoryTransactionCancelOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCancelOptions	options

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CancelTransactionAsync(RepositoryTransactionCancelOptions, CancellationToken)

Cancel a transaction

Declaration

public 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 or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CommitTransaction(RepositoryTransactionCommitOptions)

Declaration

public RepositoryTransactionResult Transaction_CommitTransaction(RepositoryTransactionCommitOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCommitOptions	options

Returns

Type	Description
RepositoryTransactionResult	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CommitTransactionAsync(RepositoryTransactionCommitOptions)

Declaration

public Task<RepositoryTransactionResult> Transaction_CommitTransactionAsync(RepositoryTransactionCommitOptions options)

Parameters

Type	Name	Description
RepositoryTransactionCommitOptions	options

Returns

Type	Description
Task<RepositoryTransactionResult>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CommitTransactionAsync(RepositoryTransactionCommitOptions, CancellationToken)

Declaration

public 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 or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CreateTransaction()

Create a new Repository transaction

Declaration

public RepositoryTransaction Transaction_CreateTransaction()

Returns

Type	Description
RepositoryTransaction	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CreateTransactionAsync()

Create a new Repository transaction

Declaration

public Task<RepositoryTransaction> Transaction_CreateTransactionAsync()

Returns

Type	Description
Task<RepositoryTransaction>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_CreateTransactionAsync(CancellationToken)

Create a new Repository transaction

Declaration

public 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 or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetItemsInTransaction(Int64)

Get Transaction metadata

Declaration

public Collection<RepositoryItem> Transaction_GetItemsInTransaction(long transactionId)

Parameters

Type	Name	Description
Int64	transactionId

Returns

Type	Description
Collection<RepositoryItem>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetItemsInTransactionAsync(Int64)

Get Transaction metadata

Declaration

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

Parameters

Type	Name	Description
Int64	transactionId

Returns

Type	Description
Task<Collection<RepositoryItem>>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetItemsInTransactionAsync(Int64, CancellationToken)

Get Transaction metadata

Declaration

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

Parameters

Type	Name	Description
Int64	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 or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetTransactions(IEnumerable<Int64>)

Get Transaction metadata

Declaration

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

Parameters

Type	Name	Description
IEnumerable<Int64>	transactionIds

Returns

Type	Description
Collection<RepositoryTransaction>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetTransactionsAsync(IEnumerable<Int64>)

Get Transaction metadata

Declaration

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

Parameters

Type	Name	Description
IEnumerable<Int64>	transactionIds

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_GetTransactionsAsync(IEnumerable<Int64>, CancellationToken)

Get Transaction metadata

Declaration

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

Parameters

Type	Name	Description
IEnumerable<Int64>	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 or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_ListTransactions(RepositoryTransactionListOptions)

Get Transaction metadata

Declaration

public Collection<RepositoryTransaction> Transaction_ListTransactions(RepositoryTransactionListOptions options)

Parameters

Type	Name	Description
RepositoryTransactionListOptions	options

Returns

Type	Description
Collection<RepositoryTransaction>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_ListTransactionsAsync(RepositoryTransactionListOptions)

Get Transaction metadata

Declaration

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

Parameters

Type	Name	Description
RepositoryTransactionListOptions	options

Returns

Type	Description
Task<Collection<RepositoryTransaction>>	Transaction metadata or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

Transaction_ListTransactionsAsync(RepositoryTransactionListOptions, CancellationToken)

Get Transaction metadata

Declaration

public 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 or Transaction metadata

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumber(String, Guid)

Gets the latest version number of a repository item.

Declaration

public long VersionNumber_GetLatestVersionNumber(string agency, Guid id)

Parameters

Type	Name	Description
String	agency
Guid	id

Returns

Type	Description
Int64	The latest version number of the item. or The latest version number of the item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumberAsync(String, Guid)

Gets the latest version number of a repository item.

Declaration

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

Parameters

Type	Name	Description
String	agency
Guid	id

Returns

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

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 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<Int64>	The latest version number of the item. or The latest version number of the item.

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 long VersionNumber_GetLatestVersionNumberOfTag(string agency, Guid id, string tag)

Parameters

Type	Name	Description
String	agency
Guid	id
String	tag

Returns

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

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 Task<long> VersionNumber_GetLatestVersionNumberOfTagAsync(string agency, Guid id, string tag)

Parameters

Type	Name	Description
String	agency
Guid	id
String	tag

Returns

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

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 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<Int64>	The latest version number of the repository item with the tag. or The latest version number of the repository item with the tag.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumbers(GetLatestVersionNumbersRequest)

Gets the latest version numbers of multiple items.

Declaration

public 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. or A collection of identifiers containing the full identification, including latest version number, of the latest versions of the requested items.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumbersAsync(GetLatestVersionNumbersRequest)

Gets the latest version numbers of multiple items.

Declaration

public 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. or A collection of identifiers containing the full identification, including latest version number, of the latest versions of the requested items.

Exceptions

Type	Condition
RestApiException	A server side error occurred.

VersionNumber_GetLatestVersionNumbersAsync(GetLatestVersionNumbersRequest, CancellationToken)

Gets the latest version numbers of multiple items.

Declaration

public 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. or A collection of identifiers containing the full identification, including latest version number, of the latest versions of the requested items.

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 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. or A list of all versions of the specified item.

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 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. or A list of all versions of the specified item.

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 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. or A list of all versions of the specified item.

Exceptions

Type	Condition
RestApiException	A server side error occurred.