Skip to content

Latest commit

 

History

History
698 lines (541 loc) · 28.9 KB

File metadata and controls

698 lines (541 loc) · 28.9 KB

HubSpot.NET.Api.RowsApi

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

Method HTTP request Description
DeleteCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftPurgeDraftTableRow DELETE /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft Permanently deletes a row
GetCmsV3HubdbTablesTableIdOrNameRowsDraftReadDraftTableRows GET /cms/v3/hubdb/tables/{tableIdOrName}/rows/draft Get rows from draft table
GetCmsV3HubdbTablesTableIdOrNameRowsGetTableRows GET /cms/v3/hubdb/tables/{tableIdOrName}/rows Get rows for a table
GetCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftGetDraftTableRowById GET /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft Get a row from the draft table
GetCmsV3HubdbTablesTableIdOrNameRowsRowIdGetTableRow GET /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId} Get a table row
PatchCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftUpdateDraftTableRow PATCH /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft Updates an existing row
PostCmsV3HubdbTablesTableIdOrNameRowsCreateTableRow POST /cms/v3/hubdb/tables/{tableIdOrName}/rows Add a new row to a table
PostCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftCloneCloneDraftTableRow POST /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone Clone a row
PutCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftReplaceDraftTableRow PUT /cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft Replaces an existing row

DeleteCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftPurgeDraftTableRow

void DeleteCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftPurgeDraftTableRow (string tableIdOrName, string rowId)

Permanently deletes a row

Permanently deletes a row from a table's draft version.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftPurgeDraftTableRowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table
            var rowId = "rowId_example";  // string | The ID of the row

            try
            {
                // Permanently deletes a row
                apiInstance.DeleteCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftPurgeDraftTableRow(tableIdOrName, rowId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.DeleteCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftPurgeDraftTableRow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table
rowId string The ID of the row

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
204 No content -
0 An error occurred. -

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

GetCmsV3HubdbTablesTableIdOrNameRowsDraftReadDraftTableRows

CollectionResponseWithTotalHubDbTableRowV3ForwardPaging GetCmsV3HubdbTablesTableIdOrNameRowsDraftReadDraftTableRows (string tableIdOrName, List sort = null, string after = null, int? limit = null, List properties = null)

Get rows from draft table

Returns rows in the draft version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5&sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview section for detailed filtering and sorting options.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCmsV3HubdbTablesTableIdOrNameRowsDraftReadDraftTableRowsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table to query.
            var sort = new List<string>(); // List<string> | Specifies the column names to sort the results by. (optional) 
            var after = "after_example";  // string | The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var limit = 56;  // int? | The maximum number of results to return. Default is `1000`. (optional) 
            var properties = new List<string>(); // List<string> | Specify the column names to get results containing only the required columns instead of all column details. If you want to include multiple columns in the result, use this query param as many times.  (optional) 

            try
            {
                // Get rows from draft table
                CollectionResponseWithTotalHubDbTableRowV3ForwardPaging result = apiInstance.GetCmsV3HubdbTablesTableIdOrNameRowsDraftReadDraftTableRows(tableIdOrName, sort, after, limit, properties);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.GetCmsV3HubdbTablesTableIdOrNameRowsDraftReadDraftTableRows: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table to query.
sort List<string> Specifies the column names to sort the results by. [optional]
after string The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. [optional]
limit int? The maximum number of results to return. Default is `1000`. [optional]
properties List<string> Specify the column names to get results containing only the required columns instead of all column details. If you want to include multiple columns in the result, use this query param as many times. [optional]

Return type

CollectionResponseWithTotalHubDbTableRowV3ForwardPaging

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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

GetCmsV3HubdbTablesTableIdOrNameRowsGetTableRows

CollectionResponseWithTotalHubDbTableRowV3ForwardPaging GetCmsV3HubdbTablesTableIdOrNameRowsGetTableRows (string tableIdOrName, List sort = null, string after = null, int? limit = null, List properties = null)

Get rows for a table

Returns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5&sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview section for detailed filtering and sorting options. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCmsV3HubdbTablesTableIdOrNameRowsGetTableRowsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table to query.
            var sort = new List<string>(); // List<string> | Specifies the column names to sort the results by. See the above description for more details. (optional) 
            var after = "after_example";  // string | The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var limit = 56;  // int? | The maximum number of results to return. Default is `1000`. (optional) 
            var properties = new List<string>(); // List<string> | Specify the column names to get results containing only the required columns instead of all column details. (optional) 

            try
            {
                // Get rows for a table
                CollectionResponseWithTotalHubDbTableRowV3ForwardPaging result = apiInstance.GetCmsV3HubdbTablesTableIdOrNameRowsGetTableRows(tableIdOrName, sort, after, limit, properties);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.GetCmsV3HubdbTablesTableIdOrNameRowsGetTableRows: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table to query.
sort List<string> Specifies the column names to sort the results by. See the above description for more details. [optional]
after string The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. [optional]
limit int? The maximum number of results to return. Default is `1000`. [optional]
properties List<string> Specify the column names to get results containing only the required columns instead of all column details. [optional]

Return type

CollectionResponseWithTotalHubDbTableRowV3ForwardPaging

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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

GetCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftGetDraftTableRowById

HubDbTableRowV3 GetCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftGetDraftTableRowById (string tableIdOrName, string rowId)

Get a row from the draft table

Get a single row by ID from a table's draft version.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftGetDraftTableRowByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table
            var rowId = "rowId_example";  // string | The ID of the row

            try
            {
                // Get a row from the draft table
                HubDbTableRowV3 result = apiInstance.GetCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftGetDraftTableRowById(tableIdOrName, rowId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.GetCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftGetDraftTableRowById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table
rowId string The ID of the row

Return type

HubDbTableRowV3

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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

GetCmsV3HubdbTablesTableIdOrNameRowsRowIdGetTableRow

HubDbTableRowV3 GetCmsV3HubdbTablesTableIdOrNameRowsRowIdGetTableRow (string tableIdOrName, string rowId)

Get a table row

Get a single row by ID from a table's published version. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCmsV3HubdbTablesTableIdOrNameRowsRowIdGetTableRowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table
            var rowId = "rowId_example";  // string | The ID of the row

            try
            {
                // Get a table row
                HubDbTableRowV3 result = apiInstance.GetCmsV3HubdbTablesTableIdOrNameRowsRowIdGetTableRow(tableIdOrName, rowId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.GetCmsV3HubdbTablesTableIdOrNameRowsRowIdGetTableRow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table
rowId string The ID of the row

Return type

HubDbTableRowV3

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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

PatchCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftUpdateDraftTableRow

HubDbTableRowV3 PatchCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftUpdateDraftTableRow (string tableIdOrName, string rowId, HubDbTableRowV3Request hubDbTableRowV3Request)

Updates an existing row

Sparse updates a single row in the table's draft version. All the column values need not be specified. Only the columns or fields that needs to be modified can be specified. See the Create a row endpoint for instructions on how to format the JSON row definitions.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftUpdateDraftTableRowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table
            var rowId = "rowId_example";  // string | The ID of the row
            var hubDbTableRowV3Request = new HubDbTableRowV3Request(); // HubDbTableRowV3Request | The JSON object of the row with necessary fields that needs to be updated.

            try
            {
                // Updates an existing row
                HubDbTableRowV3 result = apiInstance.PatchCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftUpdateDraftTableRow(tableIdOrName, rowId, hubDbTableRowV3Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.PatchCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftUpdateDraftTableRow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table
rowId string The ID of the row
hubDbTableRowV3Request HubDbTableRowV3Request The JSON object of the row with necessary fields that needs to be updated.

Return type

HubDbTableRowV3

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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

PostCmsV3HubdbTablesTableIdOrNameRowsCreateTableRow

HubDbTableRowV3 PostCmsV3HubdbTablesTableIdOrNameRowsCreateTableRow (string tableIdOrName, HubDbTableRowV3Request hubDbTableRowV3Request)

Add a new row to a table

Add a new row to a HubDB table. New rows will be added to the draft version of the table. Use publish endpoint to push these changes to published version.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCmsV3HubdbTablesTableIdOrNameRowsCreateTableRowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the target table.
            var hubDbTableRowV3Request = new HubDbTableRowV3Request(); // HubDbTableRowV3Request | The row definition JSON, formatted as described above.

            try
            {
                // Add a new row to a table
                HubDbTableRowV3 result = apiInstance.PostCmsV3HubdbTablesTableIdOrNameRowsCreateTableRow(tableIdOrName, hubDbTableRowV3Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.PostCmsV3HubdbTablesTableIdOrNameRowsCreateTableRow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the target table.
hubDbTableRowV3Request HubDbTableRowV3Request The row definition JSON, formatted as described above.

Return type

HubDbTableRowV3

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 successful operation -
0 An error occurred. -

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

PostCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftCloneCloneDraftTableRow

HubDbTableRowV3 PostCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftCloneCloneDraftTableRow (string tableIdOrName, string rowId)

Clone a row

Clones a single row in the draft version of the table.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftCloneCloneDraftTableRowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table
            var rowId = "rowId_example";  // string | The ID of the row

            try
            {
                // Clone a row
                HubDbTableRowV3 result = apiInstance.PostCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftCloneCloneDraftTableRow(tableIdOrName, rowId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.PostCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftCloneCloneDraftTableRow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table
rowId string The ID of the row

Return type

HubDbTableRowV3

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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

PutCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftReplaceDraftTableRow

HubDbTableRowV3 PutCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftReplaceDraftTableRow (string tableIdOrName, string rowId, HubDbTableRowV3Request hubDbTableRowV3Request)

Replaces an existing row

Replace a single row in the table's draft version. All the column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted. See the Create a row endpoint for instructions on how to format the JSON row definitions.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PutCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftReplaceDraftTableRowExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new RowsApi(config);
            var tableIdOrName = "tableIdOrName_example";  // string | The ID or name of the table
            var rowId = "rowId_example";  // string | The ID of the row
            var hubDbTableRowV3Request = new HubDbTableRowV3Request(); // HubDbTableRowV3Request | The JSON object of the row

            try
            {
                // Replaces an existing row
                HubDbTableRowV3 result = apiInstance.PutCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftReplaceDraftTableRow(tableIdOrName, rowId, hubDbTableRowV3Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling RowsApi.PutCmsV3HubdbTablesTableIdOrNameRowsRowIdDraftReplaceDraftTableRow: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
tableIdOrName string The ID or name of the table
rowId string The ID of the row
hubDbTableRowV3Request HubDbTableRowV3Request The JSON object of the row

Return type

HubDbTableRowV3

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

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