Dastra.Client 1.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Dastra.Client --version 1.0.1                

                    
                

            
NuGet\Install-Package Dastra.Client -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Dastra.Client" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Dastra.Client --version 1.0.1                

                    
                

            
#r "nuget: Dastra.Client, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Dastra.Client as a Cake Addin
#addin nuget:?package=Dastra.Client&version=1.0.1

// Install Dastra.Client as a Cake Tool
#tool nuget:?package=Dastra.Client&version=1.0.1

Dastra.Client - the C# library for the Dastra API

Dastra's public REST API

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://www.dastra.eu

<a name="frameworks-supported"></a>

Frameworks supported

<a name="dependencies"></a>

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Dastra.Client.Api;
using Dastra.Client.Client;
using Dastra.Client.Model;

<a name="packaging"></a>

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Dastra.Client.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Dastra.Client.Api;
using Dastra.Client.Client;
using Dastra.Client.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://localhost:44362";
            // Configure HTTP basic authorization: basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActorsApi(config);
            var workspaceId = workspaceId_example;  // string | 

            try
            {
                apiInstance.ActorsColumns(workspaceId);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ActorsApi.ActorsColumns: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://localhost:44362

Class Method HTTP request Description
ActorsApi ActorsColumns GET /v1/ws/{workspaceId}/Actors/columns
ActorsApi ActorsCreate POST /v1/ws/{workspaceId}/Actors Create a new actor
ActorsApi ActorsDelete DELETE /v1/ws/{workspaceId}/Actors/{id} Remove the actor with his id
ActorsApi ActorsDeleteBatch DELETE /v1/ws/{workspaceId}/Actors
ActorsApi ActorsExport POST /v1/ws/{workspaceId}/Actors/export/{format} Export the records in any format
ActorsApi ActorsFind GET /v1/ws/{workspaceId}/Actors/{id} Get a single actor with his id
ActorsApi ActorsList GET /v1/ws/{workspaceId}/Actors Get all actors (User inserted in the record of processing activities)
ActorsApi ActorsPatch PATCH /v1/ws/{workspaceId}/Actors/{id}
ActorsApi ActorsUpdate PUT /v1/ws/{workspaceId}/Actors/{id} Edit the actor's properties
ApplicationsApi ApplicationsColumns GET /v1/ws/{workspaceId}/Applications/columns Get all columns of an application
ApplicationsApi ApplicationsCreate POST /v1/ws/{workspaceId}/Applications Create a new application
ApplicationsApi ApplicationsDelete DELETE /v1/ws/{workspaceId}/Applications/{id} Delete an application
ApplicationsApi ApplicationsDeleteBatch DELETE /v1/ws/{workspaceId}/Applications
ApplicationsApi ApplicationsFind GET /v1/ws/{workspaceId}/Applications/{id} Get an application with his id
ApplicationsApi ApplicationsJsonPatchWithModelState PATCH /v1/ws/{workspaceId}/Applications/{id} Patch an application
ApplicationsApi ApplicationsList GET /v1/ws/{workspaceId}/Applications Get all linked applications
ApplicationsApi ApplicationsUpdate PUT /v1/ws/{workspaceId}/Applications/{id} Edit an application
AuditAttachmentsApi AuditAttachmentsDelete DELETE /v1/ws/{workspaceId}/AuditAttachments/{id}/{fileId} Remove an attachment
AuditAttachmentsApi AuditAttachmentsDownload GET /v1/ws/{workspaceId}/AuditAttachments/{id}/{fileId}/download Simple doc upload
AuditResponseTasksApi AuditResponseTasksCreate POST /v1/ws/{workspaceId}/AuditResponseTasks/{responseId}
AuditResponseTasksApi AuditResponseTasksDelete DELETE /v1/ws/{workspaceId}/AuditResponseTasks/{responseId}/{id}
AuditResponseTasksApi AuditResponseTasksUpdate PUT /v1/ws/{workspaceId}/AuditResponseTasks/{responseId}/{id}
AuditResponsesApi AuditResponsesArchiveAuditResponse PUT /v1/ws/{workspaceId}/AuditResponses/archive/{id}
AuditResponsesApi AuditResponsesCancelAuditResponse PUT /v1/ws/{workspaceId}/AuditResponses/cancel/{id} Cancel an audit
AuditResponsesApi AuditResponsesColumns GET /v1/ws/{workspaceId}/AuditResponses/columns
AuditResponsesApi AuditResponsesCreatePlanification POST /v1/ws/{workspaceId}/AuditResponses/planification Planification post
AuditResponsesApi AuditResponsesDeleteAuditResponse DELETE /v1/ws/{workspaceId}/AuditResponses/{id}
AuditResponsesApi AuditResponsesExport POST /v1/ws/{workspaceId}/AuditResponses/export/{format} Export the records in any format
AuditResponsesApi AuditResponsesFinalize PUT /v1/ws/{workspaceId}/AuditResponses/finalize/{id}
AuditResponsesApi AuditResponsesFind GET /v1/ws/{workspaceId}/AuditResponses/{id}
AuditResponsesApi AuditResponsesGenerateActionPlan POST /v1/ws/{workspaceId}/AuditResponses/action-plan-generation/{id}
AuditResponsesApi AuditResponsesGetMatrixAudit GET /v1/ws/{workspaceId}/AuditResponses/matrix/{templateId}
AuditResponsesApi AuditResponsesGetStats GET /v1/ws/{workspaceId}/AuditResponses/stats
AuditResponsesApi AuditResponsesInviteToAuditResponse PUT /v1/ws/{workspaceId}/AuditResponses/invite/{id} Send the audit invitation
AuditResponsesApi AuditResponsesList GET /v1/ws/{workspaceId}/AuditResponses
AuditResponsesApi AuditResponsesRefuse PUT /v1/ws/{workspaceId}/AuditResponses/refuse/{id} Refuse audit response
AuditResponsesApi AuditResponsesRenew POST /v1/ws/{workspaceId}/AuditResponses/renew
AuditResponsesApi AuditResponsesRestoreAuditResponse PUT /v1/ws/{workspaceId}/AuditResponses/restore/{id}
AuditResponsesApi AuditResponsesUpdate PUT /v1/ws/{workspaceId}/AuditResponses/update/{id}
AuditResponsesApi AuditResponsesUpdatePlanification PUT /v1/ws/{workspaceId}/AuditResponses/planification/{id}
AuditResponsesApi AuditResponsesUpdateRisk PUT /v1/ws/{workspaceId}/AuditResponses/set-risk/{id}
AuditResponsesApi AuditResponsesUpdateState PUT /v1/ws/{workspaceId}/AuditResponses/set-state/{id}
AuditResponsesApi AuditResponsesValidate PUT /v1/ws/{workspaceId}/AuditResponses/validate/{id}
AuditTemplatesApi AuditTemplatesColumns GET /v1/ws/{workspaceId}/AuditTemplates/columns
AuditTemplatesApi AuditTemplatesCreate POST /v1/ws/{workspaceId}/AuditTemplates
AuditTemplatesApi AuditTemplatesCreateVersion POST /v1/ws/{workspaceId}/AuditTemplates/new-version/{id}
AuditTemplatesApi AuditTemplatesDelete DELETE /v1/ws/{workspaceId}/AuditTemplates/{id} Remove a specified template
AuditTemplatesApi AuditTemplatesExport POST /v1/ws/{workspaceId}/AuditTemplates/export/{format} Export the records in any format
AuditTemplatesApi AuditTemplatesFind GET /v1/ws/{workspaceId}/AuditTemplates/{id} Get a unique audit template
AuditTemplatesApi AuditTemplatesImportOrCombine POST /v1/ws/{workspaceId}/AuditTemplates/generate-template Generates a specified template from the library
AuditTemplatesApi AuditTemplatesList GET /v1/ws/{workspaceId}/AuditTemplates Search for an audit template (paginated list)
AuditTemplatesApi AuditTemplatesPutAuditTemplate PUT /v1/ws/{workspaceId}/AuditTemplates/{id}
AuditTemplatesApi AuditTemplatesReplicate POST /v1/ws/{workspaceId}/AuditTemplates/duplicate/{id} Replicate a specified template
CategoriesApi CategoriesFind GET /v1/Categories/{id} Return a category from blog
CategoriesApi CategoriesList GET /v1/Categories Return tag lists
CommentsApi CommentsCount GET /v1/ws/{workspaceId}/Comments/count Count number of comments for display purposes
CommentsApi CommentsCreate POST /v1/ws/{workspaceId}/Comments Create a new comment
CommentsApi CommentsDelete DELETE /v1/ws/{workspaceId}/Comments/{id} Delete a comment by id
CommentsApi CommentsFind GET /v1/ws/{workspaceId}/Comments/{id} Get a comment by id
CommentsApi CommentsList GET /v1/ws/{workspaceId}/Comments Get all comments by objectId and objectType
CommentsApi CommentsUpdate PUT /v1/ws/{workspaceId}/Comments/{id} Edit comment
ContentsApi ContentsFind GET /v1/Contents/{id} Get article by id
ContentsApi ContentsFindByUrl GET /v1/Contents/url/{url} Get article by url
ContentsApi ContentsList GET /v1/Contents Contents (blog's articles, news) paginated list
DataBreachsApi DataBreachsArchive POST /v1/ws/{workspaceId}/DataBreachs/archive/{id}
DataBreachsApi DataBreachsColumns GET /v1/ws/{workspaceId}/DataBreachs/columns
DataBreachsApi DataBreachsCreate POST /v1/ws/{workspaceId}/DataBreachs
DataBreachsApi DataBreachsDelete DELETE /v1/ws/{workspaceId}/DataBreachs/{id}
DataBreachsApi DataBreachsExport GET /v1/ws/{workspaceId}/DataBreachs/export/{format} Export the records in any format
DataBreachsApi DataBreachsFind GET /v1/ws/{workspaceId}/DataBreachs/{id}
DataBreachsApi DataBreachsList GET /v1/ws/{workspaceId}/DataBreachs Get the databreach list
DataBreachsApi DataBreachsRestore POST /v1/ws/{workspaceId}/DataBreachs/restore/{id}
DataBreachsApi DataBreachsUpdate PUT /v1/ws/{workspaceId}/DataBreachs/{id} Put a databreach
DataBreachsApi DataBreachsUpdateWorkflow POST /v1/ws/{workspaceId}/DataBreachs/workflow Switching the current state
DataFieldsApi DataFieldsColumns GET /v1/ws/{workspaceId}/DataFields/columns List columns
DataFieldsApi DataFieldsCreate POST /v1/ws/{workspaceId}/DataFields Create a field
DataFieldsApi DataFieldsDelete DELETE /v1/ws/{workspaceId}/DataFields/{id} Delete by id
DataFieldsApi DataFieldsFind GET /v1/ws/{workspaceId}/DataFields/{id} Find a datafield
DataFieldsApi DataFieldsList GET /v1/ws/{workspaceId}/DataFields List data fields
DataFieldsApi DataFieldsPatch PATCH /v1/ws/{workspaceId}/DataFields/{id} Patch a data field
DataFieldsApi DataFieldsUpdate PUT /v1/ws/{workspaceId}/DataFields/{id} Update a data field
DataProcessingRelationshipsApi DataProcessingRelationshipsCreate POST /v1/ws/{workspaceId}/DataProcessingRelationships/{id} Saving or updating a datatreatment
DataProcessingRelationshipsApi DataProcessingRelationshipsDelete DELETE /v1/ws/{workspaceId}/DataProcessingRelationships/{id}
DataProcessingRelationshipsApi DataProcessingRelationshipsList GET /v1/ws/{workspaceId}/DataProcessingRelationships/{dataProcessingId} Get data treatment by id
DataProcessingsApi DataProcessingsAddRecipientBatch POST /v1/ws/{workspaceId}/DataProcessings/recipients/batch Add to batch
DataProcessingsApi DataProcessingsArchive POST /v1/ws/{workspaceId}/DataProcessings/archive/{id} Register insights
DataProcessingsApi DataProcessingsColumns GET /v1/ws/{workspaceId}/DataProcessings/columns
DataProcessingsApi DataProcessingsCreate POST /v1/ws/{workspaceId}/DataProcessings Creating a record of processing
DataProcessingsApi DataProcessingsDelete DELETE /v1/ws/{workspaceId}/DataProcessings/{id}
DataProcessingsApi DataProcessingsDeleteBatch DELETE /v1/ws/{workspaceId}/DataProcessings Batch delete using a delete + a body param
DataProcessingsApi DataProcessingsDuplicate POST /v1/ws/{workspaceId}/DataProcessings/{id}/duplicate Duplicate a data treatment object
DataProcessingsApi DataProcessingsExport POST /v1/ws/{workspaceId}/DataProcessings/export/{format} Export the records in any format
DataProcessingsApi DataProcessingsFind GET /v1/ws/{workspaceId}/DataProcessings/{id} Get data processing record by id
DataProcessingsApi DataProcessingsGetRecipients GET /v1/ws/{workspaceId}/DataProcessings/recipients/{actorId}
DataProcessingsApi DataProcessingsInsights POST /v1/ws/{workspaceId}/DataProcessings/insights
DataProcessingsApi DataProcessingsList GET /v1/ws/{workspaceId}/DataProcessings Get data treatments (Paginated)
DataProcessingsApi DataProcessingsListPurposes GET /v1/ws/{workspaceId}/DataProcessings/purposes/{id}
DataProcessingsApi DataProcessingsNodes GET /v1/ws/{workspaceId}/DataProcessings/nodes Get data treatments (Paginated)
DataProcessingsApi DataProcessingsPatchDataTreatment PATCH /v1/ws/{workspaceId}/DataProcessings/{id} Patching a data processing with his id
DataProcessingsApi DataProcessingsRestore POST /v1/ws/{workspaceId}/DataProcessings/restore/{id} registerInsights DataTreatment Archiving
DataProcessingsApi DataProcessingsRestoreHistory POST /v1/ws/{workspaceId}/DataProcessings/restore-history
DataProcessingsApi DataProcessingsStats GET /v1/ws/{workspaceId}/DataProcessings/stats
DataProcessingsApi DataProcessingsSwitchWorkflowStep POST /v1/ws/{workspaceId}/DataProcessings/workflow Switching the current state
DataProcessingsApi DataProcessingsTree GET /v1/ws/{workspaceId}/DataProcessings/tree Get data treatments (Paginated)
DataProcessingsApi DataProcessingsUpdate PUT /v1/ws/{workspaceId}/DataProcessings Saving or updating a data processing record
DataRetentionRulesApi DataRetentionRulesColumns GET /v1/ws/{workspaceId}/DataRetentionRules/columns
DataRetentionRulesApi DataRetentionRulesCreate POST /v1/ws/{workspaceId}/DataRetentionRules Create a dataset
DataRetentionRulesApi DataRetentionRulesDelete DELETE /v1/ws/{workspaceId}/DataRetentionRules/{id} Delete a dataset
DataRetentionRulesApi DataRetentionRulesFind GET /v1/ws/{workspaceId}/DataRetentionRules/{id} Get a dataset
DataRetentionRulesApi DataRetentionRulesList GET /v1/ws/{workspaceId}/DataRetentionRules List datasets
DataRetentionRulesApi DataRetentionRulesPatch PATCH /v1/ws/{workspaceId}/DataRetentionRules/{id} Patch a data field
DataRetentionRulesApi DataRetentionRulesUpdate PUT /v1/ws/{workspaceId}/DataRetentionRules/{id} Edit a dataset
DataSubjectMessagesApi DataSubjectMessagesDelete DELETE /v1/ws/{workspaceId}/DataSubjectMessages/{id} Delete customer request
DataSubjectMessagesApi DataSubjectMessagesDeleteAttachment DELETE /v1/ws/{workspaceId}/DataSubjectMessages/attachments/{id} Remove attachment linked to the request
DataSubjectMessagesApi DataSubjectMessagesDownloadFile GET /v1/ws/{workspaceId}/DataSubjectMessages/download/{id} Simple doc upload
DataSubjectMessagesApi DataSubjectMessagesFind GET /v1/ws/{workspaceId}/DataSubjectMessages/{id}
DataSubjectMessagesApi DataSubjectMessagesList GET /v1/ws/{workspaceId}/DataSubjectMessages Customer request
DataSubjectRequestsApi DataSubjectRequestsArchive POST /v1/ws/{workspaceId}/DataSubjectRequests/archive/{id} Archive an existing user request by id It set the current state of the request to "Archived" state
DataSubjectRequestsApi DataSubjectRequestsColumns GET /v1/ws/{workspaceId}/DataSubjectRequests/columns
DataSubjectRequestsApi DataSubjectRequestsCreate POST /v1/ws/{workspaceId}/DataSubjectRequests
DataSubjectRequestsApi DataSubjectRequestsDelete DELETE /v1/ws/{workspaceId}/DataSubjectRequests/{id} Delete a data subject
DataSubjectRequestsApi DataSubjectRequestsExport POST /v1/ws/{workspaceId}/DataSubjectRequests/export/{format} Export the records in any format
DataSubjectRequestsApi DataSubjectRequestsFind GET /v1/ws/{workspaceId}/DataSubjectRequests/{id} Get an existing user request by id
DataSubjectRequestsApi DataSubjectRequestsList GET /v1/ws/{workspaceId}/DataSubjectRequests User request list
DataSubjectRequestsApi DataSubjectRequestsPatch PATCH /v1/ws/{workspaceId}/DataSubjectRequests/{id} Patch an application
DataSubjectRequestsApi DataSubjectRequestsRestore POST /v1/ws/{workspaceId}/DataSubjectRequests/restore/{id}
DataSubjectRequestsApi DataSubjectRequestsSetIdentityValidation PUT /v1/ws/{workspaceId}/DataSubjectRequests/set-identity-validation/{id} Switching the identity validation state
DataSubjectRequestsApi DataSubjectRequestsStats GET /v1/ws/{workspaceId}/DataSubjectRequests/stats
DataSubjectRequestsApi DataSubjectRequestsUpdate PUT /v1/ws/{workspaceId}/DataSubjectRequests/{id} Edit a user request
DataSubjectRequestsApi DataSubjectRequestsUpdateWorkflow POST /v1/ws/{workspaceId}/DataSubjectRequests/workflow Switching the current state
DataTransfersApi DataTransfersColumns GET /v1/ws/{workspaceId}/DataTransfers/columns
DataTransfersApi DataTransfersList GET /v1/ws/{workspaceId}/DataTransfers Get data treatments (Paginated)
GenericRelationshipsApi GenericRelationshipsCreate POST /v1/ws/{workspaceId}/GenericRelationships Saving or updating a datatreatment
GenericRelationshipsApi GenericRelationshipsDelete DELETE /v1/ws/{workspaceId}/GenericRelationships/{id}
GenericRelationshipsApi GenericRelationshipsList GET /v1/ws/{workspaceId}/GenericRelationships List all data
GenericRelationshipsApi GenericRelationshipsUpdate PUT /v1/ws/{workspaceId}/GenericRelationships/{id} Saving or updating a datatreatment
IterationsApi IterationsCreate POST /v1/ws/{workspaceId}/Iterations
IterationsApi IterationsDelete DELETE /v1/ws/{workspaceId}/Iterations/{id} Delete an iteration
IterationsApi IterationsFind GET /v1/ws/{workspaceId}/Iterations/{id}
IterationsApi IterationsList GET /v1/ws/{workspaceId}/Iterations
IterationsApi IterationsUpdate PUT /v1/ws/{workspaceId}/Iterations/{id}
LogsApi LogsExport GET /v1/Logs/export Download logs as csv
LogsApi LogsHistory GET /v1/Logs/history Log history for a specific user
LogsApi LogsList GET /v1/Logs Get logs
NodesApi NodesNodes GET /v1/ws/{workspaceId}/Nodes Get a single node linked items
ProjectsApi ProjectsArchiveProject POST /v1/ws/{workspaceId}/Projects/archive/{id}
ProjectsApi ProjectsCreate POST /v1/ws/{workspaceId}/Projects
ProjectsApi ProjectsFind GET /v1/ws/{workspaceId}/Projects/{id}
ProjectsApi ProjectsList GET /v1/ws/{workspaceId}/Projects
ProjectsApi ProjectsUpdate PUT /v1/ws/{workspaceId}/Projects/{id}
RisksApi RisksColumns GET /v1/ws/{workspaceId}/Risks/columns
RisksApi RisksCreate POST /v1/ws/{workspaceId}/Risks
RisksApi RisksDelete DELETE /v1/ws/{workspaceId}/Risks/{id}
RisksApi RisksFind GET /v1/ws/{workspaceId}/Risks/{id} Find a risk by his id
RisksApi RisksList GET /v1/ws/{workspaceId}/Risks List all risks
RisksApi RisksStats GET /v1/ws/{workspaceId}/Risks/stats
RisksApi RisksUpdate PUT /v1/ws/{workspaceId}/Risks/{id}
SecurityMeasuresApi SecurityMeasuresColumns GET /v1/ws/{workspaceId}/SecurityMeasures/columns List available column for security measure
SecurityMeasuresApi SecurityMeasuresCreate POST /v1/ws/{workspaceId}/SecurityMeasures Create a new security measure
SecurityMeasuresApi SecurityMeasuresDelete DELETE /v1/ws/{workspaceId}/SecurityMeasures/{id} Delete a security measure
SecurityMeasuresApi SecurityMeasuresDeleteBatch DELETE /v1/ws/{workspaceId}/SecurityMeasures
SecurityMeasuresApi SecurityMeasuresFind GET /v1/ws/{workspaceId}/SecurityMeasures/{id} Get security measure by id
SecurityMeasuresApi SecurityMeasuresList GET /v1/ws/{workspaceId}/SecurityMeasures
SecurityMeasuresApi SecurityMeasuresUpdate PUT /v1/ws/{workspaceId}/SecurityMeasures/{id} Update an existing security measure
SecurityUpdateAlertsApi SecurityUpdateAlertsNotification POST /v1/securityupdatealerts/notification Send a notification to all users
StatusApi StatusMe GET /me
StatusApi StatusStatus GET /status
TagsApi TagsCreate POST /v1/ws/{workspaceId}/Tags Create a tag
TagsApi TagsDelete DELETE /v1/ws/{workspaceId}/Tags/{id} Delete the tag
TagsApi TagsFind GET /v1/ws/{workspaceId}/Tags/{id}
TagsApi TagsList GET /v1/ws/{workspaceId}/Tags Get all tags
TagsApi TagsUpdate PUT /v1/ws/{workspaceId}/Tags/{id} Edit tag
TasksApi TasksArchive POST /v1/ws/{workspaceId}/Tasks/{id}/archive
TasksApi TasksBurnDownChart GET /v1/ws/{workspaceId}/Tasks/burn-down-chart
TasksApi TasksColumns GET /v1/ws/{workspaceId}/Tasks/columns Columns available for table display
TasksApi TasksCount GET /v1/ws/{workspaceId}/Tasks/count
TasksApi TasksCreate POST /v1/ws/{workspaceId}/Tasks Task creation
TasksApi TasksCumulativeFlowChart GET /v1/ws/{workspaceId}/Tasks/cumulative-flow-chart
TasksApi TasksDelete DELETE /v1/ws/{workspaceId}/Tasks/{id}
TasksApi TasksDeleteBatch DELETE /v1/ws/{workspaceId}/Tasks Batch delete using a delete + a body param
TasksApi TasksExport POST /v1/ws/{workspaceId}/Tasks/export/{format} Export the records in any format
TasksApi TasksFind GET /v1/ws/{workspaceId}/Tasks/{id} Get a single task by id
TasksApi TasksList GET /v1/ws/{workspaceId}/Tasks
TasksApi TasksListGrouped GET /v1/ws/{workspaceId}/Tasks/grouped Get tasks grouped by workflow steps
TasksApi TasksPatch PATCH /v1/ws/{workspaceId}/Tasks/{id}
TasksApi TasksReporting GET /v1/ws/{workspaceId}/Tasks/task-reporting
TasksApi TasksSortOrder POST /v1/ws/{workspaceId}/Tasks/sortOrder Switching the current state of the element Using this system https://stackoverflow.com/questions/398425/maintaining-sort-order-of-database-table-rows
TasksApi TasksStats GET /v1/ws/{workspaceId}/Tasks/stats
TasksApi TasksUpdate PUT /v1/ws/{workspaceId}/Tasks/{id} Task update
TasksApi TasksUpdateWorkflow POST /v1/ws/{workspaceId}/Tasks/workflow Switching the current state of the element
TasksApi TasksVelocityChart GET /v1/ws/{workspaceId}/Tasks/velocity-chart
TasksApi TasksWorkflowStats GET /v1/ws/{workspaceId}/Tasks/workflow-stats Get the workflow stats
UserTasksApi UserTasksGet GET /v1/UserTasks Get the assigned user tasks
WebHookUrlsApi WebHookUrlsCreate POST /v1/WebHookUrls Post a new webhook url
WebHookUrlsApi WebHookUrlsDelete DELETE /v1/WebHookUrls/{id} Delete webhook url
WebHookUrlsApi WebHookUrlsFind GET /v1/WebHookUrls/{id} Get webhook by id
WebHookUrlsApi WebHookUrlsList GET /v1/WebHookUrls Get all webhooks urls configured in workspace
WebHookUrlsApi WebHookUrlsTest POST /v1/WebHookUrls/test For testing a payload request webhook
WebHookUrlsApi WebHookUrlsTestSample GET /v1/WebHookUrls/test/{evt}
WebHookUrlsApi WebHookUrlsUpdate PUT /v1/WebHookUrls/{id} Edit webhook url
WorkFlowsApi WorkFlowsFind GET /v1/ws/{workspaceId}/WorkFlows/{type} Get workflows
WorkFlowsApi WorkFlowsList GET /v1/ws/{workspaceId}/WorkFlows Get the complete
WorkFlowsApi WorkFlowsUpdate PUT /v1/ws/{workspaceId}/WorkFlows Save workflow steps in database

<a name="documentation-for-models"></a>

Documentation for Models

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="basic"></a>

basic

  • Type: HTTP basic authentication

<a name="oauth2"></a>

oauth2

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://localhost:44375/connect/authorize
  • Scopes:
    • api1: Access operations

<a name="oauth2"></a>

oauth2

  • Type: OAuth
  • Flow: application
  • Authorization URL: https://localhost:44375/connect/authorize
  • Scopes:
    • api1: Access operations
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.13 336 11/2/2023
1.0.12 143 11/2/2023
1.0.11 254 10/4/2023
1.0.10 182 7/13/2023
1.0.9 465 5/4/2023
1.0.8 149 5/4/2023
1.0.7 282 4/4/2023
1.0.6 232 3/29/2023
1.0.5 301 3/13/2023
1.0.4 576 12/21/2022
1.0.3 466 11/15/2022
1.0.2 405 10/30/2022
1.0.1 456 9/6/2022
1.0.0 390 9/6/2022

Initial release