twentycrm_client.WorkflowRunsApi

All URIs are relative to https://crm.example.com/rest

Method	HTTP request	Description
create_many_workflow_runs	POST /batch/workflowRuns	Create Many workflowRuns
create_one_workflow_run	POST /workflowRuns	Create One workflowRun
delete_many_workflow_runs	DELETE /workflowRuns	Delete Many workflowRuns
delete_one_workflow_run	DELETE /workflowRuns/{id}	Delete One workflowRun
find_many_workflow_runs	GET /workflowRuns	Find Many workflowRuns
find_one_workflow_run	GET /workflowRuns/{id}	Find One workflowRun
find_workflow_run_duplicates	POST /workflowRuns/duplicates	Find workflowRun Duplicates
group_by_workflow_runs	GET /workflowRuns/groupBy	Group By workflowRuns
merge_many_workflow_runs	PATCH /workflowRuns/merge	Merge Many workflowRuns
restore_many_workflow_runs	PATCH /restore/workflowRuns	Restore Many workflowRuns
restore_one_workflow_run	PATCH /restore/workflowRuns/{id}	Restore One workflowRun
update_many_workflow_runs	PATCH /workflowRuns	Update Many workflowRuns
update_one_workflow_run	PATCH /workflowRuns/{id}	Update One workflowRun

create_many_workflow_runs

CreateManyWorkflowRuns201Response create_many_workflow_runs(workflow_run, depth=depth, upsert=upsert)

Create Many workflowRuns

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.create_many_workflow_runs201_response import CreateManyWorkflowRuns201Response
from twentycrm_client.models.workflow_run import WorkflowRun
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    workflow_run = [twentycrm_client.WorkflowRun()] # List[WorkflowRun] | 
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    upsert = False # bool | If true, creates the object or updates it if it already exists. (optional) (default to False)

    try:
        # Create Many workflowRuns
        api_response = api_instance.create_many_workflow_runs(workflow_run, depth=depth, upsert=upsert)
        print("The response of WorkflowRunsApi->create_many_workflow_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->create_many_workflow_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_run	List[WorkflowRun]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
upsert	bool	If true, creates the object or updates it if it already exists.	[optional] [default to False]

Return type

CreateManyWorkflowRuns201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

create_one_workflow_run

CreateOneWorkflowRun201Response create_one_workflow_run(workflow_run, depth=depth, upsert=upsert)

Create One workflowRun

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.create_one_workflow_run201_response import CreateOneWorkflowRun201Response
from twentycrm_client.models.workflow_run import WorkflowRun
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    workflow_run = twentycrm_client.WorkflowRun() # WorkflowRun | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    upsert = False # bool | If true, creates the object or updates it if it already exists. (optional) (default to False)

    try:
        # Create One workflowRun
        api_response = api_instance.create_one_workflow_run(workflow_run, depth=depth, upsert=upsert)
        print("The response of WorkflowRunsApi->create_one_workflow_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->create_one_workflow_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_run	WorkflowRun	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
upsert	bool	If true, creates the object or updates it if it already exists.	[optional] [default to False]

Return type

CreateOneWorkflowRun201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

delete_many_workflow_runs

DeleteManyWorkflowRuns200Response delete_many_workflow_runs(filter=filter, soft_delete=soft_delete)

Delete Many workflowRuns

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.delete_many_workflow_runs200_response import DeleteManyWorkflowRuns200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    soft_delete = False # bool | If true, soft deletes the objects. If false, objects are permanently deleted. (optional) (default to False)

    try:
        # Delete Many workflowRuns
        api_response = api_instance.delete_many_workflow_runs(filter=filter, soft_delete=soft_delete)
        print("The response of WorkflowRunsApi->delete_many_workflow_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->delete_many_workflow_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
soft_delete	bool	If true, soft deletes the objects. If false, objects are permanently deleted.	[optional] [default to False]

Return type

DeleteManyWorkflowRuns200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

delete_one_workflow_run

DeleteOneWorkflowRun200Response delete_one_workflow_run(id, soft_delete=soft_delete)

Delete One workflowRun

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.delete_one_workflow_run200_response import DeleteOneWorkflowRun200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    soft_delete = False # bool | If true, soft deletes the objects. If false, objects are permanently deleted. (optional) (default to False)

    try:
        # Delete One workflowRun
        api_response = api_instance.delete_one_workflow_run(id, soft_delete=soft_delete)
        print("The response of WorkflowRunsApi->delete_one_workflow_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->delete_one_workflow_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
soft_delete	bool	If true, soft deletes the objects. If false, objects are permanently deleted.	[optional] [default to False]

Return type

DeleteOneWorkflowRun200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

find_many_workflow_runs

FindManyWorkflowRuns200Response find_many_workflow_runs(order_by=order_by, filter=filter, limit=limit, depth=depth, starting_after=starting_after, ending_before=ending_before)

Find Many workflowRuns

order_by, filter, limit, depth, starting_after or ending_before can be provided to request your workflowRuns

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_many_workflow_runs200_response import FindManyWorkflowRuns200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    order_by = 'createdAt' # str | Format: **field_name_1,field_name_2[DIRECTION_2]     Refer to the filter section at the top of the page for more details. (optional)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    limit = 60 # int | Limits the number of objects returned. (optional) (default to 60)
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    starting_after = 'starting_after_example' # str | Returns objects starting after a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data (optional)
    ending_before = 'ending_before_example' # str | Returns objects ending before a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data (optional)

    try:
        # Find Many workflowRuns
        api_response = api_instance.find_many_workflow_runs(order_by=order_by, filter=filter, limit=limit, depth=depth, starting_after=starting_after, ending_before=ending_before)
        print("The response of WorkflowRunsApi->find_many_workflow_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->find_many_workflow_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_by	str	Format: **field_name_1,field_name_2[DIRECTION_2] Refer to the filter section at the top of the page for more details.	[optional]
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
limit	int	Limits the number of objects returned.	[optional] [default to 60]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
starting_after	str	Returns objects starting after a specific cursor. You can find cursors in startCursor and endCursor in pageInfo in response data	[optional]
ending_before	str	Returns objects ending before a specific cursor. You can find cursors in startCursor and endCursor in pageInfo in response data	[optional]

Return type

FindManyWorkflowRuns200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

find_one_workflow_run

FindOneWorkflowRun200Response find_one_workflow_run(id, depth=depth)

Find One workflowRun

depth can be provided to request your workflowRun

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_one_workflow_run200_response import FindOneWorkflowRun200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Find One workflowRun
        api_response = api_instance.find_one_workflow_run(id, depth=depth)
        print("The response of WorkflowRunsApi->find_one_workflow_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->find_one_workflow_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

FindOneWorkflowRun200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

find_workflow_run_duplicates

FindWorkflowRunDuplicates200Response find_workflow_run_duplicates(find_workflow_run_duplicates_request, depth=depth)

Find workflowRun Duplicates

depth can be provided to request your workflowRun

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_workflow_run_duplicates200_response import FindWorkflowRunDuplicates200Response
from twentycrm_client.models.find_workflow_run_duplicates_request import FindWorkflowRunDuplicatesRequest
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    find_workflow_run_duplicates_request = twentycrm_client.FindWorkflowRunDuplicatesRequest() # FindWorkflowRunDuplicatesRequest | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Find workflowRun Duplicates
        api_response = api_instance.find_workflow_run_duplicates(find_workflow_run_duplicates_request, depth=depth)
        print("The response of WorkflowRunsApi->find_workflow_run_duplicates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->find_workflow_run_duplicates: %s\n" % e)

Parameters

Name	Type	Description	Notes
find_workflow_run_duplicates_request	FindWorkflowRunDuplicatesRequest	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

FindWorkflowRunDuplicates200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

group_by_workflow_runs

GroupByWorkflowRuns200Response group_by_workflow_runs(group_by, filter=filter, order_by=order_by, limit=limit, view_id=view_id, aggregate=aggregate, include_records_sample=include_records_sample, order_by_for_records=order_by_for_records)

Group By workflowRuns

Groups workflowRuns by specified fields and optionally computes aggregate values for each group.

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.group_by_workflow_runs200_response import GroupByWorkflowRuns200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    group_by = '[{\"updatedAt\": true}]' # str | Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    order_by = 'createdAt' # str | Format: **field_name_1,field_name_2[DIRECTION_2]     Refer to the filter section at the top of the page for more details. (optional)
    limit = 60 # int | Limits the number of objects returned. (optional) (default to 60)
    view_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | View ID to apply filters from. (optional)
    aggregate = '[\"countNotEmptyId\"]' # str | Array of aggregate operations to compute for each group. (optional)
    include_records_sample = False # bool | If true, includes a sample of records for each group in the response. (optional) (default to False)
    order_by_for_records = 'createdAt' # str | Order by clause for records within each group. Only applicable when include_records_sample is true. (optional)

    try:
        # Group By workflowRuns
        api_response = api_instance.group_by_workflow_runs(group_by, filter=filter, order_by=order_by, limit=limit, view_id=view_id, aggregate=aggregate, include_records_sample=include_records_sample, order_by_for_records=order_by_for_records)
        print("The response of WorkflowRunsApi->group_by_workflow_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->group_by_workflow_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_by	str	Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
order_by	str	Format: **field_name_1,field_name_2[DIRECTION_2] Refer to the filter section at the top of the page for more details.	[optional]
limit	int	Limits the number of objects returned.	[optional] [default to 60]
view_id	UUID	View ID to apply filters from.	[optional]
aggregate	str	Array of aggregate operations to compute for each group.	[optional]
include_records_sample	bool	If true, includes a sample of records for each group in the response.	[optional] [default to False]
order_by_for_records	str	Order by clause for records within each group. Only applicable when include_records_sample is true.	[optional]

Return type

GroupByWorkflowRuns200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

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

merge_many_workflow_runs

MergeManyWorkflowRuns200Response merge_many_workflow_runs(merge_many_workflow_runs_request, depth=depth)

Merge Many workflowRuns

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.merge_many_workflow_runs200_response import MergeManyWorkflowRuns200Response
from twentycrm_client.models.merge_many_workflow_runs_request import MergeManyWorkflowRunsRequest
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    merge_many_workflow_runs_request = twentycrm_client.MergeManyWorkflowRunsRequest() # MergeManyWorkflowRunsRequest | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Merge Many workflowRuns
        api_response = api_instance.merge_many_workflow_runs(merge_many_workflow_runs_request, depth=depth)
        print("The response of WorkflowRunsApi->merge_many_workflow_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->merge_many_workflow_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
merge_many_workflow_runs_request	MergeManyWorkflowRunsRequest	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

MergeManyWorkflowRuns200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

restore_many_workflow_runs

RestoreManyWorkflowRuns200Response restore_many_workflow_runs(filter=filter, depth=depth)

Restore Many workflowRuns

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.restore_many_workflow_runs200_response import RestoreManyWorkflowRuns200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Restore Many workflowRuns
        api_response = api_instance.restore_many_workflow_runs(filter=filter, depth=depth)
        print("The response of WorkflowRunsApi->restore_many_workflow_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->restore_many_workflow_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

RestoreManyWorkflowRuns200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

restore_one_workflow_run

RestoreOneWorkflowRun200Response restore_one_workflow_run(id, depth=depth)

Restore One workflowRun

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.restore_one_workflow_run200_response import RestoreOneWorkflowRun200Response
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Restore One workflowRun
        api_response = api_instance.restore_one_workflow_run(id, depth=depth)
        print("The response of WorkflowRunsApi->restore_one_workflow_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->restore_one_workflow_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

RestoreOneWorkflowRun200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

update_many_workflow_runs

UpdateManyWorkflowRuns200Response update_many_workflow_runs(workflow_run_for_update, depth=depth, filter=filter)

Update Many workflowRuns

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.update_many_workflow_runs200_response import UpdateManyWorkflowRuns200Response
from twentycrm_client.models.workflow_run_for_update import WorkflowRunForUpdate
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    workflow_run_for_update = twentycrm_client.WorkflowRunForUpdate() # WorkflowRunForUpdate | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)

    try:
        # Update Many workflowRuns
        api_response = api_instance.update_many_workflow_runs(workflow_run_for_update, depth=depth, filter=filter)
        print("The response of WorkflowRunsApi->update_many_workflow_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->update_many_workflow_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_run_for_update	WorkflowRunForUpdate	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]

Return type

UpdateManyWorkflowRuns200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

update_one_workflow_run

UpdateOneWorkflowRun200Response update_one_workflow_run(id, workflow_run_for_update, depth=depth)

Update One workflowRun

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.update_one_workflow_run200_response import UpdateOneWorkflowRun200Response
from twentycrm_client.models.workflow_run_for_update import WorkflowRunForUpdate
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.WorkflowRunsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    workflow_run_for_update = twentycrm_client.WorkflowRunForUpdate() # WorkflowRunForUpdate | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Update One workflowRun
        api_response = api_instance.update_one_workflow_run(id, workflow_run_for_update, depth=depth)
        print("The response of WorkflowRunsApi->update_one_workflow_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkflowRunsApi->update_one_workflow_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
workflow_run_for_update	WorkflowRunForUpdate	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

UpdateOneWorkflowRun200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

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

FilesExpand file tree

WorkflowRunsApi.md

Latest commit

History

WorkflowRunsApi.md

File metadata and controls

twentycrm_client.WorkflowRunsApi

create_many_workflow_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_one_workflow_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_many_workflow_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_one_workflow_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_many_workflow_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_one_workflow_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_workflow_run_duplicates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_by_workflow_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

merge_many_workflow_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restore_many_workflow_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restore_one_workflow_run

Example

Parameters