collibra_core.WorkflowTasksApi

All URIs are relative to http://localhost/rest/2.0

Method	HTTP request	Description
cancel_workflow_task	POST /workflowTasks/{workflowTaskId}/canceled	Cancel workflow task.
complete_workflow_tasks	POST /workflowTasks/completed	Complete workflow tasks.
find_workflow_tasks	GET /workflowTasks	Find workflow tasks.
get_task_form_data	GET /workflowTasks/{workflowTaskId}/taskFormData	Get task form data.
get_workflow_task	GET /workflowTasks/{workflowTaskId}	Get workflow task.
reassign_task	POST /workflowTasks/{workflowTaskId}/reassign	Reassign task.

cancel_workflow_task

cancel_workflow_task(workflow_task_id, body=body)

Cancel workflow task.

Cancels the workflow task with the specified ID with a reason. If the given workflow is a subprocess, this method makes sure everything is cancelled from the root process instance. If the given task is not found, this method will assume it already was cancelled without throwing any error.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.WorkflowTasksApi(api_client)
    workflow_task_id = 'workflow_task_id_example' # str | The ID of the workflow task.
body = 'body_example' # str | The reason for the cancellation of the workflow task. (optional)

    try:
        # Cancel workflow task.
        api_instance.cancel_workflow_task(workflow_task_id, body=body)
    except ApiException as e:
        print("Exception when calling WorkflowTasksApi->cancel_workflow_task: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_task_id	str	The ID of the workflow task.
body	str	The reason for the cancellation of the workflow task.	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Task successfully canceled.	-
404	Task not found.	-

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

complete_workflow_tasks

list[WorkflowTask] complete_workflow_tasks(complete_workflow_tasks_request=complete_workflow_tasks_request)

Complete workflow tasks.

Completes tasks based on the provided request and returns the following tasks, if the same user is assigned to them.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.WorkflowTasksApi(api_client)
    complete_workflow_tasks_request = collibra_core.CompleteWorkflowTasksRequest() # CompleteWorkflowTasksRequest | Request to complete the workflow tasks. (optional)

    try:
        # Complete workflow tasks.
        api_response = api_instance.complete_workflow_tasks(complete_workflow_tasks_request=complete_workflow_tasks_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowTasksApi->complete_workflow_tasks: %s\n" % e)

Parameters

Name	Type	Description	Notes
complete_workflow_tasks_request	CompleteWorkflowTasksRequest	Request to complete the workflow tasks.	[optional]

Return type

list[WorkflowTask]

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The following tasks, if the calling user is assigned to them. Empty response otherwise.	-
404	Requested workflow task does not exist.	-
500	Current user is not candidate user for workflow task.	-

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

find_workflow_tasks

WorkflowTaskPagedResponse find_workflow_tasks(offset=offset, limit=limit, business_item_id=business_item_id, business_item_type=business_item_type, workflow_task_user_relation=workflow_task_user_relation, business_item_name=business_item_name, user_id=user_id, create_date=create_date, due_date=due_date, title=title, type=type, sort_field=sort_field, sort_order=sort_order)

Find workflow tasks.

Returns the workflow tasks matching given search criteria.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.WorkflowTasksApi(api_client)
    offset = 0 # int | The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>. (optional) (default to 0)
limit = 0 # int | The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. (optional) (default to 0)
business_item_id = 'business_item_id_example' # str | The ID of the business item (optional)
business_item_type = 'business_item_type_example' # str | The type of the business item (optional)
workflow_task_user_relation = 'ALL' # str | The type of relation between user and searched tasks. This could be either set to search for all the tasks the user is permitted to view or just those assigned to the user. (optional) (default to 'ALL')
business_item_name = 'business_item_name_example' # str | The part of the name of the business item. (optional)
user_id = 'user_id_example' # str | The ID of the user for which the tasks need to be returned. If empty, the current logged in user will be used (optional)
create_date = 56 # int | The creation date of the task. It is the timestamp (in UTC time standard) (optional)
due_date = 56 # int | The due date of the task. It is the timestamp (in UTC time standard) (optional)
title = 'title_example' # str | The title/name of the task. (optional)
type = 'type_example' # str | The task type. (optional)
sort_field = 'DUE_DATE' # str | The field on which the results are sorted. On due date by default. (optional) (default to 'DUE_DATE')
sort_order = 'DESC' # str | The sorting order. (optional) (default to 'DESC')

    try:
        # Find workflow tasks.
        api_response = api_instance.find_workflow_tasks(offset=offset, limit=limit, business_item_id=business_item_id, business_item_type=business_item_type, workflow_task_user_relation=workflow_task_user_relation, business_item_name=business_item_name, user_id=user_id, create_date=create_date, due_date=due_date, title=title, type=type, sort_field=sort_field, sort_order=sort_order)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowTasksApi->find_workflow_tasks: %s\n" % e)

Parameters

Name	Type	Description	Notes
offset	int	The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.	[optional] [default to 0]
limit	int	The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used.	[optional] [default to 0]
business_item_id	str	The ID of the business item	[optional]
business_item_type	str	The type of the business item	[optional]
workflow_task_user_relation	str	The type of relation between user and searched tasks. This could be either set to search for all the tasks the user is permitted to view or just those assigned to the user.	[optional] [default to 'ALL']
business_item_name	str	The part of the name of the business item.	[optional]
user_id	str	The ID of the user for which the tasks need to be returned. If empty, the current logged in user will be used	[optional]
create_date	int	The creation date of the task. It is the timestamp (in UTC time standard)	[optional]
due_date	int	The due date of the task. It is the timestamp (in UTC time standard)	[optional]
title	str	The title/name of the task.	[optional]
type	str	The task type.	[optional]
sort_field	str	The field on which the results are sorted. On due date by default.	[optional] [default to 'DUE_DATE']
sort_order	str	The sorting order.	[optional] [default to 'DESC']

Return type

WorkflowTaskPagedResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The paged response with found workflow tasks	-

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

get_task_form_data

TaskFormData get_task_form_data(workflow_task_id, form_property_type=form_property_type)

Get task form data.

Returns the task form data of the workflow task with the specified ID and form property type.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.WorkflowTasksApi(api_client)
    workflow_task_id = 'workflow_task_id_example' # str | Workflow task ID.
form_property_type = 'form_property_type_example' # str | Form property type. (optional)

    try:
        # Get task form data.
        api_response = api_instance.get_task_form_data(workflow_task_id, form_property_type=form_property_type)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowTasksApi->get_task_form_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_task_id	str	Workflow task ID.
form_property_type	str	Form property type.	[optional]

Return type

TaskFormData

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Workflow task form data successfully found.	-
401	User don't have permission for given task	-
404	Workflow task form data could not be found.	-

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

get_workflow_task

WorkflowTask get_workflow_task(workflow_task_id)

Get workflow task.

Returns the workflow task with the specified ID. A task will only be returned when the user has the correct permission to view it.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.WorkflowTasksApi(api_client)
    workflow_task_id = 'workflow_task_id_example' # str | The ID of the workflow task to return.

    try:
        # Get workflow task.
        api_response = api_instance.get_workflow_task(workflow_task_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkflowTasksApi->get_workflow_task: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_task_id	str	The ID of the workflow task to return.

Return type

WorkflowTask

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Workflow task successfully found.	-
401	User don't have permission for given task	-
404	Workflow task could not be found.	-

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

reassign_task

reassign_task(workflow_task_id, users=users, groups=groups, roles=roles, communities=communities)

Reassign task.

Reassigns the task with the specified ID to one or more users, groups or roles. Caller needs to provide at least one of the value list for users, groups or roles. If roles are provided then the same number of communities needs to be provided also.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.WorkflowTasksApi(api_client)
    workflow_task_id = 'workflow_task_id_example' # str | The ID of the workflow task.
users = ['users_example'] # list[str] | The user IDs to reassign to. (optional)
groups = ['groups_example'] # list[str] | The group IDs to reassign to. (optional)
roles = ['roles_example'] # list[str] | The role IDs to reassign to. (optional)
communities = ['communities_example'] # list[str] | The Community IDs of the specified roles to reassign to. (optional)

    try:
        # Reassign task.
        api_instance.reassign_task(workflow_task_id, users=users, groups=groups, roles=roles, communities=communities)
    except ApiException as e:
        print("Exception when calling WorkflowTasksApi->reassign_task: %s\n" % e)

Parameters

Name	Type	Description	Notes
workflow_task_id	str	The ID of the workflow task.
users	list[str]	The user IDs to reassign to.	[optional]
groups	list[str]	The group IDs to reassign to.	[optional]
roles	list[str]	The role IDs to reassign to.	[optional]
communities	list[str]	The Community IDs of the specified roles to reassign to.	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Task successfully reassigned.	-
404	Task not found.	-

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

Files

WorkflowTasksApi.md

Latest commit

History

WorkflowTasksApi.md

File metadata and controls

collibra_core.WorkflowTasksApi

cancel_workflow_task

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

complete_workflow_tasks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_workflow_tasks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_task_form_data

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_workflow_task

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reassign_task

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details