Seismic Programs (Preview)

The Seismic Program connector offers a collection of actions and triggers designed to interact with key features in the Seismic Programs product. These include programs, which track the progress and configurations of your ongoing enablement program; tasks, the work management tool that monitors your team's activities; and requests, which enable external team members to submit work requests to your team.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Copilot Studio | 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) |
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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) |
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) |
Contact | |
---|---|
Name | Seismic |
URL | https://seismic.com |
support@seismic.com |
Connector Metadata | |
---|---|
Publisher | Seismic Software |
Website | https://seismic.com/ |
Privacy policy | https://seismic.com/privacy-policy/ |
Categories | Marketing;Sales and CRM |
Seismic Program connector
The Seismic Program connector offers a collection of actions and triggers designed to interact with key features in the Seismic Programs product. These include programs, which track the progress and configurations of your ongoing enablement program; tasks, the work management tool that monitors your team's activities; and requests, which enable external team members to submit work requests to your team.
Publisher: Seismic
Prerequisites
You need a Seismic Premium user account for the tenant.
Supported Operations
Get comments
Get a list of comments on a single node (program, task, request).
Get a comment
Get a single comment on a single node (program, task, request).
Create a comment
Create a comment on a single node (program, task, request).
Update a comment
Update an existing comment on a single node (program, task, request).
Delete a comment
Delete a comment on a single node (program, task, request).
Get programs
Get a list on programs in a tenant.
Get a program
Get a single program in a tenant.
Create a program
Create a program in a tenant.
Update a program
Update an existing program in a tenant.
Delete programs
Delete a list of programs in a tenant.
Delete a program
Delete a program in a tenant.
Get requests
Get a list of requests in a tenant.
Get a request
Get a single request in a tenant.
Create a request
Create a request in a tenant.
Update a request
Update a single request in a tenant.
Delete a request
Delete a single request in a tenant.
Delete requests
Delete a list of requests in a tenant.
Get tasks
Get a list of tasks in a tenant.
Get a task
Get a single task in a tenant.
Create a task
Create a task in a tenant.
Update a task
Update a single task in a tenant.
Delete a task
Delete a single task in a tenant.
Delete tasks
Delete a list of tasks in a tenant.
Get status schemas
Get a list of status schemas.
Get status schema
Get a single status schema
Trigger: When a program is created
A trigger that uses the ProgramCreate webhook to return program data after it has been created
Trigger: When a program is updated
A trigger that uses the ProgramUpdate webhook to return program data after it has been updated
Trigger: When a program is deleted
A trigger that uses the ProgramDelete webhook to return program data after it has been deleted
Trigger: When a task is created
A trigger that uses the ProgramTaskCreate webhook to return task data after it has been created
Trigger: When a task is updated
A trigger that uses the ProgramTaskUpdate webhook to return task data after it has been updated
Trigger: When a task is deleted
A trigger that uses the ProgramTaskDelete webhook to return task data after it has been deleted
Trigger: When a request is created
A trigger that uses the ProgramRequestCreate webhook to return request data after it has been created
Trigger: When a request is updated
A trigger that uses the ProgramRequestUpdate webhook to return request data after it has been updated
Trigger: When a request is deleted
A trigger that uses the ProgramRequestDelete webhook to return request data after it has been deleted
Obtaining Credentials
You need a Seismic Premium user account for the tenant. Contact your Seismic system administrator if you do not have sufficient permissions.
Getting Started
The Seismic Programs connector includes the following actions. Each action corresponds to an API endpoint. Refer to the article for each corresponding API endpoint for further information on the fields and properties associated with the action.
- Get comments
- Get a comment
- Create a comment
- Update a comment
- Delete a comment
- Get programs
- Get a program
- Create a program
- Update a program
- Delete programs
- Delete a program
- Get requests
- Get a request
- Create a request
- Update a request
- Delete requests
- Delete a request
- Get tasks
- Get a task
- Create a task
- Update a task
- Delete tasks
- Delete a task
- Trigger: program create
- Trigger: program update
- Trigger: program delete
- Trigger: task create
- Trigger: task update
- Trigger: task delete
- Trigger: request create
- Trigger: request update
- Trigger: request delete
Known Issues and Limitations
No issues and limitations are known at this time. All APIs operate in accordance with Seismic API policy, including Rate Limits. Please refer to the Seismic Developer portal for API specifications, restrictions, and standards.
Deployment Instructions
Please use these instructions to deploy this connector as a custom connector in Microsoft Power Automate and Power Apps.
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Create comment |
Create a comment on a given program, task, or request. Requires node (program, task, or request) ID. |
Create program |
Create a program. |
Create request |
Create a request. |
Create task |
Create a task. |
Delete comment |
Delete a comment. Requires node (program, task, or request) and comment ID. |
Delete program |
Delete a program. |
Delete programs |
Delete one or more programs. |
Delete request |
Delete a request. |
Delete requests |
Bulk delete requests. |
Delete task |
Delete a task. |
Get comment |
Get a single comment. Requires node (program, task, or request) and comment ID. |
Get comments |
Get all comments for a given program, task, or request. Requires node (program, task, or request) ID. |
Get program |
Get a single program by ID. Return tasks if desired. |
Get programs |
Get a list of programs with their attributes and associations. |
Get request |
Get a single request. |
Get requests |
Get a list of requests. |
Get status schema |
Get a single status schema by ID. These schemas hold the data for set statuses for specific work. Example: |
Get status schemas |
Get a list of task/request status schemas. These schemas hold the data for set statuses for specific work. Example: |
Get task |
Get a single task by ID. |
Get tasks |
Get a list of tasks. |
Update a program |
Update and return a program. |
Update comment |
Update an existing comment. Requires node (program, task, or request) and comment ID. |
Update request |
Update a request. |
Update task |
Update an existing task. |
Create comment
Create a comment on a given program, task, or request. Requires node (program, task, or request) ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Node ID
|
nodeId | True | string |
Node ID |
Annotation Payload
|
annotationPayload | string | ||
Annotation Type
|
annotationType | string |
Annotation type |
|
Comment Content
|
commentContent | True | string |
Content of the comment |
Is Resolved
|
isResolved | boolean |
True/false on whether the comment is resolved |
Returns
- Body
- Comment
Create program
Create a program.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Node ID
|
nodeId | string |
Node ID |
|
Node Type
|
nodeType | string |
Node type of the association |
|
Space ID
|
spaceId | string |
Space ID |
|
Custom Property ID
|
id | string | ||
Value ID
|
id | string | ||
Value
|
value |
Value data for custom property value |
||
Description
|
description | string |
Title of description |
|
Manager ID
|
managerId | string |
User ID of manager |
|
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
|
Planned End Date
|
plannedEndDate | date-time |
Date string of end date |
|
Planned Start Date
|
plannedStartDate | date-time |
Date string of start date |
|
Title
|
title | True | string |
Title of program |
Returns
- Body
- Program
Create request
Create a request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Assignee ID
|
assigneeId | string |
User ID of assignee |
|
Node ID
|
nodeId | string |
Node ID |
|
Node Type
|
nodeType | string |
Node type of the association |
|
Space ID
|
spaceId | string |
Space ID |
|
Content ID
|
contentId | uuid |
Content ID |
|
DocCenter Full Path
|
docCenterFullPath | string |
Full location path of where content exists in DocCenter |
|
Major Version
|
majorVersion | integer |
Number of major version |
|
Minor Version
|
minorVersion | integer |
Number of minor version |
|
Modified Date
|
modifiedDate | date-time |
Date the content reference was last updated |
|
Order Number
|
orderNo | integer |
Number to indicate order |
|
Profile ID
|
profileId | uuid |
Profile ID |
|
Profile Version ID
|
profileVersionId | uuid |
Version ID of profile |
|
Source
|
source | string |
Source of content |
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
Thumbnail ID
|
thumbnailId | string |
ID for image thumbnail |
|
Version ID
|
versionId | uuid |
Version ID of content |
|
Custom Property ID
|
id | string | ||
Value ID
|
id | string | ||
Value
|
value |
Value data for custom property value |
||
Form Reference
|
formRef | True |
Form reference object |
|
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
|
Planned End Date
|
plannedEndDate | date-time |
Date string of end date |
|
Planned Start Date
|
plannedStartDate | date-time |
Date string of start date |
|
Priority
|
priority | string |
Priority value |
|
Program ID
|
programId | string |
ID of program the request belongs to |
|
Status Schema ID
|
statusSchemaId | string | ||
Title
|
title | True | string |
Title of request |
Returns
- Body
- ProgramRequest
Create task
Create a task.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Assignee ID
|
assigneeId | string |
User ID of assignee |
|
Node ID
|
nodeId | string |
Node ID |
|
Node Type
|
nodeType | string |
Node type of the association |
|
Space ID
|
spaceId | string |
Space ID |
|
Custom Property ID
|
id | string | ||
Value ID
|
id | string | ||
Value
|
value |
Value data for custom property value |
||
Description
|
description | string |
Description of task |
|
Parent ID
|
parentId | string |
Task ID of parent |
|
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
|
Planned End Date
|
plannedEndDate | date-time |
Date string of end date |
|
Planned Start Date
|
plannedStartDate | date-time |
Date string of start date |
|
Priority
|
priority | string |
Priority values |
|
Program ID
|
programId | string |
ID of program the task is associated with |
|
Title
|
title | True | string |
Title of task |
Returns
- Body
- ProgramTask
Delete comment
Delete a comment. Requires node (program, task, or request) and comment ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Node ID
|
nodeId | True | string |
Node ID |
Comment ID
|
commentId | True | string |
Comment ID |
Delete program
Delete a program.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Program ID
|
programId | True | string |
Program ID |
Delete Tasks
|
deleteTasks | boolean |
Also delete associated tasks |
Returns
Delete programs
Delete one or more programs.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Program IDs
|
ids | True | array |
List of Program IDs |
Delete Tasks
|
deleteTasks | boolean |
Also delete associated tasks |
Returns
Delete request
Delete a request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Request ID
|
requestId | True | string |
Request ID |
Delete requests
Bulk delete requests.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Content-Type
|
Content-Type | string |
Content-Type |
|
Request IDs
|
ids | array of string |
List of Request IDs to delete |
Returns
Delete task
Delete a task.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Task ID
|
taskId | True | string |
Task ID |
Returns
Get comment
Get a single comment. Requires node (program, task, or request) and comment ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Node ID
|
nodeId | True | string |
Node ID |
Comment ID
|
commentId | True | string |
Comment ID |
Returns
- Body
- Comment
Get comments
Get all comments for a given program, task, or request. Requires node (program, task, or request) ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Node ID
|
nodeId | True | string |
Node ID |
Creator IDs
|
creatorIds | array |
List of user IDs to query by creator |
|
Cursor
|
cursor | string |
Cursor used for pagination |
|
Limit
|
limit | integer |
Number to limit records |
|
Sort
|
sort | array |
Sort by query |
Returns
- Body
- CommentQueryResponse
Get program
Get a single program by ID. Return tasks if desired.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Program ID
|
programId | True | string |
Program ID |
Associated Nodes Depth
|
associatedNodesDepth | integer |
Number to indicate depth of associated node data returned |
|
Include Works
|
includeWorks | boolean |
Indicator to include associated tasks data |
Returns
- Body
- Program
Get programs
Get a list of programs with their attributes and associations.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Planned End Date From
|
plannedEndDateFrom | date-time |
Filter from a planned end date |
|
Planned End Date To
|
plannedEndDateTo | date-time |
Filter to a planned end date |
|
Planned Start Date From
|
plannedStartDateFrom | date-time |
Filter from a planned start date |
|
Planned Start Date To
|
plannedStartDateTo | date-time |
Filter to a planned start date |
|
Launch Date From
|
launchDateFrom | date-time |
Filter from a launch date |
|
Launch Date To
|
launchDateTo | date-time |
Filter to a launch date |
|
Program IDs
|
ids | array |
List of Program IDs to query by |
|
Program Title
|
title | string |
Program title to query by |
|
Manager IDs
|
managerIds | array |
List of user IDs to query by manager |
|
Creator IDs
|
creatorIds | array |
List of user IDs to query by creator |
|
Associated Node IDs
|
associatedNodeIds | array |
List of association IDs to query by |
|
Cursor
|
cursor | string |
Cursor used for pagination |
|
Limit
|
limit | integer |
Number to limit records returned |
|
Sort
|
sort | array |
Sort query |
|
Custom Properties
|
customProperties | string |
List of custom properties to query by |
|
Follower IDs
|
followerIds | array |
List of user IDs to query by follower |
|
Archived
|
archived | boolean |
List of archived or non-archived programs |
|
Audience
|
audience | array |
List of program audience user IDs to query by |
|
Program Type
|
programType | string |
ProgramType enum to query by |
|
First outcome KPI metric
|
outcomeKpiFirst | string |
First Outcome KPI Metric enum to query by |
|
Second outcome KPI metric
|
outcomeKpiSecond | string |
Second Outcome KPI Metric enum to query by |
|
Third outcome KPI metric
|
outcomeKpiThird | string |
Third Outcome KPI Metric enum to query by |
|
Current Phases
|
currentPhases | array |
A list of current phase IDs to query by |
|
Include Associations
|
includeAssociations | boolean |
Indicator to allow for inclusion of association data |
|
Include Archived
|
includeDeactivatedPrograms | boolean |
Indicator to allow for inclusion of archived programs (ignored when enabled is passed) |
|
Include Pages
|
includePages | boolean |
Indicator to allow for inclusion of pages data |
Returns
- Body
- ProgramQueryResponse
Get request
Get a single request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Request ID
|
requestId | True | string |
Request ID |
Returns
- Body
- ProgramRequest
Get requests
Get a list of requests.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Planned End Date From
|
plannedEndDateFrom | date-time |
filter by request due date (inclusive) |
|
Planned End Date To
|
plannedEndDateTo | date-time |
filter by request due date (exclusive) |
|
Planned Start Date From
|
plannedStartDateFrom | date-time |
filter by request start date (inclusive) |
|
Planned Start Date To
|
plannedStartDateTo | date-time |
filter by request start date (exclusive) |
|
Created At From
|
createdAtFrom | date-time |
filter by request created date (inclusive) |
|
Created At To
|
createdAtTo | date-time |
filter by request created date (exclusive) |
|
Updated At From
|
updatedAtFrom | date-time |
filter by request updated date (inclusive) |
|
Updated At To
|
updatedAtTo | date-time |
filter by request updated date (exclusive) |
|
Request IDs
|
ids | array |
A list of request IDs |
|
Title
|
title | string |
Keyword values to search for on request titles |
|
Assignee IDs
|
assigneeIds | array |
A list of assignees' user IDs to filter by |
|
Priorities
|
priorities | array |
A list of priority values, Available values : critical, high, medium, low |
|
Keywords
|
keywords | string |
Keyword values to search |
|
Assigner IDs
|
assignerIds | array |
A list of assigner' user Ids to filter by |
|
Creator IDs
|
creatorIds | array |
A list of creators' user IDs to filter by |
|
Step IDs
|
stepIds | array |
A list of step IDs to filter by |
|
Status Schema ID
|
statusSchemaId | string |
Status schema ID to filter by |
|
Cursor
|
cursor | string |
A token used to guide the next page window |
|
Limit
|
limit | integer |
Number of items to return per page, default: 50 |
|
Sort
|
sort | array |
Sort by requests |
|
Program ID
|
programId | string |
The Program ID a request is associated to |
|
Has Program
|
hasProgram | boolean |
Filter by if requests are associated with a program |
|
Custom Properties
|
customProperties | string |
Filter by custom properties |
|
Follower IDs
|
followerIds | array |
A list of followers' user id |
|
Associated Node IDs
|
associatedNodeIds | array |
A list of Associated node IDs to filter by |
|
Content Reference Objects
|
contentRefs | array |
List of content reference objects |
|
Include Request Form Custom Properties
|
includeRequestFormCustomProperties | boolean |
whether to include request form custom properties, default false |
Returns
Get status schema
Get a single status schema by ID. These schemas hold the data for set statuses for specific work.
Example: (Not started, In progress, Complete)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Status Schema ID
|
statusSchemaId | True | string |
Status schema ID |
Returns
- Body
- StatusSchema
Get status schemas
Get a list of task/request status schemas. These schemas hold the data for set statuses for specific work.
Example: (Not started, In progress, Complete)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Is Default
|
isDefault | boolean |
Get default status schema |
|
Type
|
type | string |
Query by node type |
|
Status Schema IDS
|
ids | array |
List of status schemas IDs |
|
Creator IDs
|
creatorIds | array |
List of user IDs to query by creator |
|
Cursor
|
cursor | string |
Cursor used for pagination |
|
Limit
|
limit | integer |
Number to limit returned records |
Returns
Get task
Get a single task by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Task ID
|
taskId | True | string |
Task ID |
Returns
- Body
- ProgramTask
Get tasks
Get a list of tasks.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Planned End Date From
|
plannedEndDateFrom | date-time |
Filter by task due date (inclusive) |
|
Planned End Date To
|
plannedEndDateTo | date-time |
Filter by task due date (exclusive) |
|
Planned Start Date From
|
plannedStartDateFrom | date-time |
Filter by task start date (inclusive) |
|
Planned Start Date To
|
plannedStartDateTo | date-time |
Filter by task start date (exclusive) |
|
Created At From
|
createdAtFrom | date-time |
Filter by task created date (inclusive) |
|
Created At To
|
createdAtTo | date-time |
Filter by task created date (exclusive) |
|
Updated At From
|
updatedAtFrom | date-time |
Filter by task updated date (inclusive) |
|
Updated At To
|
updatedAtTo | date-time |
Filter by task updated date (exclusive) |
|
Task IDs
|
ids | array |
Filter by a list of task IDs |
|
Title
|
title | string |
Filter by task title |
|
Description
|
description | string |
Filter by task description |
|
Assignee IDs
|
assigneeIds | array |
List of user IDs to filter by assignee |
|
Priorities
|
priorities | array |
Filter by list of priorities |
|
Keywords
|
keywords | string |
Filter by keywords |
|
Assigner IDs
|
assignerIds | array |
List of user IDs to filter by user that assigned the task |
|
Step IDs
|
stepIds | array |
Filter by status value IDs |
|
Status Schema ID
|
statusSchemaId | string |
Filter by status schema IDs |
|
Cursor
|
cursor | string |
Cursor used for pagination |
|
Limit
|
limit | integer |
Number to limit returned records |
|
Sort
|
sort | array |
Sort by query |
|
Recursive
|
recursive | boolean |
Include subtasks within the returned list |
|
Program ID
|
programId | string |
Filter by Program ID |
|
Has Program
|
hasProgram | boolean |
Filter by tasks that are associated with a program |
|
Custom Properties
|
customProperties | string |
Filter by custom property values |
|
Follower IDs
|
followerIds | array |
List of user IDs to filter by followers |
|
Associated Node IDs
|
associatedNodeIds | array |
List of association IDs to filter by |
|
Creator IDs
|
creatorIds | array |
List of user IDs to filter by creator |
|
Include Associations
|
includeAssociations | boolean |
Include association data in the response |
|
Parent ID
|
parentId | string |
List of task IDs to filter by |
Returns
Update a program
Update and return a program.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Program ID
|
programId | True | string |
Program ID |
Phase type ID
|
phaseTypeId | True | string |
Phase type ID |
Space ID
|
spaceId | string |
Space ID |
|
Date time
|
datetime | date-time |
Date time for phase |
|
Name
|
name | string |
Name of the phase |
|
associatedToField
|
associatedToField | string |
The field the phase is associated with that comes from PhaseType |
|
Description
|
description | string |
Description of phase that comes from PhaseType |
|
Color
|
color | string |
Color of phase that comes from PhaseType |
|
Ordinality
|
ordinality | integer |
Order of phase that comes from PhaseType |
|
Archived
|
archived | boolean |
Indicator on if a program is archived or not |
|
Enabled
|
enabled | boolean |
Deprecated indicator for archive |
|
Hide Tips
|
hideTips | boolean |
Indicator if the user has hidden tips or not |
|
Launch Date
|
launchDate | date-time |
Launch date |
|
Type
|
type | string |
Type of audience object |
|
ID
|
id | string |
ID of audience (user group, user, etc.) |
|
Trackers
|
trackers | array of string |
List of keyword trackers |
|
Topics
|
topics | array of string |
List of keyword topics |
|
Program Type
|
programType | string |
Type of program |
|
First outcome KPI metric
|
outcomeKpiFirst | string |
First outcome KPI metric |
|
Second outcome KPI metric
|
outcomeKpiSecond | string |
Second outcome KPI metric |
|
Third outcome KPI metric
|
outcomeKpiThird | string |
Third outcome KPI metric |
|
Metric type
|
metricType | string |
Metric type |
|
Target value
|
targetValue | string |
User specified number target value for objective |
|
Measured in
|
measuredIn | string |
Option to set how metric is measured |
|
Trend
|
trend | string |
Option to set how the objective trend is being tracked |
|
Date range
|
dateRange | string |
Date range set for the trend |
|
Hide from overview
|
isHideFromOverView | boolean |
Option to hide metric objective from overview page |
|
Description
|
description | string |
Description of association |
|
Name
|
name | string |
Name of association |
|
Node GUID
|
nodeGuid | string |
Longer GUID format |
|
Node ID
|
nodeId | string |
Node ID |
|
Node Type
|
nodeType | string |
Node type of the association |
|
Space GUID
|
spaceGuid | string |
Longer GUID format |
|
Space ID
|
spaceId | string |
Space ID |
|
Custom Property ID
|
id | string | ||
Localizations
|
localizations | object |
Localization object |
|
Multiple Value
|
multipleValue | boolean |
Indicate if the custom property allows multiple values |
|
Name
|
name | string |
Name of custom property |
|
Value ID
|
id | string | ||
Value
|
value |
Value data for custom property value |
||
Description
|
description | string |
Description of program |
|
Is Active
|
isActive | boolean |
Indicator on whether a program is active? |
|
Manager ID
|
managerId | string |
User ID of program manager |
|
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
|
Planned End Date
|
plannedEndDate | date-time |
Date string of planned end date |
|
Planned Start Date
|
plannedStartDate | date-time |
Date string of planned start date |
|
Title
|
title | True | string |
Title of program |
Returns
- Body
- Program
Update comment
Update an existing comment. Requires node (program, task, or request) and comment ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Node ID
|
nodeId | True | string |
Node ID |
Comment ID
|
commentId | True | string |
Comment ID |
Annotation Payload
|
annotationPayload | string | ||
Annotation type
|
annotationType | string | ||
Comment Content
|
commentContent | True | string |
Content of the comment |
Is Resolved
|
isResolved | boolean |
True/false on whether the comment is resolved |
Returns
- Body
- Comment
Update request
Update a request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Request ID
|
requestId | True | string |
Request ID |
Assignee ID
|
assigneeId | string |
User ID of the assignee |
|
Content ID
|
contentId | uuid |
Content ID |
|
DocCenter Full Path
|
docCenterFullPath | string |
Full location path of where content exists in DocCenter |
|
Major Version
|
majorVersion | integer |
Number of major version |
|
Minor Version
|
minorVersion | integer |
Number of minor version |
|
Modified Date
|
modifiedDate | date-time |
Date the content reference was last updated |
|
Order Number
|
orderNo | integer |
Number to indicate order |
|
Profile ID
|
profileId | uuid |
Profile ID |
|
Profile Version ID
|
profileVersionId | uuid |
Version ID of profile |
|
Source
|
source | string |
Source of content |
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
Thumbnail ID
|
thumbnailId | string |
ID for image thumbnail |
|
Version ID
|
versionId | uuid |
Version ID of content |
|
Custom Property ID
|
id | string | ||
Value ID
|
id | string | ||
Value
|
value |
Value data for custom property value |
||
Form Reference
|
formRef | True |
Form reference object |
|
Note
|
note | string |
Note used for notifications on status changes |
|
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
|
Planned End Date
|
plannedEndDate | date-time |
Date string of planned end date (due date) |
|
Planned Start Date
|
plannedStartDate | date-time |
Date string of planned start date |
|
Priority
|
priority | string |
Priority value |
|
Program ID
|
programId | string |
Program ID of the program the request belongs to |
|
Step ID
|
stepId | True | integer |
Step ID indicating status |
Title
|
title | True | string |
Title of the request |
Returns
- Body
- ProgramRequest
Update task
Update an existing task.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Space ID
|
spaceId | True | string |
Space ID |
Task ID
|
taskId | True | string |
Task ID |
Assignee ID
|
assigneeId | string |
User ID of the assignee |
|
Custom Property ID
|
id | string | ||
Value ID
|
id | string | ||
Value
|
value |
Value data for custom property value |
||
Description
|
description | string |
Description of task |
|
Parent ID
|
parentId | string |
Task ID of parent task |
|
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
|
Planned End Date
|
plannedEndDate | date-time |
Date string of planned end date |
|
Planned Start Date
|
plannedStartDate | date-time |
Date string of planned start date |
|
Priority
|
priority | string |
Priority value |
|
Program ID
|
programId | string |
Program ID that the task belongs to |
|
Step ID
|
stepId | integer |
Step ID indicating the task status |
|
Title
|
title | True | string |
Title of task |
Returns
- Body
- ProgramTask
Triggers
When a program is created |
Trigger to respond to when a program is created |
When a program is deleted |
Trigger to respond to when a program is deleted |
When a program is updated |
Trigger to respond to when a program is updated |
When a request is created |
Trigger to respond to when a request is created |
When a request is deleted |
Trigger to respond to when a request is deleted |
When a request is updated |
Trigger to respond to when a request is updated |
When a task is created |
Trigger to respond to when a task is created |
When a task is deleted |
Trigger to respond to when a task is deleted |
When a task is updated |
Trigger to respond to when a task is updated |
When a program is created
Trigger to respond to when a program is created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | ProgramWebhookResponse |
data |
When a program is deleted
Trigger to respond to when a program is deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | ProgramWebhookResponse |
data |
When a program is updated
Trigger to respond to when a program is updated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | ProgramWebhookResponse |
data |
When a request is created
Trigger to respond to when a request is created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | RequestWebhookResponse |
When a request is deleted
Trigger to respond to when a request is deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | RequestWebhookResponse |
When a request is updated
Trigger to respond to when a request is updated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | RequestWebhookResponse |
When a task is created
Trigger to respond to when a task is created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | TaskWebhookResponse |
When a task is deleted
Trigger to respond to when a task is deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | TaskWebhookResponse |
When a task is updated
Trigger to respond to when a task is updated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
filter
|
filter | string |
Example: $.data..[?(@.id == 'foo')] , JsonPath based filter expression, refer https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events for details. |
Returns
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
A unique identifier for the event. |
version
|
version | string |
The version of the event, e.g., "ProgramCreateV1". |
occurredAt
|
occurredAt | date-time |
ISO 8601 timestamp when the event occurred in UTC. |
tenantId
|
tenantId | uuid |
Unique identifier for the tenant. |
tenantName
|
tenantName | string |
Name of the tenant. |
application
|
application | string |
The application where the event originated. |
productArea
|
productArea | string |
The product area related to the event. |
data
|
data | TaskWebhookResponse |
Definitions
Association
Name | Path | Type | Description |
---|---|---|---|
Description
|
description | string |
Description of association |
Name
|
name | string |
Name of association |
Node GUID
|
nodeGuid | string |
Longer GUID format |
Node ID
|
nodeId | string |
Node ID |
Node Type
|
nodeType | string |
Node type of the association |
Space GUID
|
spaceGuid | string |
Longer GUID format |
Space ID
|
spaceId | string |
Space ID |
AsyncOperationResponse
Name | Path | Type | Description |
---|---|---|---|
Async Operation IDs
|
asyncOperationIds | array of string |
List of async action IDs |
Audience
Audience object
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
Type of audience object |
ID
|
id | string |
ID of audience (user group, user, etc.) |
Comment
Name | Path | Type | Description |
---|---|---|---|
Annotation Payload
|
annotationPayload | string | |
Annotation Type
|
annotationType | string | |
Comment Content
|
commentContent | string | |
Created At
|
createdAt | date-time |
Date string of date created |
Creator ID
|
creatorId | string |
User ID of the creator |
Comment ID
|
id | string |
Comment ID |
Is Resolved
|
isResolved | boolean |
True/false on whether the comment is resolved |
Node ID
|
nodeId | string |
Node ID |
Node Type
|
nodeType | string |
Node type of the comment |
Page Index
|
pageIndex | string |
Number page index |
Parent ID
|
parentId | string |
Parent comment ID |
Reply Count
|
replyCount | integer |
Number of replies |
Space ID
|
spaceId | string |
Space ID |
Updated At
|
updatedAt | date-time |
Date string of updated date |
CommentQueryResponse
Name | Path | Type | Description |
---|---|---|---|
Count
|
count | integer |
Number of records returned |
Cursor
|
cursor | string |
Cursor used for pagination |
Items
|
items | array of Comment |
List of items in the response |
Limit
|
limit | integer |
Number to limit records |
Metadata object
|
meta | Meta |
Metadata object |
ContentRef
Name | Path | Type | Description |
---|---|---|---|
Content ID
|
contentId | uuid |
Content ID |
DocCenter Full Path
|
docCenterFullPath | string |
Full location path of where content exists in DocCenter |
Major Version
|
majorVersion | integer |
Number of major version |
Minor Version
|
minorVersion | integer |
Number of minor version |
Modified Date
|
modifiedDate | date-time |
Date the content reference was last updated |
Order Number
|
orderNo | integer |
Number to indicate order |
Profile ID
|
profileId | uuid |
Profile ID |
Profile Version ID
|
profileVersionId | uuid |
Version ID of profile |
Source
|
source | string |
Source of content |
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
Thumbnail ID
|
thumbnailId | string |
ID for image thumbnail |
Version ID
|
versionId | uuid |
Version ID of content |
CustomProperty
Name | Path | Type | Description |
---|---|---|---|
Allow Multiple Values
|
allowMultipleValues | boolean |
Indicates if custom property allows for multiple values |
Created By ID
|
createdById | string |
User ID of the creator |
Has Domain Of Values
|
hasDomainOfValues | boolean |
Indicates if custom property has possible values |
Hint
|
hint | string |
Value that describes the hint displayed under the custom property name |
Custom Property ID
|
id | string | |
Is Required
|
isRequired | boolean |
Indicates whether the custom property is required or not |
Last Modified By ID
|
lastModifiedById | string |
User ID of the user that last updated the custom property |
Name
|
name | string |
Name of custom property |
Operation Setting
|
operationSetting | string |
Object that describes settings for different operations on a custom property |
Order
|
order | integer |
Number indicating order within custom property list |
Possible Values
|
possibleValues | array of PossibleValuesItem |
List of possible values for the custom property (if applicable) |
Scope Settings
|
scopeSettings | array of ScopeSettingsItemDefinition |
Object that describes settings for different scopes on a custom property |
Scopes
|
scopes | array of string |
List of scopes |
Value Schema Name
|
valueSchemaName | string |
Name of custom property value schema |
valueSchemaProperty
|
valueSchemaProperty | ValueSchemaPropertyDefinition |
Value schema definition |
Value Type
|
valueType | string |
Type of custom property value |
CustomPropertyValues
Name | Path | Type | Description |
---|---|---|---|
Custom Property ID
|
id | string | |
Localizations
|
localizations | object |
Localization object |
Multiple Value
|
multipleValue | boolean |
Indicate if the custom property allows multiple values |
Name
|
name | string |
Name of custom property |
Values
|
values | array of CustomPropertyValuesValues |
List of custom property values |
CustomPropertyValuesValues
Name | Path | Type | Description |
---|---|---|---|
Value ID
|
id | string | |
Value
|
value |
Value data for custom property value |
Follower
Name | Path | Type | Description |
---|---|---|---|
User/User group ID
|
id | string |
User/User group ID of follower |
Type
|
type | string |
Either user or user group follower type |
Meta
Metadata object
Name | Path | Type | Description |
---|---|---|---|
Count
|
count | integer |
Number of records returned |
Query
|
query | array of MetaQueryInfo |
Query object |
MetaQueryInfo
Name | Path | Type | Description |
---|---|---|---|
Sort
|
sort | array of string |
Sort query |
MetricObjective
Metric objective object
Name | Path | Type | Description |
---|---|---|---|
Metric type
|
metricType | string |
Metric type |
Target value
|
targetValue | string |
User specified number target value for objective |
Measured in
|
measuredIn | string |
Option to set how metric is measured |
Trend
|
trend | string |
Option to set how the objective trend is being tracked |
Date range
|
dateRange | string |
Date range set for the trend |
Hide from overview
|
isHideFromOverView | boolean |
Option to hide metric objective from overview page |
Phase
Program phase
Name | Path | Type | Description |
---|---|---|---|
Phase type ID
|
phaseTypeId | string |
Phase type ID |
Space ID
|
spaceId | string |
Space ID |
Date time
|
datetime | date-time |
Date time for phase |
Name
|
name | string |
Name of the phase |
associatedToField
|
associatedToField | string |
The field the phase is associated with that comes from PhaseType |
Description
|
description | string |
Description of phase that comes from PhaseType |
Color
|
color | string |
Color of phase that comes from PhaseType |
Ordinality
|
ordinality | integer |
Order of phase that comes from PhaseType |
Program
Name | Path | Type | Description |
---|---|---|---|
Actual Duration
|
actualDuration | integer |
Calculated actual duration in days |
Actual End Date
|
actualEndDate | date-time |
Calculated end date from when the program actually ended |
Actual Start Date
|
actualStartDate | date-time |
Calculated start date from when the program actually started |
Analytic Setting
|
analyticSetting | ProgramAnalyticSetting | |
Associated Nodes
|
associatedNodes | array of ProgramAssociatedNodes |
List of association data |
Associations
|
associations | array of Association |
List of associations (Library content) |
Copy From
|
copyFrom | string |
Program ID the program is copied from |
Created At
|
createdAt | date-time |
Date string of created date |
Creator ID
|
creatorId | string |
User ID of creator |
Custom Properties
|
customProperties | array of CustomPropertyValues |
List of custom properties |
Brief Description
|
description | string |
Brief description of program |
Followers
|
followers | array of Follower |
List of followers |
Program ID
|
id | string | |
Is Active
|
isActive | boolean |
Indicator on if a program is active or not |
Is Template
|
isTemplate | boolean |
Indicator on if the program is a template or not |
Manager ID
|
managerId | string |
User ID of program manager |
Max Rank
|
maxRank | string |
Maximum rank number |
Min Rank
|
minRank | string |
Minimum rank number |
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
Planned End Date
|
plannedEndDate | date-time |
Date string of planned end date |
Planned Start Date
|
plannedStartDate | date-time |
Date string of planned start date |
Space ID
|
spaceId | string | |
Template ID
|
templateId | string |
Template ID the the program was created from |
Title
|
title | string |
Title of program |
Updated At
|
updatedAt | date-time |
Date program was last updated |
Works
|
works | array of ProgramTask |
List of tasks and requests |
ProgramAnalyticSetting
Name | Path | Type | Description |
---|---|---|---|
Phase
|
currentPhase | Phase |
Program phase |
Phases
|
phases | array of Phase |
List of possible program phases |
Archived
|
archived | boolean |
Indicator on if a program is archived or not |
Enabled
|
enabled | boolean |
Deprecated indicator for archive |
Hide Tips
|
hideTips | boolean |
Indicator if the user has hidden tips or not |
Launch Date
|
launchDate | date-time |
Launch date |
Audience
|
audience | array of Audience |
List of user groups for program audience |
Trackers
|
trackers | array of string |
List of keyword trackers |
Topics
|
topics | array of string |
List of keyword topics |
Program Type
|
programType | string |
Type of program |
First outcome KPI metric
|
outcomeKpiFirst | string |
First outcome KPI metric |
Second outcome KPI metric
|
outcomeKpiSecond | string |
Second outcome KPI metric |
Third outcome KPI metric
|
outcomeKpiThird | string |
Third outcome KPI metric |
Metric Objectives
|
metricObjectives | array of MetricObjective |
List of metric objectives |
ProgramQueryResponse
Name | Path | Type | Description |
---|---|---|---|
Count
|
count | integer |
Number of records returned |
Cursor
|
cursor | string |
Cursor used for pagination |
Program objects
|
items | array of Program |
List of program items in the response |
Limit
|
limit | integer |
Number to limit records |
Metadata object
|
meta | Meta |
Metadata object |
ProgramWebhookResponse
data
Name | Path | Type | Description |
---|---|---|---|
tenantId
|
tenantId | string |
data/tenantId |
tenantName
|
tenantName | string |
data/tenantName |
actorId
|
actorId | string |
data/actorId |
eventTimestamp
|
eventTimestamp | integer |
data/eventTimestamp |
programId
|
programId | string |
data/programId |
title
|
title | string |
data/title |
description
|
description | string |
data/description |
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
creatorId
|
creatorId | string |
data/creatorId |
createdAt
|
createdAt | date-time |
data/createdAt |
attachedContent
|
attachedContent | array of object |
attachedContent |
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
attachedRequests
|
attachedRequests | array of object |
attachedRequests |
spaceId
|
attachedRequests.spaceId | string |
data/attachedRequests/spaceId |
requestId
|
attachedRequests.requestId | string |
data/attachedRequests/requestId |
attachedTasks
|
attachedTasks | array of object |
attachedTasks |
spaceId
|
attachedTasks.spaceId | string |
data/attachedTasks/spaceId |
taskId
|
attachedTasks.taskId | string |
data/attachedTasks/taskId |
managerId
|
managerId | string |
data/managerId |
isTemplate
|
isTemplate | boolean |
data/isTemplate |
updatedAt
|
updatedAt | date-time |
data/updatedAt |
actualDuration
|
actualDuration | integer |
data/actualDuration |
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
copyFrom
|
copyFrom | string |
data/copyFrom |
followers
|
followers | array of object |
followers |
userId
|
followers.userId | string |
userId |
spaceId
|
spaceId | string |
data/spaceId |
templateId
|
templateId | string |
data/templateId |
updateDiffs
|
updateDiffs | array of object | |
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
before
|
updateDiffs.before | string |
data/updateDiffs/before |
after
|
updateDiffs.after | string |
data/updateDiffs/after |
Analytic Setting
|
analyticSetting | ProgramAnalyticSetting | |
customProperties
|
customProperties | array of object | |
id
|
customProperties.id | string |
data/customProperties/id |
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
name
|
customProperties.name | string |
data/customProperties/name |
customProperties
|
customProperties.customProperties | array of object | |
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
type
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ProgramRequest
Name | Path | Type | Description |
---|---|---|---|
Assignee ID
|
assigneeId | string |
User ID of the assignee |
Assigner ID
|
assignerId | string |
User ID of the assigner |
Associations
|
associations | array of Association |
List of associations (Library content) |
Content Reference Objects
|
contentRefs | array of ContentRef |
List of content references (WorkSpace and DocCenter content) |
Created At
|
createdAt | date-time |
Date string for created date |
Creator ID
|
creatorId | string |
User ID of the creator |
Custom Properties
|
customProperties | array of CustomPropertyValues |
List of custom properties |
Followers
|
followers | array of Follower |
List of followers |
Form Ref
|
formRef |
Form reference object |
|
Request ID
|
id | string | |
Note
|
note | string |
Note for notifications on status changes |
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
Planned End Date
|
plannedEndDate | date-time |
Date string of planned end date |
Plannted Start Date
|
plannedStartDate | date-time |
Date string of planned start date |
Priority
|
priority | string |
Priority value |
Program ID
|
programId | string |
Program ID of the program the request is associated with |
Rank
|
rank | string |
Rank of request in request list |
requestFormCustomPropertyOption
|
requestFormCustomPropertyOption | RequestFormCustomProperties |
Request form custom properties |
Space ID
|
spaceId | string | |
Status Schema ID
|
statusSchemaId | string | |
Step ID
|
stepId | integer |
Step ID indicating the status value |
Title
|
title | string |
Title of the request |
Updated At
|
updatedAt | date-time |
Date the request was last updated |
ProgramRequestQueryResponse
Name | Path | Type | Description |
---|---|---|---|
Count
|
count | integer |
Number of records returned |
Cursor
|
cursor | string |
Cursor used for pagination |
Request objects
|
items | array of ProgramRequest |
List of request objects in the response |
Limit
|
limit | integer |
Number to limit records |
Metadata object
|
meta | Meta |
Metadata object |
PlannerSubTask
Name | Path | Type | Description |
---|---|---|---|
Actual Duration
|
actualDuration | integer |
Calculated actual duration in days |
Actual End Date
|
actualEndDate | date-time |
Date when work on the task was completed |
Actual Start Date
|
actualStartDate | date-time |
Date when work on the task started |
Assignee ID
|
assigneeId | string |
User ID of assignee |
Assigner ID
|
assignerId | string |
User ID of the last user to add an assignee |
Associations
|
associations | array of Association |
List of associations on a task |
Copy From
|
copyFrom | string |
Task ID that task was copied from |
Created At
|
createdAt | date-time |
Date the task was created |
Creator ID
|
creatorId | string |
User ID of creator |
Custom Properties
|
customProperties | array of CustomPropertyValues |
List of custom properties on a task |
Description
|
description | string |
Description of task |
Followers
|
followers | array of Follower |
List of followers on a task |
Task ID
|
id | string | |
Is Template
|
isTemplate | boolean |
Indicates if a task is part of a template |
Max Rank
|
maxRank | string |
Maximum rank |
Min Rank
|
minRank | string |
Minimum rank |
Parent ID
|
parentId | string |
Task ID of parent if task is a subtask |
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
Planned End Date
|
plannedEndDate | date-time |
Date string of end date (due date) |
Planned Start Date
|
plannedStartDate | date-time |
Date string of start date |
Priority
|
priority | string |
Priority value |
Program ID
|
programId | string |
Program ID the task belongs to |
Rank
|
rank | string |
Rank of task in a task list |
Space ID
|
spaceId | string | |
Status Schema ID
|
statusSchemaId | string | |
Step ID
|
stepId | integer |
Id of step in status schema |
Template ID
|
templateId | string |
Template ID of the template the task belongs to |
Title
|
title | string |
Title of task |
Type
|
type | string |
Type of task |
Update At
|
updatedAt | date-time |
Date the task was last updated |
ProgramTask
Name | Path | Type | Description |
---|---|---|---|
Actual Duration
|
actualDuration | integer |
Calculated actual duration in days |
Actual End Date
|
actualEndDate | date-time |
Date when work on the task was completed |
Actual Start Date
|
actualStartDate | date-time |
Date when work on the task started |
Assigne ID
|
assigneeId | string |
User ID of assignee |
Assigner ID
|
assignerId | string |
User ID of the last user to add an assignee |
Associations
|
associations | array of Association |
List of associations on a task |
Copy From
|
copyFrom | string |
Task ID that task was copied from |
Created At
|
createdAt | date-time |
Date the task was created |
Creator ID
|
creatorId | string |
User ID of creator |
Custom Properties
|
customProperties | array of CustomPropertyValues |
List of custom properties on a task |
Description
|
description | string |
Description of task |
Followers
|
followers | array of Follower |
List of followers on a task |
Task ID
|
id | string | |
Is Template
|
isTemplate | boolean |
Indicates if a task is part of a template |
Max Rank
|
maxRank | string |
Maximum rank |
Min Rank
|
minRank | string |
Minimum rank |
Parent ID
|
parentId | string |
Task ID of parent if task is a subtask |
Planned Duration
|
plannedDuration | integer |
Planned duration in days |
Planned End Date
|
plannedEndDate | date-time |
Date string of planned end date (due date) |
Planned Start Date
|
plannedStartDate | date-time |
Date string of planned start date |
Priority
|
priority | string |
Priority value |
Program ID
|
programId | string |
Program ID the task belongs to |
Rank
|
rank | string |
Rank of task in a task list |
Space ID
|
spaceId | string | |
Status Schema ID
|
statusSchemaId | string | |
Step ID
|
stepId | integer |
Id of step in status schema |
Sub Task IDs
|
subTaskIds | array of string |
List of subtask IDs |
Sub Tasks
|
subTasks | array of PlannerSubTask |
List of subtasks on the task |
Template ID
|
templateId | string |
Template ID of the template the task belongs to |
Title
|
title | string |
Title of task |
Type
|
type | string |
Type of task |
Updated At
|
updatedAt | date-time |
Date the task was last updated |
ProgramTaskQueryResponse
Name | Path | Type | Description |
---|---|---|---|
Count
|
count | integer |
Number of records returned |
Cursor
|
cursor | string |
Cursor used for pagination |
Task objects
|
items | array of ProgramTask |
List of task objects in the response |
Limit
|
limit | integer |
Number to limit records |
Metadata object
|
meta | Meta |
Metadata object |
PossibleValuesItem
Name | Path | Type | Description |
---|---|---|---|
Value ID
|
id | string | |
Order
|
order | integer |
Number to indicate order |
Value
|
value |
Actual value data |
ProgramAssociatedNodes
Name | Path | Type | Description |
---|---|---|---|
Node ID
|
nodeId | string | |
Node Type
|
nodeType | string |
Node type of the association |
Space ID
|
spaceId | string |
RequestFormCustomProperties
Request form custom properties
Name | Path | Type | Description |
---|---|---|---|
Created At
|
createdAt | date-time |
Date string of created date |
Custom Properties
|
customProperties | array of CustomProperty |
List of custom properties |
RequestWebhookResponse
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
data/id |
tenantId
|
tenantId | string |
data/tenantId |
tenantName
|
tenantName | string |
data/tenantName |
requestId
|
requestId | string |
data/requestId |
eventTimestamp
|
eventTimestamp | integer |
data/eventTimestamp |
actorId
|
actorId | string |
data/actorId |
spaceId
|
spaceId | string |
data/spaceId |
title
|
title | string |
data/title |
assigneeId
|
assigneeId | string |
data/assigneeId |
assignerId
|
assignerId | string |
data/assignerId |
creatorId
|
creatorId | string |
data/creatorId |
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
createdAt
|
createdAt | date-time |
data/createdAt |
updatedAt
|
updatedAt | date-time |
data/updatedAt |
status
|
status | string |
data/status |
priority
|
priority | string |
data/priority |
programId
|
programId | string |
data/programId |
note
|
note | string |
data/note |
formId
|
formRef.formId | string |
data/formRef/formId |
minorVersion
|
formRef.minorVersion | integer |
data/formRef/minorVersion |
majorVersion
|
formRef.majorVersion | integer |
data/formRef/majorVersion |
followers
|
followers | array of object |
followers |
userId
|
followers.userId | string |
userId |
attachedContent
|
attachedContent | array of object |
attachedContent |
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
updateDiffs
|
updateDiffs | array of object |
data/updateDiffs |
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
before
|
updateDiffs.before | string |
data/updateDiffs/before |
after
|
updateDiffs.after | string |
data/updateDiffs/after |
customProperties
|
customProperties | array of object |
data |
id
|
customProperties.id | string |
data/customProperties/id |
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
name
|
customProperties.name | string |
data/customProperties/name |
customProperties
|
customProperties.customProperties | array of object |
customProperties |
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
type
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ScopeSettingsItemDefinition
Name | Path | Type | Description |
---|---|---|---|
Is Required
|
isRequired | boolean |
Indicator on whether a field is required or not |
Scope
|
scope | string |
Type list of node types that the custom property definition belongs to |
StatusSchema
Name | Path | Type | Description |
---|---|---|---|
Created At
|
createdAt | date-time |
Date string of created date |
Creator ID
|
creatorId | string |
User ID of creator |
Status schema ID
|
id | string | |
Is Default
|
isDefault | boolean |
Indicator on if the status schema is the default schema |
Name
|
name | string |
Name of status schema |
Space ID
|
spaceId | string | |
Steps
|
steps | array of string |
List of steps and their values |
Transitions
|
transitions | array of array |
List of transition rules |
items
|
transitions | array of integer | |
Type
|
type | string |
Node type the status schema can be used for |
Updated At
|
updatedAt | date-time |
Date the status schema was last updated |
StatusSchemaQueryResponse
Name | Path | Type | Description |
---|---|---|---|
Count
|
count | integer |
Number of records returned |
Cursor
|
cursor | string |
Cursor used for pagination |
Status Schema Objects
|
items | array of StatusSchema |
List of status schema objects in the response |
Limit
|
limit | integer |
Number to limit records |
Metadata object
|
meta | Meta |
Metadata object |
TaskWebhookResponse
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
data/id |
tenantId
|
tenantId | string |
data/tenantId |
tenantName
|
tenantName | string |
data/tenantName |
taskId
|
taskId | string |
data/taskId |
eventTimestamp
|
eventTimestamp | integer |
data/eventTimestamp |
actorId
|
actorId | string |
data/actorId |
spaceId
|
spaceId | string |
data/spaceId |
title
|
title | string |
data/title |
description
|
description | string |
data/description |
assigneeId
|
assigneeId | string |
data/assigneeId |
assignerId
|
assignerId | string |
data/assignerId |
creatorId
|
creatorId | string |
data/creatorId |
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
actualDuration
|
actualDuration | integer |
data/actualDuration |
createdAt
|
createdAt | date-time |
data/createdAt |
updatedAt
|
updatedAt | date-time |
data/updatedAt |
status
|
status | string |
data/status |
priority
|
priority | string |
data/priority |
parentId
|
parentId | string |
data/parentId |
programId
|
programId | string |
data/programId |
copyFrom
|
copyFrom | string |
data/copyFrom |
followers
|
followers | array of object |
followers |
userId
|
followers.userId | string |
userId |
templateId
|
templateId | string |
data/templateId |
attachedContent
|
attachedContent | array of object |
attachedContent |
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
attachedSubTasks
|
attachedSubTasks | array of object |
attachedSubTasks |
spaceId
|
attachedSubTasks.spaceId | string |
data/attachedSubTasks/spaceId |
taskId
|
attachedSubTasks.taskId | string |
data/attachedSubTasks/taskId |
updateDiffs
|
updateDiffs | array of object | |
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
before
|
updateDiffs.before | string |
data/updateDiffs/before |
after
|
updateDiffs.after | string |
data/updateDiffs/after |
customProperties
|
customProperties | array of object |
data |
id
|
customProperties.id | string |
data/customProperties/id |
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
name
|
customProperties.name | string |
data/customProperties/name |
customProperties
|
customProperties.customProperties | array of object |
customProperties |
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
type
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ValueSchemaPropertyDefinition
Value schema definition
Name | Path | Type | Description |
---|---|---|---|
Maximum number
|
max | string | |
Minimum number
|
min | string |