Com.Gridly.Api.BranchApi

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

Method	HTTP request	Description
Create	POST /v1/branches	create
CreateDiffCheck	POST /v1/branches/diffcheck	createDiffCheck
Delete	DELETE /v1/branches/{branchId}	delete
Get	GET /v1/branches/{branchId}	get
GetDiffCheck	GET /v1/branches/diffcheck/{taskId}	getDiffCheck
List	GET /v1/branches	list
Merge	POST /v1/branches/{branchId}/merge	merge

Create

Branch Create (CreateBranch createBranch, string gridId = null, string branchId = null)

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 BranchApi(Configuration.Default);
            var createBranch = new CreateBranch(); // CreateBranch | 
            var gridId = "gridId_example";  // string | gridId (optional) 
            var branchId = "branchId_example";  // string | branchId (optional) 

            try
            {
                // create
                Branch result = apiInstance.Create(createBranch, gridId, branchId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BranchApi.Create: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createBranch	CreateBranch
gridId	string	gridId	[optional]
branchId	string	branchId	[optional]

Return type

Branch

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]

CreateDiffCheck

Task CreateDiffCheck (string sourceViewId, string destinationViewId)

createDiffCheck

Example

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

namespace Example
{
    public class CreateDiffCheckExample
    {
        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 BranchApi(Configuration.Default);
            var sourceViewId = "sourceViewId_example";  // string | sourceViewId
            var destinationViewId = "destinationViewId_example";  // string | destinationViewId

            try
            {
                // createDiffCheck
                Task result = apiInstance.CreateDiffCheck(sourceViewId, destinationViewId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BranchApi.CreateDiffCheck: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
sourceViewId	string	sourceViewId
destinationViewId	string	destinationViewId

Return type

Task

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-

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

Delete

void Delete (string branchId)

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 BranchApi(Configuration.Default);
            var branchId = "branchId_example";  // string | branchId

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

Parameters

Name	Type	Description	Notes
branchId	string	branchId

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

Branch Get (string branchId)

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 BranchApi(Configuration.Default);
            var branchId = "branchId_example";  // string | branchId

            try
            {
                // get
                Branch result = apiInstance.Get(branchId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BranchApi.Get: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
branchId	string	branchId

Return type

Branch

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]

GetDiffCheck

List<BranchDiffRecord> GetDiffCheck (string taskId, List mergeRecordOptions = null, string query = null, string page = null)

getDiffCheck

Example

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

namespace Example
{
    public class GetDiffCheckExample
    {
        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 BranchApi(Configuration.Default);
            var taskId = "taskId_example";  // string | taskId
            var mergeRecordOptions = new List<string>(); // List<string> | mergeRecordOptions (optional) 
            var query = "\"{}\"";  // string | query (optional)  (default to "{}")
            var page = "\"{}\"";  // string | page (optional)  (default to "{}")

            try
            {
                // getDiffCheck
                List<BranchDiffRecord> result = apiInstance.GetDiffCheck(taskId, mergeRecordOptions, query, page);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BranchApi.GetDiffCheck: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
taskId	string	taskId
mergeRecordOptions	List<string>	mergeRecordOptions	[optional]
query	string	query	[optional] [default to "{}"]
page	string	page	[optional] [default to "{}"]

Return type

List<BranchDiffRecord>

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<Branch> List (string gridId)

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 BranchApi(Configuration.Default);
            var gridId = "gridId_example";  // string | gridId

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

Parameters

Name	Type	Description	Notes
gridId	string	gridId

Return type

List<Branch>

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]

Merge

Task Merge (string branchId, string destinationBranchId, MergeBranchRequest mergeBranchRequest, List mergeRecordOptions = null)

merge

Example

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

namespace Example
{
    public class MergeExample
    {
        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 BranchApi(Configuration.Default);
            var branchId = "branchId_example";  // string | branchId
            var destinationBranchId = "destinationBranchId_example";  // string | destinationBranchId
            var mergeBranchRequest = new MergeBranchRequest(); // MergeBranchRequest | 
            var mergeRecordOptions = new List<string>(); // List<string> | mergeRecordOptions (optional) 

            try
            {
                // merge
                Task result = apiInstance.Merge(branchId, destinationBranchId, mergeBranchRequest, mergeRecordOptions);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BranchApi.Merge: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
branchId	string	branchId
destinationBranchId	string	destinationBranchId
mergeBranchRequest	MergeBranchRequest
mergeRecordOptions	List<string>	mergeRecordOptions	[optional]

Return type

Task

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Accepted	-

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

Files

BranchApi.md

Latest commit

History

BranchApi.md

File metadata and controls

Com.Gridly.Api.BranchApi

Create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateDiffCheck

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetDiffCheck

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

List

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Merge

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details