Skip to content

Latest commit

 

History

History
510 lines (374 loc) · 13.2 KB

ViewDependencyApi.md

File metadata and controls

510 lines (374 loc) · 13.2 KB

Com.Gridly.Api.ViewDependencyApi

All URIs are relative to https://api.gridly.com

Method HTTP request Description
Create POST /v1/views/{viewId}/dependencies create
Delete DELETE /v1/views/{viewId}/dependencies delete
DeleteById DELETE /v1/views/{viewId}/dependencies/{dependencyId} deleteById
Get GET /v1/views/{viewId}/dependencies/{dependencyId} get
List GET /v1/views/{viewId}/dependencies list
Update PUT /v1/views/{viewId}/dependencies/{dependencyId} update

Create

Dependency Create (string viewId, CreateDependency createDependency)

create

create

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Gridly.Api;
using Com.Gridly.Client;
using Com.Gridly.Model;

namespace Example
{
    public class CreateExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.gridly.com";
            // Configure API key authorization: ApiKey
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ViewDependencyApi(Configuration.Default);
            var viewId = "viewId_example";  // string | viewId
            var createDependency = new CreateDependency(); // CreateDependency | 

            try
            {
                // create
                Dependency result = apiInstance.Create(viewId, createDependency);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewDependencyApi.Create: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
viewId string viewId
createDependency CreateDependency

Return type

Dependency

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Delete

void Delete (string viewId, DeleteDependency deleteDependency)

delete

delete

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Gridly.Api;
using Com.Gridly.Client;
using Com.Gridly.Model;

namespace Example
{
    public class DeleteExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.gridly.com";
            // Configure API key authorization: ApiKey
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ViewDependencyApi(Configuration.Default);
            var viewId = "viewId_example";  // string | viewId
            var deleteDependency = new DeleteDependency(); // DeleteDependency | 

            try
            {
                // delete
                apiInstance.Delete(viewId, deleteDependency);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewDependencyApi.Delete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
viewId string viewId
deleteDependency DeleteDependency

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteById

void DeleteById (string viewId, string dependencyId)

deleteById

deleteById

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Gridly.Api;
using Com.Gridly.Client;
using Com.Gridly.Model;

namespace Example
{
    public class DeleteByIdExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.gridly.com";
            // Configure API key authorization: ApiKey
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ViewDependencyApi(Configuration.Default);
            var viewId = "viewId_example";  // string | viewId
            var dependencyId = "dependencyId_example";  // string | dependencyId

            try
            {
                // deleteById
                apiInstance.DeleteById(viewId, dependencyId);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewDependencyApi.DeleteById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
viewId string viewId
dependencyId string dependencyId

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get

Dependency Get (string dependencyId, string viewId)

get

get

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Gridly.Api;
using Com.Gridly.Client;
using Com.Gridly.Model;

namespace Example
{
    public class GetExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.gridly.com";
            // Configure API key authorization: ApiKey
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ViewDependencyApi(Configuration.Default);
            var dependencyId = "dependencyId_example";  // string | dependencyId
            var viewId = "viewId_example";  // string | viewId

            try
            {
                // get
                Dependency result = apiInstance.Get(dependencyId, viewId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewDependencyApi.Get: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
dependencyId string dependencyId
viewId string viewId

Return type

Dependency

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

List

List<Dependency> List (string viewId)

list

list

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Gridly.Api;
using Com.Gridly.Client;
using Com.Gridly.Model;

namespace Example
{
    public class ListExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.gridly.com";
            // Configure API key authorization: ApiKey
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ViewDependencyApi(Configuration.Default);
            var viewId = "viewId_example";  // string | viewId

            try
            {
                // list
                List<Dependency> result = apiInstance.List(viewId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewDependencyApi.List: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
viewId string viewId

Return type

List<Dependency>

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update

Dependency Update (string dependencyId, string viewId, UpdateDependency updateDependency)

update

update

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Gridly.Api;
using Com.Gridly.Client;
using Com.Gridly.Model;

namespace Example
{
    public class UpdateExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.gridly.com";
            // Configure API key authorization: ApiKey
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ViewDependencyApi(Configuration.Default);
            var dependencyId = "dependencyId_example";  // string | dependencyId
            var viewId = "viewId_example";  // string | viewId
            var updateDependency = new UpdateDependency(); // UpdateDependency | 

            try
            {
                // update
                Dependency result = apiInstance.Update(dependencyId, viewId, updateDependency);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewDependencyApi.Update: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
dependencyId string dependencyId
viewId string viewId
updateDependency UpdateDependency

Return type

Dependency

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]