Cascade (Preview)
Cascade is a cloud-based strategic planning and execution platform for teams to plan, execute, measure, and adapt their strategy all in one place. Connect your Cascade workspace to the rest of your tools to always have the most up-to-date and relevant data that pertains to your strategy.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Cascade Support |
| URL | https://help.cascade.app |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Cascade |
| Website | https://www.cascade.app |
| Privacy policy | https://www.cascade.app/privacy-policy |
| Categories | Business Management;Collaboration |
Cascade's Power Automate connector is an extremely powerful tool to connect your Cascade instance to other applications in your tech-stack. You are able to create truly automated workflows to pipe data into Cascade from other tools, and even pull data out as well. There is complete functionality around your Cascade Goals, Tasks, Risks and Updates. How ever you would like to manipulate those you will be able to stitch a workflow together with Power Automate to suit your needs.
Prerequisites
A Cascade Enterprise plan will be necessary for you to use Power Automate.
How to get credentials
To gain credentials you will click your initials at the bottom-left portion of the screen. Click 'System', and then 'Security'. Here you will click 'Add Token', issue it to an individual, and make sure to include all options in the 'Scope' of the token. You will then click 'Add Token', and you will see it appear in the list of your account's API tokens.
Simply copy the token and use it to create a connection within Power Automate. When creating a connection within Power Automate, please be sure to include the text 'Bearer ' in front of your token. For example:
Bearer 1D22717FAF450E414523DAA4E48976SDF87SDFS8
Get started with your connector
Since there are only actions for the Cascade connector you will need to trigger your flow from a different application, an instant cloud flow, or a scheduled cloud flow.
Most use cases will revolve around creating or updating a Cascade goal with data that is being stored in another application (e.g., Microsoft SharePoint, Power BI, etc.). Using this functionality, you will be able to completely automate the transference of data, so no manual or double-work is needed. All you will need is a Cascade goal's ID to update it with the desired information. You are able to either hard code the goal ID into the flow directly change a Cascade goal, or you could store multiple Cascade goal IDs within your data to be able to iterate over and update multiple goals within a single flow.
You will select the desired trigger, and then work Cascade's connector into your flow. Typically, you will be sourcing information out of another software. You will be able to dynamically pull data down from previous steps to automatically populate the fields within the Cascade connector!
Known issues and limitations
For authentication, you need to use an API token. To learn how to generate a token, go to this link. How to generate an API access token
Certain fields are expecting certain data types. For example, for all date fields are expecting dates to be in Unix Time or ISO8601 format. Visit our API documentation to understand what data types are being expected for each field.
You will have to include your instance name with every step you use the Cascade connector. Your Cascade instance name is https://{yourInstanceName}.executestrategy.net/
Goal, Task, Risk or Update owners are dictated by its Role ID. This is a numeric value that is assigned to a specific role in Cascade. The user is then assigned to the role. To figure out what Role ID a certain user has you will need to send a GET request to your Cascade instance's API endpoint (https://{yourInstanceName}.executestrategy.net/api/v2/users). You can also reach out to Cascade's support email or chat bot, and a Cascade employee can provide you with that data.
Visit Cascade's help article for exact instructions on how to use Cascade's Power Automate connector. Visit help.cascade.app, and search Power Automate
Common errors and remedies
- If you receive a 422 Unprocessable Entity error code that means that the data type does not match what is expected. Or invalid data has been entered (e.g., providing a Role ID that does not exist within your account).
FAQ
Visit Cascade's help article for instructions on how to use Cascade's Power Automate connector. Visit help.cascade.app, and search Power Automate
Visit our API documentation for examples and documentation on our API.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a Goal |
Creates a new Goal within an instance. |
| Create a Risk |
Creates a new Risk on an existing Cascade Goal. |
| Create a Task |
Creates a new Task on an existing Cascade Goal. |
| Create an Update |
Creates a new Update on an existing Cascade Goal. |
| Delete Goal |
Deletes a Goal based off of its Goal ID. |
| Delete Risk |
Deletes a Risk based off of its Risk ID. |
| Delete Task |
Deletes a Task based off of its Task ID. |
| Delete Update |
Deletes an Update based off of its Update ID. |
| Get all Goals |
Returns all Goals within an instance. |
| Get all Risks |
Returns all Risks within an instance. |
| Get all Tasks |
Returns all Tasks within an instance. |
| Get all Updates |
Returns all Updates within an instance. |
| Get single Goal |
Returns a single Goal based off of its Goal ID. |
| Get single Risk |
Returns a single Risk based off of its Risk ID. |
| Get single Task |
Returns a single Task based off of its Task ID. |
| Get single Update |
Returns a single Update based off of its Update ID. |
| Update a Goal |
Updates an existing Goal's details based off of its Goal ID. |
| Update an Update |
Revises an existing Update's details based off of its Update ID. |
| Update Risk |
Updates an existing Risk's details based off of its Risk ID. |
| Update Task |
Updates an existing Task's details based off of its Task ID. |
Create a Goal
Creates a new Goal within an instance.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Role ID
|
role_id | integer |
ID of the role that the goal belongs to |
|
|
Creator ID
|
creator_id | integer |
The ID of the user who created the goal |
|
|
Status
|
status | string |
States whether goal is active, archived or in draft form |
|
|
Completion Criteria
|
completion_criteria | string |
Criteria to determine when the goal is complete |
|
|
Target Flow
|
target_flow | string |
The tracking direction of the goal |
|
|
Action
|
action | True | string |
First word of goal's title – This is typically the action word |
|
Details
|
details | True | string |
Reminder of the goal's title - After the 'Action' |
|
Initial
|
initial | double |
Initial value of the goal’s Progress |
|
|
Progress
|
progress | double |
Current Progress of a goal |
|
|
Target
|
target | double |
Expected Target of the goal |
|
|
Start Time
|
start_time | True | string |
Intended start time of the goal, in Unix time or ISO 8601 format |
|
End Time
|
end_time | True | string |
Expected end time of the goal, in Unix time or ISO 8601 format |
|
Weight ID
|
weight_id | True | integer |
The weight of a Task’s priority. The highest priority is 1. The lowest is 4. |
|
Is Private
|
is_private | integer |
Whether the goal is private |
|
|
Tracking Type
|
tracking_type | string |
Tracking schema used to track the goal |
|
|
Entity Template ID
|
entity_template_id | integer |
The ID of the goal template |
|
|
direct_focus_area_ids
|
direct_focus_area_ids | array of integer |
direct_focus_area_ids |
|
|
aligned_from_ids
|
aligned_from_ids | array of integer |
aligned_from_ids |
|
|
aligned_to_ids
|
aligned_to_ids | array of integer |
aligned_to_ids |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Role ID
|
goal.role_id | integer |
ID of the role that the goal belongs to |
|
Creator ID
|
goal.creator_id | integer |
The ID of the user who created the goal |
|
Status
|
goal.status | string |
States whether goal is active, archived or in draft form |
|
Completion Criteria
|
goal.completion_criteria | string |
Criteria to determine when the goal is complete |
|
Target Flow
|
goal.target_flow | string |
The tracking direction of the goal |
|
Action
|
goal.action | string |
First word of goal's title – This is typically the action word |
|
Details
|
goal.details | string |
Reminder of the goal's title - After the 'Action' |
|
Initial
|
goal.initial | double |
Initial value of the goal’s Progress |
|
Progress
|
goal.progress | double |
Current Progress of a goal |
|
Target
|
goal.target | double |
Expected Target of the goal |
|
Start Time
|
goal.start_time | string |
Intended start time of the goal, in Unix time or ISO 8601 format |
|
End Time
|
goal.end_time | string |
Expected end time of the goal, in Unix time or ISO 8601 format |
|
Weight ID
|
goal.weight_id | integer |
The weight of a goal’s priority. The highest priority is 1. The lowest is 4. |
|
Is Private
|
goal.is_private | integer |
Whether the goal is private |
|
Tracking Type
|
goal.tracking_type | string |
Tracking schema used to track the goal |
|
Created At
|
goal.created_at | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
Updated At
|
goal.updated_at | string |
Date when the goal was last updated, in Unix time or ISO 8601 format |
|
Entity Template ID
|
goal.entity_template_id | integer |
The ID of the goal template |
|
direct_focus_area_ids
|
goal.direct_focus_area_ids | array of integer |
direct_focus_area_ids |
|
inherited_focus_area_ids
|
goal.inherited_focus_area_ids | array of integer |
inherited_focus_area_ids |
|
aligned_from_ids
|
goal.aligned_from_ids | array of integer |
aligned_from_ids |
|
aligned_to_ids
|
goal.aligned_to_ids | array of integer |
aligned_to_ids |
|
Title
|
goal.title | string |
Whole title of goal with Target and due date |
|
ancestor_ids
|
goal.ancestor_ids | array of integer |
ancestor_ids |
|
descendant_ids
|
goal.descendant_ids | array of integer |
descendant_ids |
|
issue_ids
|
goal.issue_ids | array of integer |
issue_ids |
|
task_ids
|
goal.task_ids | array of integer |
task_ids |
Create a Risk
Creates a new Risk on an existing Cascade Goal.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Issue
|
issue | True | string |
Title of the Risk |
|
Is Critical
|
is_critical | integer |
Whether Risk is critical or not |
|
|
Is Resolved
|
is_resolved | integer |
Whether Risk is resolved or not |
|
|
Role ID
|
role_id | integer |
ID of role that created Risk |
|
|
Goal ID
|
goal_id | True | integer |
ID of the Goal the Risk is associated with |
|
Due Date
|
due_date | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
|
Entity Template ID
|
entity_template_id | integer |
The ID of the goal template |
|
|
Likelihood
|
CA1573011281053 | integer |
Likelihood of the Risk |
|
|
Consequence
|
CA1573011296755 | integer |
Consequence of the Risk |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Risk ID
|
issue.id | string |
ID of Risk |
|
Issue
|
issue.issue | string |
Title of the Risk |
|
Is Critical
|
issue.is_critical | integer |
Whether Risk is critical or not |
|
Is Resolved
|
issue.is_resolved | integer |
Whether Risk is resolved or not |
|
User ID
|
issue.user_id | integer |
ID of the user that created the Risk |
|
Role ID
|
issue.role_id | integer |
ID of role that created Risk |
|
Goal ID
|
issue.goal_id | integer |
ID of the Goal the Risk is associated with |
|
Due Date
|
issue.due_date | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
Entity Template ID
|
issue.entity_template_id | integer |
The ID of the goal template |
|
Likelihood
|
issue.custom_attributes.CA1573011281053 | integer |
Likelihood of the Risk |
|
Consequence
|
issue.custom_attributes.CA1573011296755 | integer |
Consequence of the Risk |
Create a Task
Creates a new Task on an existing Cascade Goal.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Task
|
task | True | string |
Title of the Task |
|
Description
|
comment | string |
A Task's description |
|
|
Is Complete
|
is_complete | integer |
Whether Task is completed or not |
|
|
Role ID
|
role_id | integer |
ID of the role that created the Task |
|
|
Goal ID
|
goal_id | True | integer |
ID of the Goal the Task is associated with |
|
Start Date
|
start_date | string |
Intended start date of the Task, in Unix time or ISO 8601 format |
|
|
Due Date
|
due_date | string |
Intended due date of the Task, in Unix time or ISO 8601 format |
|
|
Weight ID
|
weight_id | integer |
The weight of a Task’s priority. The highest priority is 1. The lowest is 4. |
|
|
Entity Template ID
|
entity_template_id | integer |
The ID of the Task template |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
tasks.id | integer |
ID of the Task |
|
Task
|
tasks.task | string |
Title of the Task |
|
Description
|
tasks.comment | string |
A Task's description |
|
Is Complete
|
tasks.is_complete | integer |
Whether Task is completed or not |
|
User ID
|
tasks.user_id | integer |
ID of the user that created the Task |
|
Role ID
|
tasks.role_id | integer |
ID of the role that created the Task |
|
Completed User ID
|
tasks.completed_user_id | string |
ID of user that completed the Task |
|
Goal ID
|
tasks.goal_id | integer |
ID of the Goal the Task is associated with |
|
Start Date
|
tasks.start_date | string |
Intended start date of the Task, in Unix time or ISO 8601 format |
|
Due Date
|
tasks.due_date | string |
Intended due date of the Task, in Unix time or ISO 8601 format |
|
Weight ID
|
tasks.weight_id | integer |
The weight of a Task’s priority. The highest priority is 1. The lowest is 4. |
|
Entity Template ID
|
tasks.entity_template_id | integer |
The ID of the Task template |
Create an Update
Creates a new Update on an existing Cascade Goal.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Comment
|
comment | True | string |
A comment associated with the Update |
|
Goal ID
|
goal_id | True | integer |
ID of the Goal the Update is associated with |
|
Entity Template ID
|
entity_template_id | integer |
The ID of the Update template |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
update.id | string |
ID of the Update |
|
Type
|
update.type | string |
Type of Update |
|
Comment
|
update.comment | string |
A comment associated with the Update |
|
Created At
|
update.created_at | string |
Date when the Update was created, in Unix time or ISO 8601 format |
|
Updated At
|
update.updated_at | string |
Date when the Update was last updated, in Unix time or ISO 8601 format |
|
User ID
|
update.user_id | integer |
ID of the user that created the Update |
|
Goal ID
|
update.goal_id | integer |
ID of the Goal the Update is associated with |
|
Deleted
|
update.deleted | integer |
Whether an update has been deleted |
|
Entity Template ID
|
update.entity_template_id | integer |
The ID of the Update template |
Delete Goal
Deletes a Goal based off of its Goal ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Goal ID
|
id | True | string |
The ID of the Goal to delete. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
message
|
message | string |
message |
|
code
|
code | integer |
code |
|
status
|
status | string |
status |
Delete Risk
Deletes a Risk based off of its Risk ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Risk ID
|
id | True | string |
The ID of the Risk to delete. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
message
|
message | string |
message |
|
code
|
code | integer |
code |
|
status
|
status | string |
status |
Delete Task
Deletes a Task based off of its Task ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
id | True | string |
The ID of the Task to delete. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
message
|
message | string |
message |
|
code
|
code | integer |
code |
|
status
|
status | string |
status |
Delete Update
Deletes an Update based off of its Update ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Update ID
|
id | True | string |
The ID of the Update to delete. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
message
|
message | string |
message |
|
code
|
code | integer |
code |
|
status
|
status | string |
status |
Get all Goals
Returns all Goals within an instance.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Goal ID
|
goal.id | integer |
ID of the Goal |
|
Role ID
|
goal.role_id | integer |
ID of the role that the goal belongs to |
|
Creator ID
|
goal.creator_id | integer |
The ID of the user who created the goal |
|
Status
|
goal.status | string |
States whether goal is active, archived or in draft form |
|
Completion Criteria
|
goal.completion_criteria | string |
Criteria to determine when the goal is complete |
|
Target Flow
|
goal.target_flow | string |
The tracking direction of the goal |
|
Action
|
goal.action | string |
First word of goal's title – This is typically the action word |
|
Details
|
goal.details | string |
Reminder of the goal's title - After the 'Action' |
|
Initial
|
goal.initial | double |
Initial value of the goal’s Progress |
|
Progress
|
goal.progress | double |
Current Progress of a goal |
|
Target
|
goal.target | double |
Expected Target of the goal |
|
Start Time
|
goal.start_time | string |
Intended start time of the goal, in Unix time or ISO 8601 format |
|
End Time
|
goal.end_time | string |
Expected end time of the goal, in Unix time or ISO 8601 format |
|
Weight ID
|
goal.weight_id | integer |
The weight of a goal’s priority. The highest priority is 1. The lowest is 4. |
|
Is Private
|
goal.is_private | integer |
Whether the goal is private |
|
Tracking Type
|
goal.tracking_type | string |
Tracking schema used to track the goal |
|
Created At
|
goal.created_at | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
Updated At
|
goal.updated_at | string |
Date when the goal was last updated, in Unix time or ISO 8601 format |
|
Entity Template ID
|
goal.entity_template_id | integer |
The ID of the goal template |
|
direct_focus_area_ids
|
goal.direct_focus_area_ids | array of integer |
direct_focus_area_ids |
|
inherited_focus_area_ids
|
goal.inherited_focus_area_ids | array of integer |
inherited_focus_area_ids |
|
aligned_from_ids
|
goal.aligned_from_ids | array of integer |
aligned_from_ids |
|
aligned_to_ids
|
goal.aligned_to_ids | array of integer |
aligned_to_ids |
|
Title
|
goal.title | string |
Whole title of goal with Target and due date |
|
ancestor_ids
|
goal.ancestor_ids | array of integer |
ancestor_ids |
|
descendant_ids
|
goal.descendant_ids | array of integer |
descendant_ids |
|
issue_ids
|
goal.issue_ids | array of integer |
issue_ids |
|
task_ids
|
goal.task_ids | array of integer |
task_ids |
Get all Risks
Returns all Risks within an instance.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Risk ID
|
issue.id | integer |
ID of the Risk |
|
Issue
|
issue.issue | string |
Title of the Risk |
|
Is Critical
|
issue.is_critical | integer |
Whether Risk is critical or not |
|
Is Resolved
|
issue.is_resolved | integer |
Whether Risk is resolved or not |
|
User ID
|
issue.user_id | integer |
ID of the user that created the Risk |
|
Role ID
|
issue.role_id | integer |
ID of role that created Risk |
|
Goal ID
|
issue.goal_id | integer |
ID of the Goal the Risk is associated with |
|
Due Date
|
issue.due_date | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
Entity Template ID
|
issue.entity_template_id | integer |
The ID of the goal template |
|
Likelihood
|
issue.custom_attributes.CA1573011281053 | integer |
Likelihood of the Risk |
|
Consequence
|
issue.custom_attributes.CA1573011296755 | integer |
Consequence of the Risk |
Get all Tasks
Returns all Tasks within an instance.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
tasks
|
tasks | array of object |
tasks |
|
ID
|
tasks.id | integer |
ID of the Task |
|
Task
|
tasks.task | string |
Title of the Task |
|
Description
|
tasks.comment | string |
A Task's description |
|
Is Complete
|
tasks.is_complete | integer |
Whether Task is completed or not |
|
User ID
|
tasks.user_id | integer |
ID of the user that created the Task |
|
Role ID
|
tasks.role_id | integer |
ID of the role that created the Task |
|
Completed User ID
|
tasks.completed_user_id | integer |
ID of user that completed the Task |
|
Goal ID
|
tasks.goal_id | integer |
ID of the Goal the Task is associated with |
|
Start Date
|
tasks.start_date | string |
Intended start date of the Task, in Unix time or ISO 8601 format |
|
Due Date
|
tasks.due_date | string |
Intended due date of the Task, in Unix time or ISO 8601 format |
|
Weight ID
|
tasks.weight_id | integer |
The weight of a Task’s priority. The highest priority is 1. The lowest is 4. |
|
Entity Template ID
|
tasks.entity_template_id | integer |
The ID of the Task template |
Get all Updates
Returns all Updates within an instance.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
update.id | integer |
ID of the Update |
|
Type
|
update.type | string |
Type of Update |
|
Comment
|
update.comment | string |
A comment associated with the Update |
|
Created At
|
update.created_at | string |
Date when the Update was created, in Unix time or ISO 8601 format |
|
Updated At
|
update.updated_at | string |
Date when the Update was last updated, in Unix time or ISO 8601 format |
|
User ID
|
update.user_id | integer |
ID of the user that created the Update |
|
Goal ID
|
update.goal_id | integer |
ID of the Goal the Update is associated with |
|
Deleted
|
update.deleted | integer |
Whether an update has been deleted |
|
Entity Template ID
|
update.entity_template_id | integer |
The ID of the Update template |
Get single Goal
Returns a single Goal based off of its Goal ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Goal ID
|
id | True | string |
The ID of the Goal to retrieve. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Goal ID
|
goal.id | integer |
ID of the Goal |
|
Role ID
|
goal.role_id | integer |
ID of the role that the goal belongs to |
|
Creator ID
|
goal.creator_id | integer |
The ID of the user who created the goal |
|
Status
|
goal.status | string |
States whether goal is active, archived or in draft form |
|
Completion Criteria
|
goal.completion_criteria | string |
Criteria to determine when the goal is complete |
|
Target Flow
|
goal.target_flow | string |
The tracking direction of the goal |
|
Action
|
goal.action | string |
First word of goal's title – This is typically the action word |
|
Details
|
goal.details | string |
Reminder of the goal's title - After the 'Action' |
|
Initial
|
goal.initial | double |
Initial value of the goal’s Progress |
|
Progress
|
goal.progress | double |
Current Progress of a goal |
|
Target
|
goal.target | double |
Expected Target of the goal |
|
Start Time
|
goal.start_time | string |
Intended start time of the goal, in Unix time or ISO 8601 format |
|
End Time
|
goal.end_time | string |
Expected end time of the goal, in Unix time or ISO 8601 format |
|
Weight ID
|
goal.weight_id | integer |
The weight of a goal’s priority. The highest priority is 1. The lowest is 4. |
|
Is Private
|
goal.is_private | integer |
Whether the goal is private |
|
Tracking Type
|
goal.tracking_type | string |
Tracking schema used to track the goal |
|
Created At
|
goal.created_at | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
Updated At
|
goal.updated_at | string |
Date when the goal was last updated, in Unix time or ISO 8601 format |
|
Entity Template ID
|
goal.entity_template_id | integer |
The ID of the goal template |
|
direct_focus_area_ids
|
goal.direct_focus_area_ids | array of integer |
direct_focus_area_ids |
|
inherited_focus_area_ids
|
goal.inherited_focus_area_ids | array of integer |
inherited_focus_area_ids |
|
aligned_from_ids
|
goal.aligned_from_ids | array of integer |
aligned_from_ids |
|
aligned_to_ids
|
goal.aligned_to_ids | array of integer |
aligned_to_ids |
|
Title
|
goal.title | string |
Whole title of goal with Target and due date |
|
ancestor_ids
|
goal.ancestor_ids | array of integer |
ancestor_ids |
|
descendant_ids
|
goal.descendant_ids | array of integer |
descendant_ids |
|
issue_ids
|
goal.issue_ids | array of integer |
issue_ids |
|
task_ids
|
goal.task_ids | array of integer |
task_ids |
Get single Risk
Returns a single Risk based off of its Risk ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Risk ID
|
id | True | string |
The ID of the Risk to retrieve. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Risk ID
|
issue.id | integer |
ID of Risk |
|
Title
|
issue.issue | string |
Title of the Risk |
|
Is Critical
|
issue.is_critical | integer |
Whether Risk is critical or not |
|
Is Resolved
|
issue.is_resolved | integer |
Whether Risk is resolved or not |
|
Created At
|
issue.created_at | string |
Date when the risk was created, in Unix time or ISO 8601 format |
|
User ID
|
issue.user_id | integer |
ID of the user that created the Risk |
|
Role ID
|
issue.role_id | integer |
ID of role associated that created Risk |
|
Goal ID
|
issue.goal_id | integer |
ID of the Goal the risk is associated with |
|
Due Date
|
issue.due_date | string |
Expected due date of the risk, in Unix time or ISO 8601 format |
|
Entity Template ID
|
issue.entity_template_id | integer |
The ID of the Risk Template |
|
Likelihood
|
issue.custom_attributes.CA1573011281053 | integer |
Likelihood of risk |
|
Consequence
|
issue.custom_attributes.CA1573011296755 | integer |
Consequence of risk |
Get single Task
Returns a single Task based off of its Task ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
id | True | string |
The ID of the Task to retrieve. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
task.id | integer |
ID of the task |
|
Task Title
|
task.task | string |
Title of task |
|
Description
|
task.comment | string |
A Task's description |
|
Created at
|
task.created_at | string |
Date when the task was created, in Unix time or ISO 8601 format |
|
Is Complete
|
task.is_complete | integer |
Whether the task is complete or not. 0 = No; 1 = Yes |
|
Completed At
|
task.completed_at | string |
Date when the task was completed, in Unix time or ISO 8601 format |
|
Updated At
|
task.updated_at | string |
Last time task was updated, in Unix time or ISO 8601 format |
|
User ID
|
task.user_id | integer |
ID of user that owns the task |
|
Role ID
|
task.role_id | integer |
ID of the role that owns the task |
|
Completed User ID
|
task.completed_user_id | integer |
ID of user that completed the task |
|
Goal ID
|
task.goal_id | integer |
ID of the Goal the task resides on |
|
Start Date
|
task.start_date | string |
Intended start date of the goal, in Unix time or ISO 8601 format |
|
Due Date
|
task.due_date | string |
Date when the task is due, in Unix time or ISO 8601 format |
|
Weight ID
|
task.weight_id | integer |
The weight of a tasks priority. The highest priority is 1. The lowest is 4. |
|
Entity Template ID
|
task.entity_template_id | integer |
The ID of the Task Template |
Get single Update
Returns a single Update based off of its Update ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Update ID
|
id | True | string |
The ID of the Update to retrieve. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
update.id | integer |
ID of the Update |
|
Type
|
update.type | string |
Type of Update |
|
Comment
|
update.comment | string |
A comment associated with the Update |
|
Created At
|
update.created_at | string |
Date when the Update was created, in Unix time or ISO 8601 format |
|
Updated At
|
update.updated_at | string |
Date when the Update was last updated, in Unix time or ISO 8601 format |
|
User ID
|
update.user_id | integer |
ID of the user that created the Update |
|
Goal ID
|
update.goal_id | integer |
ID of the Goal the Update is associated with |
|
Deleted
|
update.deleted | integer |
Whether an update has been deleted |
|
Entity Template ID
|
update.entity_template_id | integer |
The ID of the Update template |
Update a Goal
Updates an existing Goal's details based off of its Goal ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Goal ID
|
id | True | string |
The ID of the Goal to update. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Role ID
|
role_id | integer |
ID of the role that the goal belongs to |
|
|
Creator ID
|
creator_id | integer |
The ID of the user who created the goal |
|
|
Status
|
status | string |
States whether goal is active, archived or in draft form |
|
|
Completion Criteria
|
completion_criteria | string |
Criteria to determine when the goal is complete |
|
|
Target Flow
|
target_flow | string |
The tracking direction of the goal |
|
|
Action
|
action | string |
First word of goal's title – This is typically the action word |
|
|
Details
|
details | string |
Reminder of the goal's title - After the 'Action' |
|
|
Initial
|
initial | double |
Initial value of the goal’s Progress |
|
|
Progress
|
progress | double |
Current Progress of a goal |
|
|
Target
|
target | double |
Expected Target of the goal |
|
|
Start Time
|
start_time | string |
Intended start time of the goal, in Unix time or ISO 8601 format |
|
|
End Time
|
end_time | string |
Expected end time of the goal, in Unix time or ISO 8601 format |
|
|
Weight ID
|
weight_id | integer |
The weight of a Task’s priority. The highest priority is 1. The lowest is 4. |
|
|
Is Private
|
is_private | integer |
Whether the goal is private |
|
|
Tracking Type
|
tracking_type | string |
Tracking schema used to track the goal |
|
|
Entity Template ID
|
entity_template_id | integer |
The ID of the goal template |
|
|
direct_focus_area_ids
|
direct_focus_area_ids | array of integer |
direct_focus_area_ids |
|
|
inherited_focus_area_ids
|
inherited_focus_area_ids | array of integer |
inherited_focus_area_ids |
|
|
aligned_from_ids
|
aligned_from_ids | array of integer |
aligned_from_ids |
|
|
aligned_to_ids
|
aligned_to_ids | array of integer |
aligned_to_ids |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Goal ID
|
goal.id | integer |
ID of the Goal |
|
Role ID
|
goal.role_id | integer |
ID of the role that the goal belongs to |
|
Creator ID
|
goal.creator_id | integer |
The ID of the user who created the goal |
|
Status
|
goal.status | string |
States whether goal is active, archived or in draft form |
|
Completion Criteria
|
goal.completion_criteria | string |
Criteria to determine when the goal is complete |
|
Target Flow
|
goal.target_flow | string |
The tracking direction of the goal |
|
Action
|
goal.action | string |
First word of goal's title – This is typically the action word |
|
Details
|
goal.details | string |
Reminder of the goal's title - After the 'Action' |
|
Initial
|
goal.initial | double |
Initial value of the goal’s Progress |
|
Progress
|
goal.progress | double |
Current Progress of a goal |
|
Target
|
goal.target | double |
Expected Target of the goal |
|
Start Time
|
goal.start_time | string |
Intended start time of the goal, in Unix time or ISO 8601 format |
|
End Time
|
goal.end_time | string |
Expected end time of the goal, in Unix time or ISO 8601 format |
|
Weight ID
|
goal.weight_id | integer |
The weight of a goal’s priority. The highest priority is 1. The lowest is 4. |
|
Is Private
|
goal.is_private | integer |
Whether the goal is private |
|
Tracking Type
|
goal.tracking_type | string |
Tracking schema used to track the goal |
|
Created At
|
goal.created_at | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
Updated At
|
goal.updated_at | string |
Date when the goal was last updated, in Unix time or ISO 8601 format |
|
Entity Template ID
|
goal.entity_template_id | integer |
The ID of the goal template |
|
direct_focus_area_ids
|
goal.direct_focus_area_ids | array of integer |
direct_focus_area_ids |
|
inherited_focus_area_ids
|
goal.inherited_focus_area_ids | array of integer |
inherited_focus_area_ids |
|
aligned_from_ids
|
goal.aligned_from_ids | array of integer |
aligned_from_ids |
|
aligned_to_ids
|
goal.aligned_to_ids | array of integer |
aligned_to_ids |
|
Title
|
goal.title | string |
Whole title of goal with Target and due date |
|
ancestor_ids
|
goal.ancestor_ids | array of integer |
ancestor_ids |
|
descendant_ids
|
goal.descendant_ids | array of integer |
descendant_ids |
|
issue_ids
|
goal.issue_ids | array of integer |
issue_ids |
|
task_ids
|
goal.task_ids | array of integer |
task_ids |
Update an Update
Revises an existing Update's details based off of its Update ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Update ID
|
id | True | string |
The ID of the Update to revise. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Comment
|
comment | string |
A comment associated with the Update |
|
|
Created At
|
created_at | string |
Date when the Update was created, in Unix time or ISO 8601 format |
|
|
Updated At
|
updated_at | string |
Date when the Update was last updated, in Unix time or ISO 8601 format |
|
|
Goal ID
|
goal_id | integer |
ID of the Goal the Update is associated with |
|
|
Deleted
|
deleted | integer |
Whether an update has been deleted |
|
|
Entity Template ID
|
entity_template_id | integer |
The ID of the Update template |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
update.id | integer |
ID of the Update |
|
Type
|
update.type | string |
Type of Update |
|
Comment
|
update.comment | string |
A comment associated with the Update |
|
Created At
|
update.created_at | string |
Date when the Update was created, in Unix time or ISO 8601 format |
|
Updated At
|
update.updated_at | string |
Date when the Update was last updated, in Unix time or ISO 8601 format |
|
User ID
|
update.user_id | integer |
ID of the user that created the Update |
|
Goal ID
|
update.goal_id | integer |
ID of the Goal the Update is associated with |
|
Deleted
|
update.deleted | integer |
Whether an update has been deleted |
|
Entity Template ID
|
update.entity_template_id | integer |
The ID of the Update template |
Update Risk
Updates an existing Risk's details based off of its Risk ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Risk ID
|
id | True | string |
The ID of the Risk to update. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Issue
|
issue | string |
Title of the Risk |
|
|
Is Critical
|
is_critical | integer |
Whether Risk is critical or not |
|
|
Is Resolved
|
is_resolved | integer |
Whether Risk is resolved or not |
|
|
Role ID
|
role_id | integer |
ID of role that created Risk |
|
|
Due Date
|
due_date | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
|
Entity Template ID
|
entity_template_id | integer |
The ID of the risk template |
|
|
Likelihood
|
CA1573011281053 | integer |
Likelihood of the Risk |
|
|
Consequence
|
CA1573011296755 | integer |
Consequence of the Risk |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Issue
|
issue.issue | integer |
Title of the Risk |
|
Is Critical
|
issue.is_critical | integer |
Whether Risk is critical or not |
|
Is Resolved
|
issue.is_resolved | integer |
Whether Risk is resolved or not |
|
User ID
|
issue.user_id | integer |
ID of the user that created the Risk |
|
Role ID
|
issue.role_id | integer |
ID of role that created Risk |
|
Goal ID
|
issue.goal_id | integer |
ID of the Goal the Risk is associated with |
|
Due Date
|
issue.due_date | string |
Date when the goal was created, in Unix time or ISO 8601 format |
|
Entity Template ID
|
issue.entity_template_id | integer |
The ID of the goal template |
|
Likelihood
|
issue.custom_attributes.CA1573011281053 | integer |
Likelihood of the Risk |
|
Consequence
|
issue.custom_attributes.CA1573011296755 | integer |
Consequence of the Risk |
Update Task
Updates an existing Task's details based off of its Task ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task ID
|
id | True | string |
The ID of the Task to update. |
|
Cascade Instance
|
Instance | True | string |
https://{instance}.executestrategy.net - Your Cascade instance name is the subdomain part of your site url. |
|
Task
|
task | string |
Title of the Task |
|
|
Description
|
comment | string |
A Task's description |
|
|
Is Complete
|
is_complete | integer |
Whether Task is completed or not |
|
|
Role ID
|
role_id | integer |
ID of the role that created the Task |
|
|
Goal ID
|
goal_id | integer |
ID of the Goal the Task is associated with |
|
|
Start Date
|
start_date | string |
Intended start date of the Task, in Unix time or ISO 8601 format |
|
|
Due Date
|
due_date | string |
Intended due date of the Task, in Unix time or ISO 8601 format |
|
|
Weight ID
|
weight_id | integer |
The weight of a Task’s priority. The highest priority is 1. The lowest is 4. |
|
|
Entity Template ID
|
entity_template_id | integer |
The ID of the Task template |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
task.id | integer |
ID of the task |
|
Task Title
|
task.task | string |
Title of task |
|
Comment
|
task.comment | string |
A comment's text |
|
Created at
|
task.created_at | string |
Date when the task was created, in Unix time or ISO 8601 format |
|
Is Complete
|
task.is_complete | integer |
Whether the task is complete or not. 0 = No; 1 = Yes |
|
Completed At
|
task.completed_at | string |
Date when the task was completed, in Unix time or ISO 8601 format |
|
Updated At
|
task.updated_at | string |
Last time task was updated, in Unix time or ISO 8601 format |
|
User ID
|
task.user_id | integer |
ID of user that owns the task |
|
Role ID
|
task.role_id | integer |
ID of the role that owns the task |
|
Completed User ID
|
task.completed_user_id | integer |
ID of user that completed the task |
|
Goal ID
|
task.goal_id | integer |
ID of the Goal the task resides on |
|
Start Date
|
task.start_date | string |
Intended start date of the goal, in Unix time or ISO 8601 format |
|
Due Date
|
task.due_date | string |
Date when the task is due, in Unix time or ISO 8601 format |
|
Weight ID
|
task.weight_id | integer |
The weight of a tasks priority. The highest priority is 1. The lowest is 4. |
|
Entity Template ID
|
task.entity_template_id | integer |
The ID of the Task Template |