IProgramsService.Programs

Collection of functions to interact with the Programs API endpoint.

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

Method	HTTP request	Description
CreateProgramAsync	POST /programs	Create a program
DeleteProgramAsync	DELETE /programs/{programID}	Delete a program
SearchProgramsAsync	GET /programs	Searches all programs
FindProgramByIdAsync	GET /programs/{programID}	Searches programs by program ID
UpdateProgramAsync	PUT /programs/{programID}	Update a program

CreateProgramAsync

Task<Program> CreateProgramAsync(
    Program program,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Create a new program in the server.

DeleteProgramAsync

Task<Program> DeleteProgramAsync(
    string programId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Delete an existing program with the program ID.

SearchProgramsAsync

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

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

FindProgramByIdAsync

Task<Program> FindProgramByIdAsync(
    string programId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Find program associated by the program ID.

UpdateProgramAsync

Task<Program> UpdateProgramAsync(
    string programId,
    Program program,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Update an existing program with specified program ID.