Add comment to a work item
Required Arguments:
* `system_details` - Details of the plugin instance including 'url', 'username' and 'password' as dictionary.
{
'system_type': 'v1plugin',
'url': 'plugin_url',
'username': 'some_username',
'password': 'password/token'
}
In case the plugin expects token instead of password, put the token value in 'password' key.
* `comment_details` - Details of the comment to post on work item
{
'workitem_id': workitem_id,
'body': 'content of the comment'
}
Return the comment resource created in the plugin system
None
Creates a custom field
Required Arguments:
* `system_details` - Details of the plugin instance including 'url', 'username' and 'password' as dictionary.
{
'system_type': 'v1plugin',
'url': 'plugin_url',
'username': 'some_username',
'password': 'password/token'
}
In case the plugin expects token instead of password, put the token value in 'password' key.
* `assets` - Details of the custom field categorized as per their asset type
"assets": {
"Story": {
"create_fields": [
{
"name": "v1_story_text_1",
"type": "text",
"is_required": True
},
{
"name": "v1_story_text_2",
"type": "text",
"is_required": True
}
]
},
"Task": {
"create_fields": [
{
"name": "v1_task_number_1",
"type": "number"
},
{
"name": "v1_task_text_3",
"type": "text"
}
]
}
}
Returns the list of success messages for create custom fields.
Create projects in a system.
Required Arguments:
* "system_details": Dict of system details.
eg:
{
"system_type": "v1plugin",
"url": "http://localhost:8080",
"username": "admin_user",
"password": "admin_password"
}
* "projects" : List of project names that needs to be created a system.
* Return list of success message list
Check if a given data map exists, if yes then deletes it and 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.
None
None
Fetch comment from a work item
Required Arguments:
* `system_details` - Details of the plugin instance including 'url', 'username' and 'password' as dictionary.
{
'system_type': 'v1plugin',
'url': 'plugin_url',
'username': 'some_username',
'password': 'password/token'
}
In case the plugin expects token instead of password, put the token value in 'password' key.
* `comment_details` - Details of the comment to post on work item
{
'workitem_id': workitem_id
}
Return the comment from the work item
None
generate data mapping'
Required Arguments:
* system1_field_id - The field id of the system1.
* system2_field_id - The field id of the systemm2.
* input_mapping - input json of field mapping
Returns a data map json.
Required Arguments:
* `id` - Data map id.
* `workitem_id` - Workitem ID.
* `sync_reference_direction` - Sync reference direction.
Returns:
True if sync reference is successful (If backlink is created successfully in a respective system)
False if sync reference is unsuccessful (If backlink is not created successfully in a respective system)
None
Compares two comments and returns the comparison result
Required Arguments:
* `comment_details` - Details of the comment to fetch from work item
{
'comment_from_source': "some comment",
'comment_from_target': 'some comment'
}
Return True/False if the comment is found in the work item
Accepts any JSON payload submitted, and runs it through the defined list of Directives.
Required Arguments:
handler - name of a defined 'Webhook Handler' containing directives to apply to this payload.Returns: Success message if successful, error message on failure.
Adds a Key Pair to a Cloud.
Required Arguments:
cloud - Name or ID of the Cloud to update.name - a name for the Key Pair.private_key - the private key.Optional Arguments:
passphrase - a passphrase for this Key Pair.Returns: A list of Cloud KeyPair Objects.
Adds a security Tag to an object.
Only users with the following roles can add a tag to an object: ["System Administrator", "Team Administrator"].
Required Arguments:
tag - The name of the Tag.object_id - The ID of the object.object_type - The numeric type of the object.Returns: Success message successful, error message on failure.
Valid and currently implemented object_type values are:
User = 1Asset = 2Task = 3Canvas Item = 50Add Phases to a given Progression.
Required Arguments:
* `name` - the name of a Progression.
* `phases` - An array of Phase objects to be added
Phase Shape:
* `name` - The name of the Phase
* `description` - Description of the Phase
* `before_phase` - ** OPTIONAL ** Name of the existing Phase to be inserted before. If omitted, the new Phase will be appended to the end.
* `code_complete` - **OPTIONAL** Boolean True if "delivery category" is to be set to "packaged"
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:
project - Name of the Project to alter.origin - Name of the VCS to mark as the Projects 'Changes From' field.
'github' - GitHub Webhook
'gitlab' - GitLab Webhook
'ispw' - Compuware ISPW
'tfsgit' - VSTS/TFS Git Webhook
'tfvc' - VSTS/TFS TFVC Webhook
'tfstfvs_soap' - VSTS/TFS 2013 SOAP Webhook
'teamforgegit' - TeamForge Git Webhook
'teamforgesvn' - TeamForge Subversion Webhook
'bitbucket' - BitBucket Cloud Webhook
'bitbucketserver' - BitBucket Server Webhook
'other' - Continuum Format Webhook
'git' - Git Post Receive Hook * Not Currently supported *
'subversion' - Subversion Poller * Not Currently supported *
Optional Arguments:
plugin_instance_name - the name of the plugin instance to use when making external api callsReturns: Continuum Endpoint on success, errors otherwise.
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:
team - Name or ID of the Team to change.user - Name or ID of the User to add.Cancel a running Pipeline Instance.
All Pending or Processing statuses will be set to Canceled.
Required Arguments:
pi - The Name or ID of a Pipeline Instance.Returns: 'true' on success, errors on failure.
Cancel failed event
Required Arguments:
* `inbound_id` - The inbound id of the failed event
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.
Clone data map.
Required Arguments:
* `id` - The id of the data map.
Given a Phase, Package Name, Revision (or Full Version), and Activity Name - will complete that Activity with either 'success' or 'failure'.
Required Arguments:
package - Name of the Package to promote to a progression Phase.revision - Revision number of a Package to promote, takes precedence over full_version.full_version - Full Version of package to promote, optional alternative selector to revision.phase - Name of the Phase containing the Activity to complete.activity - Name of the Activity to complete.Optional Arguments:
notes - Notes to be attached to the Activity. (May be configured to be required.)failure - Mark the Activity as a 'failure'. (success if omitted.)forcewith - Force completion by setting all Controls to pass or fail.completion_time - Mark the activity complete at a specified time.
timezome - Optional modifier for 'completion_time'.
Returns: success on success, errors otherwise.
Configure a specific Flow Plugin.
Required Arguments:
plugin - JSON object formatted as valid configuration for the specified plugin. Contains the following fields:
_plugin - The name or ui label of the plugin to be modified._enabled - boolean, the plugin is enabled or notteam - The team for which the plugin is being configured, omit if global.instances - Individual instances of the plugin. Can be omitted. See 'get_plugin_schema' for an example of an instance for the given plugin.The following keys will be encrypted if provided:
token,password.
NOTE: This is a destructive operation! Configuring a plugin's instances will replace all previous configured instances for the given team. If no team is specified, all global instances of the plugin will be replaced with the new configuration instead. If you wish to reconfigure any one particular instance of the plugin, see 'configure_plugin_instance'.
Returns: success or error.
Add a new instance for a particular plugin type. Note: does not overwrite existing instances unless 'overwrite' flag is True. Required Arguments:
plugin - Plugin type.name - Name of new plugin instance.Optional Arguments:
team - Team with which to associate this plugin instance. Defaults to All Teams.isdefault - Will make this the default instance for the Team. Defaults to False.overwrite - Will allow API to overwrite an instance with existing name.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.
url - Server URL.user - LoginID for server.password - Password for server.api_token - API token for plugin instance. This will map to a value of "Token" in the ui and "token" in the database.Returns: success or error.
Configures a Flow Plugin.
WARNING: at this time, any plugins in the input JSON will be OVERWRITTEN!
USE WITH CAUTION.
Required Arguments:
plugins - A list of JSON objects, each formatted as a valid Plugin config.A valid plugin configuration will always contain the following:
_plugin - The name or ui label of the plugin to be modified._enabled - boolean, the plugin is enabled or notteam - The team for which the plugin is being configured, omit if global.instances - Individual instances of the plugin. Can be omitted. See 'get_plugin_schema' for an example of an instance for the given plugin.Returns: success or error.
Gets the details for the creation of an instance for a plugin.
Arguments:
args: Dictionary consisting with the fields and values required for creating an instance.
example :
{
system_details:{
"url": "http://localhost:8082",
"plugin": "jiraplugin"
}
"normal_user": {
"user": "admin_user",
"password": "admin_pass",
"api_token": "api_admin_token"
},
"sync_user": {
"user": "sync_user",
"password": "sync_pass",
"api_token": "api_sync_token"
}
}
Returns: List of instance names.
None
Copy a Project.
Required Arguments:
project - the id or name of a Project.newname - a name for the new Project.Returns: 'true' on success, errors on failure.
Creates a Cloud Account.
Required Arguments:
name - a name for the new Account.provider - one of the valid cloud providers.login - the login id (access key) for this Account.password - a password (secret key) for this Account.default_cloud - the name of a default Cloud for this Account.Optional Arguments:
account_number - an Account number.Returns: The new Cloud Account Object.
Creates an Asset.
Required Arguments:
Optional Arguments:
status - either 'Active' or 'Inactive'. ('Active' if omitted.)db_name - a Database name.address - the network address of the Asset.port - a service port for the Address.conn_string - some Assets make their connections via an explicit connection string.user - a User ID to associate with this Asset.password - a Password to associate with this Asset.shared_credential - the name of a Shared Credential to use.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:
user - a User ID for the Credentialpassword - a Password for the CredentialTo specify a Shared Credential, provide the shared_credential argument, which is the name of an existing Credential.
Returns: An Asset Object.
Creates a new Canvas item.
Required Arguments:
project - a Canvas Project name.component - a Canvas Component name.name - a Canvas item name.resourcedata - the content of the item.Optional Arguments:
ignoreconflicts - if 'true' existing items will be overwritten.Returns: Success or Error message.
Creates a Cloud.
Required Arguments:
name - a name for the new Cloud.provider - one of the valid cloud providers.apiurl - URL of the Cloud API endpoint.apiprotocol - Cloud API endpoint protocol.Optional Arguments:
default_account - the name of a default Account for this Cloud.Returns: The new Cloud Object.
Creates a new Shared Credential.
Only a 'Developer' can create Credentials.
Required Arguments:
name - The full name of the user.username - A login name for the user.password - Password for the user. If password is not provided, a random password will be generated.Optional Arguments:
description - Description of the Credential.domain - A domain for the Credential.Returns: A Credential Object.
Creat data map for assets.
Required Arguments:
name - Name of mapping used to associate.source - Source system from which sync has to happendestinations - Destination systems to which the sync has to happenOptional Arguments:
description - Description of mapping.projects - List of project mappings across external systems.Returns: Created ID or error message.
None
Create a Package Definition.
Required Arguments:
name - the name of a Package.team - Team to which the Package Definition should belong.Optional Arguments:
description - a description of the Package Definition.progression - a Progression to associate with the Package Definition.Returns: A Package Definition Object.
Create a Pipeline Definition.
Required Arguments:
template - A JSON document formatted as a CSK Pipeline Definition.Returns: A Pipeline Definition Object.
Create a Progression Definition.
Required Arguments:
name - the name of a Progression.Optional Arguments:
description - a description of the Progression.Returns: A Progression Definition Object.
Create a Project.
Required Arguments:
name - Name of the Project.team - Team which the Project belongs to.Returns: A Project Object.
Creates a new Tag for grouping Users.
Only users with the following roles can create tags: ["System Administrator", "Team Administrator"].
Required Arguments:
name - The name of the new Tag. (AlphaNumeric ONLY. Cannot contain spaces, punctuation or special characters.)Optional Arguments:
description - Describe the Tag.Returns: The new Tag Object if successful, error message on failure.
Create a new Task.
Required Arguments:
name - a name for the new Task.team - Team which the task belongs to.Optional Arguments:
code - a Task code.desc - a Task description.Returns: A Task Object.
Create a new Task from a JSON Task backup document.
Required Arguments:
json - A properly formatted JSON representation of a Task.Returns: A Task Object.
Create a new team
Only users with the following roles can create teams: ["System Administrator", "Team Administrator"]. If the credentials used for this API call do not have the required permission, the call will not succeed.
Required Arguments:
name - A name for the new Team.Optional Arguments:
description - A description of the new Team.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.
Creates a new instance of a particular plugin.
Required Arguments:
* `plugin_id` - The system plugin id.
* '_config' - Configuration parameters for the new plugin instance.
* name - The instance name.
* url - The url of the instance.
* user - The username for the instance.
* password - The password for the instance.
* token - The token for the instance.
* description - Description of the instance.
Returns the newly created plugin instance.
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:
user - A login name for the user.name - The full name of the user.role - The user's role. (Valid values: Administrator, Developer, User)teams - A list of teams the user belongs to, along with a role for each team. Teams and roles are separated by a
a colon. Team/role pairs are separated by commas. Valid roles are: Team Administrator, Developer, User.
Example: "Default:User,Team1:Team Administrator,Team2:Developer"Optional Arguments:
is_system_administrator - Whether the user should have system administrator privileges. (Valid values: 'true' or 'false') Default is false.is_shared_asset_manager - Whether the user should have shared asset manager privileges. (Valid values: 'true' or 'false') Default is false.password - Password for the user. If password is not provided, a random password will be generated.email - Email address for the user. Required if 'password' is omitted.authtype - 'local' or 'ldap'. Default is 'local' if omitted.forcechange - Require user to change password. Default is 'true' if omitted. (Valid values: 'true' or 'false')status - Status of the new account. Default is 'enabled' if omitted. (Valid values: enabled, disabled, locked)expires - Expiration date for this account. Default is 'never expires'. Must be in mm/dd/yyyy format.groups - A list of assignment groups the user belongs to. Group names cannot contain spaces. Comma delimited list.get_token - If true, will return an automatic login token. (Valid values: 1, yes, true)contributors - A list of contributors the user is mapped to. Contributors cannot contain spaces. Comma delimited list.Returns: A User Object.
Creates a new outbound Webhook configuration.
Only users with the role "Shared Asset Manager" can create webhooks.
Required Arguments:
name - The name of the Webhook configuration.destinationurl - The URL to which events will be posted.Returns: Success message if successful, error message on failure.
Deletes an Asset.
Required Arguments:
asset - Either the Asset ID or Name.Returns: Nothing if successful, error messages on failure.
Removes a Key Pair from a Cloud.
Required Arguments:
cloud - Name or ID of the Cloud.name - Name of the Key Pair to delete.Returns: A list of Cloud KeyPair Objects.
Removes a Shared Credential.
Required Arguments:
credential - Name or ID of the Credential to delete.Returns: Success message if successful, error message on failure.
Delete data map.
Required Arguments:
mapping_id - data mapping to deleteReturns: Success or error message.
Delete a Package Definition. Destructive of history, and there is no undo.
Required Arguments:
package - the id or name of a Package.Optional Arguments:
preserve - If true, will delete all data but preserve the actual package definition. Valid values: true|false (default).Returns: 'true' on success, errors on failure.
Permanently delete a Pipeline Definition.
Required Arguments:
pipeline - the id or name of a Pipeline Definition.Returns: 'true' on success, errors on failure.
Permanently delete a Pipeline Instance Group.
NOTE: at the moment, requires the '_id' of the Pipeline Instance Group.
Required Arguments:
pg - The ID of a Pipeline Instance Group.Returns: 'true' on success, errors on failure.
Permanently delete a Pipeline Instance.
Required Arguments:
pi - The Name or ID of a Pipeline Instance.Returns: 'true' on success, errors on failure.
Deletes a specific queued execution Plan.
Required Arguments:
plan_id - The integer ID of the Plan to delete.Returns: Nothing if successful, error messages on failure.
Delete a Progression Definition. Destructive of history, and there is no undo.
Required Arguments:
progression - the id or name of a Progression.Returns: 'true' on success, errors on failure.
Permanently delete a Project.
Required Arguments:
project - the id or name of a Project.Optional Arguments:
preserve - If true, will delete all data but preserve the actual project. Valid values: true|false (default).Returns: 'true' on success, errors on failure.
Permanently delete a registry.
Required Arguments:
registry - Name of the Registry document.Returns: 'true' on success, errors on failure.
Deletes a Task Schedule and all queued execution Plans.
Required Arguments:
schedule_id - The UUID of the Schedule to delete.Returns: Nothing if successful, error messages on failure.
Deletes a security Tag.
Only users with the following roles can delete tags: ["System Administrator", "Team Administrator"].
Required Arguments:
name - The name of the Tag.Returns: Success message if successful, error message on failure. Note: A success message is also returned when the to-be-deleted tag does not exist.
Deletes all versions of a Task.
Required Arguments:
task - Either the Task ID or Name.Optional Arguments:
force_delete - Delete the Task, even if there are historical rows and references. (Valid values: 1, yes, true)Returns: Nothing if successful, error messages on failure.
Delete the data map.
Required Arguments:
* `id` - The id of the data map.
Deletes a specific instance of a particular plugin.
Required Arguments:
* `plugin_id` - The system plugin id.
* 'instance_id' - The id of the instance.
Returns success upon successful deletion of the plugin instance.
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:
user - ID or Name of the User to delete.Delivers a Package Revision out of a Progression into a Delivered condition.
Required Arguments:
package - Name of the Package.revision - Revision number of a Package to deliver, takes precedence over full_version.full_version - Optional Full Version of package to deliver, optional alternative selector to revision.Returns: success on success, errors otherwise.
Describes the Parameters for a Task.
Required Arguments:
task - Value can be either a Task ID, Code or Name.Optional Arguments:
Returns: A help document describing the Task Parameters.
Configure email notification for the data map.
Required Arguments:
* `id` - The id of the data map.
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:
project - filter by a Canvas Project name.component - filter by a Canvas Component. (Project is required.)repository - specify the repository ('file' or 'db', 'db' if omitted.)Returns: A JSON document containing Canvas items.
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.
Gets a data map as a file for export.
Required Arguments:
* `id` - The id of the data map to be exported.
Returns a file with exported datamap.
Export a Package Definition as a portable backup JSON document.
Required Arguments:
package - the id or name of a Package.Returns: A Package Definition Object.
Export a Pipeline Definition as a portable backup JSON document.
Required Arguments:
pipeline - the id or name of a Pipeline Definition.Returns: A Pipeline Definition Object.
Export the configuration one or all Plugins.
Optional Arguments:
name - Name of specific plugin.Returns: an array of plugins, a single plugin, or error.
Export a Progression Definition as a portable backup JSON document.
Required Arguments:
progression - the id or name of a Progression.Returns: A Progression Definition Object.
Gets a Project object for export. (Will not include the _id.)
Required Arguments:
project - the id or name of a Project.Returns: A Project Object.
Create a backup file for a single Task.
The behavior of this command is different depending on the
Acceptheader.
Required Arguments:
task - Value can be either a Task ID, Code or Name.Optional Arguments:
Returns: A collection of Task backup objects.
Gets a Cloud Account.
Required Arguments:
name - a Cloud Account name or ID.Returns: A Cloud Account Object.
Gets an Asset.
Required Arguments:
asset - an Asset Name or ID.Returns: An Asset Object.
Gets a Cloud object.
Required Arguments:
name - a Cloud name or ID.Returns: A Cloud Object.
Get list of data mappings.
If no 'mapping_id' is supplied, return all mappings.
Optional Arguments:
mapping_id - data mapping to returnReturns: Result or error message.
Get the effective delivery category for a feature, as determined by the condition of all that features workitems.
Required Arguments:
id - The internal _id OR the authoritative ID from the origin system OR the key (user facing identifier) from the origin system.Returns: An array of timeline events for the specified workitem.
Get the license details.
Only users with the role "System Administrator" can get the license details.
Required Arguments:
license - The text of a license key provided by Continuum.Returns: The relevant properties of the current license.
Gets the log for a specific service or automation instance.
Non-instance process logs can only be requested by system administrators. Instance process logs can be requested by team members (users, developers, team administrators) of the given instance's team.
Required Arguments:
process - the name of the process of the log to retrieve.Optional Arguments:
instance - If process represents instanced data (such as pipelines or tasks), the instance is also required.lines - The number of log lines to retrieve. (An integer, or the word all. 100 lines if omitted).level - Filter lines to a specific debug logging level and higher. Default is all levels. (Valid values: 10 (DEBUG), 20 (INFO), 30 (WARNING), 40 (ERROR), 50 (CRITICAL))concatenate - Concatenate log lines into a single text value. Default is 'false' - returning an array of rows - if omitted. (Valid values: 'true' or 'false')NOTE: specifying
lines=allcan 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.
Retrieves manifest from provided filter. Required Arguments:
progression - Name of the Progression.Optional Arguments:
phase - Name of the phase.package - Name of the Package.version - Version of the Package.verbose - Will return artifacts and changes if True, default FalseReturns: The Manifest (Workitems, Changes and Artifacts) contained in the specified filter.
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 the next integer id in a named ID set.
Required Arguments:
name - the name of the ID setOptional Arguments:
reseed - (integer) If provided, reset the pool to the specified value. (This is the value that will be returned.)fallback - (integer) In the case of any errors, the provided fallback number will be returned. 0 if omitted.Returns: 'true' on success, errors on failure.
None
Returns the definition of the specified Package.
Required Arguments:
package - Name of the Package.Returns: The Package definition document.
Returns the complete Manifest of a Package Version, given a range of Revisions.
Required Arguments:
package - Name of the Package.Optional Arguments:
version - Version of the Package. If omitted, optionally use...version_of_rev - (integer) A specific Revision. If provided, discover and use the Version of this specific Revision.Note: If both
versionandversion_of_revare provided,versiontakes precedence.
from - (integer) A starting (older) Revision. If omitted, will use the oldest Revision in the specified Version.to - (integer) An ending (later) Revision. If omitted, will use the newest Revision in the specified Version.verbose - (true/false) Return verbose Manifest details. false if omitted.Returns: The Manifest (Workitems, Changes and Artifacts) contained in the specified Package Revision range.
Returns the complete Manifest of a Package Version, given a range of Revisions.
Required Arguments:
package - Name of the Package.revision - A specific Package Revision.Optional Arguments:
verbose - (true/false) Return verbose Manifest details. false if omitted.Returns: The Manifest (Workitems, Changes and Artifacts) of the specified Package Revision.
Creates a new Revision of a specified Version of a Package.
Required Arguments:
package - Name of the Package.revision - A specific Package Revision.Returns: Data about the current Revisions relationships in its Progression.
Returns the Progression definition for a specific Package Revision. (Name, Phase names and order, etc.)
Required Arguments:
package - Name of the Package.revision - A specific Package Revision.Returns: The Progression the specified Package Revision subscribes to.
Gets the Changes from the Manifest of a Pipeline Instance.
Required Arguments:
pi - the id or name of a Pipeline Instance.Returns: A JSON document representing all Changes on the Manifest.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
Gets the Changes from the Manifest of a Pipeline Instance.
Required Arguments:
pi - the id or name of a Pipeline Instance.Returns: A JSON document representing all Changes on the Manifest.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
Gets a Pipeline Instance Data object.
Required Arguments:
pi - the id or name of a Pipeline Instance.Optional Arguments:
lookup - Lookup using an expression that evaluates to a subsection of the document.Returns: A Pipeline Instance.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
Gets the Workitems from the Manifest of a Pipeline Instance.
Required Arguments:
pi - the id or name of a Pipeline Instance.Returns: A JSON document representing all Workitems on the Manifest.
Note: the response is 'json' - 'text' and 'xml' object_output options are not supported.
Gets a Pipeline Definition object.
Required Arguments:
pipeline - the id or name of a Pipeline Definition.Returns: A Pipeline Definition Object.
Gets a Pipeline Instance object.
Required Arguments:
pi - the id or name of a Pipeline Instance.Optional Arguments:
include_stages - include Stage, Step and Plugin data and status.Returns: A Pipeline Instance.
Returns the Schema for a given plugin.
REQUIRED Args:
- plugin_name: The name of the plugin to be returned.
OPTIONAL Args:
- metadata: If true, will return 'plugin_name' and 'path' (if any)
Gets details about a Progression suitable for populating the display of a Progression Board.
Required Arguments:
progression - the id or name of a Progression.Optional Arguments:
packages - a comma-delimited list of Package ids to include in the results.
If not provided, all readable packages will be selected.teams - a comma-delimited list of Package ids/names to include in the results.
If not provided, all teams associated with the API user will be selected.Returns: A Progression Details Object.
Gets a Project object.
Required Arguments:
project - the id or name of a Project.Returns: A Project Object.
Gets all the changes submitted to a Project.
Required Arguments:
project - the id or name of a Project.Returns: An array of change objects.
Gets a registry document by name.
Required Arguments:
name - Name of the Registry document.Returns: the entire Registry document on success, 'not found' otherwise.
Lists all the settings of modules.
Only users with the role "System Administrator" can get settings.
Optional Arguments:
module - name of the module. If omitted, all module settings are returned.Returns: A Settings Object.
Gets a raw 'Submission' payload using a query.
Required Arguments:
query - Valid MongoDB query to identify the previous payload to resubmit.If the query would return multiple submissions, the newest one is matched.
Returns: the Submission document on success, 'not found' otherwise.
None
Gets the system log. If all arguments are omitted, will return the most recent 100 entries.
Only users with the role "System Administrator" can get the system log.
Optional Arguments:
object_id - An object_id filter to limit the results.object_type - An object_type filter to limit the results.log_type - A log_type filter. ('Security' or 'Object')action - An action filter.filter - A filter to limit the results.from - a date string to set as the "from" marker. (mm/dd/yyyy format)to - a date string to set as the "to" marker. (mm/dd/yyyy format)records - a maximum number of results to get.Returns: A list of Log Entry Objects.
Gets a Task object.
Required Arguments:
task - Value can be either a Task ID or Name.Optional Arguments:
include_code - Whether to include Codeblocks and Steps. (Only included if 'output_format' is 'json' or 'xml'. 'False' if omitted.)Returns: A Task Object.
Gets the details of a Task Instance.
Required Arguments:
instance - The Task Instance identifier.Returns: A Task Instance Object.
Gets just the Status of a Task Instance.
Required Arguments:
instance - The Task Instance identifier.Returns: The 'Status' from a Task Instance Object.
Gets a list of Task Instances.
Optional Arguments:
filter - A filter to limit the results.status - A comma separated list of statuses to filter the results.from - a date string to set as the "from" marker. (mm/dd/yyyy format)to - a date string to set as the "to" marker. (mm/dd/yyyy format)records - a maximum number of results to get.Returns: A list of Task Instance Objects.
Gets the run log for a Task Instance.
Required Arguments:
instance - The Task Instance identifier.Returns: A Task Log Object.
Gets a Parameters template for a Task.
Required Arguments:
task - Value can be either a Task ID, Code or Name.Optional Arguments:
basic - in JSON mode, if provided, will omit descriptive details.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.
Gets a list of the queued execution plans for a Task.
Required Arguments:
task - Value can be either a Task ID or Name.Optional Arguments:
Returns: A list of Execution Plan Objects.
Gets a list of Schedule definitions for a Task.
Required Arguments:
task - Value can be either a Task ID or Name.Optional Arguments:
Returns: A list of Task Schedule Objects.
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.
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>}.
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.
None
Gets a data map for listing.
Required Arguments:
* `id` - The id of the data map to be retrieved.
Returns a single data map object.
Gets syncronization log records.
Required Arguments:
* `id` - The id of the data map whose logs will be returned.
Optional Arguments:
* `status` - Status value by which to filter returned records.
* `gt_id` - If provided, return only records whose IDs are greater than this value.
Returns up to 50 syncronization log records. Use `gt_id` to fetch additional "pages" of records.
Gets syncronization log records for specific inbound event.
Required Arguments:
* `id` - The id of the data map whose logs will be returned.
* `inbound_id` - The inbound event id whose logs will be returned.
Optional Arguments:
* `status` - Status value by which to filter returned records.
Returns syncronization log records.
Gets all the available data maps.
Returns a list of data map objects.
Gets a data map for editing.
Required Arguments:
* `id` - The id of the data map to be retrieved.
Returns a single data map object.
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>}.
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>}.
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>}
Gets a specific instance of a particular plugin.
Required Arguments:
* `plugin_id` - The system plugin id.
* 'instance_id' - The id of the instance.
Returns the specific instance of the plugin.
Gets all instances for a particular plugin.
Required Arguments:
* `plugin_id` - The system plugin id.
Returns all instances of the plugin.
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>}.
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.
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 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 the details of a specific workitem.
Required Arguments:
id - The internal _id of the workitem OR the authoritative ID from the origin system OR the key (user facing identifier) from the origin system.Returns: A workitem document.
Get all the packages a workitem is in, and the effective delivery category for the workitem.
Required Arguments:
id - The internal _id of the workitem OR the authoritative ID from the origin system OR the key (user facing identifier) from the origin system.Returns: An array of timeline events for the specified workitem.
Get the details of a specific feature.
Required Arguments:
id - The internal _id of the feature OR the authoritative ID from the origin system OR the key (user facing identifier) from the origin system.Returns: A workitem parent document.
Get the timeline of a specific workitem.
Required Arguments:
id - The internal _id of the workitem OR the authoritative ID from the origin system OR the key (user facing identifier) from the origin system.Returns: An array of timeline events for the specified workitem.
Gets a list of Pipeline in 'pending' status.
Optional Arguments:
filter - a key:value filter to limit the results.Returns: A list of pending Pipeline Instances.
Performs a 'health check' on the sytem.
Returns: true/false if the system is 'healthy' and additional details.
Imports an XML or JSON backup file.
DEPRECATED: this function is deprecated. Use
import_taskinstead.
Required Arguments:
import_text - An XML or JSON document in the format of a Task backup file.Returns: A list of items in the backup file, with the success/failure of each import.
Import all Project, Pipeline, Package, and Task definitions from a catalog as a JSON document.
Optional Arguments:
projects - An array of project JSON objects to import.pipelines - An array of pipeline JSON objects to import.packages - An array of package JSON objects to import.tasks - An array of task JSON objects to import.overwrite - Valid values: true|false (default).
If 'overwrite' is 'true' and the Definition exists, it will be replaced.human_readable - Valid values: true (default)|false.
Whether to provide output as name/messgae or id/(true or false).
It might be useful to set this to false if you are importing the catalog as part of some automation.import_into_team - Team "name" or id. If specified, the catalog will be imported into the specified team, rather than the teams specified in the input.
This may be useful if you wish to import items from another team or Continuum instanceReturns: A list of all Project, Pipeline, Package, and Task definitions with the name and status of import or exception.
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 a Package Definition from a backup file.
Required Arguments:
backup - A JSON document formatted as a Package Definition backup.Optional Arguments:
overwrite - Valid values: true|false (default).If 'overwrite' is 'true' and the Definition exists, it will be replaced.
Returns: Success or error.
Import a Pipeline Definition.
Required Arguments:
backup - A JSON document formatted as a complete Continuum Pipeline Definition backup.Optional Arguments:
overwrite - Valid values: true|false (default).
If 'overwrite' is 'true' and the Definition exists, it will be replaced.
Returns: A Pipeline Definition Object.
Import a Progression Definition from a backup file.
Required Arguments:
backup - A JSON document formatted as a Progression Definition backup.Optional Arguments:
overwrite - Valid values: true|false (default).
If 'overwrite' is 'true' and the Progression exists, it will be replaced.
Returns: Success or error.
Import a Project.
Required Arguments:
backup - A JSON document formatted as a complete Project backup.Optional Arguments:
overwrite - Valid values: true|false (default).
If 'overwrite' is 'true' the Project will be replaced.
Returns: A Project Object.
Imports a Task backup file.
Required Arguments:
backup - A JSON document in the format of a Task backup file.Optional Arguments:
overwrite - Valid values: true|false (default).
If 'overwrite' is 'true' the Task(s) will be replaced.
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.
Attempt to initiate a Pipeline Definition.
Required Arguments:
definition - ID or Name of a Pipeline Definition to initiate.project - An identifying name for a Project. (ie: repo name) Useful if a single pipeline definition supports multiple projects.group - Summary name, (ie: branch name) used to group all runs of this definition/project combination. Describes your 'use' of this Pipeline.Optional Arguments:
instance_name - An explicit name to use for this unique run. (ie: commit id)details - a JSON object with additional properties for the Pipeline Instance, often required by specific plugins.Returns: A Pipeline Instance Object.
Installs an Add-On from the vs-exchange
Required Arguments:
name - Name of the Add-On to install.Optional Arguments:
team - Team to which to add parts of the Add-On that are scoped to a team. Required if the Add-On contains any such parts.Returns: success on success, errors otherwise.
Installs a license file.
Only users with the role "System Administrator" can install a license.
Required Arguments:
license - The text of a license key provided by Continuum.Returns: Success or Error message.
Invoke a Plugin Function.
Required Arguments:
plugin - The name of the Plugin PLUS the Module. (ex: github.main)method - The method to invoke. (ex "test_connection")Optional Arguments:
args - A JSON formatted string of arguments which will be sent to the Plugin Function.team - The Team in which to search for the Plugin Instance to use when invoking a Plugin Function that requires an Instance.
Defaults to Plugins available to All Teams.instance_name - A named Plugin instance in the Continuum configuration.
Defaults to the Plugin Instance marked as default either within the specified Team or All Teams.timeout - The number of seconds to wait for the Plugin Function to execute before returning a timeout error.
Defaults to 60 seconds.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.
Lists all Add-Ons installed in this Continuum instance.
Optional Arguments:
include_contents - If true, lists the names of all parts of each of the Add-Ons. Defaults to falseReturns: A list of Add-On details.
Lists all Assets.
Optional Arguments:
filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)
Returns: A list of Asset Objects.
Returns a list of all elements in the Canvas feature.
Optional Arguments:
project - filter by a Canvas Project name.component - filter by a Canvas Component. (Project is required.)repository - specify the repository ('file' or 'db', 'db' if omitted.)Returns: A list of all Canvas elements.
Lists all Changes.
Optional Arguments:
project - will limit the results to a specific 'project'.group - will limit the results to a specific 'group'.since - will only return changes since the provided timestamp.managed - will list only the managed changes.unmanaged - will list only the unmanaged changes.limit - Maximum number of items to return, or 0 for unlimited. (Default is 100.)Returns: A list of Changes{:target="robjs"}.
Lists all Cloud Accounts.
Optional Arguments:
filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)
Returns: A list of Cloud Account Objects.
Lists all the Key Pairs defined on a Cloud.
Required Arguments:
cloud - Name or ID of a Cloud.Returns: A list of Cloud KeyPair Objects.
Lists all Clouds.
Optional Arguments:
filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)
Returns: A list of Cloud Objects.
Lists all Shared Credentials.
Optional Arguments:
filter - will filter a value match in Credential Name, Username, Domain or Description. (Multiple filter arguments can be provided, delimited by spaces.)Returns: A list of Credential Objects.
Lists all Package Definitions.
Optional Arguments:
filter - a key:value filter to limit the results.limit - Maximum number of items to return, or 0 for unlimited. (Default is 100.)Returns: A list of Package Definition Objects.
Lists all Pipeline Instance Groups (Stories).
Optional Arguments:
pipeline - will limit the results a specific Pipeline Definition.project - will limit the results a specific 'project'.group - will limit the results to a specific 'group'.limit - Maximum number of items to return, or 0 for unlimited. (Default is unlimited.)Returns: A list of Pipeline Instance Group Objects.
Lists all Pipeline Instances.
Optional Arguments:
definition - will limit the results a specific Pipeline Definition.project - will limit the results to a specific 'project'.group - will limit the results to a specific 'group'.since - Will only return instances since the provided timestamp.limit - Maximum number of items to return, or 0 for unlimited. (Default is 100.)Returns: A list of Pipeline Instance Objects.
Lists all Pipeline Definitions.
Optional Arguments:
limit - Maximum number of items to return, or 0 for unlimited. (Default is unlimited.)Returns: A list of Pipeline Definition Objects.
Lists all running processes.
Returns: A list of Process Objects.
Lists all Progressions.
Optional Arguments:
limit - Maximum number of items to return, or 0 for unlimited. (Default is unlimited.)Returns: A list of [Progression Objects](api-response-objects#progression.
Lists all Projects.
Optional Arguments:
by_name - A regex expression to filter project results by name.
limit - Maximum number of items to return, or 0 for unlimited. (Default is unlimited.)
Returns: A list of Project Objects.
Lists all Registries
Returns: A list of [Registry Objects]
Lists all Tags.
Optional Arguments:
filter - will filter a value match in Tag Name. (Multiple filter arguments can be provided, delimited by spaces.)Returns: A list of Tag Objects.
Lists all Tasks..
Optional Arguments:
filter - will filter a value match in Task Name, Code or Description. (Multiple filter arguments can be provided, delimited by spaces.)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_taskendpoint.
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:
filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)
limit - Maximum number of items to return, or 0 for unlimited. (Default is unlimited.)
Returns: A list of User Objects.
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
Creates a new Revision of a specified Version of a Package.
Required Arguments:
package - Name of the Package to revise.version - Version in which to create a new Revision. (Package Revisions increment within specific Versions.)Optional Arguments:
full_version - Full Version of package to promote, optional alternative selector to revision.Note: Often, it is desireable that the
full_versionactually contain the number of the newly created Revision. A special keyword,__NEWREVISION, is recognized in the value provided forfull_versionand will be replaced with the new Revision number.
Returns: A Package Revision document if successful, errors otherwise.
Given a Package Revision, a Phase and a Control Name, will override that Control if it exists and is failed.
Required Arguments:
package - Name of the Package to promote to a progression Phase.revision - Revision number of a Package to promote, takes precedence over full_version.full_version - Full Version of package to promote, optional alternative selector to revision.phase - Name of the Phase containing the Activity of the Control to override.activity - Name of the Activity containing the Control to override.control - Name of the Control to override.reason - Description of the reason for overriding the Control.Returns: success on success, errors otherwise.
Post data to the Workspace on a running Pipeline Instance.
Required Arguments:
pi - the id or name of a Pipeline Instance.key - key to set in the Workspace data.value - value for the provided key.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"
Promotes a Package Revision to a particular Phase.
Required Arguments:
package - Name of the Package to promote to a Progression Phase.revision - Revision number of a Package to promote, takes precedence over full_version.full_version - Optional Full Version of package to promote, optional alternative selector to revision.phase - Name of the Phase to which the specified Package Revision will be promoted.Optional Arguments:
new_version - If provided, all Revisions being promoted will be updated to the provided new_version. (Will attempt to also update full_version if possible.)Returns: success on success, errors otherwise.
Record a new revision of a specific Artifact.
Required Arguments:
project - Name or ID of the Project where this Artifact is defined.name - Name of the Artifact to revise.branch - Branch in the repository from which this artifact was built.location - Optional URL or path to where this Artifact can be found.build_data - Optional JSON object additional data about the build.Returns: success on success, errors otherwise.
Removes a Tag from an object.
Only users with the following roles can remove a tag from an object: ["System Administrator", "Team Administrator"].
Required Arguments:
tag - The name of the Tag.object_id - The ID of the object.object_type - The numeric type of the object.Returns: Success message if successful, error message on failure.
Remove an empty Team.
Only users with the following roles can remove a team: ["System Administrator", "Team Administrator"]. If the credentials used for this API call do not have the required permission, the call will not succeed.
Required Arguments:
team - Name or ID of the Team to change.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:
team - Name or ID of the Team to change.user - Name or ID of the User to remove.Optional Arguments:
default - Users must be in at least one Team. If the removal operation would leave this User Teamless, specify a new default Team Name for the User. Will attempt to use Default if omitted.NOTE: if a new Default Team is assigned, the User will be given the
Userrole in the Default Team
Rerun an Instance, using the saved 'initial data'.
This creates a new Instance exactly as the provided one was started.
Required Arguments:
pi - The Name or ID of a Pipeline Instance.Returns: A Pipeline Instance Object.
Resets the password of the authenticated, or a specified User.
If a user is specified, and the authenticated user has the permission to reset other users' passwords, this will reset the password of the specified user to the provided value. Only users with the role "System Administrator" can change other users' passwords.
If no user is specified, the password of the authenticated user will be changed.
NOTE: to prevent accidental change of an Administrator's 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:
password - the new password -or-generate - generate a random password.Optional Arguments:
user - Either the User ID or Name.Returns: Success message if successful, error messages on failure.
Resubmits a change 'Submission' payload to the specified Project.
Required Arguments:
query - Valid MongoDB query to identify the previous payload to resubmit.If the query would return multiple submissions, the newest one is matched.
Returns: 'true' on success, errors on failure.
Resubmits an Errored or Cancelled Task Instance. Resubmit is only valid on Errored or Cancelled Task Instances.
Required Arguments:
instance - The Task Instance identifier.Returns: Returns: Nothing if successful, error messages on failure.
Resync all failed event
Required Arguments:
* `data_map_id` - Id of the mapping
Resync failed event
Required Arguments:
* `inbound_id` - The inbound id of the failed event
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:
pi - The Name or ID of a Pipeline Instance.Returns: A Pipeline Instance Object.
Changes the Version of the specified (and all matching previous) Package Revisions.
Required Arguments:
package - Name of the Package to promote to a Progression Phase.revision - Revision number of a Package to promote, takes precedence over full_version.full_version - Optional Full Version of package to promote, optional alternative selector to revision.new_version - If provided, all Revisions being promoted will be updated to the provided new_version. (Will attempt to also update full_version if possible.)Returns: success on success, errors otherwise.
Runs a specific metric.
Required Arguments:
module - Name of the metrics module that contains the metric function to runmetric - Name of a function definition in the specified moduleOptional Arguments:
args - a JSON object of arguments the target metric may requireReturns: success on success, errors otherwise.
Runs a Task.
Required Arguments:
task - Either the Task ID or Name.Optional Arguments:
initialdata - A JSON document defining the intial Runtime Variable environment for this Task.log_level - an integer (0-4) where 0 is none, 2 is normal and 4 is verbose. Default is 2.parameters - A JSON or XML document defining parameters for the Task.options - a JSON object defining certain options for this Task. Typically used to provide scope for extensions to the Task Engine.run_later - if provided, the Task will be scheduled to run at the specified date/time. ex. "7/4/1776 15:30"run_on_worker - if provided, the Task will be explicitly assigned to the specified worker. (Use the 'user@host' format to identify the target worker.)"Returns: A Task Instance Object.
Configure email notification for the data map.
Required Arguments:
* `id` - The id of the data map.
Schedules one or more Tasks.
Required Arguments:
tasks - a JSON document containing a list of Tasks and schedule details.Schedule definition format:
All lists are zero based integers.
The Task Schedule Object response from the
get_task_schedulescommand 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.
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:
to - a single or comma-separated list of valid email addresses or Continuum Users.subject - a subject linemessage - the message bodyOptional Arguments:
cc - a carbon copy list of comma-separated email addresses or Continuum Users.bcc - a blind carbon copy list of comma-separated email addresses or Continuum Users.Returns: Success message if successful, error message on failure.
Set Workspace data on a running Pipeline Instance.
Required Arguments:
pi - the id or name of a Pipeline Instance.key - key to set in the Workspace data. (Certain internal keys are restricted and cannot be overridden.)value - value for the provided key.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 the description of a specific Pipeline Instance
Required Arguments:
pi - the id or name of a Pipeline Instancedescription - Description to set (HTML allowed)Returns: 'true' on success, errors on failure.
Set global summary data on a pipeline instance
Required Arguments:
pi - the id or name of a pipeline instancekey - key to set in the global summaryvalue - value for the provided keyReturns: '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 the autonumber root on Pipeline Instance Group. (Used to issue ascending numbers to Instances in the Group.)
Required Arguments:
pg - The ID of a Pipeline Instance Group.newnumber - The new number to set as the autonumber root.Returns: 'true' on success, errors on failure.
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:
assign_to_pipeline - Assign to Pipelinejira_workitem_lookup - Lookup Issues - Atlassian Jiralifecycle_workitem_lookup - Lookup Worktitems - VersionOne Lifecycleteamforge_workitem_lookup - Lookup Workitems - CollabNet TeamForgevsts_tfs_workitem_lookup - Lookup Workitems - Microsoft VSTS/TFSredirect_to_project - Redirect to Projectplugin_function - Plugin Functionrun_task - Run a Taskassign_to_version - Assign to Versionignore_submission - Ignore Submissionstop_processing - Stop Processingpackage_revision - Package into Phaseworker_ci - Continuum CIinitiate_pipeline - Initiate PipelineRequired Arguments:
project_id - Id of the project.directives - List of directives to set for the project.Each directive consists of a dictionary with the following shape:
{
"type": "jira_workitem_lookup",
"when": "always",
"details": {}
}
type - The directive typewhen - Valid values are always, never, group, evaluate, signature.
Any value other than always or never requires an additional payload property with a matching name
which contains the related condition. (optional, defaults to always)details - Additional parameters depending on the given directive type.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.
Sets values in a specific Registry document.
Required Arguments:
name - Name of the Registry document.Optional Arguments:
value - Value to set at specified path, or entire document. If omitted, target key or document will be cleared.path - If specified, will place value at this path. If omitted, will update the entire document.action - Valid values: set | unset | addtoset | push | pull | mergecreate - Create named Registry if it doesn't exist? Valid values: true | falseoptions - Additional Options. Dependent on the value of "action"
action: merge is specified, the available options are:
overwrite - Overwrite exisiting keys on conflict? Valid values: true|false (default).deep - Perform a shallow or deep merge when merging objects Valid values: true|false (default).Returns: success on success, errors otherwise.
Stops a running Task Instance.
Required Arguments:
instance - The Task Instance identifier.Returns: Nothing if successful, error messages on failure.
Submits a change payload to the specified Project.
Required Arguments:
toproject - the ID or Name of a Project.NOTE: This API is different than most others. It's expecting a JSON document as HTTP POST data. The required
toprojectargument can either be provided inside the POST data, or on the URL querystring.
Returns: 'true' on success, errors on failure.
Tests the connection based on the parameters provided for a plugin instance.
Required Arguments:
* `plugin` - The system plugin id.
* 'instance_details' - Configuration parameters for the new plugin instance.
* name - The instance name.
* url - The url of the instance.
* user - The username for the instance.
* password - The password for the instance.
* token - The token for the instance.
Returns success upon test connection being successful.
Tests connectivity to a Plugin instance defined in the Continuum configuration.
Required Arguments:
One of:
plugin_name - the name of a Plugin. (ex: v1plugin) This will look up the proper Module.plugin - DEPRECATED - the name of the Plugin PLUS the Module. (ex: v1plugin.main)Optional Arguments:
instance - A named Plugin instance in the Continuum configuration. If not used, the default instance will be tested.team - the Team to search for the Plugin Instance. Defaults to plugins available to All Teams.plugin_details - the details of a plugin to test. This is useful if you want to test a plugin configuration before saving. See the get_plugin_schema api to determine the shape of this object.Returns: A success message or error message
Uninstalls an Add-On from Continuum
Required Arguments:
name - Name of the Add-On to uninstall.Returns: success on success, errors otherwise.
Updates a Cloud.
Required Arguments:
name - Name or ID of the Cloud to update.Optional Arguments:
apiurl - URL of the Cloud API endpoint.apiprotocol - Cloud API endpoint protocol.default_account - the name of a default Account for this Cloud.Returns: The updated Cloud Object.
Updates the settings of a process or module.
Only users with the role "System Administrator" can update settings.
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:
module - name of the module to apply the settings.settings - a list of name:value setting objects.Returns: Nothing if successful, error messages on failure.
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.
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.
Updates an instance of a particular plugin.
Required Arguments:
* `plugin_id` - The system plugin id.
* `instance_id` - The system instance id.
* '_config' - Configuration parameters for the new plugin instance.
* name - The instance name.
* url - The url of the instance.
* user - The username for the instance.
* password - The password for the instance.
* token - The token for the instance.
* description - Description of the instance.
Returns the updated plugin instance.
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:
user - ID or Name of the User to update.Optional Arguments:
name - The full name of the user.role - The user's role. (Valid values: Administrator, Developer, User)teams - A list of teams the user belongs to, along with a role for each team. Teams and roles are separated by a
a colon. Team/role pairs are separated by commas. Valid roles are: Team Administrator, Developer, User.
Example: "Default:User,Team1:Team Administrator,Team2:Developer"is_system_administrator - Whether the user should have system administrator privileges. (Valid values: 'true' or 'false') Default is false.is_shared_asset_manager - Whether the user should have shared asset manager privileges. (Valid values: 'true' or 'false') Default is false.email - Email address for the user. Can be cleared with "None".authtype - 'local' or 'ldap'.forcechange - Require user to change password on next login. (Valid values: 'true' or 'false')status - Status of the account. (Valid values: enabled, disabled, locked)expires - Expiration date for this account. Must be in mm/dd/yyyy format. Can be cleared with "None".groups - Add to the list of assignment groups the user belongs to. Group names cannot contain spaces. Comma delimited list.contributors - Contributors are usernames in source control management systems related to this User
(Enter one or more comma-separated Contributor 'aliases').password - The new password. If a password is set then the 'generate' option is ignored`.generate - Generate a random password. (This only works if no password is provided via the 'password' option.)Returns: A User Object.
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 an instance of Continuum exists and the request is authenticated.
Returns: Success or Error message.
Returns: The Continuum version.
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.
Required Arguments:
commit_shas - a list of all the Changes to associate to a Workitem.associated_by - User that made the association in Digital.ai Agility.workitem_number - Workitem number from Digital.ai Agility.instance_url - Digital.ai Agility instance url.Gets all pipeline instances that a workitem participated in.
Required Arguments:
number - a Workitem Identifier.Returns: Related Pipeline Instances.
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.
origin_project - The Name or ID of the Project where the workitem originated.Returns: 'true' on success, errors on failure.
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.
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:
continuum_context - All of the Continuum context that was passed to the XL Release when it was triggered.xlrelease_details - A document containing all the details of the XL Release - phases, tasks, status indicators, etc.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.