/collibra_apiclient

Primary LanguagePython

swagger-client

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ActivitiesApi()
activity_type = 'activity_type_example' # str | The type of the activity (optional)
call_id = 'call_id_example' # str | The <code>id</code> of the call (optional)
categories = ['categories_example'] # list[str] | The set of the categories of activities that should be searched. One of [ATTRIBUTE, ATTACHMENT, RELATION, COMMENT, STATUS, WORKFLOW, RESPONSIBILITY, USER, USER_GROUP, ROLE, TAGS, OTHERS] (optional)
context_id = 'context_id_example' # str | The <code>id</code> of the context which the activities should be searched for (optional)
end_date = 8.14 # float | The end date of the searched activities. It is the timestamp (in UTC time standard) (optional)
involved_people_ids = ['involved_people_ids_example'] # list[str] | The list of <code>id</code>s of the people that should be involved in searched activities (optional)
involved_role_ids = ['involved_role_ids_example'] # list[str] | The list of <code>id</code>s of the roles that should be involved in searched activities (optional)
limit = 0 # int | The maximum number of results to retrieve. If not set (value = <tt>0</tt>), the default limit will be used (optional) (default to 0)
offset = 0 # int | The first result to retrieve. If not set (value = <tt>0</tt>), results will be retrieved starting from row <tt>0</tt> (optional) (default to 0)
performed_by_role_ids = ['performed_by_role_ids_example'] # list[str] | The list of <code>id</code>s of the roles assigned to users who performed searched activities (optional)
performed_by_user_id = 'performed_by_user_id_example' # str | The <code>id</code> of the user who performed searched activities (optional)
resource_types = ['resource_types_example'] # list[str] | The set of the resource types that searched activities refer to, i.e. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance] (optional)
start_date = 8.14 # float | The start date of the searched activities. It is the timestamp (in UTC time standard) (optional)
task_id = 'task_id_example' # str | The <code>id</code> of the task which contains the basic find activities request (optional)

try:
    # Returns activities matching the given search criteria.
    api_response = api_instance.resource_activity_stream_resource_get_activities_get(activity_type=activity_type, call_id=call_id, categories=categories, context_id=context_id, end_date=end_date, involved_people_ids=involved_people_ids, involved_role_ids=involved_role_ids, limit=limit, offset=offset, performed_by_role_ids=performed_by_role_ids, performed_by_user_id=performed_by_user_id, resource_types=resource_types, start_date=start_date, task_id=task_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivitiesApi->resource_activity_stream_resource_get_activities_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ActivitiesApi resource_activity_stream_resource_get_activities_get GET /activities Returns activities matching the given search criteria.
ApplicationApi resource_application_resource_get_info_get GET /application/info Returns the basic information about the application.
AssetTypesApi resource_asset_type_resource_add_asset_type_post POST /assetTypes Adds new asset type.
AssetTypesApi resource_asset_type_resource_add_asset_types_post POST /assetTypes/bulk Adds multiple asset types.
AssetTypesApi resource_asset_type_resource_change_asset_type_patch PATCH /assetTypes/{assetTypeId} Changes the asset type with the information that is present in the request.
AssetTypesApi resource_asset_type_resource_change_asset_types_patch PATCH /assetTypes/bulk Changes multiple asset types.
AssetTypesApi resource_asset_type_resource_find_asset_types_get GET /assetTypes Returns asset types matching the given search criteria.
AssetTypesApi resource_asset_type_resource_find_sub_asset_types_get GET /assetTypes/{assetTypeId}/subTypes Finds all the sub types of the asset type as described in the request object.
AssetTypesApi resource_asset_type_resource_get_asset_type_get GET /assetTypes/{assetTypeId} Returns asset type identified by given UUID.
AssetTypesApi resource_asset_type_resource_remove_asset_type_delete DELETE /assetTypes/{assetTypeId} Removes asset type identified by given UUID.
AssetTypesApi resource_asset_type_resource_remove_asset_types_delete DELETE /assetTypes/bulk Removes multiple asset types.
AssetsApi resource_asset_resource_add_asset_post POST /assets Adds a new asset into a domain.
AssetsApi resource_asset_resource_add_assets_post POST /assets/bulk Adds multiple assets.
AssetsApi resource_asset_resource_add_tags_to_asset_post POST /assets/{assetId}/tags Adds tags to given asset.
AssetsApi resource_asset_resource_change_asset_patch PATCH /assets/{assetId} Change the asset with the information that is present in the request.
AssetsApi resource_asset_resource_change_assets_patch PATCH /assets/bulk Changes multiple assets.
AssetsApi resource_asset_resource_find_assets_get GET /assets Returns assets matching the given search criteria.
AssetsApi resource_asset_resource_get_asset_get GET /assets/{assetId} Returns an asset identified by given id.
AssetsApi resource_asset_resource_get_asset_tags_get GET /assets/{assetId}/tags Returns all tags of given asset.
AssetsApi resource_asset_resource_remove_asset_delete DELETE /assets/{assetId} Removes an asset identified by given id.
AssetsApi resource_asset_resource_remove_assets_delete DELETE /assets/bulk Removes multiple assets.
AssetsApi resource_asset_resource_remove_tags_from_asset_delete DELETE /assets/{assetId}/tags Remove tags from given asset.
AssetsApi resource_asset_resource_set_asset_attributes_put PUT /assets/{assetId}/attributes Replaces all the attributes of the asset (of given attribute type) with the attributes from the request, except matching attributes, these are retained.
AssetsApi resource_asset_resource_set_asset_relations_put PUT /assets/{assetId}/relations Sets relations for given asset.
AssetsApi resource_asset_resource_set_asset_responsibilities_put PUT /assets/{assetId}/responsibilities Sets responsibilities for given asset.
AssetsApi resource_asset_resource_set_tags_for_asset_put PUT /assets/{assetId}/tags Sets tags for given asset.
AssignmentsApi resource_assignment_resource_get_assignments_for_asset_get GET /assignments/asset/{assetId} Returns assignment for given asset id.
AssignmentsApi resource_assignment_resource_get_assignments_for_asset_type_get GET /assignments/assetType/{assetTypeId} Returns assignments for given asset type id.
AssignmentsApi resource_assignment_resource_get_available_asset_types_for_domain_get GET /assignments/domain/{domainId}/assetTypes Returns available asset types for domain identified by given id.
AssignmentsApi resource_assignment_resource_get_available_attribute_types_for_asset_get GET /assignments/asset/{assetId}/attributeTypes Returns available attribute types for asset identified by given id.
AssignmentsApi resource_assignment_resource_get_available_complex_relation_types_for_asset_get GET /assignments/asset/{assetId}/complexRelationTypes Returns available complex relation types for asset identified by given id.
AssignmentsApi resource_assignment_resource_get_available_relation_types_for_asset_get GET /assignments/asset/{assetId}/relationTypes Returns available relation types for asset identified by given id.
AttachmentsApi resource_attachment_resource_add_attachment_post POST /attachments Adds new attachment.
AttachmentsApi resource_attachment_resource_find_attachments_get GET /attachments Returns attachments matching the given search criteria.
AttachmentsApi resource_attachment_resource_get_attachment_content_get GET /attachments/{attachmentId}/file Returns content of the attachment identified by given id.
AttachmentsApi resource_attachment_resource_get_attachment_get GET /attachments/{attachmentId} Returns information about the attachment identified by id.
AttachmentsApi resource_attachment_resource_remove_attachment_delete DELETE /attachments/{attachmentId} Removes attachment identified by given id.
AttributeTypesApi resource_attribute_type_resource_add_attribute_type_post POST /attributeTypes Adds new attribute type.
AttributeTypesApi resource_attribute_type_resource_add_attribute_types_post POST /attributeTypes/bulk Adds multiple attribute types.
AttributeTypesApi resource_attribute_type_resource_change_attribute_type_patch PATCH /attributeTypes/{attributeTypeId} Changes the attribute type with the information that is present in the request.
AttributeTypesApi resource_attribute_type_resource_change_attribute_types_patch PATCH /attributeTypes/bulk Changes multiple attribute types.
AttributeTypesApi resource_attribute_type_resource_find_attribute_types_get GET /attributeTypes Returns attribute types matching the given search criteria.
AttributeTypesApi resource_attribute_type_resource_get_attribute_type_by_name_get GET /attributeTypes/name/{attributeTypeName} Returns attribute type identified by given name.
AttributeTypesApi resource_attribute_type_resource_get_attribute_type_get GET /attributeTypes/{attributeTypeId} Returns attribute type identified by given id.
AttributeTypesApi resource_attribute_type_resource_remove_attribute_type_delete DELETE /attributeTypes/{attributeTypeId} Removes attribute type identified by given id.
AttributeTypesApi resource_attribute_type_resource_remove_attribute_types_delete DELETE /attributeTypes/bulk Removes multiple attribute types.
AttributesApi resource_attribute_resource_add_attribute_post POST /attributes Adds a new attribute to an asset.
AttributesApi resource_attribute_resource_add_attributes_post POST /attributes/bulk Adds multiple attributes.
AttributesApi resource_attribute_resource_change_attribute_patch PATCH /attributes/{attributeId} Changes the attribute with the information that is present in the request.
AttributesApi resource_attribute_resource_change_attributes_patch PATCH /attributes/bulk Changes multiple attributes with the information that is present in the request.
AttributesApi resource_attribute_resource_find_attributes_get GET /attributes Returns attributes matching the given search criteria.
AttributesApi resource_attribute_resource_get_attribute_get GET /attributes/{attributeId} Returns the attribute identified by given id.
AttributesApi resource_attribute_resource_remove_attribute_delete DELETE /attributes/{attributeId} Removes the attribute identified by given id.
AttributesApi resource_attribute_resource_remove_attributes_delete DELETE /attributes/bulk Removes the attributes identified by given ids.
AuthenticationSessionsApi resource_session_resource_is_logged_in_get GET /auth/sessions/current Gets current session (checks if user is logged in).
AuthenticationSessionsApi resource_session_resource_login_post POST /auth/sessions Login.
AuthenticationSessionsApi resource_session_resource_logout_delete DELETE /auth/sessions/current Logout.
CommentsApi resource_comment_resource_add_comment_post POST /comments Adds new comment.
CommentsApi resource_comment_resource_change_comment_patch PATCH /comments/{commentId} Changes the comment with the information that is present in the request.
CommentsApi resource_comment_resource_find_comments_get GET /comments Returns comments matching the given search criteria.
CommentsApi resource_comment_resource_get_comment_get GET /comments/{commentId} Returns comment identified by given id.
CommentsApi resource_comment_resource_remove_comment_delete DELETE /comments/{commentId} Removes comment identified by given id.
CommunitiesApi resource_community_resource_add_communities_post POST /communities/bulk Adds multiple communities.
CommunitiesApi resource_community_resource_add_community_post POST /communities Adds new community.
CommunitiesApi resource_community_resource_change_communities_patch PATCH /communities/bulk Changes multiple communities.
CommunitiesApi resource_community_resource_change_community_patch PATCH /communities/{communityId} Changes the community with the information that is present in the request.
CommunitiesApi resource_community_resource_find_communities_get GET /communities Returns communities matching the given search criteria.
CommunitiesApi resource_community_resource_get_community_get GET /communities/{communityId} Returns community identified by given id.
CommunitiesApi resource_community_resource_remove_communities_delete DELETE /communities/bulk Removes multiple communities.
CommunitiesApi resource_community_resource_remove_communities_in_job_post POST /communities/removalJobs Removes multiple communities in job.
CommunitiesApi resource_community_resource_remove_community_delete DELETE /communities/{communityId} Removes community identified by given id.
ComplexRelationTypesApi resource_complex_relation_type_resource_add_complex_relation_type_post POST /complexRelationTypes Adds new complex relation type.
ComplexRelationTypesApi resource_complex_relation_type_resource_change_relation_type_patch PATCH /complexRelationTypes/{complexRelationTypeId} Changes the complex relation type with the information that is present in the request.
ComplexRelationTypesApi resource_complex_relation_type_resource_get_all_complex_relation_types_get GET /complexRelationTypes Returns all complex relation types.
ComplexRelationTypesApi resource_complex_relation_type_resource_get_complex_relation_type_get GET /complexRelationTypes/{complexRelationTypeId} Returns complex relation type identified by given id.
ComplexRelationTypesApi resource_complex_relation_type_resource_remove_complex_relation_type_delete DELETE /complexRelationTypes/{complexRelationTypeId} Removes complex relation type identified by given id.
ComplexRelationsApi resource_complex_relation_resource_add_complex_relation_post POST /complexRelations Adds new complex relation.
ComplexRelationsApi resource_complex_relation_resource_change_complex_relation_patch PATCH /complexRelations/{complexRelationId} Change the complex relation with the information that is present in the request.
ComplexRelationsApi resource_complex_relation_resource_find_complex_relations_get GET /complexRelations Returns complex relations matching the given search criteria.
ComplexRelationsApi resource_complex_relation_resource_get_complex_relation_get GET /complexRelations/{complexRelationId} Returns complex relation identified by given id.
ComplexRelationsApi resource_complex_relation_resource_remove_complex_relation_delete DELETE /complexRelations/{complexRelationId} Removes complex relation identified by given id.
DataQualityRulesApi resource_data_quality_rule_resource_add_data_quality_rule_post POST /dataQualityRules Adds new data quality rule.
DataQualityRulesApi resource_data_quality_rule_resource_change_data_quality_rule_patch PATCH /dataQualityRules/{dataQualityRuleId} Changes the data quality rule with the information that is present in the request.
DataQualityRulesApi resource_data_quality_rule_resource_find_data_quality_rules_get GET /dataQualityRules Returns data quality rules matching the given search criteria.
DataQualityRulesApi resource_data_quality_rule_resource_get_data_quality_rule_get GET /dataQualityRules/{dataQualityRuleId} Returns data quality rule identified by given id.
DataQualityRulesApi resource_data_quality_rule_resource_remove_data_quality_rule_delete DELETE /dataQualityRules/{dataQualityRuleId} Removes data quality rule identified by given id.
DiagramPicturesApi resource_diagram_picture_resource_add_asset_type_post POST /diagramPictures Take a diagram picture for a given asset and diagram view.
DomainTypesApi resource_domain_type_resource_add_domain_type_post POST /domainTypes Adds new domain type.
DomainTypesApi resource_domain_type_resource_add_domain_types_post POST /domainTypes/bulk Adds multiple domain types.
DomainTypesApi resource_domain_type_resource_change_domain_type_patch PATCH /domainTypes/{domainTypeId} Changes the domain type with the information that is present in the request.
DomainTypesApi resource_domain_type_resource_change_domain_types_patch PATCH /domainTypes/bulk Changes multiple domain types.
DomainTypesApi resource_domain_type_resource_find_domain_types_get GET /domainTypes Returns domain types matching the given search criteria.
DomainTypesApi resource_domain_type_resource_find_sub_asset_types_get GET /domainTypes/{domainTypeId}/subTypes Finds all the sub types of the domain type as described in the request object.
DomainTypesApi resource_domain_type_resource_get_domain_type_get GET /domainTypes/{domainTypeId} Returns domain type identified by given id.
DomainTypesApi resource_domain_type_resource_remove_domain_type_delete DELETE /domainTypes/{domainTypeId} Removes domain type identified by given id.
DomainTypesApi resource_domain_type_resource_remove_domain_types_delete DELETE /domainTypes/bulk Removes multiple domain types.
DomainsApi resource_domain_resource_add_domain_post POST /domains Adds a new domain into a community.
DomainsApi resource_domain_resource_add_domains_post POST /domains/bulk Adds multiple domains.
DomainsApi resource_domain_resource_change_domain_patch PATCH /domains/{domainId} Changes the domain with the information that is present in the request.
DomainsApi resource_domain_resource_change_domains_patch PATCH /domains/bulk Changes multiple domains.
DomainsApi resource_domain_resource_find_domains_get GET /domains Returns domains matching the given search criteria.
DomainsApi resource_domain_resource_get_domain_get GET /domains/{domainId} Returns a domain identified by given id.
DomainsApi resource_domain_resource_remove_domain_delete DELETE /domains/{domainId} Removes a domain identified by given id.
DomainsApi resource_domain_resource_remove_domains_delete DELETE /domains/bulk Removes multiple domains.
DomainsApi resource_domain_resource_remove_domains_in_job_post POST /domains/removalJobs Removes multiple domains in job.
FilesApi resource_file_resource_add_files_post POST /files Uploads files.
FilesApi resource_file_resource_get_file_get GET /files/{fileId} Downloads file identified by given id.
FilesApi resource_file_resource_get_file_info_get GET /files/{fileId}/info Returns information about the file identified by given id.
IssuesApi resource_issue_resource_add_issue_post POST /issues Add a new issue with the given parameters.
IssuesApi resource_issue_resource_find_issues_get GET /issues Returns issues matching the given search criteria.
JobsApi resource_job_resource_cancel_job_post POST /jobs/{jobId}/canceled Cancels given job.
JobsApi resource_job_resource_get_job_get GET /jobs/{jobId} Returns the job identified by given UUID.
OutputModuleApi resource_output_module_resource_export_csv_in_job_post POST /outputModule/export/csv-job Starts a job that performs an Output Module query and stores the results in a file in CSV format.
OutputModuleApi resource_output_module_resource_export_csv_to_file_post POST /outputModule/export/csv-file Performs an Output Module query and stores the query results in a file in CSV format.
OutputModuleApi resource_output_module_resource_export_csvpost POST /outputModule/export/csv Performs an Output Module query and exports the returns results immediately in CSV format.
OutputModuleApi resource_output_module_resource_export_excel_in_job_post POST /outputModule/export/excel-job Starts a job that performs an Output Module query and stores the results in a file in Excel format.
OutputModuleApi resource_output_module_resource_export_excel_to_file_post POST /outputModule/export/excel-file Performs an Output Module query and stores the query results in a file in Excel format.
OutputModuleApi resource_output_module_resource_export_json_in_job_post POST /outputModule/export/json-job Starts a job that performs an Output Module query and stores the results in a file in JSON format.
OutputModuleApi resource_output_module_resource_export_json_to_file_post POST /outputModule/export/json-file Performs an Output Module query and stores the query results in a file in JSON format.
OutputModuleApi resource_output_module_resource_export_jsonpost POST /outputModule/export/json Performs an Output Module query and exports the returns results immediately in JSON format.
OutputModuleApi resource_output_module_resource_export_xml_in_job_post POST /outputModule/export/xml-job Starts a job that performs an Output Module query and stores the results in a file in XML format.
OutputModuleApi resource_output_module_resource_export_xml_to_file_post POST /outputModule/export/xml-file Performs an Output Module query and stores the query results in a file in XML format.
OutputModuleApi resource_output_module_resource_export_xmlpost POST /outputModule/export/xml Performs an Output Module query and exports the returns results immediately in XML format.
OutputModuleApi resource_output_module_resource_get_table_view_config_by_view_id_get GET /outputModule/tableViewConfigs/viewId/{viewId} .
RelationTypesApi resource_relation_type_resource_add_relation_type_post POST /relationTypes Adds new relation type.
RelationTypesApi resource_relation_type_resource_add_relation_types_post POST /relationTypes/bulk Adds multiple relation types.
RelationTypesApi resource_relation_type_resource_change_relation_type_patch PATCH /relationTypes/{relationTypeId} Changes the relation type with the information that is present in the request.
RelationTypesApi resource_relation_type_resource_change_relation_types_patch PATCH /relationTypes/bulk Changes multiple relation types.
RelationTypesApi resource_relation_type_resource_find_relation_types_get GET /relationTypes Returns relation types matching the given search criteria.
RelationTypesApi resource_relation_type_resource_get_relation_type_get GET /relationTypes/{relationTypeId} Returns relation type identified by given id.
RelationTypesApi resource_relation_type_resource_remove_relation_type_delete DELETE /relationTypes/{relationTypeId} Removes relation type identified by given id.
RelationTypesApi resource_relation_type_resource_remove_relation_types_delete DELETE /relationTypes/bulk Removes multiple relation types.
RelationsApi resource_relation_resource_add_relation_post POST /relations Adds a new relation.
RelationsApi resource_relation_resource_add_relations_post POST /relations/bulk Adds multiple relations in one go.
RelationsApi resource_relation_resource_change_relation_patch PATCH /relations/{relationId} Change the relation with the information that is present in the request.
RelationsApi resource_relation_resource_change_relations_patch PATCH /relations/bulk Changes multiple relations with the information that is present in the request.
RelationsApi resource_relation_resource_find_relations_get GET /relations Returns relations matching the given search criteria.
RelationsApi resource_relation_resource_get_relation_get GET /relations/{relationId} Returns an relation identified by given id.
RelationsApi resource_relation_resource_remove_relation_delete DELETE /relations/bulk Removes relations identified by given ids.
RelationsApi resource_relation_resource_remove_relation_delete_0 DELETE /relations/{relationId} Removes an relation identified by given id.
ResponsibilitiesApi resource_responsibility_resource_add_responsibilities_post POST /responsibilities/bulk Adds new responsibilities in one go.
ResponsibilitiesApi resource_responsibility_resource_add_responsibility_post POST /responsibilities Adds new responsibility.
ResponsibilitiesApi resource_responsibility_resource_find_responsibilities_get GET /responsibilities Returns responsibilities matching the given search criteria.
ResponsibilitiesApi resource_responsibility_resource_get_responsibility_get GET /responsibilities/{responsibilityId} Returns responsibility identified by given id.
ResponsibilitiesApi resource_responsibility_resource_remove_responsibilities_delete DELETE /responsibilities/bulk Removes responsibilities identified by given ids.
ResponsibilitiesApi resource_responsibility_resource_remove_responsibility_delete DELETE /responsibilities/{responsibilityId} Removes responsibility identified by given id.
RolesApi resource_role_resource_add_role_post POST /roles Adds new role.
RolesApi resource_role_resource_change_role_patch PATCH /roles/{roleId} Changes the role with the information that is present in the request.
RolesApi resource_role_resource_find_roles_get GET /roles Returns roles matching the given search criteria.
RolesApi resource_role_resource_get_role_get GET /roles/{roleId} Returns role identified by given id.
RolesApi resource_role_resource_remove_role_delete DELETE /roles/{roleId} Removes role identified by given id.
SAMLApi resource_saml_resource_get_sp_metadata_as_string_get GET /security/saml Returns the SAML Service Provider metadata for a this instance.
ScopesApi resource_scope_resource_add_scope_post POST /scopes Adds new scope.
ScopesApi resource_scope_resource_change_scope_patch PATCH /scopes/{scopeId} Changes the scope with the information that is present in the request.
ScopesApi resource_scope_resource_get_all_scopes_get GET /scopes Returns all scopes.
ScopesApi resource_scope_resource_get_scope_get GET /scopes/{scopeId} Returns scope identified by given id.
ScopesApi resource_scope_resource_remove_scope_delete DELETE /scopes/{scopeId} Removes scope identified by given id.
StatusesApi resource_status_resource_add_status_post POST /statuses Adds new status.
StatusesApi resource_status_resource_add_statuses_post POST /statuses/bulk Adds multiple statuses.
StatusesApi resource_status_resource_change_status_patch PATCH /statuses/{statusId} Changes the status with the information that is present in the request.
StatusesApi resource_status_resource_change_statuses_patch PATCH /statuses/bulk Changes multiple statuses.
StatusesApi resource_status_resource_find_statuses_get GET /statuses Returns statuses matching the given search criteria.
StatusesApi resource_status_resource_get_status_by_name_get GET /statuses/name/{statusName} Returns status identified by given name.
StatusesApi resource_status_resource_get_status_get GET /statuses/{statusId} Returns status identified by given id.
StatusesApi resource_status_resource_remove_status_delete DELETE /statuses/{statusId} Removes status identified by given id.
StatusesApi resource_status_resource_remove_statuses_delete DELETE /statuses/bulk Removes multiple statuses.
TagsApi resource_tag_resource_find_tags_get GET /tags Returns tags matching given search criteria.
TagsApi resource_tag_resource_get_tag_get GET /tags/{tagId} Returns a tag identified by given id.
TagsApi resource_tag_resource_get_tags_by_asset_id_get GET /tags/asset/{assetId} Retrieves all tags of given asset.
UserGroupsApi resource_user_group_resource_add_user_group_post POST /userGroups Adds new user group.
UserGroupsApi resource_user_group_resource_add_user_to_user_group_post POST /userGroups/{userGroupId}/users Adds users to existing user group.
UserGroupsApi resource_user_group_resource_change_user_group_patch PATCH /userGroups/{userGroupId} Changes the user group with the information that is present in the request.
UserGroupsApi resource_user_group_resource_find_user_groups_get GET /userGroups Returns user groups matching the given search criteria.
UserGroupsApi resource_user_group_resource_get_user_group_get GET /userGroups/{userGroupId} Returns user group identified by given id.
UserGroupsApi resource_user_group_resource_remove_user_group_delete DELETE /userGroups/{userGroupId} Removes user group identified by given id.
UserGroupsApi resource_user_group_resource_remove_users_from_user_group_delete DELETE /userGroups/{userGroupId}/users Removes users from the user group identified by given id.
UsersApi resource_user_resource_add_user_groups_for_user_post POST /users/{userId}/userGroups Adds user to multiple user groups.
UsersApi resource_user_resource_add_user_post POST /users Adds new user.
UsersApi resource_user_resource_add_users_post POST /users/bulk Adds multiple users.
UsersApi resource_user_resource_change_user_avatar_patch PATCH /users/{userId}/avatar Changes the avatar for the user identified by given id.
UsersApi resource_user_resource_change_user_patch PATCH /users/{userId} Changes the user with the information that is present in the request.
UsersApi resource_user_resource_find_users_get GET /users Returns users matching the given search criteria.
UsersApi resource_user_resource_get_avatar_file_get GET /users/{userId}/avatar Return the avatar image for the user identified with the requested UUID.
UsersApi resource_user_resource_get_current_user_get GET /users/current Returns current user, if logged in.
UsersApi resource_user_resource_get_user_by_email_address_get GET /users/email/{emailAddress} Returns user identified by given email address.
UsersApi resource_user_resource_get_user_get GET /users/{userId} Returns user identified by given id.
UsersApi resource_user_resource_remove_user_from_user_groups_delete DELETE /users/{userId}/userGroups Removes user from multiple user groups.
UsersApi resource_user_resource_set_user_groups_for_user_put PUT /users/{userId}/userGroups Sets user groups for user identified by given id.
WorkflowDefinitionsApi resource_workflow_definition_resource_add_asset_type_assignment_rule_post POST /workflowDefinitions/{workflowDefinitionId}/assetTypeAssignmentRules Adds an asset type assignment rule to the workflow definition specified in the request.
WorkflowDefinitionsApi resource_workflow_definition_resource_add_domain_type_assignment_rule_post POST /workflowDefinitions/{workflowDefinitionId}/domainTypeAssignmentRules Adds an domain type assignment rule to the workflow definition specified in the request.
WorkflowDefinitionsApi resource_workflow_definition_resource_change_asset_type_assignment_rule_patch PATCH /workflowDefinitions/{workflowDefinitionId}/assetTypeAssignmentRules/{ruleId} Changes asset type assignment rule with the information that is present in the request.
WorkflowDefinitionsApi resource_workflow_definition_resource_change_domain_type_assignment_rule_patch PATCH /workflowDefinitions/{workflowDefinitionId}/domainTypeAssignmentRules/{ruleId} Changes domain type assignment rule with the information that is present in the request.
WorkflowDefinitionsApi resource_workflow_definition_resource_change_workflow_definition_patch PATCH /workflowDefinitions/{workflowDefinitionId} Changes the workflow definition with the information that is present in the request.
WorkflowDefinitionsApi resource_workflow_definition_resource_deploy_workflow_definition_post POST /workflowDefinitions Deploys workflow definition (the business process and resources) using the specified request.
WorkflowDefinitionsApi resource_workflow_definition_resource_find_workflow_definitions_get GET /workflowDefinitions Finds the workflow definitions matching the criteria described in the request object.
WorkflowDefinitionsApi resource_workflow_definition_resource_get_configuration_start_form_data_get GET /workflowDefinitions/workflowDefinition/{workflowDefinitionId}/configurationStartFormData Returns the configuration start form data of the workflow task.
WorkflowDefinitionsApi resource_workflow_definition_resource_get_start_form_data_get GET /workflowDefinitions/workflowDefinition/{workflowDefinitionId}/startFormData Returns the start form data of the workflow task.
WorkflowDefinitionsApi resource_workflow_definition_resource_get_workflow_definition_diagram_get GET /workflowDefinitions/{workflowDefinitionId}/diagram Returns the diagram of the process with workflow definition identified by the given id.
WorkflowDefinitionsApi resource_workflow_definition_resource_get_workflow_definition_get GET /workflowDefinitions/process/{processId} Returns the workflow definition identified by given process id.
WorkflowDefinitionsApi resource_workflow_definition_resource_get_workflow_definition_xmlget GET /workflowDefinitions/{workflowDefinitionId}/xml Returns the XML source of the workflow definition identified by the given id.
WorkflowDefinitionsApi resource_workflow_definition_resource_remove_assignment_rule_delete DELETE /workflowDefinitions/{workflowDefinitionId}/assignmentRules/{ruleId} Removes an assignment rule identified by the given id of the assignment rule and the id of the workflow definition.
WorkflowDefinitionsApi resource_workflow_definition_resource_remove_workflow_definition_delete DELETE /workflowDefinitions/{workflowDefinitionId} Removes the workflow definition identified by given id.
WorkflowDefinitionsApi resource_workflow_definition_resource_remove_workflow_definition_post POST /workflowDefinitions/removalJobs Removes multiple workflow definitions asynchronously.
WorkflowInstancesApi resource_workflow_instance_resource_cancel_workflow_instances_post POST /workflowInstances/{workflowInstanceId}/canceled Cancels the workflow instance identified by the given.
WorkflowInstancesApi resource_workflow_instance_resource_find_workflow_instances_get GET /workflowInstances Returns workflow instances matching given search criteria.
WorkflowInstancesApi resource_workflow_instance_resource_get_workflow_instance_diagram_get GET /workflowInstances/{workflowInstanceId}/diagram Returns the file representing the diagram of workflow instance identified by the given id.
WorkflowInstancesApi resource_workflow_instance_resource_message_event_received_post POST /workflowInstances/{processInstanceId}/messageEvents/{messageName} Passes the message event to the workflow engine.
WorkflowInstancesApi resource_workflow_instance_resource_start_workflow_instances_in_job_post POST /workflowInstances/startJobs Starts workflow instances in job basing on the provided request.
WorkflowInstancesApi resource_workflow_instance_resource_start_workflow_instances_post POST /workflowInstances Starts multiple workflow instances basing on the provided request.
WorkflowTasksApi resource_workflow_task_resource_cancel_workflow_task_post POST /workflowTasks/{workflowTaskId}/canceled Cancels the workflow task identified by the given id with provided reason.
WorkflowTasksApi resource_workflow_task_resource_complete_workflow_tasks_post POST /workflowTasks/completed Completes and returns the workflow tasks basing on the provided request.
WorkflowTasksApi resource_workflow_task_resource_find_workflow_tasks_get GET /workflowTasks Returns the workflow tasks matching given search criteria.
WorkflowTasksApi resource_workflow_task_resource_get_task_form_data_get GET /workflowTasks/{workflowTaskId}/taskFormData Returns the task form data of the workflow task.
WorkflowTasksApi resource_workflow_task_resource_get_workflow_task_get GET /workflowTasks/{workflowTaskId} Returns the workflow task identified by given id.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author