Digital.ai APIs and client tools

Home

Digital.ai Continuum REST API

accept_webhook 

Accepts any JSON payload submitted, and runs it through the defined list of Directives.

Required Arguments:

Returns: Success message if successful, error message on failure.

add_cloud_keypair 

Adds a Key Pair to a Cloud.

Required Arguments:

Optional Arguments:

Returns: A list of Cloud KeyPair Objects.

add_object_tag 

Adds a security Tag to an object.

Required Arguments:

Returns: Success message successful, error message on failure.

Valid and currently implemented object_type values are:

add_project_source 

Given a Project and an Origin this will mark a Project as a "Source" Project, mark the Origin as the Projects Changes from, and will return the webhook.

Required Arguments:

Optional Arguments:

Returns: Continuum Endpoint on success, errors otherwise.

add_team_user 

Add a User to a Team.

Only a 'Team Administrator' can manage Team membership. If the credentials used for this API call are not a Team Administrator for the specified Team, the call will not succeed.

Required Arguments:

cancel_pipelineinstance 

Cancel a running Pipeline Instance.

All Pending or Processing statuses will be set to Canceled.

Required Arguments:

Returns: 'true' on success, errors on failure.

cancel_transformer_event 

Cancel failed event

    Required Arguments:

    * `inbound_id` - The inbound id of the failed event

check_transformer_data_map_name_exists 

Check if a mapping name already exists.

    Required Arguments:

    * `name` - The mapping name to be checked for existence.

    Returns a boolean indicating if the mapping already exists.

complete_activity 

Given a Phase, Package Name, Revision (or Full Version), and Activity Name - will complete that Activity with either 'success' or 'failure'.

Required Arguments:

Optional Arguments:

Returns: success on success, errors otherwise.

configure_plugin 

Configure a specific Flow Plugin.

Required Arguments:

The following keys will be encrypted if provided: token, password.

Returns: success or error.

configure_plugin_instance 

Add a new instance for a particular plugin type. Note: does not overwrite existing instances.

Required Arguments:

Optional Arguments:

Conditional Arguments: The args passed in are dependent on the plugin type specified in plugin arg. For most types they will be as they appear below, some types have other naming conventions such as api_token instead of password.

Returns: success or error.

configure_plugins 

None

copy_project 

Copy a Project.

Required Arguments:

Returns: 'true' on success, errors on failure.

create_account 

Creates a Cloud Account.

Required Arguments:

Optional Arguments:

Returns: The new Cloud Account Object.

create_asset 

Creates an Asset.

Required Arguments:

Optional Arguments:

Regarding Credentials:

Credentials are optional on an Asset, however if provided there are rules. Explicit details can be associated with only this Asset, or a Shared Credential can be specified.

The minimum required to create a LOCAL set of credentials on this Asset are:

To specify a Shared Credential, provide the shared_credential argument, which is the name of an existing Credential.

Returns: An Asset Object.

create_canvas_item 

Creates a new Canvas item.

Required Arguments:

Optional Arguments:

Returns: Success or Error message.

create_cloud 

Creates a Cloud.

Required Arguments:

Optional Arguments:

Returns: The new Cloud Object.

create_credential 

Creates a new Shared Credential.

Only a 'Developer' can create Credentials.

Required Arguments:

Optional Arguments:

Returns: A Credential Object.

create_data_map 

Creat data map for assets.

Required Arguments:

Optional Arguments:

Returns: Created ID or error message.

create_package 

Create a Package Definition.

Required Arguments:

Optional Arguments:

Returns: A Package Definition Object.

create_pipeline 

Create a Pipeline Definition.

Required Arguments:

Returns: A Pipeline Definition Object.

create_progression 

Create a Progression Definition.

Required Arguments:

Optional Arguments:

Returns: A Progression Definition Object.

create_project 

Create a Project.

Required Arguments:

Returns: A Project Object.

create_tag 

Creates a new Tag for grouping Users.

Required Arguments:

Optional Arguments:

Returns: The new Tag Object if successful, error message on failure.

create_task 

Create a new Task.

Required Arguments:

Optional Arguments:

Returns: A Task Object.

create_task_from_json 

Create a new Task from a JSON Task backup document.

Required Arguments:

Returns: A Task Object.

create_team 

Create a new team

Only an 'Administrator' can create teams. If the credentials used for this API call are not an Administrator, the call will not succeed.

Required Arguments:

Optional Arguments:

create_transformer_data_map 

Creates a new data map.

    Required Arguments:

    * `name` - The name of the data map.
    * `direction_type` - The direction of the mapping (forward-direction, backward-direction or bi-direction).
    * `forward-direction` - The field mappings for the forward direction.
    * `backward-direction` - The field mappings for the backward direction.

    Returns the id of the newly created data map.

create_user 

Creates a new user account.

Only users with the role "System Administrator" can create other users. If the credentials used for this API call do not have the proper permission, the call will not succeed.

Required Arguments:

Optional Arguments:

Returns: A User Object.

create_webhook 

Creates a new outbound Webhook configuration.

Required Arguments:

Returns: Success message if successful, error message on failure.

delete_asset 

Deletes an Asset.

Required Arguments:

Returns: Nothing if successful, error messages on failure.

delete_cloud_keypair 

Removes a Key Pair from a Cloud.

Required Arguments:

Returns: A list of Cloud KeyPair Objects.

delete_credential 

Removes a Shared Credential.

Required Arguments:

Returns: Success message if successful, error message on failure.

delete_data_map 

Delete data map.

Required Arguments:

Returns: Success or error message.

delete_package 

Delete a Package Definition. Destructive of history, and there is no undo.

Required Arguments:

Optional Arguments:

Returns: 'true' on success, errors on failure.

delete_pipeline 

Permanently delete a Pipeline Definition.

Required Arguments:

Returns: 'true' on success, errors on failure.

delete_pipelinegroup 

Permanently delete a Pipeline Instance Group.

NOTE: at the moment, requires the '_id' of the Pipeline Instance Group.

Required Arguments:

Returns: 'true' on success, errors on failure.

delete_pipelineinstance 

Permanently delete a Pipeline Instance.

Required Arguments:

Returns: 'true' on success, errors on failure.

delete_plan 

Deletes a specific queued execution Plan.

Required Arguments:

Returns: Nothing if successful, error messages on failure.

delete_progression 

Delete a Progression Definition. Destructive of history, and there is no undo.

Required Arguments:

Returns: 'true' on success, errors on failure.

delete_project 

Permanently delete a Project.

Required Arguments:

Optional Arguments:

Returns: 'true' on success, errors on failure.

delete_registry 

Permanently delete a registry.

Required Arguments:

Returns: 'true' on success, errors on failure.

delete_schedule 

Deletes a Task Schedule and all queued execution Plans.

Required Arguments:

Returns: Nothing if successful, error messages on failure.

delete_tag 

Deletes a security Tag.

Required Arguments:

Returns: Success message if successful, error message on failure.

delete_task 

Deletes all versions of a Task.

Required Arguments:

Optional Arguments:

Returns: Nothing if successful, error messages on failure.

delete_transformer_data_map 

Delete the data map.

    Required Arguments:

    * `id` - The id of the data map.

delete_user 

Deletes a user account

Only users with the role "System Administrator" can delete users. If the credentials used for this API call do not have the proper permission, the call will not succeed.

Required Arguments:

deliver_revision 

Delivers a Package Revision out of a Progression into a Delivered condition.

Required Arguments:

Returns: success on success, errors otherwise.

describe_task_parameters 

Describes the Parameters for a Task.

Required Arguments:

Optional Arguments:

Returns: A help document describing the Task Parameters.

edit_email_configuration 

Configure email notification for the data map.

           Required Arguments:

           * `id` - The id of the data map.

export_canvas 

Generates an export JSON document all Canvas items.

This function is capable of exporting items from the "filesystem" repository, which is an administrative feature.

Optional Arguments:

Returns: A JSON document containing Canvas items.

export_catalog 

Export all Project, Pipeline, Package, and Task definitions to a catalog as a JSON document.

Returns: A JSON document containing all Project, Pipeline, Package, and Task definitions.

export_package 

Export a Package Definition as a portable backup JSON document.

Required Arguments:

Returns: A Package Definition Object.

export_pipeline 

Export a Pipeline Definition as a portable backup JSON document.

Required Arguments:

Returns: A Pipeline Definition Object.

export_plugins 

None

export_progression 

Export a Progression Definition as a portable backup JSON document.

Required Arguments:

Returns: A Progression Definition Object.

export_project 

Gets a Project object for export. (Will not include the _id.)

Required Arguments:

Returns: A Project Object.

export_task 

Create a backup file for a single Task.

The behavior of this command is different depending on the Accept header.

Required Arguments:

Optional Arguments:

Returns: A collection of Task backup objects.

get_account 

Gets a Cloud Account.

Required Arguments:

Returns: A Cloud Account Object.

get_asset 

Gets an Asset.

Required Arguments:

Returns: An Asset Object.

get_cloud 

Gets a Cloud object.

Required Arguments:

Returns: A Cloud Object.

get_data_map 

Get list of data mappings.

If no 'mapping_id' is supplied, return all mappings.

Optional Arguments:

Returns: Result or error message.

get_feature_deliverycategory 

Get the effective delivery category for a feature, as determined by the condition of all that features workitems.

Required Arguments:

Returns: An array of timeline events for the specified workitem.

get_license 

Get the license details.

Required Arguments:

Returns: The relevant properties of the current license.

get_log 

Gets the log for a specific service or automation instance.

Required Arguments:

Optional Arguments:

NOTE: specifying lines=all can return a very large amount of data.

Returns: An array of log entries or a text buffer (depending on the concatenate option) in the requested format.

get_mappings_for_relationship 

Gets all the available data maps for given instances.

    Required Arguments:

    * `inbound_instance` - The system 1 instance id.
    * `outbound_instance` - The system 2 instance id.
    * `mappingId` - Id of current data map.

    Returns a list of data map objects.

get_next_id 

Get the next integer id in a named ID set.

Required Arguments:

Optional Arguments:

Returns: 'true' on success, errors on failure.

get_package 

Returns the definition of the specified Package.

Required Arguments:

Returns: The Package definition document.

get_package_manifest 

Returns the complete Manifest of a Package Version, given a range of Revisions.

Required Arguments:

Optional Arguments:

Note: If both version and version_of_rev are provided, version takes precedence.

Returns: The Manifest (Workitems, Changes and Artifacts) contained in the specified Package Revision range.

get_package_revision_manifest 

Returns the complete Manifest of a Package Version, given a range of Revisions.

Required Arguments:

Optional Arguments:

Returns: The Manifest (Workitems, Changes and Artifacts) of the specified Package Revision.

get_package_revision_phase_doc 

Creates a new Revision of a specified Version of a Package.

Required Arguments:

Returns: Data about the current Revisions relationships in its Progression.

get_package_revision_progression 

Returns the Progression definition for a specific Package Revision. (Name, Phase names and order, etc.)

Required Arguments:

Returns: The Progression the specified Package Revision subscribes to.

get_pi_artifacts 

Gets the Changes from the Manifest of a Pipeline Instance.

Required Arguments:

Returns: A JSON document representing all Changes on the Manifest.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pi_changes 

Gets the Changes from the Manifest of a Pipeline Instance.

Required Arguments:

Returns: A JSON document representing all Changes on the Manifest.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pi_data 

Gets a Pipeline Instance Data object.

Required Arguments:

Optional Arguments:

Returns: A Pipeline Instance.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pi_workitems 

Gets the Workitems from the Manifest of a Pipeline Instance.

Required Arguments:

Returns: A JSON document representing all Workitems on the Manifest.

Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.

get_pipeline 

Gets a Pipeline Definition object.

Required Arguments:

Returns: A Pipeline Definition Object.

get_pipelineinstance 

Gets a Pipeline Instance object.

Required Arguments:

Optional Arguments:

Returns: A Pipeline Instance.

get_plugin_schema 

Returns the Schema for a given plugin.

    REQUIRED Args:
        - plugin_name: The name of the plugin to be returned.

get_progression_details 

Gets details about a Progression suitable for populating the display of a Progression Board.

Required Arguments:

Optional Arguments:

Returns: A Progression Details Object.

get_project 

Gets a Project object.

Required Arguments:

Returns: A Project Object.

get_project_changes 

Gets all the changes submitted to a Project.

Required Arguments:

Returns: An array of change objects.

get_registry 

Gets a registry document by name.

Required Arguments:

Returns: the entire Registry document on success, 'not found' otherwise.

get_settings 

Lists all the settings of modules.

Optional Arguments:

Returns: A Settings Object.

get_submission 

Gets a raw 'Submission' payload using a query.

Required Arguments:

If the query would return multiple submissions, the newest one is matched.

Returns: the Submission document on success, 'not found' otherwise.

get_system_log 

Gets the system log. If all arguments are omitted, will return the most recent 100 entries.

Optional Arguments:

Returns: A list of Log Entry Objects.

get_task 

Gets a Task object.

Required Arguments:

Optional Arguments:

Returns: A Task Object.

get_task_instance 

Gets the details of a Task Instance.

Required Arguments:

Returns: A Task Instance Object.

get_task_instance_status 

Gets just the Status of a Task Instance.

Required Arguments:

Returns: The 'Status' from a Task Instance Object.

get_task_instances 

Gets a list of Task Instances.

Optional Arguments:

Returns: A list of Task Instance Objects.

get_task_log 

Gets the run log for a Task Instance.

Required Arguments:

Returns: A Task Log Object.

get_task_parameters 

Gets a Parameters template for a Task.

Required Arguments:

Optional Arguments:

Returns: An XML template defining the Parameters for a Task.

This function is not affected by the output_format option. The Response is always an XML document.

get_task_plans 

Gets a list of the queued execution plans for a Task.

Required Arguments:

Optional Arguments:

Returns: A list of Execution Plan Objects.

get_task_schedules 

Gets a list of Schedule definitions for a Task.

Required Arguments:

Optional Arguments:

Returns: A list of Task Schedule Objects.

get_token 

Gets an authentication token for the API, which is the preferred alternative to 'Basic' authorization.

This function requires Basic authorization to be enabled.

Pass an Authorization header of type Basic to retrieve your Token.

If a token doesn't exist for the authenticated User, this method will generate a new token.

Returns: An authentication token.

get_transformer_assets 

Gets all asset types for the selected project in the selected transformer plugin instance.

    Required Arguments:

    * `plugin_id` - The id of the plugin.
    * `instance_id` - The id of the instance of the plugin.
    * `project_id` - The id of the selected project.

    Returns a list of the format {'id': <ASSET_ID>, 'name': <ASSET_NAME>}.

get_transformer_automap 

Gets a data map for automapped fields

    Required Arguments:
    
    * `source_field_id` - The field id of the source system.
    * `target_field_id` - The field id of the target system.

    Returns a data map objct with automapped fields.

get_transformer_data_map 

Gets a data map for listing.

    Required Arguments:

    * `id` - The id of the data map to be retrieved.

    Returns a single data map object.

get_transformer_data_map_all_sync_log 

None

get_transformer_data_map_sync_log_by_inbound 

None

get_transformer_data_maps 

Gets all the available data maps.

    Returns a list of data map objects.

get_transformer_datamap_for_edit 

Gets a data map for editing.

    Required Arguments:

    * `id` - The id of the data map to be retrieved.

    Returns a single data map object.

get_transformer_fields 

Gets all asset types for the selected project in the selected transformer plugin instance.

    Required Arguments:

    * `plugin_id` - The id of the plugin.
    * `instance_id` - The id of the instance of the plugin.
    * `project_id` - The id of the selected project.
    * `project_name` - The name of the selected project.

    Optional arguments:
    * `tracker_id` - The id of the selected tracker. (Mandatory for TF).
    * `tracker_name` - The name of the selected tracker. (Mandatory for TF).
    * `issuetype_id` - The id of the selected issyuetype. (Mandatory for Jira).
    * `issuetype_name` - The name of the selected issyuetype. (Mandatory for Jira).
    * `asset_type_id` - The id of the selected asset type. (Mandatory for V1).
    * `asset_type` - The name of the selected asset type. (Mandatory for V1).
    * `workitemtype_id` - The id of the selected workitem type. (Mandatory for Azure Devops).
    * `workitemtype_name` - The name of the selected workitem type. (Mandatory for Azure Devops).

    Returns a list of the format {'id': <ASSET_ID>, 'name': <ASSET_NAME>}.

get_transformer_fields_for_create 

Gets all asset types for the selected project for the 2 selected transformer plugin instances.

    Required Arguments:

    * `system_1` - Details of the first plugin instance.
    * `system_2` - Details of the second plugin instance.

    Mandatory Details for both system_1 and system_2.

    * `plugin_id` - The id of the plugin.
    * `instance_id` - The id of the instance of the plugin.
    * `asset` -
        * `project_id` - The id of the selected project.
        * `project_name` - The name of the selected project.

    Optional Details for both system_1 and system_2:
    * `asset` -
        * `tracker_id` - The id of the selected tracker. (Mandatory for TF).
        * `tracker_name` - The name of the selected tracker. (Mandatory for TF).
        * `issuetype_id` - The id of the selected issyuetype. (Mandatory for Jira).
        * `issuetype_name` - The name of the selected issyuetype. (Mandatory for Jira).
        * `asset_type_id` - The id of the selected asset type. (Mandatory for V1).
        * `asset_type` - The name of the selected asset type. (Mandatory for V1).

    Returns a list of the format {'id': <ASSET_ID>, 'name': <ASSET_NAME>}.

get_transformer_instances 

Gets all plugin instances that support transformer functionality.

    Returns a list of the following format.
    {'id': <PLUGIN_ID>, 'name': <PLUGIN_NAME>, 'instances': {'id': <INSTANCE_ID>, 'name': <INSTANCE_NAME>}

get_transformer_projects 

Gets all projects in the selected transformer plugin instance.

    Required Arguments:

    * `plugin_id` - The id of the plugin.
    * `instance_id` - The id of the instance of the plugin.

    Returns a list of the format {'id': <PROJECT_ID>, 'name': <PROJECT_NAME>}.

get_transformer_system_info_for_edit 

Gets a data map for listing without the field mapping info.

    Required Arguments:

    * `id` - The id of the data map to be retrieved.

    Returns a single data map object without field mapping info.

get_transformer_workflow 

Gets the workflow for given projects and asset type.

            Required Arguments:

            * `instance_id` - The system instance id.
            * `plugin_id` - The system plugin id.
            * `projects` - selected projects.
            *  `assets`  - selected asset

            Returns a workflow.

get_user_teams 

Get a list of all Teams of which the authenticated API user is a member, and their assigned Role.

Returns: A list of the User's Teams and Roles.

get_workitem 

Get the details of a specific workitem.

Required Arguments:

Returns: A workitem document.

get_workitem_deliverycategory 

Get all the packages a workitem is in, and the effective delivery category for the workitem.

Required Arguments:

Returns: An array of timeline events for the specified workitem.

get_workitem_parent 

Get the details of a specific feature.

Required Arguments:

Returns: A workitem parent document.

get_workitem_timeline 

Get the timeline of a specific workitem.

Required Arguments:

Returns: An array of timeline events for the specified workitem.

get_worklist 

Gets a list of Pipeline in 'pending' status.

Optional Arguments:

Returns: A list of pending Pipeline Instances.

healthcheck 

Performs a 'health check' on the sytem.

Returns: true/false if the system is 'healthy' and additional details.

import_backup 

Imports an XML or JSON backup file.

DEPRECATED: this function is deprecated. Use import_task instead.

Required Arguments:

Returns: A list of items in the backup file, with the success/failure of each import.

import_catalog 

Import all Project, Pipeline, Package, and Task definitions from a catalog as a JSON document.

Optional Arguments:

Returns: A list of all Project, Pipeline, Package, and Task definitions with the name and status of import or exception.

import_mapping 

Extracts relevant information from imported Mapping from ALMC mapping.

            Required Arguments:

            * `Source` - Source to which imported mapping belongs.

            Required for ALMC:

            * `MappingData` - Data from Mapping XML.
            * `IntegrationData` - Data from Integration json.

            Returns the extracted data as a dictionary.

import_package 

Import a Package Definition from a backup file.

Required Arguments:

Optional Arguments:

If 'overwrite' is 'true' and the Definition exists, it will be replaced.

Returns: Success or error.

import_pipeline 

Import a Pipeline Definition.

Required Arguments:

Optional Arguments:

Returns: A Pipeline Definition Object.

import_progression 

Import a Progression Definition from a backup file.

Required Arguments:

Optional Arguments:

Returns: Success or error.

import_project 

Import a Project.

Required Arguments:

Optional Arguments:

Returns: A Project Object.

import_task 

Imports a Task backup file.

Required Arguments:

Optional Arguments:

NOTE: There may be multiple Tasks in a single backup file, as often Tasks have dependencies on other Tasks, so all are included.

Returns: A list of items in the backup file, with the success/failure of each import.

initiate_pipeline 

Attempt to initiate a Pipeline Definition.

Required Arguments:

Optional Arguments:

Returns: A Pipeline Instance Object.

install_add_on 

Installs an Add-On from the vs-exchange

Required Arguments:

Optional Arguments:

Returns: success on success, errors otherwise.

install_license 

Installs a license file.

Required Arguments:

Returns: Success or Error message.

invoke_plugin 

Invoke a Plugin Function.

Required Arguments:

Optional Arguments:

This API call will block the thread while it waits for the Plugin Function to execute. Therefore, the timeout argument should be kept reasonably small based on the Plugin Function being executed to reduce the amount of time the thread remains blocked. This API cannot invoke Pipeline Step Plugin Functions. Pipeline Step Plugin Functions require the context of a Step to run successfully.

Returns: Response varies depending on the Plugin Function called.

list_add_ons 

Lists all Add-Ons installed in this Continuum instance.

Optional Arguments:

Returns: A list of Add-On details.

list_assets 

Lists all Assets.

Optional Arguments:

Returns: A list of Asset Objects.

list_canvas_items 

Returns a list of all elements in the Canvas feature.

Optional Arguments:

Returns: A list of all Canvas elements.

list_changes 

Lists all Changes.

Optional Arguments:

Returns: A list of Changes{:target="robjs"}.

list_cloud_accounts 

Lists all Cloud Accounts.

Optional Arguments:

Returns: A list of Cloud Account Objects.

list_cloud_keypairs 

Lists all the Key Pairs defined on a Cloud.

Required Arguments:

Returns: A list of Cloud KeyPair Objects.

list_clouds 

Lists all Clouds.

Optional Arguments:

Returns: A list of Cloud Objects.

list_credentials 

Lists all Shared Credentials.

Optional Arguments:

Returns: A list of Credential Objects.

list_packages 

Lists all Package Definitions.

Returns: A list of Package Definition Objects.

list_pipelinegroups 

Lists all Pipeline Instance Groups (Stories).

Optional Arguments:

Returns: A list of Pipeline Instance Group Objects.

list_pipelineinstances 

Lists all Pipeline Instances.

Optional Arguments:

Returns: A list of Pipeline Instance Objects.

list_pipelines 

Lists all Pipeline Definitions.

Returns: A list of Pipeline Definition Objects.

list_processes 

Lists all running processes.

Returns: A list of Process Objects.

list_progressions 

Lists all Progressions.

Returns: A list of [Progression Objects](api-response-objects#progression.

list_projects 

Lists all Projects.

Optional Arguments:

Returns: A list of Project Objects.

list_registries 

Lists all Registries

Returns: A list of [Registry Objects]

list_tags 

Lists all Tags.

Optional Arguments:

Returns: A list of Tag Objects.

list_tasks 

Lists all Tasks..

Optional Arguments:

Returns: A list of Task Objects.

The Task Objects returned to this function are streamlined - they do not contain all the properties available in the get_task endpoint.

list_users 

Lists all registered Users.

Only users with the role "System Administrator" can list all registered users. If the credentials used for this API call do not have the proper permission, the call will not succeed.

Optional Arguments:

Returns: A list of User Objects.

metric 

Given a named metric and required context retrieve the value of that metric

Required Arguments:

* `type` - The name of the desired metric
* `context` - A collection of key value pairs specific to the type provided

Returns: The value of the the requested metric

new_revision 

Creates a new Revision of a specified Version of a Package.

Required Arguments:

Optional Arguments:

Note: Often, it is desireable that the full_version actually contain the number of the newly created Revision. A special keyword, __NEWREVISION, is recognized in the value provided for full_version and will be replaced with the new Revision number.

Returns: A Package Revision document if successful, errors otherwise.

override_control 

Given a Package Revision, a Phase and a Control Name, will override that Control if it exists and is failed.

Required Arguments:

Returns: success on success, errors otherwise.

post_pi_data 

Post data to the Workspace on a running Pipeline Instance.

Required Arguments:

All data is posted under a parent key - 'returns', to protect the overall Workspace.

Returns: 'true' on success, errors on failure.

Example using curl using a variable for the pipeline instance id and posting an array of values:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Token 5752fb9abb288013973fabf4" -d "{\"pi\": \"$PI_ID\", \"key\":\"hello\", \"value\": [\"world2\", \"earth\", \"mars\"]}" "http://continuum-server.example.com:8080/api/post_pi_data"

promote_revision 

Promotes a Package Revision to a particular Phase.

Required Arguments:

Optional Arguments:

Returns: success on success, errors otherwise.

register_artifact 

Record a new revision of a specific Artifact.

Required Arguments:

Returns: success on success, errors otherwise.

remove_object_tag 

Removes a Tag from an object.

Required Arguments:

Returns: Success message if successful, error message on failure.

remove_team 

Remove an empty Team.

Only a 'System Administrator' can remove a team. If the credentials used for this API call are not a Syetem Administrator, the call will not succeed.

Required Arguments:

remove_team_user 

Remove a User from a Team.

Only a 'Team Administrator' can manage Team membership. If the credentials used for this API call are not a Team Administrator for the specified Team, the call will not succeed.

Required Arguments:

Optional Arguments:

NOTE: if a new Default Team is assigned, the User will be given the User role in the Default Team

rerun_pipelineinstance 

Rerun an Instance, using the saved 'initial data'.

This creates a new Instance exactly as the provided one was started.

Required Arguments:

Returns: A Pipeline Instance Object.

reset_password 

Resets the password of the authenticated, or a specified User.

If a user is specified, and the authenticated user is an Administrator, this will reset the password of the specified user to the provided value.

If no user is specified, the password of the authenticated user will be changed.

NOTE: to prevent accidental change of an Administrators password, an extra trap is in place: the username (or id) MUST be provided, even if the authenticated user is the user being changed.

Required Arguments:

Optional Arguments:

Returns: Success message if successful, error messages on failure.

resubmit_change 

Resubmits a change 'Submission' payload to the specified Project.

Required Arguments:

If the query would return multiple submissions, the newest one is matched.

Returns: 'true' on success, errors on failure.

resubmit_task_instance 

Resubmits an Errored or Cancelled Task Instance. Resubmit is only valid on Errored or Cancelled Task Instances.

Required Arguments:

Returns: Returns: Nothing if successful, error messages on failure.

resync_transformer_event 

Resync failed event

    Required Arguments:

    * `inbound_id` - The inbound id of the failed event

retry_pipelineinstance 

Attempt to retry a failed Pipeline Instance. Simply restarts it again at Phase One.

CAUTION: The Workspace data is not cleared or reset. Depending on the design of the Pipeline, this may not succeed, or might produce unexpected results.

Required Arguments:

Returns: A Pipeline Instance Object.

reversion_packagerevision 

Changes the Version of the specified (and all matching previous) Package Revisions.

Required Arguments:

Returns: success on success, errors otherwise.

run_metric 

Runs a specific metric.

Required Arguments:

Optional Arguments:

Returns: success on success, errors otherwise.

run_task 

Runs a Task.

Required Arguments:

Optional Arguments:

Returns: A Task Instance Object.

save_email_configuration 

Configure email notification for the data map.

           Required Arguments:

           * `id` - The id of the data map.

schedule_tasks 

Schedules one or more Tasks.

Required Arguments:

Schedule definition format:

All lists are zero based integers.

The Task Schedule Object response from the get_task_schedules command in JSON format can provide schedule definition examples for this command.

[
    {
        "Task" : *task name*,
        "Version" : *optional*,
        "Months": "*" or [list of months],
        "DaysOrWeekdays": "Days" = days of the month, "Weekdays" = days of the week (default),
        "Days": "*" or [list of days],
        "Hours": "*" or [list of hours],
        "Minutes": "*" or [list of minutes]
    },
    {
        ...
    }
]

Returns: Nothing if successful, error messages on failure.

send_message 

Sends a message to a registered user. Message will be 'From' the authenticated API user.

The 'to' argument accepts both email addresses AND Continuum Users. Each item in the 'to' list will try to look up a Continuum User, and if it doesn't match, will assume the entry is an email address.

Required Arguments:

Optional Arguments:

Returns: Success message if successful, error message on failure.

set_pi_data 

Set Workspace data on a running Pipeline Instance.

Required Arguments:

NOTE: USE WITH CAUTION! This function has the ability to overwrite values anywhere in the Workspace. For safer and more common cases, use 'post_pi_data'.

Returns: 'true' on success, errors on failure.

Example using curl:

curl http://continuum-server.example.com:8080/api/set_pi_data?token=5752fb9abb288013973fabf4&key=hello&value=world&pi=57acb49a320c7a41bf32958a

set_pi_description 

Set the description of a specific Pipeline Instance

Required Arguments:

Returns: 'true' on success, errors on failure.

set_pi_global_summary 

Set global summary data on a pipeline instance

Required Arguments:

Returns: 'true' on success, errors on failure.

Example using curl:

curl http://continuum-server.example.com:8080/api/set_pi_data?token=5752fb9abb288013973fabf4&key=hello&value=world&pi=57acb49a320c7a41bf32958a

set_pipelinegroup_number 

Set the autonumber root on Pipeline Instance Group. (Used to issue ascending numbers to Instances in the Group.)

Required Arguments:

Returns: 'true' on success, errors on failure.

set_project_directives 

Set the directives of an existing project with id project_id.

The parameter directives must be present, but its value can be null or an empty list. Any existing directives will be removed from the project before the given directives are added. Therefore, if directives is null or [], the project will be updated to no longer have any directives.

Currently, the following directive types are supported:

Required Arguments:

Each directive consists of a dictionary with the following shape:

{
  "type": "jira_workitem_lookup",
  "when": "always",
  "details": {}
}

Example payload:

{
  "project_id": "5fda00c4c78ea1fe8779cf8e",
  "directives": [
    {
      "type": "jira_workitem_lookup",
      "when": "always",
      "details": {
        "instance_name": ""
      }
    },
    {
      "type": "assign_to_pipeline",
      "when": "always",
      "details": {
        "project": "",
        "group": "a group",
        "definition": "a definition"
      }
    }
  ]
}

Returns: success on success, errors otherwise.

set_registry 

Sets values in a specific Registry document.

Required Arguments:

Optional Arguments:

Returns: success on success, errors otherwise.

stop_task 

Stops a running Task Instance.

Required Arguments:

Returns: Nothing if successful, error messages on failure.

submit_change 

Submits a change payload to the specified Project.

Required Arguments:

NOTE: This API is different than most others. It's expecting a JSON document as HTTP POST data. The required toproject argument can either be provided inside the POST data, or on the URL querystring.

Returns: 'true' on success, errors on failure.

test_plugin_connection 

Tests connectivity to a Plugin instance defined in the Continuum configuration.

Required Arguments:

One of:

Optional Arguments:

Returns: A success message or error message

uninstall_add_on 

Uninstalls an Add-On from Continuum

Required Arguments:

Returns: success on success, errors otherwise.

update_cloud 

Updates a Cloud.

Required Arguments:

Optional Arguments:

Returns: The updated Cloud Object.

update_settings 

Updates the settings of a process or module.

NOTE: the update_settings command requires submission of a JSON settings object. As a guide for updating settings, first execute this command with the Accept: application/json header (or output_format=json argument).

For example, to update Messenger settings, first do:

get_settings?module=messenger&output_format=json

...then use the result as a template for update_settings.

Required Arguments:

Returns: Nothing if successful, error messages on failure.

update_transformer_data_map 

Updates a data map.

    Required Arguments:

    * `id` - The id of the data map.

    Optional Arguments:

    * `name` - The name of the data map.
    * `direction_type` - The direction of the mapping (forward-direction, backward-direction or bi-direction).
    * `forward-direction` - The field mappings for the forward direction.
    * `backward-direction` - The field mappings for the backward direction.

    Returns the id of the data map.

update_transformer_data_map_with_new_fields 

Updates data map by fetching new fields from the target systems

    Required Arguments:
    *  id - The id of the data map


    Returns the id of the data map.

update_user 

Updates a user account.

Only users with the role "System Administrator" can update users. If the credentials used for this API call do not have the proper permission, the call will not succeed.

Properties will only be updated if the option is provided. Omitted properties will not be changed.

NOTE: the "username" of a user cannot be changed.

If a user has 'locked' their account by numerous failed login attempts, the flag is reset by setting any property. It's easiest to just set the status to 'enabled'.

Required Arguments:

Optional Arguments:

Returns: A User Object.

v1_workitem_sync 

Accepts telemetry from Digital.ai Agility regarding changes to Workitems.

NOTE: This API is specifically bound to the format of Digital.ai Agility webhooks. It's expecting a JSON document as HTTP POST data. See the Digital.ai Agility webhooks documentation for the actual schema.

This API hands processing off to a jobhandler thread. Therefore it will always return 'success' in accepting the payload, or an error. A 'success'ful API transaction does not mean that Continuum successfully processed the payload - watch the jobhandler log for details.

validate_instance 

Validate an instance of Continuum exists and the request is authenticated.

Returns: Success or Error message.

version 

Returns: The Continuum version.

INTERNAL API FUNCTIONS

The following endpoints are for internal use. They are not guaranteed to remain in the API, and can change at any time without warning. Use at your own risk.

associate_commits_to_v1_workitem 

Required Arguments:

build_stream 

Gets all pipeline instances that a workitem participated in.

Required Arguments:

Returns: Related Pipeline Instances.

delete_workitems 

Permanently delete a matched set of Workitems.

NOTE: This is a destructive operation that cannot be undone. Deleting workitems affects audit history, package and automation manifests, and metrics.

Optional Arguments:

At least one of the following options must be provided. These are matching criteria for the workitems to delete.

Returns: 'true' on success, errors on failure.

winrm_command 

Test connectivity or issue Windows Remote Management commands on a defined Asset.

Required Arguments:

OR

Optional Arguments:

Returns: The result of the command, or errors.

xlrelease_status 

This endpoint expects a customized response from XL Release.

This payload will be evaluated and mapped (if possible) to the appropriate Continuum context, be that a Pipeline Instance, Package Revision, or other asset.

This payload must be an JSON object with the following two root level keys:

Example Payload:

{
    "continuum_context": {
        "project_id": "abc123",
        "pipeline_id": ""zyx890",
        "all the other": "data in the context"
    },
    "xlrelease_details": {
        "all the details": "of the release"
    }
}

Returns: HTTP Return Code, no data.