Agravity.Public 8.2.1

Agravity.Public - the C# library for the Agravity OpenAPI Documentation - Public Functions

<h1>Agravity API Reference</h1>This is the public API description of Agravity GmbH.<br/><h2>Resources</h2><ul> <li>Collection type management</li> <li>Collections management</li> <li>Assets management</li> <li>Assets operations</li> <li>Assets publishing</li> <li>Collection Sharing (consume share)</li> <li>Secure Upload (validate + upload file)</li> <li>Download ZIP</li> <li>Search</li> <li>General management</li></ul><h2> Operations</h2>Agravity API performs the following operations:<ul> <li>List / get single collection types</li> <li>List / get single collections</li> <li>List / get single assets</li> <li>Operations on assets like: blobs, rotate, resize, similar, collections, customfields, download</li> <li>List / get single published asset</li> <li>Search for assets or collections</li> <li>Get version of deployment</li></ul><br/><b>API key is needed to access these endpoints.</b><br/><br/>Copyright © Agravity GmbH 2024. All Rights Reserved

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

• API version: 8.2.1
• SDK version: 8.2.1
• Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://agravity.io

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

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

<a id="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

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 id="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

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

using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;

<a id="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 id="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;

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

            Configuration config = new Configuration();
            config.BasePath = "http://localhost:7072/api";
            // Configure API key authorization: function_key
            config.ApiKey.Add("x-functions-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("x-functions-key", "Bearer");

            var apiInstance = new PublicAssetManagementApi(config);
            var acceptLanguage = "acceptLanguage_example";  // string | The requested language of the response. If not matching it falls back to default language. (optional) 
            var name = "name_example";  // string |  (optional) 
            var collectionid = "collectionid_example";  // string |  (optional) 
            var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt"));  // System.IO.Stream |  (optional) 
            var filename = "filename_example";  // string |  (optional) 
            var previewof = "previewof_example";  // string |  (optional) 

            try
            {
                Asset result = apiInstance.HttpAssetUploadFile(acceptLanguage, name, collectionid, file, filename, previewof);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling PublicAssetManagementApi.HttpAssetUploadFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

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

Documentation for API Endpoints

All URIs are relative to http://localhost:7072/api

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

Documentation for Models

• Model.AgravityErrorResponse
• Model.AgravityInfoResponse
• Model.AgravityVersion
• Model.AllWebAppData
• Model.ArtificialIntelligenceGroup
• Model.Asset
• Model.AssetAvailability
• Model.AssetBlob
• Model.AssetIconRule
• Model.AssetIdFormat
• Model.AssetPageResult
• Model.AzSearchOptions
• Model.CollTypeItem
• Model.Collection
• Model.CollectionType
• Model.CollectionUDL
• Model.CollectionUDLListEntity
• Model.CollectionUDLReference
• Model.CreateSftpUserResult
• Model.DataResult
• Model.DeletedEntities
• Model.DistZipResponse
• Model.DownloadFormat
• Model.DynamicImageOperation
• Model.EntityId
• Model.EntityIdName
• Model.FrontendAppConfig
• Model.GroupAllAppData
• Model.MoveCollectionBody
• Model.PermissionEntity
• Model.Portal
• Model.PortalConfiguration
• Model.PortalLinks
• Model.PortalTheme
• Model.PortalZipRequest
• Model.PublishEntity
• Model.PublishedAsset
• Model.QuickShareFull
• Model.SasToken
• Model.SavedSearch
• Model.SearchAdminDataSourceStatus
• Model.SearchAdminIndexStatus
• Model.SearchAdminIndexerLastRun
• Model.SearchAdminIndexerStatus
• Model.SearchAdminSkillStatus
• Model.SearchAdminStatistics
• Model.SearchAdminStatus
• Model.SearchFacet
• Model.SearchFacetEntity
• Model.SearchResult
• Model.SearchableItem
• Model.SecureUploadEntity
• Model.SharedAllowedFormat
• Model.SharedAsset
• Model.SharedCollectionFull
• Model.SharedCollectionZipRequest
• Model.SignalRConnectionInfo
• Model.StaticDefinedList
• Model.VersionEntity
• Model.VersionedAsset
• Model.WhereParam
• Model.Workspace

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

Documentation for Authorization

Authentication schemes defined for the API: <a id="function_key"></a>

function_key

• Type: API key
• API key parameter name: x-functions-key
• Location: HTTP header