WebApi - FW

This is Swagger Docs for Framework WebApi Teamsystemn Enterprise Cloud, more detail at https://swagger.io.

This C# SDK is automatically generated by the Swagger Codegen project:

• API version: v2025.1000
• SDK version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.dotnet.CSharpClientCodegen For more information, please visit https://mysupport.teamsystem.com/

Frameworks supported

• .NET 4.7.1 or later

Dependencies

• RestSharp - 111.4.1 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.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

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following commands to generate the DLL

cd src/IO.Swagger
dotnet restore
dotnet build

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

using Api;
using Client;
using Model;

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 csproj

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

Getting Started

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

namespace Example
{
    public class Example
    {
        public void main()
        {
            // Configure HTTP basic authorization: Basic
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AsyncCatalogFWApi();
            var op = op_example;  // string | The value must be 'new'
            var environment = environment_example;  // string | 
            var authorizationScope = authorizationScope_example;  // string | The environment where this operation will be executed. This must match with the environment in the url.
            var company = company_example;  // string | Company code (optional) 
            var user = user_example;  // string | Application user (mandatory if the WebApi user does not have any mapped application user) (optional) 
            var acceptLanguage = acceptLanguage_example;  // string | Example for multilanguage (optional)  (default to it-IT)

            try
            {
                // Get new
                AsyncCatalogFWDTO result = apiInstance.ApiV1EnvironmentFWAsyncCatalogFWGet(op, environment, authorizationScope, company, user, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AsyncCatalogFWApi.ApiV1EnvironmentFWAsyncCatalogFWGet: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://apicsdemo.teamsystem.io

Class	Method	HTTP request	Description
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWGet	GET /api/v1/production/FW/AsyncCatalogFW	Get new
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWIdDelete	DELETE /api/v1/production/FW/AsyncCatalogFW/0	Delete
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWIdGet	GET /api/v1/production/FW/AsyncCatalogFW/0	Get by ID
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWIdPatch	PATCH /api/v1/production/FW/AsyncCatalogFW/0	Update partial
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWIdPut	PUT /api/v1/production/FW/AsyncCatalogFW/0	Update
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWPost	POST /api/v1/production/FW/AsyncCatalogFW	Create
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWReadPost	POST /api/v1/production/FW/AsyncCatalogFW/read	Read
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWSearchPost	POST /api/v1/production/FW/AsyncCatalogFW/search	Search
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWValidatePost	POST /api/v1/production/FW/AsyncCatalogFW/validate	Validate
AsyncCatalogFWApi	ApiV1EnvironmentFWAsyncCatalogFWValidatePropertiesPost	POST /api/v1/production/FW/AsyncCatalogFW/validateProperties	Validation of one on more properties of Type
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWGet	GET /api/v1/production/FW/AsyncSchedulerFW	Get new
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWIdDelete	DELETE /api/v1/production/FW/AsyncSchedulerFW/0	Delete
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWIdGet	GET /api/v1/production/FW/AsyncSchedulerFW/0	Get by ID
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWIdPatch	PATCH /api/v1/production/FW/AsyncSchedulerFW/0	Update partial
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWIdPut	PUT /api/v1/production/FW/AsyncSchedulerFW/0	Update
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWPost	POST /api/v1/production/FW/AsyncSchedulerFW	Create
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWReadPost	POST /api/v1/production/FW/AsyncSchedulerFW/read	Read
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWSearchPost	POST /api/v1/production/FW/AsyncSchedulerFW/search	Search
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWValidatePost	POST /api/v1/production/FW/AsyncSchedulerFW/validate	Validate
AsyncSchedulerFWApi	ApiV1EnvironmentFWAsyncSchedulerFWValidatePropertiesPost	POST /api/v1/production/FW/AsyncSchedulerFW/validateProperties	Validation of one on more properties of Type
EditPathFWApi	ApiV1EnvironmentFWEditPathFWGetfilePost	POST /api/v1/production/FW/EditPathFW/getfile	Get a file from Edit Path
EditPathFWApi	ApiV1EnvironmentFWEditPathFWGetfilelistPost	POST /api/v1/production/FW/EditPathFW/getfilelist	Get file list from Edit Path
EditPathFWApi	ApiV1EnvironmentFWEditPathFWRemovefilePost	POST /api/v1/production/FW/EditPathFW/removefile	Remove a file Edit Path for error
EditPathFWApi	ApiV1EnvironmentFWEditPathFWUploadfilePost	POST /api/v1/production/FW/EditPathFW/uploadfile	Upload a file to Edit Path
LicenseFWApi	ApiV1EnvironmentFWLicenseFWInfoIdGet	GET /api/v1/production/FW/LicenseFW/info/0	Get information about a license (validity, number of seats, quantity, demo license)

Documentation for Models

• Model.ApproveLicenseFWDTO
• Model.AsyncCatalogFWDTO
• Model.AsyncSchedulerFWDTO
• Model.EditPathFWUploadfileBody
• Model.FileEditPathParamsDTO
• Model.FileListEditPathParamsDTO
• Model.FileListEditPathResultDTO
• Model.GetEditPathParamsDTO
• Model.OneOfSearchGroupDTOItemsItems
• Model.SearchDTO
• Model.SearchElementDTO
• Model.SearchGroupDTO
• Model.SearchNodeDTO
• Model.SearchNodeValueDTO
• Model.StringObjectKeyValuePair
• Model.ValidateDTO
• Model.ValidationResultDTO

Documentation for Authorization

Basic

• Type: HTTP basic authentication

Bearer