Directus .NET/C# SDK

Website • Docs • API Reference • User Guide • Demo • Contribute

This codebase is a work-in-progress. The repo is here as a placeholder for anyone interested in contributing to the software development kit. Pull-requests and contributions are welcome!

This C# SDK was initially automatically generated by the Swagger Codegen project, and later adapted by @mghextreme to support .NET Core and .NET Standard.

• API version: 1.1
• SDK version: 2.0.0
• Build package: io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

• .NET Standard 2.0
  • .NET Core 2.0 or later
  • .NET Framework 4.6.1 or later

Dependencies

• Microsoft.CSharp - 4.5.0 or later
• RestSharp - 106.6.9 or later
• Json.NET - 12.0.2 or later
• System.ComponentModel.Annotations - 4.5.0 or later

To restore the latest versions using [NuGet] (https://docs.nuget.org/consume/installing-nuget), run the following command:

dotnet restore

Building

To build the package, either run the VSCode key shortcut Ctrl + Shift + B or run the dotnet build command.

Packaging

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

If you use VSCode, you can easily pack by using the Ctrl + Shift + P key shortcut, Run Task and selecting pack

It is not mandatory, but you may publish to a local feed or other host and consume the new package via Nuget as usual.

Installation

The package may now be installed in your project using either dotnet add (.NET CLI) or Install-Package (Package Manager).

In your project, use the following namespaces to use the Directus SDK.

using IO.Directus.Api;
using IO.Directus.Client;
using IO.Directus.Model;

Getting Started

using System;
using System.Diagnostics;
using IO.Directus.Api;
using IO.Directus.Client;
using IO.Directus.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            Configuration.Default.BasePath = "https://myinstance.directus.io/api/1.1";

            var apiInstance = new ActivityApi();

            try
            {
                // Returns activity
                GetActivity result = apiInstance.GetActivity();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActivityApi.GetActivity: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to your configured base path, as per example.

Documentation for Models

• Model.GetActivity
• Model.GetActivityData
• Model.GetActivityMeta
• Model.GetBookmark
• Model.GetBookmarks
• Model.GetBookmarksData
• Model.GetBookmarksMeta
• Model.GetFile
• Model.GetFiles
• Model.GetFilesData
• Model.GetGroup
• Model.GetGroups
• Model.GetGroupsData
• Model.GetGroupsDataData
• Model.GetGroupsDataMeta
• Model.GetMessage
• Model.GetMessages
• Model.GetMessagesData
• Model.GetMessagesMeta
• Model.GetMessagesResponses
• Model.GetPreferences
• Model.GetPreferencesData
• Model.GetPrivileges
• Model.GetPrivilegesData
• Model.GetPrivilegesForTable
• Model.GetSettings
• Model.GetSettingsData
• Model.GetSettingsDataFiles
• Model.GetSettingsDataGlobal
• Model.GetSettingsFor
• Model.GetSettingsForMeta
• Model.GetTable
• Model.GetTableColumn
• Model.GetTableColumnData
• Model.GetTableColumns
• Model.GetTableColumnsData
• Model.GetTableData
• Model.GetTableRow
• Model.GetTableRows
• Model.GetTableRowsData
• Model.GetTableRowsMeta
• Model.GetTables
• Model.GetTablesData
• Model.GetTablesMeta

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: access_token
• Location: URL query string

Directus is released under the GPLv3 license. RANGER Studio LLC owns all Directus trademarks and logos on behalf of our project's community. Copyright © 2006-2018, RANGER Studio LLC.