Skip to content

Latest commit

 

History

History
596 lines (438 loc) · 15.3 KB

ViewColumnApi.md

File metadata and controls

596 lines (438 loc) · 15.3 KB

Com.Gridly.Api.ViewColumnApi

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

Method HTTP request Description
Add POST /v1/views/{viewId}/columns/{columnId}/add add
BulkCreate POST /v1/views/{viewId}/columns/bulk bulkCreate
Create POST /v1/views/{viewId}/columns create
Delete DELETE /v1/views/{viewId}/columns/{columnId} delete
Get GET /v1/views/{viewId}/columns/{columnId} get
Remove POST /v1/views/{viewId}/columns/{columnId}/remove remove
Update PATCH /v1/views/{viewId}/columns/{columnId} update

Add

ViewColumn Add (string columnId, string viewId)

add

add

Example

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

namespace Example
{
    public class AddExample
    {
        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 ViewColumnApi(Configuration.Default);
            var columnId = "columnId_example";  // string | columnId
            var viewId = "viewId_example";  // string | viewId

            try
            {
                // add
                ViewColumn result = apiInstance.Add(columnId, viewId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewColumnApi.Add: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
columnId string columnId
viewId string viewId

Return type

ViewColumn

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]

BulkCreate

List<ViewColumn> BulkCreate (string viewId, List createColumn)

bulkCreate

bulkCreate

Example

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

namespace Example
{
    public class BulkCreateExample
    {
        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 ViewColumnApi(Configuration.Default);
            var viewId = "viewId_example";  // string | viewId
            var createColumn = new List<CreateColumn>(); // List<CreateColumn> | 

            try
            {
                // bulkCreate
                List<ViewColumn> result = apiInstance.BulkCreate(viewId, createColumn);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewColumnApi.BulkCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
viewId string viewId
createColumn List<CreateColumn>

Return type

List<ViewColumn>

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]

Create

ViewColumn Create (string viewId, CreateColumn createColumn)

create

Create a Column

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 ViewColumnApi(Configuration.Default);
            var viewId = "viewId_example";  // string | viewId
            var createColumn = new CreateColumn(); // CreateColumn | 

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

Parameters

Name Type Description Notes
viewId string viewId
createColumn CreateColumn

Return type

ViewColumn

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 columnId, string viewId)

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 ViewColumnApi(Configuration.Default);
            var columnId = "columnId_example";  // string | columnId
            var viewId = "viewId_example";  // string | viewId

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

Parameters

Name Type Description Notes
columnId string columnId
viewId string viewId

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

ViewColumn Get (string columnId, 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 ViewColumnApi(Configuration.Default);
            var columnId = "columnId_example";  // string | columnId
            var viewId = "viewId_example";  // string | viewId

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

Parameters

Name Type Description Notes
columnId string columnId
viewId string viewId

Return type

ViewColumn

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]

Remove

void Remove (string columnId, string viewId)

remove

remove

Example

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

namespace Example
{
    public class RemoveExample
    {
        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 ViewColumnApi(Configuration.Default);
            var columnId = "columnId_example";  // string | columnId
            var viewId = "viewId_example";  // string | viewId

            try
            {
                // remove
                apiInstance.Remove(columnId, viewId);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ViewColumnApi.Remove: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
columnId string columnId
viewId string viewId

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
200 OK -

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

Update

ViewColumn Update (string columnId, string viewId, UpdateColumn updateColumn)

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 ViewColumnApi(Configuration.Default);
            var columnId = "columnId_example";  // string | columnId
            var viewId = "viewId_example";  // string | viewId
            var updateColumn = new UpdateColumn(); // UpdateColumn | 

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

Parameters

Name Type Description Notes
columnId string columnId
viewId string viewId
updateColumn UpdateColumn

Return type

ViewColumn

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]