IVensService.Vens

Collection of functions to interact with the Vens API endpoint.

All URI’s are relative to the VTN URL configured.

Method	HTTP request	Description
CreateVenAsync	POST /vens	Create a ven
DeleteVenAsync	DELETE /vens/{venID}	Delete a ven
SearchVensAsync	GET /vens	Searches all vens
FindVenByIdAsync	GET /vens/{venID}	Searches vens by ven ID
UpdateVenAsync	PUT /vens/{venID}	Update a ven
CreateVenResourceAsync	POST /vens/{venID}/resources	Create ven resource
DeleteVenResourceAsync	DELETE /vens/{venID}/resources/{resourceID}	Delete ven resource
SearchVenResourcesAsync	GET /vens/{venID}/resources	Search ven resources
FindVenResourceByIdAsync	GET /vens/{venID}/resources/{resourceID}	Search ven resources by resource ID
UpdateVenResourceAsync	PUT /vens/{venID}/resources/{resourceID}	Update ven resource

Ven

---

CreateVenAsync

Task<Ven> CreateVenAsync(
    Ven ven,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Create a new ven in the server.

DeleteVenAsync

Task<Ven> DeleteVenAsync(
    string venId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Delete an existing ven with the ven ID.

SearchVensAsync

Task<List<Ven>> SearchVensAsync(
    string? targetType = default,
    List<string>? targetValues = default,
    int? skip = default,
    int? limit = default,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Searches all vens known to the server. Use skip and pagination query params to limit response size.

FindVenByIdAsync

Task<Ven> FindVenByIdAsync(
    string venId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Find ven associated by the ven ID.

UpdateVenAsync

Task<Ven> UpdateVenAsync(
    string venId,
    Ven ven,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Update an existing ven with specified ven ID.

Ven Resource

---

CreateVenResourceAsync

Task<Resource> CreateVenResourceAsync(
    string venId,
    Resource resource,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Create a new ven resource in the server.

DeleteVenResourceAsync

Task<Resource> DeleteVenResourceAsync(
    string venId,
    string resourceId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Delete an existing ven resource with the ven resource ID.

SearchVenResourcesAsync

Task<List<Resource>> SearchVenResourcesAsync(
    string venId,
    string? targetType = default,
    List<string>? targetValues = default,
    int? skip = default,
    int? limit = default,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Searches all ven resources known to the server. Use skip and pagination query params to limit response size.

FindVenResourceByIdAsync

Task<Resource> FindVenResourceByIdAsync(
    string venId,
    string resourceId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Find ven resource associated by the ven resource ID.

UpdateVenResourceAsync

Task<Resource> UpdateVenResourceAsync(
    string venId,
    string resourceId,
    Resource resource,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Update an existing ven resource with specified ven resource ID.