logo
API docs by Redocly

Workflow Management Service (2.17)

Workflow Management Service Concepts

Abstract

The primary purpose of the workflow service is to allow relying applications to alter workflow definitions and to facilitate the processing of workflow instances.

Operations

Create Batch

Provides the ability to create a batch of items which allow the system to aggregate various information across the items in the batch. [Rev 1.14]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateBatch
Request Body schema: application/soap+xml
required
object (CreateBatch)

Responses

Create Data Definition Template

Provides the ability to create a data definition template. [Rev 1.09]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateDataDefinitionTemplate
Request Body schema: application/soap+xml
required
object (CreateDataDefinitionTemplate)

Provides the ability to create a data definition template. [Rev 1.09]

Responses

Create Data Source Hub

Provides the ability to create a custom data source hub. [Rev 1.15]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateDataSourceHub
Request Body schema: application/soap+xml
required
object (CreateDataSourceHub)

Provides the ability to create a custom data source hub. [Rev 1.15]

Responses

Create List

Provides the ability to create a custom list of name value pairs. [Rev 1.11]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateList
Request Body schema: application/soap+xml
required
object (CreateList)

Provides the ability to create a custom list of name value pairs. [Rev 1.11]

Responses

Create Subscription

Provides the ability to associate an action to an event. [Rev 1.06]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateSubscription
Request Body schema: application/soap+xml
required
object (CreateSubscription)

Provides the ability to associate an action to an event. [Rev 1.06]

Responses

Create User Group

Provides the ability to create a user group. [Rev 1.03]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateUserGroup
Request Body schema: application/soap+xml
required
object (CreateUserGroup)

Provides the ability to create a user group. [Rev 1.03]

Responses

Create Workflow

Creates a Workflow

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateWorkflow
Request Body schema: application/soap+xml
required
object (CreateWorkflow)

Responses

Create Workflow Instance

Provides the ability to create a new workflow instance and optionally start it at the same time.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/CreateWorkflowInstance
Request Body schema: application/soap+xml
required
object (CreateWorkflowInstance)

Provides the ability to create a new workflow instance and optionally start it at the same time.

Responses

Modify Batch

Provides the ability to modify an existing batch. [Rev 1.14]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyBatch
Request Body schema: application/soap+xml
required
object (ModifyBatch)

Provides the ability to modify an existing batch. [Rev 1.14]

Responses

Modify Data Definition Template

Provides the ability to modify an existing data definition template. [Rev 1.09]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyDataDefinitionTemplate
Request Body schema: application/soap+xml
required
object (ModifyDataDefinitionTemplate)

Provides the ability to modify an existing data definition template. [Rev 1.09]

Responses

Modify Data Source Hub

Provides the ability to modify a custom data source hub. [Rev 1.15]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyDataSourceHub
Request Body schema: application/soap+xml
required
object (ModifyDataSourceHub)

Provides the ability to modify a custom data source hub. [Rev 1.15]

Responses

Modify List

Provides the ability to modify a custom list of name value pairs. [Rev 1.11]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyList
Request Body schema: application/soap+xml
required
object (ModifyList)

Provides the ability to modify a custom list of name value pairs. [Rev 1.11]

Responses

Modify Subscription

Provides the ability to change the action associated with an event. [Rev 1.06]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifySubscription
Request Body schema: application/soap+xml
required
object (ModifySubscription)

Provides the ability to change the action associated with an event. [Rev 1.06]

Responses

Modify User Group

Provides the ability to update a user group. [Rev 1.03]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyUserGroup
Request Body schema: application/soap+xml
required
object (ModifyUserGroup)

Provides the ability to update a user group. [Rev 1.03]

Responses

Modify Workflow

Provides the ability to modify a workflow.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyWorkflow
Request Body schema: application/soap+xml
required
object (ModifyWorkflow)

Responses

Modify Workflow Instance

Provides the ability to modify or start a workflow instance.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyWorkflowInstance
Request Body schema: application/soap+xml
required
object (ModifyWorkflowInstance)

Provides the ability to modify or start a workflow instance.

Responses

Modify Workflow Version

Provides the ability to modify a workflow version.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyWorkflowVersion
Request Body schema: application/soap+xml
required
object (ModifyWorkflowVersion)

Provides the ability to modify a workflow version.

Responses

Modify Work Item Instance

Provides the ability to modify an existing work item instance.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/WorkflowManagementService1/ModifyWorkItemInstance
Request Body schema: application/soap+xml
required
object (ModifyWorkItemInstance)

Provides the ability to modify an existing work item instance.

Responses

Workflow Data Service

Abstract

The purpose of the WorkflowDataService endpoint is to supply a set of search capabilities that can be used for workflow data retrieval.

Authorization

In order to retrieve information from a data service, proper authorization credentials must be included in a header of the request. To do this, first find the Simple Web Token claim (ClaimType = "http://idibilling.com/SWT") within the Request Security Token returned to you from the 'Issue' call to the Security Token Service. Once found, the Simple Web Token must be submitted with each request in an "Authorization" header with a value in the following format: WRAP access_token="<Simple WebToken>" where the <Simple Web Token> is replaced with the claim value string.

Action Information

List of available actions that can be used by a work item or event within an environment.

  • Note: The combination of ActionID and EnvironmentID make a record unique within this collection since the information pertaining to an action may be different depending on the environment.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ActionID": 475746,
  • "ActionType": "Action Type Name",
  • "ActionTypeID": 4475746,
  • "DataDefinitionGroupID": 568475746,
  • "Description": "Action Information Description",
  • "DurationSeconds": 30,
  • "DurationType": "Duration Type Name",
  • "DurationTypeID": 4475746,
  • "Environment": "Environment NameMy Environment Name",
  • "EnvironmentID": 4475746,
  • "GalleryCategory": "Gallery Category Name",
  • "GalleryCategoryID": 4475746,
  • "Name": "Action Name"
}

Allowed Step Status Transition

List of allowed step statuses to which step instances can be transitioned, based on the step type, the workflowflow instance status, and the existing step status. [Rev 1.18]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "FromStepStatus": "Current Step Status Name",
  • "FromStepStatusID": 475746,
  • "StepType": "Step Type Name",
  • "StepTypeID": 475746,
  • "ToStepStatus": "Desired Step Status Name",
  • "ToStepStatusID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusID": 475746
}

Allowed Workflow Status Transition

List of allowed workflow statuses that can be transitioned to based on the current workflow status. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "FromWorkflowStatus": "Current Workflow Status Name",
  • "FromWorkflowStatusID": 46475746,
  • "ToWorkflowStatus": "Workflow Status Name",
  • "ToWorkflowStatusID": 5475746
}

Allowed Work Item Status Transition

List of allowed work item statuses that can be transitioned to based on the current work item status of a work item instance and the workflow status of the associated workflow instance.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "FromWorkItemStatus": "Work Item Status Name",
  • "FromWorkItemStatusID": 346475746,
  • "ToWorkItemStatus": "Work Item Status Name",
  • "ToWorkItemStatusID": 43475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusID": 424475746
}

Assignment Set

List of all the assignment sets that can be used within a given workflow. [Rev 1.04]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignmentSetID": 4475746,
  • "AutoAssignmentType": "Auto Assignment Type Name",
  • "AutoAssignmentTypeID": 4475746,
  • "DefaultAssignedUser": "Default Assigned Username",
  • "DefaultAssignedUserGroup": "Default Assigned User Group Name",
  • "DefaultAssignedUserGroupID": 6446,
  • "Environment": "Environment NameMy Environment Name",
  • "EnvironmentID": 467475746,
  • "Name": "Assignment Set Name",
  • "Workflow": "Workflow Name",
  • "WorkflowID": 467475746,
  • "WorkflowVersion": 1,
  • "WorkflowVersionID": 467475746
}

Assignment Set Instance

List of all the assignment set instances that can be used in a running instance of a workflow. [Rev 1.04]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedUser": "Assigned User Username",
  • "AssignedUserGroup": "Assigned User Group Name",
  • "AssignedUserGroupID": 34475746,
  • "AssignmentSet": "Assignment Set Name",
  • "AssignmentSetID": 53475746,
  • "AssignmentSetInstanceID": 5475746,
  • "AutoAssignmentType": "Auto Assignment Type Name",
  • "AutoAssignmentTypeID": 475746,
  • "Environment": "Environment NameMy Environment Name",
  • "EnvironmentID": 356475746,
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 35475746
}

Auto Assignment Type

List of the available auto assignment types. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoAssignmentTypeID": 85475746,
  • "Description": "Auto Assignment Type Description",
  • "Name": "Auto Assignment Type"
}

Batch Extended Information Item

List of all the extended information items that are in a batch within an environment. [Rev 1.14]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "BatchID": 3463,
  • "BatchType": "Batch Type Name",
  • "BatchTypeID": 475746,
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "IsExplicitlyInBatch": false,
  • "IsLinked": true,
  • "IsRequired": true,
  • "Key": "Extended Information Item Name",
  • "List": "List Name",
  • "ListDataType": "List Type Name",
  • "ListDataTypeID": 475746,
  • "ListID": 475746,
  • "Value": "My Value",
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkItemInstance": "Work Item Instance Name",
  • "WorkItemInstanceID": 463
}

Batch Extended Information Item Overview

List of overview records by key, data type id and list id for a batch. [Rev 1.14]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "BatchID": 3463,
  • "BatchType": "Batch Type Name",
  • "BatchTypeID": 475746,
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "ExplicitlyInBatchCount": 6,
  • "Key": "Extended Information Item Name",
  • "LinkedCount": 5,
  • "List": "List Name",
  • "ListID": 457,
  • "RequiredCount": 5,
  • "RequiredPopulatedCount": 5
}

Batch Workflow Instance

List of all the workflow instances that are in a batch within an environment. [Rev 1.14]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "BaselineCompletionDate": "2017-09-09T17:35:09.156Z",
  • "BatchID": 3525,
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "ExtendedInformationID": 475746,
  • "IsTestMode": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "Workflow Instance Name",
  • "ParentWorkflowInstance": "Parent Workflow Instance Name",
  • "ParentWorkflowInstanceID": 475746,
  • "RequestedDueDate": "2017-09-09T17:35:09.156Z",
  • "RequestedWorkflowStatus": "Requested Workflow Status",
  • "RequestedWorkflowStatusID": 475746,
  • "RootWorkflowInstance": "Root Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "UniqueID": 475746,
  • "Workflow": "Workflow Name",
  • "WorkflowID": 475746,
  • "WorkflowInstanceID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusID": 475746,
  • "WorkflowType": "Workflow Type Name",
  • "WorkflowTypeDataDefinitionGroupID": 475746,
  • "WorkflowTypeID": 475746,
  • "WorkflowVersion": 1,
  • "WorkflowVersionDataDefinitionGroupID": 475746,
  • "WorkflowVersionID": 475746
}

Batch Work Item Instance Overview

List of work item instances per batch in the system. [Rev 1.14]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Action": "Action Name",
  • "ActionID": 475746,
  • "ActionType": "Action Type Name",
  • "ActionTypeID": 475746,
  • "AssignedUser": "Username",
  • "AssignedUserGroup": "Group Name",
  • "AssignedUserGroupID": 475746,
  • "AssignmentSetInstance": "Assignment Set Instance Name",
  • "AssignmentSetInstanceAssignedUser": "Username",
  • "AssignmentSetInstanceAssignedUserGroup": "User Group Name",
  • "AssignmentSetInstanceAssignedUserGroupID": 475746,
  • "AssignmentSetInstanceAutoAssignmentType": "Auto assignment Method Name",
  • "AssignmentSetInstanceAutoAssignmentTypeID": 346,
  • "AssignmentSetInstanceID": 475746,
  • "AutoAssignmentType": "Auto Assignment method Name",
  • "AutoAssignmentTypeID": 475746,
  • "BatchID": 363,
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "Work Item Instance Description",
  • "DueDate": "2017-09-09T17:35:09.156Z",
  • "DurationSeconds": 60,
  • "DurationType": "Duration Type Name",
  • "DurationTypeID": 475746,
  • "EffortDurationType": "Duration Type Name",
  • "EffortDurationTypeID": 475746,
  • "EffortSeconds": 60,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LinkedExtendedInformationItemCount": 4,
  • "ProjectedAssignedUser": "Username",
  • "ProjectedAssignedUserGroup": "Group Name",
  • "ProjectedAssignedUserGroupID": 3463,
  • "ProjectedWorkItemStatus": "Projected Work Item Status Name",
  • "ProjectedWorkItemStatusID": 4642,
  • "Rank": 3,
  • "RequestedWorkItemStatus": "Requested Work Item Status",
  • "RequestedWorkItemStatusID": 475746,
  • "RequiredExtendedInformationItemCount": 5,
  • "RequiredPopulatedExtendedInformationItemCount": 6,
  • "RootWorkflowInstance": "Root Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "StepInstance": "Step Name",
  • "StepInstanceID": 475746,
  • "Title": "Work Iten Instance Title",
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkItemID": 346,
  • "WorkItemInstanceID": 475746,
  • "WorkItemStatus": "Work Item Status",
  • "WorkItemStatusID": 475746
}

Clause

A group of conditions and clauses that must be met in order for the clause to evaluate to true.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ClauseID": 35475746,
  • "ConjunctionType": "My Conjunction Name",
  • "ConjunctionTypeID": 356475746,
  • "Environment": "Environment NameMy Environment Name",
  • "EnvironmentID": 35635678,
  • "Name": "Clause Name",
  • "ParentClause": "Parent Clause Name",
  • "ParentClauseID": 756475746,
  • "Rank": 1,
  • "RootClause": "Root Clause Name",
  • "RootClauseID": 758
}

Clause Instance

List of clause instances within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Clause": "Clause Name",
  • "ClauseID": 475746,
  • "ClauseInstanceID": 475746,
  • "ClauseResult": "My Clause Result",
  • "ConjunctionType": "My Conjunction Name",
  • "ConjunctionTypeID": 475746,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "Clause Instance Name",
  • "ParentClauseInstance": "Parent Clause Instance Name",
  • "ParentClauseInstanceID": 1,
  • "Rank": 2,
  • "RootClauseInstance": "Root Clause Instance Name",
  • "RootClauseInstanceID": 536
}

Condition

A statement that must be met in order for the clause to evaluate to true.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ConditionID": 475746,
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "OperatorType": "Operator Name",
  • "OperatorTypeID": 475746,
  • "ParameterIndex": 4,
  • "ParentClause": "Parent Clause Name",
  • "ParentClauseID": 475746,
  • "PropertyName": "Property Name",
  • "Rank": 2,
  • "RootClause": "Root Clause Name",
  • "RootClauseID": 3,
  • "Value": "My Value"
}

Condition Instance

List of condition instances within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ConditionID": 475746,
  • "ConditionInstanceID": 475746,
  • "ConditionResult": "My Condition Result",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "OperatorType": "Operator Name",
  • "OperatorTypeID": 475746,
  • "ParentClauseInstance": "Parent Clause Instance Name",
  • "ParentClauseInstanceID": 475746,
  • "PropertyName": "Property Name",
  • "PropertyValue": "Property Value",
  • "Rank": 3,
  • "RootClauseInstance": "Root Clause Instance Name",
  • "RootClauseInstanceID": 46234,
  • "Value": "My Value"
}

Conjunction Type

List of available conjunction types that can be used for grouping conditions and clauses within a parent clause.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ConjunctionTypeID": 475746,
  • "Description": "My Conjunction Description",
  • "Name": "Conjunction Name"
}

Data Definition Group Member Information

List of data definitions by the group they belong to within an environment.

  • Note: The combination of DataDefinitionGroupMemberID and EnvironmentID make a record unique within this collection since the information pertaining to a DataDefinitionGroupMember may be different depending on the environment.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataDefinitionGroupID": 475746,
  • "DataDefinitionGroupMemberID": 475746,
  • "DataDefinitionID": 475746,
  • "DataDefinitionTemplate": "Data Definition Template Name",
  • "DataDefinitionTemplateID": 475746,
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "DefaultValue": "My Value",
  • "Description": "Data Definition Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "HookType": "My HookType",
  • "IsDataDefinitionTemplateSynchronized": true,
  • "IsRequired": true,
  • "List": "List Name",
  • "ListDataType": "List Data Type Name",
  • "ListDataTypeID": 475746,
  • "ListID": 475746,
  • "Name": "Data Definition Name",
  • "SequenceNumber": 3
}

Data Definition Group Member Usage

List of all the items that are currently using the specified data definition within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataDefinitionID": 475746,
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "Name": "Data Definition",
  • "UsageID": 475746,
  • "UsageType": "My UsageType"
}

Data Definition Template

List of all the data definition templates in an environment. [Rev 1.09]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "DataDefinitionTemplateID": 475746,
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "DefaultValue": "My Value",
  • "Description": "Data Definition Template Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsDisabled": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "List": "List Name",
  • "ListDataType": "Type of List Name",
  • "ListDataTypeID": 475746,
  • "ListID": 475746,
  • "Name": "Data Definition Template",
  • "PropertyName": "Property Name",
  • "SynchronizeDate": "2017-09-09T17:35:09.156Z"
}

Data Source Hub

A response object for information pertaining to a data source hub.[Rev 1.15]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Clause": "Clause Name",
  • "ClauseID": 475746,
  • "Column": "Column Name",
  • "DataSource": "Data Source Name",
  • "DataSourceHubID": 475746,
  • "DataSourceID": 475746,
  • "DataSourceURI": "https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top",
  • "Environment": "Enironment Name",
  • "EnvironmentID": 475746,
  • "FilterClause": "OData Filter Clause",
  • "HookType": "My Hook Type",
  • "HubKey": 475746,
  • "IsCustom": true,
  • "IsDisabled": true,
  • "Name": "Data Source Hub Name"
}

Data Source Information

A list of remote data sources. [Rev 1.08]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{}

Data Type

List of all the available types of data that can be used by a data definition.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataTypeID": 475746,
  • "Description": "Data Type Description",
  • "Name": "Data Type Name",
  • "Validation": "Validation Regex Description",
  • "ValidationRegex": "(?i)(<title.*?>)(.+?)()",
  • "ValidationRegexStrict": "(?i)(<title.*?>)(.+?)()"
}

Duration Type

List of all the available duration types that can be used to quantify how a bucket of seconds should be converted and displayed to a user.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DurationTypeID": 475746,
  • "Name": "Duration Type Name",
  • "SecondsDivisor": 3
}

Event Information

List of available events that can be attached to within an environment. [Rev 1.06]

  • Note: The combination of EventID and EnvironmentID make a record unique within this collection since the information pertaining to an event may be different depending on the environment.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataDefinitionGroupID": 475746,
  • "Description": "Event Information Description",
  • "Environment": 475746,
  • "EnvironmentID": 475746,
  • "EventCode": "My Alternate Key",
  • "EventID": 45245,
  • "EventType": "My Event Type Description",
  • "EventTypeID": 475746,
  • "GalleryCategory": "Gallery Category Name",
  • "GalleryCategoryID": 475746,
  • "Name": "Event Name"
}

Extended Information Item

Represents a single Key/Value pair of additional property information that is associated to an item.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ComputedValue": "My Computed Value",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "ExtendedInformationID": 475746,
  • "Key": "Extended Property Name",
  • "LastComputedDate": "2017-09-09T17:35:09.156Z",
  • "ObjectID": 356,
  • "ObjectType": "WorkflowInstance",
  • "Value": "My Value"
}

List Information

A listing of selectable lists defined in the system. A list is a collection of key/value pairs used to aid users in selecting a single value from a known set of values. Some lists are populated by remote resources represented by their DataSourceURI. [Rev 1.08]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AdditionalColumns": "column1, column2, column3",
  • "DataSource": "Data Source Name",
  • "DataSourceID": 475746,
  • "DataSourceURI": "https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top",
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "FilterClause": "My Filter Clause",
  • "FilterContainsOperator": "search.ismatch('{value}*','{field}')",
  • "IsCustom": true,
  • "IsDisabled": true,
  • "KeyColumn": "My Key Column",
  • "ListID": 475746,
  • "Name": "List Name",
  • "OrderClause": "My Order Clause",
  • "ValueColumn": "My Value Column"
}

List Value

A response object for information pertaining to a list. [Rev 1.11]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "ListID": 475746,
  • "Name": "List Value Name",
  • "Value": "My List Value"
}

Operator Type

List of available operators that can be used in comparing two values within a condition.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Description": "Operation Description",
  • "Name": "My Operator Name",
  • "OperatorTypeID": 475746,
  • "Symbol": "+"
}

Recurrence Pattern

Defines the pattern, interval, and effective dates at which events or actions should recur. [Rev 1.20]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DayOfWeekFridayEnabled": true,
  • "DayOfWeekMondayEnabled": true,
  • "DayOfWeekSaturdayEnabled": true,
  • "DayOfWeekSundayEnabled": true,
  • "DayOfWeekThursdayEnabled": true,
  • "DayOfWeekTuesdayEnabled": true,
  • "DayOfWeekWednesdayEnabled": true,
  • "EndDate": "2018-01-01T05:00:00.000Z",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "OnDay": 27,
  • "OnMonth": 3,
  • "RecurrencePatternID": 475746,
  • "RecurringIntervalType": "Interval Type Name",
  • "RecurringIntervalTypeID": 2,
  • "RecurringIntervalValue": 35,
  • "StartDate": "2017-09-09T04:00:00.000Z",
  • "StartTime": "2018-07-18T18:30:00.000Z",
  • "TimeZoneName": "America/New_York"
}

Splitter Step

A list of splitter steps in a Workflow definition. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Clause": "clause name",
  • "ClauseID": 83468,
  • "Environment": "Environment Name",
  • "EnvironmentID": 83468,
  • "Name": "splitter step name",
  • "SplitMethod": "split method name",
  • "SplitMethodGrouping": "split method grouping name",
  • "SplitMethodGroupingID": 83468,
  • "SplitMethodID": 83468,
  • "StepID": 83468,
  • "Workflow": "workflow name",
  • "WorkflowID": 83468,
  • "WorkflowVersionID": 83468
}

Splitter Step Grouping

A list of groupings for a splitter step in a Workflow definition. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Environment": "Environment Name",
  • "EnvironmentID": 83468,
  • "IsDefault": false,
  • "Name": "splitter step grouping name",
  • "SplitterStepGroupingID": 83468,
  • "Step": "splitter step name",
  • "StepID": 83468,
  • "SubworkflowSplitterStepConfigurationID": 83468,
  • "Workflow": "workflow name",
  • "WorkflowID": 83468,
  • "WorkflowInstancePerMember": false,
  • "WorkflowVersionID": 83468
}

Splitter Step Grouping Instance

A list of splitter step grouping instances within an environment. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Environment": "Environment Name",
  • "EnvironmentID": 83468,
  • "IsDefault": false,
  • "Name": "splitter step grouping instance name",
  • "SplitterStepGroupingInstanceID": 83468,
  • "StepInstance": "splitter step instance name",
  • "StepInstanceID": 83468,
  • "SubworkflowSplitterStepInstanceConfigurationID": 83468,
  • "WorkflowInstance": "workflow instance name",
  • "WorkflowInstanceID": 83468,
  • "WorkflowInstancePerMember": false
}

Splitter Step Grouping Member

A list of members for a splitter step grouping in a Workflow definition. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DisplayValue": "My Display value",
  • "Environment": "Environment Name",
  • "EnvironmentID": 83468,
  • "SplitterStepGroupingID": 83468,
  • "SplitterStepGroupingMemberID": 83468,
  • "Step": "splitter step name",
  • "StepID": 83468,
  • "Value": "My Value",
  • "Workflow": "workflow name",
  • "WorkflowID": 83468,
  • "WorkflowVersionID": 83468
}

Splitter Step Grouping Member Instance

A list of splitter step grouping member instances within an environment. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DisplayValue": "My Display Value",
  • "Environment": "Environment Name",
  • "EnvironmentID": 83468,
  • "SplitterStepGroupingInstanceID": 83468,
  • "SplitterStepGroupingMemberInstanceID": 83468,
  • "StepInstance": "splitter step instance name",
  • "StepInstanceID": 83468,
  • "Value": "My Value",
  • "WorkflowInstance": "workflow instance name",
  • "WorkflowInstanceID": 83468
}

Splitter Step Instance

A list of splitter step instances within an environment. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ClauseInstance": "clause instance name",
  • "ClauseInstanceID": 83468,
  • "Environment": "Environment Name",
  • "EnvironmentID": 83468,
  • "Name": "splitter step instance name",
  • "SplitMethod": "split method name",
  • "SplitMethodGrouping": "split method grouping name",
  • "SplitMethodGroupingID": 83468,
  • "SplitMethodID": 83468,
  • "StepInstanceID": 83468,
  • "WorkflowInstance": "workflow instance name",
  • "WorkflowInstanceID": 83468
}

Step

A base set of elements which all steps contain. This class should not be used in requests.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Clause": "My Clause Name",
  • "ClauseID": 475746,
  • "Description": "My Step Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "Name": "My Step Name",
  • "RepeatType": "My Repeat Type Name",
  • "RepeatTypeID": 475746,
  • "StepID": 475746,
  • "StepTemplate": "My Step Template Name",
  • "StepTemplateID": 475746,
  • "StepType": "My Step Type",
  • "StepTypeID": 475746,
  • "SynchronizeDate": "2017-09-09T17:35:09.156Z",
  • "Workflow": "Workflow Name",
  • "WorkflowID": 475746,
  • "WorkflowVersionID": 475746
}

Step Instance

List of step instances within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ClauseInstance": "My Clause Instance List",
  • "ClauseInstanceID": 475746,
  • "ClauseResult": "My Clause Result",
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "My Step Instance Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "EvaluateDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "Step Instance Name",
  • "ReevaluateSubworkflow": true,
  • "RepeatResult": 34,
  • "RepeatType": "My Repeat Type Name",
  • "RepeatTypeID": 475746,
  • "RequestedClauseResult": "My Requested Clause Result",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "Step": "My Step Instance Name",
  • "StepID": 475746,
  • "StepInstanceID": 475746,
  • "StepStatus": "My Step Instance Status",
  • "StepStatusID": 475746,
  • "StepType": "My Step Instance Type",
  • "StepTypeID": 475746,
  • "SubworkflowAutoComplete": true,
  • "WorkflowInstance": "My Workflow Instance List",
  • "WorkflowInstanceID": 475746
}

Step Instance Summary

List of summary records for each step instance within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedCount": 3,
  • "AssignedUserCount": 3,
  • "AssignedUserGroupCount": 3,
  • "ClauseInstance": "My Clause Insance List",
  • "ClauseInstanceID": 475746,
  • "ClauseResult": true,
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "My Step Instance Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "EvaluateDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "My Step Instance Name",
  • "ReevaluateSubworkflow": true,
  • "RepeatResult": 3,
  • "RepeatType": "My Repeat Type Name",
  • "RepeatTypeID": 475746,
  • "RequestedClauseResult": true,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "Step": "My Step Name",
  • "StepID": 475746,
  • "StepInstanceID": 475746,
  • "StepStatus": "My Current Status",
  • "StepStatusID": 475746,
  • "StepType": "My Step Type",
  • "StepTypeID": 475746,
  • "SubworkflowAutoComplete": true,
  • "WorkflowInstance": "My WorkflowInstance List",
  • "WorkflowInstanceID": 475746,
  • "WorkItemInstanceCount": 3,
  • "WorkItemInstanceDueWithin12HoursCount": 3,
  • "WorkItemInstanceDueWithin14DaysCount": 3,
  • "WorkItemInstanceDueWithin24HoursCount": 3,
  • "WorkItemInstanceDueWithin4HoursCount": 3,
  • "WorkItemInstanceDueWithin7DaysCount": 3,
  • "WorkItemInstanceDueWithin8HoursCount": 3,
  • "WorkItemInstanceFinishedCount": 3,
  • "WorkItemInstanceFinishedPercent": 0.1,
  • "WorkItemInstanceNewCount": 3,
  • "WorkItemInstanceOverdueCount": 3,
  • "WorkItemInstanceRunningCount": 3
}

Subscription

A response object for information pertaining to a subscription. [Rev 1.06]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Action": "My Action Name",
  • "ActionID": 475746,
  • "ClauseID": 475746,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "My Subscription Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "Event": "My Event Name",
  • "EventID": 475746,
  • "IsDisabled": true,
  • "IsUserDefined": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "My Subscription Name",
  • "RecurrencePatternID": 475746,
  • "SubscriptionID": 475746
}

Subscription Parameter

List of parameters associated with a subscription. [Rev 1.06]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataDefinition": "Data Definition Name",
  • "DataDefinitionID": 475746,
  • "DataType": "My Data Type Name",
  • "DataTypeID": 475746,
  • "DefaultValue": "My Value",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsRequired": true,
  • "Name": "My Subscription Parameter Name",
  • "SequenceNumber": 3,
  • "Subscription": "My Subscription Name",
  • "SubscriptionID": 475746,
  • "Value": "My Value"
}

Subworkflow Instance Summary

List of all of the subworkflow instances in the system, including steps that could create subworkflows but have not been activated. [Rev 1.18]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoComplete": true,
  • "BaselineCompletionDate": "2017-09-09T17:35:09.156Z",
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "Coordinator": "Coordinator Name",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 346,
  • "Name": "Subworkflow Name",
  • "ParentWorkflowInstance": "Parent Workflow Instance Name",
  • "ParentWorkflowInstanceID": 475746,
  • "ProjectedCompletionDate": "2017-09-09T17:35:09.156Z",
  • "ProjectedCompletionDateDeltaSeconds": 60,
  • "ReevaluateSubworkflow": true,
  • "RequestedDueDate": "2017-09-09T17:35:09.156Z",
  • "RootWorkflowInstance": "Root Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "SplitterStepGroupingInstanceID": 475746,
  • "SplitterStepGroupingInstanceName": "My Grouping Instance Name",
  • "SplitterStepGroupingMemberInstanceDisplayValue": "My Display Value",
  • "SplitterStepGroupingMemberInstanceID": 475746,
  • "SplitterStepGroupingMemberInstanceValue": "My Value",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "StepInstance": "Step Name",
  • "StepInstanceID": 536,
  • "StepStatus": "Step Instance Status",
  • "StepStatusID": 35678,
  • "SubworkflowInstanceID": 475746,
  • "WorkflowStatus": "47574Workflow Status Name6",
  • "WorkflowStatusID": 475746,
  • "WorkItemInstanceFinishedPercent": 0.1,
  • "WorkItemInstanceOverdueCount": 4
}

Subworkflow Splitter Step Configuration

A list of subworkflow configuration data assigned to Splitter Steps in a Workflow definition. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoComplete": false,
  • "Coordinator": "username",
  • "Environment": "environment name",
  • "EnvironmentID": 5357,
  • "ExtendedInformationID": 5357,
  • "InheritLinkReference": true,
  • "IsDefault": false,
  • "OutputExtendedInformationID": 5357,
  • "SplitterStepGroupingID": 5357,
  • "Step": "splitter step name",
  • "StepID": 5357,
  • "Subworkflow": "workflow definition name",
  • "SubworkflowID": 5357,
  • "SubworkflowName": "My Value",
  • "SubworkflowSplitterStepConfigurationID": 5357,
  • "Workflow": "workflow definition name",
  • "WorkflowID": 5357,
  • "WorkflowInstancePerMember": false,
  • "WorkflowVersionID": 5357
}

Subworkflow Splitter Step Instance Configuration

A list of subworkflow configuration data assigned to splitter step instances in a Workflow instance. [Rev 1.28]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoComplete": false,
  • "Coordinator": "username",
  • "Environment": "environment name",
  • "EnvironmentID": 5357,
  • "ExtendedInformationID": 5357,
  • "IsDefault": false,
  • "InheritLinkReference": true,
  • "OutputExtendedInformationID": 5357,
  • "ReevaluateSubworkflow": false,
  • "SplitterStepGroupingInstanceID": 5357,
  • "StepInstance": "splitter step instance name",
  • "StepInstanceID": 5357,
  • "Subworkflow": "workflow definition name",
  • "SubworkflowID": 5357,
  • "SubworkflowName": "My Value",
  • "SubworkflowSplitterStepInstanceConfigurationID": 5357,
  • "Workflow": "workflow definition name",
  • "WorkflowID": 5357,
  • "WorkflowInstancePerMember": true,
  • "WorkflowVersionID": 464
}

Subworkflow Step Configuration

A list of subworkflow configuration data assigned to Steps in a Workflow definition. [Rev 1.18]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoComplete": true,
  • "Coordinator": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "ExtendedInformationID": 475746,
  • "InheritLinkReference": true,
  • "OutputExtendedInformationID": 475746,
  • "Step": "Step Name",
  • "StepID": 475746,
  • "Subworkflow": "Workflow Definition Name",
  • "SubworkflowID": 475746,
  • "SubworkflowName": "Subworkflow Name",
  • "Workflow": "Workflow Definition Name",
  • "WorkflowID": 475746,
  • "WorkflowVersionID": 475746
}

Subworkflow Step Instance Configuration

A list of subworkflow configuration data assigned to step instances in a Workflow instance. [Rev 1.18]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoComplete": true,
  • "Coordinator": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "ExtendedInformationID": 475746,
  • "InheritLinkReference": true,
  • "OutputExtendedInformationID": 475746,
  • "ReevaluateSubworkflow": false,
  • "StepInstance": "Step Instance Name",
  • "StepInstanceID": 475746,
  • "Subworkflow": "Workflow Definition Name",
  • "SubworkflowID": 475746,
  • "SubworkflowName": "Subworkflow Name",
  • "Workflow": "Workflow Definition Name",
  • "WorkflowID": 475746,
  • "WorkflowVersionID": 475746
}

Transition

An item that links two steps together within a workflow.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "FromStep": "Start Step Name",
  • "FromStepID": 475746,
  • "RequiredClauseResult": "My Clause Value",
  • "ToStep": "My End Step Name",
  • "ToStepID": 475746,
  • "Workflow": "My Workflow Transition Name",
  • "WorkflowID": 475746,
  • "WorkflowVersion": 1,
  • "WorkflowVersionID": 475746
}

Transition Instance

List of transition instances within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "FromStepInstance": "My Start Step Instance Name",
  • "FromStepInstanceID": 475746,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "RequiredClauseResult": "My Clause Value",
  • "ToStepInstance": "End Step Instance Name",
  • "ToStepInstanceID": 475746,
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746
}

User Group

List of transition instances within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "User Group Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsDisabled": false,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "User Group Name",
  • "UserGroupID": 475746
}

User Group Member

List of the users that belong to a user group within an environment. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "User": "Username",
  • "UserGroup": "My User Group",
  • "UserGroupID": 475746,
  • "UserGroupMemberID": 475746
}

Workflow

A response object for information pertaining to a work flow.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CheckOutDate": "2017-09-09T17:35:09.156Z",
  • "CheckOutUser": "Username",
  • "CheckOutVersion": 1,
  • "CheckOutWorkflowVersionID": 475746,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "My Workflow Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsTestMode": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Name": "Workflow Name",
  • "PromotedDataDefinitionGroupID": 475746,
  • "PromotedVersion": 1,
  • "PromotedWorkflowVersionID": 475746,
  • "WorkflowID": 475746,
  • "WorkflowType": "Workflow Type Name",
  • "WorkflowTypeID": 475746
}

Workflow Instance

A response object for the information pertaining to a workflow instance.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoResumeDate": "2017-09-09T17:35:09.156Z",
  • "BaselineCompletionDate": "2017-09-09T17:35:09.156Z",
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "ExtendedInformationID": 475746,
  • "IsTestMode": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LinkReferenceID": 12,
  • "LinkReferenceType": "Link Reference Type Object",
  • "LinkReferenceTypeID": 0,
  • "Name": "Workflow Instance Name",
  • "ParentWorkflowInstance": "Parent Workflow Instance Name",
  • "ParentWorkflowInstanceID": 475746,
  • "RequestedDueDate": "2017-09-09T17:35:09.156Z",
  • "RequestedWorkflowStatus": "My Requested Workflow Status",
  • "RequestedWorkflowStatusID": 475746,
  • "RootAutoResumeDate": "2017-09-09T17:35:09.156Z",
  • "RootWorkflowInstance": "Root Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "UniqueID": 475746,
  • "Workflow": "Workflow Name",
  • "WorkflowID": 475746,
  • "WorkflowInstanceID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusID": 475746,
  • "WorkflowType": "Workflow Type Name",
  • "WorkflowTypeDataDefinitionGroupID": 475746,
  • "WorkflowTypeID": 475746,
  • "WorkflowVersion": 1,
  • "WorkflowVersionDataDefinitionGroupID": 475746,
  • "WorkflowVersionID": 475746
}

Workflow Instance Assigned User Or Group Overview

An overview per unique user or group assigned in a workflow instance of the number of work items they have in that workflow instance for a given work item status. [Rev 1.03]

  • Note: Only records which are assigned only to a group and not also to an individual user will count towards the group count. If a user or group does not have any work items in a particular status, no record is returned for that combination.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedUserOrGroup": "Username",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsUserGroupResponsible": true,
  • "Name": "My Workflow Instance",
  • "WorkflowInstanceID": 475746,
  • "WorkItemStatus": "My Work Item Status Name",
  • "WorkItemStatusCount": 3,
  • "WorkItemStatusID": 475746
}

Workflow Instance Assigned User Overview

An overview per unique user assigned in a workflow instance of the number of work items they have in that workflow instance for a given status work item status.

  • Note: If a user does not have any work items in a particular status, no record is returned for that combination.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedUser": "Username",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "Name": "My Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkItemStatus": "My Work Item Status Name",
  • "WorkItemStatusCount": 3,
  • "WorkItemStatusID": 475746
}

Workflow Instance History

List of changes that were made to workflow instance and all the values that were currently associated with it when those changes were made. [Rev 1.09]

  • Note: A history record is generated whenever one of the history fields change on the related workflow instance. When a history records is generated all current values are written into the history.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "Note": "My Note",
  • "PreviousWorkflowStatus": "My Previous Workflow Status Name",
  • "PreviousWorkflowStatusID": 3643,
  • "PreviousWorkflowStatusSeconds": 60,
  • "RequestedWorkflowStatus": "My Requested Workflow Status Name",
  • "RequestedWorkflowStatusID": 475746,
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceHistoryID": 475746,
  • "WorkflowInstanceID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusChangeReason": "My Workflow Status Change Reason Name",
  • "WorkflowStatusChangeReasonID": 475746,
  • "WorkflowStatusID": 475746
}

Workflow Instance History Combined

List of all history records associated with workflow instances, step instances and work item instances. This listing replaces WorkflowInstanceHistoryExpanded [Rev 1.18]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "HistoryRecordID": 475746,
  • "HistoryRecordType": "StepInstance",
  • "Note": "My Notes",
  • "ParentWorkflowInstance": "First Parent Workflow Instance Name",
  • "ParentWorkflowInstanceID": 475746,
  • "PreviousStepStatus": "Previous Step Status",
  • "PreviousStepStatusID": 345,
  • "PreviousWorkflowStatus": "Previous Workflow Status Name",
  • "PreviousWorkflowStatusID": 246,
  • "RequestedStepStatus": "Step Status Name",
  • "RequestedStepStatusID": 346,
  • "RequestedWorkflowStatus": "Workflow Status Name",
  • "RequestedWorkflowStatusID": 357,
  • "RequestedWorkItemStatus": "Work Item Status Name",
  • "RequestedWorkItemStatusID": 357,
  • "RootWorkflowInstance": "Last Parent Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "StepInstance": "Step Instance Name",
  • "StepInstanceID": 475746,
  • "StepStatus": "Step Status Name",
  • "StepStatusID": 7534,
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusChangeReason": "My Workflow Status Change Reason Name",
  • "WorkflowStatusChangeReasonID": 35678,
  • "WorkflowStatusID": 56475,
  • "WorkItemInstance": "Work Item Instance Name",
  • "WorkItemInstanceID": 5678,
  • "WorkItemStatus": "Work Item Status Name",
  • "WorkItemStatusID": 5855
}

Workflow Instance History Expanded

List of all history associated with workflows and work items. [Rev 1.16]

  • Deprecated: Replaced by WorkflowInstanceHistoryCombined [Rev 1.18]
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "Note": "My Notes",
  • "PreviousWorkflowStatus": "Previous Workflow Status Name",
  • "PreviousWorkflowStatusID": 3463,
  • "RequestedWorkflowStatus": "Workflow Status Name",
  • "RequestedWorkflowStatusID": 3636,
  • "RequestedWorkItemStatus": "Work Item Status",
  • "RequestedWorkItemStatusID": 6478,
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceHistoryID": 474,
  • "WorkflowInstanceID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusID": 474,
  • "WorkItemInstance": "Work Item Instance Name",
  • "WorkItemInstanceHistoryID": 4684,
  • "WorkItemInstanceID": 468,
  • "WorkItemStatus": "Work Item Status Name",
  • "WorkItemStatusID": 426
}

Workflow Instance Summary

A list of summary records for each workflow instance in the system.

Some fields now guard against an overflow when computing a date difference. If the date difference would overflow the maximum integer value, it will return the maximum integer value (2,147,483,647). If the difference would overflow the minimum integer value, it will return the minimum integer value (-2,147,483,648). The fields affected are listed below. [Rev 1.39]

  • ProjectedCompletionDateDeltaSeconds
  • RequestedDueDateDeltaSeconds
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedCount": 3,
  • "AssignedUserCount": 54,
  • "AssignedUserGroupCount": 3,
  • "AutoResumeDate": "2017-09-09T17:35:09.156Z",
  • "BaselineCompletionDate": "2017-09-09T17:35:09.156Z",
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "My Environment",
  • "EnvironmentID": 475746,
  • "ExtendedInformationID": 475746,
  • "IsTestMode": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LinkReferenceID": 20,
  • "LinkReferenceType": "foo",
  • "LinkReferenceTypeID": 3,
  • "Name": "My Workflow Instance Name",
  • "ParentWorkflowInstance": "My Parent Workflow Instance Name",
  • "ParentWorkflowInstanceID": 475746,
  • "ProjectedCompletionDate": "2017-09-09T17:35:09.156Z",
  • "ProjectedCompletionDateDeltaSeconds": 60,
  • "RequestedDueDate": "2017-09-09T17:35:09.156Z",
  • "RequestedDueDateDeltaSeconds": 60,
  • "RequestedWorkflowStatus": "The Workflow Instance Status",
  • "RequestedWorkflowStatusID": 475746,
  • "RootAutoResumeDate": "2017-09-09T17:35:09.156Z",
  • "RootWorkflowInstance": "Root Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "StepInstanceCount": 4,
  • "UniqueID": 475746,
  • "Workflow": "Workflow Instance Name",
  • "WorkflowID": 475746,
  • "WorkflowInstanceID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusID": 475746,
  • "WorkflowType": "My Workflow Instance Type Name",
  • "WorkflowTypeDataDefinitionGroupID": 475746,
  • "WorkflowTypeID": 475746,
  • "WorkflowVersion": 1,
  • "WorkflowVersionDataDefinitionGroupID": 475746,
  • "WorkflowVersionID": 475746,
  • "WorkItemInstanceCount": 3,
  • "WorkItemInstanceDueWithin12HoursCount": 3,
  • "WorkItemInstanceDueWithin14DaysCount": 3,
  • "WorkItemInstanceDueWithin24HoursCount": 3,
  • "WorkItemInstanceDueWithin4HoursCount": 3,
  • "WorkItemInstanceDueWithin7DaysCount": 3,
  • "WorkItemInstanceDueWithin8HoursCount": 3,
  • "WorkItemInstanceFinishedCount": 3,
  • "WorkItemInstanceFinishedPercent": 0.1,
  • "WorkItemInstanceNewCount": 3,
  • "WorkItemInstanceOverdueCount": 3,
  • "WorkItemInstanceRunningCount": 3
}

Workflow Instance Summary Inclusive

A list of summary records for each workflow instance in the system, including calculations taking into considerations the effects of subworkflow instances. [Rev 1.19]

Some fields now guard against an overflow when computing a date difference. If the date difference would overflow the maximum integer value, it will return the maximum integer value (2,147,483,647). If the difference would overflow the minimum integer value, it will return the minimum integer value (-2,147,483,648). The fields affected are listed below. [Rev 1.39]

  • ProjectedCompletionDateDeltaSeconds
  • ProjectedCompletionDateInclusiveDeltaSeconds
  • RequestedDueDateDeltaSeconds
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoComplete": true,
  • "AutoResumeDate": "2017-09-09T17:35:09.156Z",
  • "BaselineCompletionDate": "2017-09-09T17:35:09.156Z",
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "Environment Name",
  • "EnvironmentID": 475746,
  • "ExtendedInformationID": 475746,
  • "IsTestMode": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LinkReferenceID": 20,
  • "LinkReferenceType": "foo",
  • "LinkReferenceTypeID": 3,
  • "Name": "Workflow Instance Name",
  • "ParentWorkflowInstance": "First Parent Workflow Instance Name",
  • "ParentWorkflowInstanceID": 475746,
  • "ProjectedCompletionDate": "2017-09-09T17:35:09.156Z",
  • "ProjectedCompletionDateDeltaSeconds": 60,
  • "ProjectedCompletionDateInclusive": "2017-09-09T17:35:09.156Z",
  • "ProjectedCompletionDateInclusiveDeltaSeconds": 60,
  • "RequestedDueDate": "2017-09-09T17:35:09.156Z",
  • "RequestedDueDateDeltaSeconds": 60,
  • "RequestedWorkflowStatus": "Requested Workflow Status",
  • "RequestedWorkflowStatusID": 475746,
  • "RootAutoResumeDate": "2017-09-09T17:35:09.156Z",
  • "RootWorkflowInstance": "Last Parent Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "UniqueID": 475746,
  • "Workflow": "Workflow Name",
  • "WorkflowID": 475746,
  • "WorkflowInstanceID": 475746,
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusID": 475746,
  • "WorkflowTypeID": 475746,
  • "WorkflowVersion": 1,
  • "WorkflowVersionDataDefinitionGroupID": 475746,
  • "WorkflowVersionID": 475746
}

Workflow Instance Work Item Status Overview

An overview per unique work item status in a workflow instance of the number of work items in a given status work item status.

  • Note: If a work item status does not have any work items, then no record is returned for that status.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "Name": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkItemStatus": "Work Item Status Name",
  • "WorkItemStatusCount": 3,
  • "WorkItemStatusID": 475746
}

Workflow Status

List of available statuses that a workflow instance can be set to.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Description": "Workflow Status Description",
  • "Name": "Workflow Status Name",
  • "WorkflowStatusID": 475746
}

Workflow Status Change Reason

A list of change reasons applicable when requesting workflow status changes. [Rev. 1.10]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Description": "Workflow Status Change Reason Description",
  • "Name": "Workflow Status Change Reason Name",
  • "WorkflowStatus": "Workflow Status Name",
  • "WorkflowStatusChangeReasonID": 475746,
  • "WorkflowStatusID": 475746
}

Workflow Type Information

List of available workflow types that workflows can derive from within an environment.

  • Note: The combination of WorkflowTypeID and EnvironmentID make a record unique within this collection since the information pertaining to an workflow type may be different depending on the environment.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataDefinitionGroupID": 363,
  • "Description": "Workflow Type Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "Name": "Workflow Type Name",
  • "WorkflowTypeID": 475746
}

Workflow Version

A version of the workflow. This object contains all the work items, steps and transitions that were modified as part of the request.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoAssignmentType": "Auto Assignment Type Name",
  • "AutoAssignmentTypeID": 475746,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "DataDefinitionGroupID": 475746,
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsCheckedOut": true,
  • "IsPromoted": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "Note": "My Notes",
  • "Version": 1,
  • "Workflow": "Workflow Name",
  • "WorkflowID": 475746,
  • "WorkflowVersionID": 475746
}

Work Item

List of all the work items within an environment.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Action": "Action Name",
  • "ActionID": 475746,
  • "ActionType": "Action Type Name",
  • "ActionTypeID": 475746,
  • "AssignmentSet": "Assignment Set Name",
  • "AssignmentSetAutoAssignmentType": "Assignment Set Auto Assignment Type Name",
  • "AssignmentSetAutoAssignmentTypeID": 3536,
  • "AssignmentSetDefaultAssignedUser": "Username",
  • "AssignmentSetDefaultAssignedUserGroup": "Username",
  • "AssignmentSetDefaultAssignedUserGroupID": 475746,
  • "AssignmentSetID": 475746,
  • "AutoAssignmentType": "Auto Assignment Name",
  • "AutoAssignmentTypeID": 464,
  • "DefaultAssignedUser": "Username",
  • "DefaultAssignedUserGroup": "Default User Group Name",
  • "DefaultAssignedUserGroupID": 475746,
  • "Description": "My Work Item Description",
  • "DurationSeconds": 60,
  • "DurationType": "My Duration Type Name",
  • "DurationTypeID": 475746,
  • "EffortDurationType": "Effort Duration Type Name",
  • "EffortDurationTypeID": 475746,
  • "EffortSeconds": 60,
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "Rank": 2,
  • "Step": "Step Name",
  • "StepID": 475746,
  • "Title": "Work Item Title",
  • "Workflow": "Workflow Name",
  • "WorkflowID": 475746,
  • "WorkflowVersionID": 475746,
  • "WorkItemID": 475746
}

Work Item Data Definition

A list of data definitions available to be linked to a work item. [Rev 1.07]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataDefinitionGroupAssociation": "WorkflowType",
  • "DataDefinitionGroupID": 475746,
  • "DataDefinitionGroupSequenceNumber": 2,
  • "DataDefinitionID": 475746,
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "DefaultValue": "My Value",
  • "Description": "Data Definition Description",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsLinkedToWorkItem": true,
  • "IsRequiredForWorkItem": true,
  • "IsRequiredToStartWorkflow": false,
  • "Name": "Data Definition Name",
  • "StepID": 475746,
  • "StepName": "Step Name",
  • "WorkItemID": 475746,
  • "WorkItemTitle": "Work Item Title"
}

Work Item Instance

A response object for information pertaining to a work item instance.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Action": "Action Name",
  • "ActionID": 475746,
  • "ActionType": "Action Type Name",
  • "ActionTypeID": 475746,
  • "AssignedUser": "Username",
  • "AssignedUserGroup": "Username",
  • "AssignedUserGroupID": 475746,
  • "AssignmentSetInstance": "Assignment Set Instance Name",
  • "AssignmentSetInstanceAssignedUser": "Username",
  • "AssignmentSetInstanceAssignedUserGroup": "User Group Name",
  • "AssignmentSetInstanceAssignedUserGroupID": 475746,
  • "AssignmentSetInstanceAutoAssignmentType": "Auto Assignment Method Name",
  • "AssignmentSetInstanceAutoAssignmentTypeID": 364,
  • "AssignmentSetInstanceID": 475746,
  • "AutoAssignmentType": "Auto Assignment Type Name",
  • "AutoAssignmentTypeID": 475746,
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "Work Item Instance Description",
  • "DueDate": "2017-09-09T17:35:09.156Z",
  • "DurationSeconds": 60,
  • "DurationType": "Duration Type Name",
  • "DurationTypeID": 475746,
  • "EffortDurationType": "My Duration Type Name",
  • "EffortDurationTypeID": 475746,
  • "EffortSeconds": 60,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LinkReferenceID": 20,
  • "LinkReferenceType": "foo",
  • "LinkReferenceTypeID": 3,
  • "ProjectedAssignedUser": "Username",
  • "ProjectedAssignedUserGroup": "User Group Name",
  • "ProjectedAssignedUserGroupID": 563,
  • "ProjectedWorkItemStatus": "My Projected Work Item Status",
  • "ProjectedWorkItemStatusID": 574,
  • "Rank": 2,
  • "RequestedWorkItemStatus": "My Requested Work Item Status",
  • "RequestedWorkItemStatusID": 475746,
  • "RootWorkflowInstance": "Root Workflow Instance Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "StepInstance": "Step Instance Name",
  • "StepInstanceID": 475746,
  • "Title": "Work Iten Instance Name",
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkItemID": 3573,
  • "WorkItemInstanceID": 475746,
  • "WorkItemStatus": "Work Item Status",
  • "WorkItemStatusID": 475746
}

Work Item Instance Expanded

List of all the work item instances currently in the system. If the work item instance is only assigned to a user group, then that item will show up multiple times as assigned to each group member. [Rev 1.03]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Action": "My Action Name",
  • "ActionID": 475746,
  • "ActionType": "My Action Type Name",
  • "ActionTypeID": 475746,
  • "AssignedUser": "Username",
  • "AssignedUserGroup": "User Group Name",
  • "AssignedUserGroupID": 475746,
  • "AssignmentSetInstance": "Assignment Set Status Name",
  • "AssignmentSetInstanceID": 475746,
  • "AutoAssignmentType": "Auto Assignment Algorithm Name",
  • "AutoAssignmentTypeID": 3463,
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "Work Item Instance Description",
  • "DueDate": "2017-09-09T17:35:09.156Z",
  • "DurationSeconds": 60,
  • "DurationType": "Duration Type Name",
  • "DurationTypeID": 475746,
  • "EffortDurationType": "Duration Type Name",
  • "EffortDurationTypeID": 475746,
  • "EffortSeconds": 60,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "IsDerivedFromAssignmentSet": true,
  • "IsUserGroupResponsible": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LinkReferenceID": 20,
  • "LinkReferenceType": "foo",
  • "LinkReferenceTypeID": 3,
  • "ProjectedWorkItemStatus": "Work Item Status Name",
  • "ProjectedWorkItemStatusID": 345,
  • "Rank": 2,
  • "RequestedWorkItemStatus": "Work Item Instance Status",
  • "RequestedWorkItemStatusID": 475746,
  • "RootWorkflowInstance": "Very Top Workflow Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "StepInstance": "Step Name",
  • "StepInstanceID": 475746,
  • "Title": "Work Item Instance Title",
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkItemID": 4633,
  • "WorkItemInstanceID": 475746,
  • "WorkItemStatus": "Work Item Instance Status",
  • "WorkItemStatusID": 475746
}

Work Item Instance Extended Information

A list of extended information items that are associated to a work item instance. [Rev 1.07]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsRequired": true,
  • "KeyName": "Extended Information Item Name",
  • "StepInstance": "Step Instance Name",
  • "StepInstanceID": 475746,
  • "Value": "My Value",
  • "WorkItemInstanceID": 475746,
  • "WorkItemInstanceTitle": "Work Item Instnace Title"
}

Work Item Instance History

List of changes that were made to a work item instance and all the values that were currently associated with it when those changes were made.

  • Note: A history record is generated whenever one of the history fields change on the related work item instance. When a history record is generated all current values are written into the history.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedUser": "Username",
  • "AssignedUserGroup": "User Group Name",
  • "AssignedUserGroupID": 475746,
  • "AssignmentSetInstance": "Assignment Set Instance Name",
  • "AssignmentSetInstanceID": 475746,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "Note": "My Note",
  • "Rank": 2,
  • "RequestedWorkItemStatus": "Work Item Instance Status",
  • "RequestedWorkItemStatusID": 475746,
  • "WorkItemInstanceHistoryID": 475746,
  • "WorkItemInstanceID": 475746,
  • "WorkItemStatus": "Work Item Status",
  • "WorkItemStatusID": 475746,
  • "WorkflowActionLogFilename": "TestSubscription_2017-01-01T14-00-00.0000000-05-00.log"
}

Work Item Instance Parameter

List of parameters associated with a work item instance.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ComputedValue": "My Value",
  • "DataDefinition": "Data Definition Name",
  • "DataDefinitionID": 475746,
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "DefaultValue": "My Value",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsRequired": true,
  • "IsTestMode": true,
  • "LastComputedDate": "2017-09-09T17:35:09.156Z",
  • "Name": "Work Item Instance Parameter Name",
  • "SequenceNumber": 3,
  • "TestValue": "My Test Value",
  • "Value": "My Value",
  • "WorkItemInstanceID": 475746,
  • "WorkItemInstanceTitle": "My Work Item Instance Title"
}

Work Item Instance Summary

List of summary records for each work item instance in the system. [Rev 1.07]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Action": "Action Name",
  • "ActionID": 475746,
  • "ActionType": "Action Type Name",
  • "ActionTypeID": 475746,
  • "AssignedUser": "Username",
  • "AssignedUserGroup": "Assigned User Group Name",
  • "AssignedUserGroupID": 475746,
  • "AssignmentSetInstance": "Assignment Set Instance Name",
  • "AssignmentSetInstanceAssignedUser": "Username",
  • "AssignmentSetInstanceAssignedUserGroup": "User Group Name",
  • "AssignmentSetInstanceAssignedUserGroupID": 475746,
  • "AssignmentSetInstanceAutoAssignmentType": "Auto Assignment Method Name",
  • "AssignmentSetInstanceAutoAssignmentTypeID": 23624,
  • "AssignmentSetInstanceID": 475746,
  • "AutoAssignmentType": "Auto Assignment Method Name",
  • "AutoAssignmentTypeID": 475746,
  • "Coordinator": "Username",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "Description": "Work Item Instance Description",
  • "DueDate": "2017-09-09T17:35:09.156Z",
  • "DurationSeconds": 60,
  • "DurationType": "My Duration Type Name",
  • "DurationTypeID": 475746,
  • "EffortDurationType": "My Duration Type Name",
  • "EffortDurationTypeID": 475746,
  • "EffortSeconds": 60,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 35678,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "LinkedExtendedInformationItemCount": 4,
  • "LinkReferenceID": 20,
  • "LinkReferenceType": "foo",
  • "LinkReferenceTypeID": 3,
  • "ProjectedAssignedUser": "Username",
  • "ProjectedAssignedUserGroup": "Group Name",
  • "ProjectedAssignedUserGroupID": 464,
  • "ProjectedWorkItemStatus": "Projected Work Item Status Name",
  • "ProjectedWorkItemStatusID": 353,
  • "Rank": 3,
  • "RequestedWorkItemStatus": "My Work Item Status",
  • "RequestedWorkItemStatusID": 475746,
  • "RequiredExtendedInformationItemCount": 3,
  • "RequiredPopulatedExtendedInformationItemCount": 3,
  • "RootWorkflowInstance": "Workflow Name",
  • "RootWorkflowInstanceID": 475746,
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "StepInstance": "Step Name",
  • "StepInstanceID": 475746,
  • "Title": "Work Item Instance Title",
  • "WorkflowInstance": "Workflow Instance Name",
  • "WorkflowInstanceID": 475746,
  • "WorkItemID": 3452,
  • "WorkItemInstanceID": 475746,
  • "WorkItemStatus": "Work Item Instance Status",
  • "WorkItemStatusID": 475746
}

Work Item Parameter

An object associated with a work item that will define how the work item will operate.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "DataDefinition": "Data Definition Name",
  • "DataDefinitionID": 475746,
  • "DataType": "Data Type Name",
  • "DataTypeID": 475746,
  • "DefaultValue": "My Value",
  • "Environment": "My Environment Name",
  • "EnvironmentID": 475746,
  • "IsRequired": true,
  • "IsTestMode": true,
  • "Name": "Work Item Parameter Name",
  • "SequenceNumber": 2,
  • "TestValue": "My Test Value",
  • "Value": "My Value",
  • "WorkItemID": 475746,
  • "WorkItemTitle": "Work Item Title"
}

Work Item Status

List of available statuses that a work item instance can be set to.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Description": "Status Description",
  • "IsFinished": true,
  • "IsRunning": true,
  • "Name": "Status Name",
  • "WorkItemStatusID": 475746
}

Release Notes

Latest WSDL

Release Notes 2.17

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.16

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.15

Release Notes 2.14

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.13

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.12

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.11

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.10

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.07

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.06

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.50

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.49

Release Notes 1.48

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.47

Release Notes 1.46

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.45

Release Notes 1.44

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.43

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.42

  • WSDL

  • Added IsUserDefined

Release Notes 1.41

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.40

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.39

  • WSDL

  • Some fields now guard against an overflow when computing a date difference. If the date difference would overflow the maximum integer value, it will return the maximum integer value (2,147,483,647). If the difference would overflow the minimum integer value, it will return the minimum integer value (-2,147,483,648). The fields affected are listed below.

Release Notes 1.38

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.37

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.36

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.35

Release Notes 1.34

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.33

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.32

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.31

Release Notes 1.30

  • WSDL

  • Added AdditionalColumns.

  • Added FilterContainsOperator.

  • Added Splitter Step type to list of available Steps for use in Modify Workflow Version.

Release Notes 1.29

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.28

  • WSDL
  • Added SplitterStep, SplitterStepGrouping, SplitterStepGroupingInstance, SplitterStepGroupingMember, SplitterStepGroupingMemberInstance, SplitterStepInstance, SubworkflowSplitterStepConfiguration

Release Notes 1.27

  • WSDL
  • Added ObjectTypes for 'SplitterStepSubworkflowConfiguration', 'SplitterStepSubworkflowConfiguration.Output', 'SplitterStepSubworkflowConfigurationInstance', 'SplitterStepSubworkflowConfigurationInstance.Output'

Release Notes 1.26

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.25

  • WSDL
  • When associated to a DataDefinitionGroupMember the Value property is validated against the DataType. If the DataType is DateTime or Date the Value will be standardized to ISO 8601 format.

Release Notes 1.24

  • WSDL
  • Value property is only required when adding condition that has an operator type of neither 'equals' or 'not equals'.

Release Notes 1.23

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.22

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.21

  • WSDL
  • Added GalleryCategory and GalleryCategoryID
  • Added WorkItemInstanceID
  • Added AutoCompleteWorkItemInstance
  • Added ParentWorkflowInstance, ParentWorkflowInstanceID, RootWorkflowInstance, RootWorkflowInstanceID

Release Notes 1.20

  • WSDL
  • Added RecurrencePattern
  • Added ReminderType
  • Added EventType, EventTypeID
  • Added Reminders
  • Added Reminder
  • Added RecurrencePattern
  • Added RecurrencePatternID
  • Added Reminders
  • Added AutoResumeDate, RootAutoResumeDate

Release Notes 1.19

  • WSDL
  • Added IsDisabled
  • Added the following to ObjectType: 'SubworkflowStepConfiguration.Output', 'SubworkflowStepInstanceConfiguration', 'SubworkflowStepInstanceConfiguration.Output'
  • Added OutputExtendedInformation
  • Added OutputExtendedInformationID
  • Added WorkflowInstanceSummaryInclusive

Release Notes 1.18

  • WSDL
  • Added the following to ObjectType: 'SubworkflowStepConfiguration'
  • Added SubworkflowStep, SubworkflowStepInstance
  • Added RequestedStepStatusID
  • Added ReevaluateSubworkflow, SubworkflowAutoComplete
  • Added AllowedStepStatusTransition, SubworkflowInstanceSummary, SubworkflowStepConfiguration, SubworkflowStepInstanceConfiguration, WorkflowInstanceHistoryCombined

Release Notes 1.17

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.16

  • Added WorkflowInstanceHistoryExpanded

Release Notes 1.15

  • Added ParameterIndex
  • Added Clause, ClauseID, DataSourceHubID, IsDisabled and Name
  • Added ComputedValue, LastComputedDate
  • Added DataSourceHub
  • Added ComputeExtendedInformationItems
  • Added CreateDataSourceHubReq, CreateDataSourceHubResult, DataSourceHub, ModifyDataSourceHubReq, ModifyDataSourceHubResult
  • Added CreateDataSourceHub, ModifyDataSourceHub

Release Notes 1.14

  • Added BatchType
  • Added Batch
  • Added Batch, BatchItem, CreateBatchReq, CreateBatchResult, ModifyBatchReq, ModifyBatchResult
  • Added CreateBatch, ModifyBatch
  • Added BatchExtendedInformationItem, BatchExtendedInformationItemOverview, BatchWorkflowInstance, BatchWorkItemInstanceOverview

Release Notes 1.13

  • Added Coordinator.

Release Notes 1.12

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.11

  • Added HookType
  • Added IsCustom and IsDisabled
  • Added CreateListReq, CreateListResult, List, ListValue, ModifyListReq and ModifyListResult.
  • Added CreateList and ModifyList
  • Added DataSourceHub

Release Notes 1.10

  • Added ReevaluateClauseResult
  • Added WorkflowStatusChangeReasonID
  • Added StepInstanceWorkItem
  • Added nillable to the min max for the element WorkItemInstance this fixed a previous documentation mismatch.
  • Added StepInstanceWorkItems
  • Added StepInstance and StepInstanceID.
  • Added WorkflowStatusChangeReason
  • Added WorkflowStatusChangeReason, WorkflowStatusChangeReasonID

Release Notes 1.09

  • Added DataDefinitionTemplateID
  • Added DataDefinitionTemplate, DataDefinitionTemplateID and IsDataDefinitionTemplateSynchronized
  • Added Note and RequestedWorkflowStatusID
  • Added RequestedWorkflowStatusID
  • Added CreateDataDefinitionTemplateReq, CreateDataDefinitionTemplateResult, DataDefinitionTemplate, ModifyDataDefinitionTemplateReq and ModifyDataDefinitionTemplateResult
  • Added CreateDataDefinitionTemplate and ModifyDataDefinitionTemplate
  • Added AllowedWorkflowStatusTransition, DataDefinitionTemplate and WorkflowInstanceHistory
  • Added RequestedWorkflowStatus and RequestedWorkflowStatusID

Release Notes 1.08

  • Added ListID
  • Added List, ListDataType, ListDataTypeID and ListID
  • Added DataSourceInformation, ListInformation, ListValue.

Release Notes 1.07

  • Added LinkedDataDefinition, WorkItemInstanceSummary
  • Added WorkItemDataDefinition, WorkItemInstanceExtendedInformation
  • Added LinkedDataDefinitions

Release Notes 1.06

  • Added Description
  • Added CreateSubscriptionReq, CreateSubscriptionResult, ModifySubscriptionReq, ModifySubscriptionResult,Subscription and SubscriptionParameter
  • Added CreateSubscription and ModifySubscription
  • Added EventInformation, Subscription, and SubscriptionParameter

Release Notes 1.05

  • Added NewName
  • Added ProjectedAssignedUser, ProjectedAssignedUserGroup and ProjectedAssignedUserGroupID.

Release Notes 1.04

  • Added AssignmentSets
  • Added AssignmentSet, AssignmentSetInstance
  • Added AssignmentSetInstances
  • Added AssignmentSetInstanceID
  • Added AssignmentSet, AssignmentSetInstance
  • Added note to AssignedUserOrGroup to account for assignment sets.
  • Added note to AssignedUser to account for assignment sets.
  • Added AssignmentSetID
  • Added AssignmentSet, AssignmentSetAutoAssignmentType, AssignmentSetAutoAssignmentTypeID, AssignmentSetDefaultAssignedUser, AssignmentSetDefaultUserGroup, AssignmentSetDetaultUserGroupID. AssignmentSetInstanceID
  • Added AssignmentSetInstance, AssignmentSetInstanceAssignedUser, AssignmentSetInstanceAssignedUserGroup, AssignmentSetInstanceAssignedUserGroupID, AssignmentSetInstanceAutoAssignmentType, AssignmentSetInstanceAutoAssignmentTypeID, AssignmentSetInstanceID
  • Added AssignmentSetInstance, AssignmentSetInstanceID, IsDerivedFromAssignmentSet.
  • Added AssignmentSetInstance, AssignmentSetInstanceID

Release Notes 1.03

  • Added AutoAssignmentTypeID
  • Added UserGroup
  • Added AssignedUserGroupID, AutoAssignmentTypeID, EffortDurationTypeID, EffortSeconds
  • Added CreateUserGroupReq, CreateUserGroupResult,
  • Added CreateUserGroup, ModifyUserGroup, ModifyUserGroupReq, ModifyUserGroupResult, UserGroup, UserGroupMember
  • Added AssignedCount, AssignedUserGroupCount
  • Added AutoAssignmentType, UserGroup, UserGroupMember, WorkflowInstanceAssignedUserOrGroupOverview, WorkItemInstanceExpanded
  • Added AutoAssignmentTypeID, DefaultAssignedUserGroupID, EffortDurationTypeID, EffortSeconds
  • Added AssignedUserGroup, AssignedUserGroupID, AutoAssignmentType, AutoAssignmentTypeID, EffortDurationType, EffortDurationTypeID, EffortSeconds
  • Added AssignedUserGroup, AssignedUserGroupID
  • Added AutoAssignmentType, AutoAssignmentTypeID

Release Notes 1.02

  • Note: Internal service changes only.

Release Notes 1.01

  • Note: Internal service changes only. |-