ISOPlanner
ISOPlanner lets you automate compliance work by reacting to events and performing actions such as creating or updating tasks, incidents, and library items. Ideal for ISO 27001/27701 workflows. Requires an active ISOPlanner license.
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 | ISOPlanner Support |
| URL | https://isoplanner.app/support |
| support@isoplanner.app |
| Connector Metadata | |
|---|---|
| Publisher | REDLAB |
| Website | https://isoplanner.app/ |
| Privacy policy | https://isoplanner.app/privacy-policy/ |
| Categories | Productivity |
ISOPlanner is an easy to use and powerfull Compliance Management solution, integrated with Microsoft 365. This integration allows you to build workflows that respond to events or execute various actions in ISOPlanner.
Prerequisites
To use this integration, you will need an ISOPlanner subscription (or trial). You also need to have a management license within the ISOPlanner solution.
How to get credentials
You can connect with your Microsoft account which must have a valid management license in ISOPlanner.
Get started with your connector
First, create an event template in ISOPlanner. Then, create a workflow that starts with the trigger the 'When an event is created'. Save the workflow an go back to ISOPlanner and observe that the event template is connected to the workflow.
Known issues and limitations
As of right now, there are no known issues with this connector.
Common errors and remedies
BadRequest (400)
When the a BadRequest error is received (HTTP response code 400). Check the returned error message that should specify the cause. For example, when you try to create a task but you don't specify the task name, a 400 error code is returned and the error contains 'Task name must be specified'.
FAQ
What does the 'Org Unit Id' field mean?
Every trigger and action starts by selecting the Organizational Unit in ISOPlanner. An organizational unit is a seperate environment in ISOPlanner with its own authorization and content. In ISOPlanner, Premium subscriptions can create multiple organizational units. For other subscription types, just choose the one available.
Creating a connection
The connector supports the following authentication types:
| Client Certificate Auth | Provide Microsoft Entra ID credentials using PFX certificate and password | All regions | Shareable |
| OAuth Connection | OAuth Connection | All regions | Not shareable |
| Service Principal Connection | Service Principal Connection | All regions | Shareable |
| Default [DEPRECATED] | This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. | All regions | Not shareable |
Client Certificate Auth
Auth ID: certOauth
Applicable: All regions
Provide Microsoft Entra ID credentials using PFX certificate and password
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
| Name | Type | Description | Required |
|---|---|---|---|
| Client ID | string | True | |
| Client certificate secret | clientCertificate | The client certificate secret allowed by this application | True |
| Tenant | string | True |
OAuth Connection
Auth ID: oauth2-auth
Applicable: All regions
OAuth 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.
Service Principal Connection
Auth ID: oAuthClientCredentials
Applicable: All regions
Service Principal Connection
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
| Name | Type | Description | Required |
|---|---|---|---|
| Client ID | string | True | |
| Client Secret | securestring | True | |
| Tenant | string | True |
Default [DEPRECATED]
Applicable: All regions
This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add a library item to a task |
Add a library item to a task. |
| Add a library item to an event |
Add a library item to an event. |
| Add context to a KPI data point |
Add context to a KPI data point. |
| Create a KPI data point |
Add data to the specified KPI. |
| Create a subtask for an event |
Create a subtask for an event. |
| Create a task |
Create a new task. |
| Create a webhook |
Create a webhook in ISOPlanner |
| Create an asset |
Create an asset. |
| Create an event |
Create a new event. |
| Create an event for an approval |
Create a new event. |
| Create or Update Library item |
Create or Update Library item. |
| Delete a KPI data point |
Delete data for the specified KPI. |
| Delete a subtask of an event |
Delete a subtask of an event. |
| Delete a task |
Delete a task. |
| Delete an asset |
Delete an asset. |
| Delete an asset for an external Id |
Delete an asset. |
| Delete an event |
Delete an event. |
| Get a KPI |
Get the details of a KPI. |
| Get a KPI data point |
Get data for the specified KPI. |
| Get a Library item |
Get the details of the specified Library item. |
| Get a Library item by Url |
Get the details of the specified Library item. |
| Get a subtask of an event based on Id |
Get a subtask of an event based on Id. |
| Get a subtask of an event based on Name |
Get a subtask of an event based on Name. |
| Get an asset |
Get the details of an asset. |
| Get an asset for an external Id |
Get the details of an asset for an external Id. |
| Get assets |
Get a list of all assets. |
| Get events |
Get all events or filtered events. |
| Get tasks |
Get all tasks or filtered tasks. |
| Submit evidence to a KPI |
Check the evidence and add extracted data to a KPI. |
| Update a KPI data point |
Update data for the specified KPI. |
| Update a subtask for an event |
Update a subtask for an event. |
| Update a task |
Update a task. |
| Update an asset |
Update an asset. |
| Update an event |
Update an event |
| Update an event from approval |
Update an event from an approval result. |
Add a library item to a task
Add a library item to a task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Library Item Id
|
LibraryItemId | True | integer |
The Id of the library item. |
|
Task Id
|
TaskId | True | integer |
The Id of the task. |
Add a library item to an event
Add a library item to an event.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Library Item Id
|
LibraryItemId | True | integer |
The Id of the library item. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
Add context to a KPI data point
Add context to a KPI data point.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
KPI Id
|
KPIId | True | integer |
The Id of the KPI. |
|
KPI Data Id
|
KPIDataId | True | integer |
The Id of the KPI data point. |
|
Entity Type
|
EntityType | True | integer |
The type of context. |
|
Entity Id
|
EntityId | True | integer |
The Id of the entity that matches the type. |
Create a KPI data point
Add data to the specified KPI.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
KPI Id
|
KPIId | True | integer |
The Id of the KPI. |
|
Task Id
|
TaskId | integer |
The Task Id of the task context. This KPI data will be set on the form of the task. |
|
|
Value (Number)
|
ResultNumber | number |
The value of the KPI for type Number. |
|
|
Value (Text)
|
ResultText | string |
The value of the KPI for type Text. |
|
|
Value (Date)
|
ResultDate | date-time |
The value of the KPI for type Date and Time. |
|
|
Comment
|
ResultComment | string |
The comment for this data point. |
|
|
Created
|
Created | date-time |
When the data point is created. |
|
|
CreatedBy
|
CreatedBy | string |
Name or email address of the user who created the data point. |
|
|
CreatedById
|
CreatedById | string |
Id of the user who created the data point. |
|
|
Modified
|
Modified | date-time |
When the data point was Modified. |
|
|
ModifiedBy
|
ModifiedBy | string |
Name or email address of the user who modified the data point. |
|
|
ModifiedById
|
ModifiedById | string |
Id of the user who modified the data point. |
Create a subtask for an event
Create a subtask for an event.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
|
Task External Id
|
ExternalId | string |
The External Id of the task. |
|
|
Name
|
Name | True | string |
The name of the task. |
|
Description
|
Description | string |
The description of the task. |
|
|
Form Id
|
FormId | integer |
The form Id of the task. |
|
|
Status
|
Status | string |
The status of the task. |
|
|
Assignee Id
|
AssigneeId | string |
The user Id to which the task is assigned. |
|
|
Start Date Time
|
StartDateTime | date-time |
The start date and time of the task. |
|
|
End Date Time
|
EndDateTime | date-time |
The end date and time of the task. |
|
|
Deadline
|
Deadline | date-time |
The deadline of the task. |
|
|
Hidden
|
Hidden | boolean |
Whether the task is hidden in user views. |
Create a task
Create a new task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Name
|
name | True | string |
The name of the task. |
|
ExternalId
|
externalId | string |
The External Id of the task. |
|
|
Template
|
templateId | integer |
The Id of the Template. |
Create a webhook
Create a webhook in ISOPlanner
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Type
|
EventType | True | string |
The type of event. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Event Type Id
|
EventTypeId | True | integer |
The entity Id for which the webhook must run. |
|
Url
|
Url | True | string |
Url that ISOPlanner will call (POST). |
Create an asset
Create an asset.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Code
|
Code | True | string |
The code of the asset. |
|
Name
|
Name | True | string |
The name of the asset. |
|
Description
|
Description | string |
The description of the asset. |
|
|
Owner User Id
|
UserId | string |
The Id of User that represents the owner. |
|
|
Owner Role Id
|
RoleId | string |
The Id of Role that represents the owner. |
|
|
Type
|
Type | True | integer |
The type of asset. |
|
Status
|
State | True | string |
The status of the asset. |
|
Life cycle start
|
LifeCycleStart | date |
Life cycle start of the Asset. |
|
|
Life cycle end
|
LifeCycleEnd | date |
Life cycle end of the Asset. |
|
|
Library Category Id
|
LibraryCategoryId | integer |
The Library Category Id connected to the asset. |
|
|
External Id
|
ExternalId | string |
The external Id of the asset. |
|
|
Container external Id collection
|
ExternalContainerIds | array of string |
Collection of containers of the asset. |
|
|
Tag Id
|
TagId | integer |
The Id of the tag. |
Create an event
Create a new event.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Name
|
name | True | string |
Name of the event. |
|
External Id
|
externalId | string |
External Id of the event. |
|
|
Template
|
templateId | integer |
The Id of the template. |
|
|
Library Item Id
|
firstLibraryItemId | integer |
One library item Id to link to this event. |
Create an event for an approval
Create a new event.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Name
|
Name | True | string |
The name of the event. |
|
Type
|
Type | string | ||
|
Fixed users
|
Users | string |
A comma seperated list of email addresses. |
|
|
Template
|
TemplateId | integer |
The Id of the template. |
|
|
Library Item Id
|
LibraryItemId | integer |
The Id of the Library item to approve. |
|
|
Comment
|
Comment | string |
The comment of the creator. |
Create or Update Library item
Create or Update Library item.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Category Id
|
libraryCategoryId | integer |
Id of the category in the ISOPlanner library. |
|
|
SharePoint Item Id
|
libraryItemSPItemId | string |
Item Id of a generic list item, document or page. |
|
|
Library Item Id
|
libraryItemId | integer |
Id of the library item in ISOPlanner. |
|
|
Web URL
|
libraryItemUrl | string |
URL that points to the item. |
|
|
Name
|
libraryItemName | string |
Name of the library item in ISOPlanner. |
|
|
Owner Id
|
UserId | string |
Id of the owner of this item. |
Delete a KPI data point
Delete data for the specified KPI.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
KPI Id
|
KPIId | True | integer |
The Id of the KPI. |
|
KPI Data Id
|
KPIDataId | True | integer |
The Data Id of the KPI. |
Delete a subtask of an event
Delete a subtask of an event.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
|
Task Id
|
TaskId | True | integer |
The Id of the subtask. |
Delete a task
Delete a task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Task Id
|
TaskId | True | integer |
The Id of the task. |
Delete an asset
Delete an asset.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Asset Id
|
AssetId | True | integer |
The Id of the asset. |
Delete an asset for an external Id
Delete an asset.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Asset External Id
|
ExternalId | True | string |
The External Id of the asset. |
Delete an event
Delete an event.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
Get a KPI
Get the details of a KPI.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
KPI Id
|
KPIId | True | integer |
The Id of the KPI. |
Get a KPI data point
Get data for the specified KPI.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
KPI Id
|
KPIId | True | integer |
The Id of the KPI. |
|
KPI Data Id
|
KPIDataId | True | integer |
The Data Id of the KPI. |
Get a Library item
Get the details of the specified Library item.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Library Item Id
|
libraryItemId | True | integer |
The Id of the Library item. |
Get a Library item by Url
Get the details of the specified Library item.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Library Item Url
|
value | True | string |
The Url of the Library item. |
Get a subtask of an event based on Id
Get a subtask of an event based on Id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
|
Task Id
|
TaskId | True | integer |
The Id of the task. |
Get a subtask of an event based on Name
Get a subtask of an event based on Name.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
|
Task Name
|
TaskName | True | string |
The Name of the task. |
Get an asset
Get the details of an asset.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Asset Id
|
AssetId | True | integer |
The Id of the Asset. |
Get an asset for an external Id
Get the details of an asset for an external Id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Asset External Id
|
ExternalId | True | string |
The External Id of the Asset. |
Get assets
Get a list of all assets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
Get events
Get all events or filtered events.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Filter
|
filter | string |
Filter options for the events. |
Get tasks
Get all tasks or filtered tasks.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Filter
|
filter | string |
Filter options for the tasks. |
Submit evidence to a KPI
Check the evidence and add extracted data to a KPI.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
KPI Id
|
KPIId | True | integer |
The Id of the KPI. |
|
Evidence
|
Evidence | True | string |
The evidence object in JSON format. |
|
Task Id
|
TaskId | integer |
The Id of the task. |
|
|
Created
|
Created | date-time |
When the data point is created. |
|
|
CreatedBy
|
CreatedBy | string |
Name or email address of the user who created the data point. |
|
|
CreatedById
|
CreatedById | string |
Id of the user who created the data point. |
|
|
Comment
|
ResultComment | string |
The comment for the new KPI data point if accepted. |
Update a KPI data point
Update data for the specified KPI.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Org Unit Id
|
OrgUnitId | string |
The Id of the organizational unit. |
|
|
KPI Id
|
KPIId | integer |
The Id of the KPI. |
|
|
KPI Data Id
|
KPIDataId | integer |
The Id of the KPI data point. |
|
|
Created
|
Created | date-time |
When the data point is created. |
|
|
CreatedBy
|
CreatedBy | string |
Name or email address of the user who created the data point. |
|
|
CreatedById
|
CreatedById | string |
Id of the user who created the data point. |
|
|
Modified
|
Modified | date-time |
When the data point was Modified. |
|
|
ModifiedBy
|
ModifiedBy | string |
Name or email address of the user who modified the data point. |
|
|
ModifiedById
|
ModifiedById | string |
Id of the user who modified the data point. |
|
|
Value (Number)
|
ResultNumber | number |
The value of the KPI for type Number. |
|
|
Value (Text)
|
ResultText | string |
The value of the KPI for type Text. |
|
|
Comment
|
ResultComment | string |
The comment for this data point. |
Update a subtask for an event
Update a subtask for an event.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
|
Task Id
|
TaskId | True | integer |
The Id of the task. |
|
Task External Id
|
ExternalId | string |
The External Id of the task. |
|
|
Name
|
Name | string |
The name of the task. |
|
|
Description
|
Description | string |
The description of the task. |
|
|
Form Id
|
FormId | integer |
The form Id of the task. |
|
|
Status
|
Status | string |
The status of the task. |
|
|
Assignee Id
|
AssigneeId | string |
The user Id to which the task is assigned. |
|
|
Start Date Time
|
StartDateTime | date-time |
The start date and time of the task. |
|
|
End Date Time
|
EndDateTime | date-time |
The end date and time of the task. |
|
|
Deadline
|
Deadline | date-time |
The deadline of the task. |
|
|
Hidden
|
Hidden | boolean |
Whether the task is hidden in user views. |
Update a task
Update a task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Task Id
|
TaskId | True | integer |
The Id of the task. |
|
Task External Id
|
ExternalId | string |
The External Id of the task. |
|
|
Name
|
Name | string |
The name of the task. |
|
|
Description
|
Description | string |
The description of the task. |
|
|
Form Id
|
FormId | integer |
The form Id of the task. |
|
|
Status
|
Status | string |
The status of the task. |
|
|
Assignee Id
|
AssigneeId | string |
The user Id to which the task is assigned. |
|
|
Start Date Time
|
StartDateTime | date-time |
The start date and time of the task. |
|
|
End Date Time
|
EndDateTime | date-time |
The end date and time of the task. |
|
|
Deadline
|
Deadline | date-time |
The deadline of the task. |
|
|
Hidden
|
Hidden | boolean |
Whether the task is hidden in user views. |
Update an asset
Update an asset.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Asset Id
|
AssetId | True | integer |
The Id of the asset. |
|
Code
|
Code | string |
The code of the asset. |
|
|
Name
|
Name | string |
The name of the asset. |
|
|
Description
|
Description | string |
The description of the asset. |
|
|
Owner User Id
|
UserId | string |
The Id of User that represents the owner. |
|
|
Owner Role Id
|
RoleId | string |
The Id of Role that represents the owner. |
|
|
Type
|
Type | integer |
The type of asset. |
|
|
Status
|
State | string |
The status of the asset. |
|
|
Life cycle start
|
LifeCycleStart | date |
Life cycle start of the Asset. |
|
|
Life cycle end
|
LifeCycleEnd | date |
Life cycle end of the Asset. |
|
|
Library Category Id
|
LibraryCategoryId | integer |
The Library Category Id connected to the asset. |
|
|
External Id
|
ExternalId | string |
The external Id of the asset. |
|
|
Container external Id collection
|
ExternalContainerIds | array of string |
Collection of containers of the asset. |
|
|
Tag Id
|
TagId | integer |
The Id of the tag. |
Update an event
Update an event
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
|
Event External Id
|
ExternalId | string |
The External Id of the event. |
|
|
Name
|
Name | string |
The name of the task. |
|
|
Description
|
Description | string |
The description of the task. |
|
|
Form Id
|
FormId | integer |
The form Id of the task. |
|
|
Status
|
Status | string |
The status of the task. |
Update an event from approval
Update an event from an approval result.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Event Id
|
EventId | True | integer |
The Id of the event. |
|
Final Result
|
Final | True | boolean |
Indicates whether this is the final result for this event. |
|
|
object |
Triggers
| When a risk is created |
When a risk is created. |
| When a risk is deleted |
When a risk is deleted. |
| When a risk is updated |
When a risk is updated. |
| When a task is created |
When a task is created based on the specified template. |
| When a task is deleted |
When a task is deleted based on the specified template. |
| When a task is updated |
When a task with the selected template is updated. |
| When an annual plan task is started |
When a task in the annual plan is ready to start according to schedule. |
| When an event is created |
When an event is created based on the specified template. |
| When an event is deleted |
When an event is deleted based on the specified template. |
| When an event is updated |
When an event with the selected template is updated. |
When a risk is created
When a risk is created.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | risk |
When a risk is deleted
When a risk is deleted.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | risk |
When a risk is updated
When a risk is updated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | risk |
When a task is created
When a task is created based on the specified template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Template
|
EventTypeId | True | integer |
Choose the task template. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | task |
When a task is deleted
When a task is deleted based on the specified template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Template
|
EventTypeId | True | integer |
Choose the task template. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | task |
When a task is updated
When a task with the selected template is updated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Template
|
EventTypeId | True | integer |
Choose the task template. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | task |
When an annual plan task is started
When a task in the annual plan is ready to start according to schedule.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Template
|
EventTypeId | True | integer |
Choose the annual plan task. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | task |
When an event is created
When an event is created based on the specified template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Template
|
EventTypeId | True | integer |
Choose the event template. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | event |
When an event is deleted
When an event is deleted based on the specified template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Template
|
EventTypeId | True | integer |
Choose the event template. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | event |
When an event is updated
When an event with the selected template is updated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Org Unit Id
|
orgunitid | True | string |
The Organizational Unit Id. |
|
Workflow Name
|
WorkflowName | string |
The name of the workflow shown in ISOPlanner. |
|
|
Secret
|
Secret | string |
The secret to protect from unauthorized activation. |
|
|
Template
|
EventTypeId | True | integer |
Choose the event template. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TraceId
|
TraceId | string |
Unique Id for this trigger request. |
|
Secret
|
Secret | string |
Secret to protect from unauthorized activation. |
|
Payload
|
Payload | event |
Definitions
task
| Name | Path | Type | Description |
|---|---|---|---|
|
Org Unit Id
|
OrgUnitId | string |
The Id of the organizational unit. |
|
Task Id
|
TaskId | integer |
The Id of the task. |
|
Task External Id
|
ExternalId | string |
The External Id of the task. |
|
Task Type
|
TaskType | integer |
The type of the task. |
|
Form Id
|
FormId | integer |
The form Id of the task. |
|
Status
|
Status | string |
The status of the task. |
|
Name
|
Name | string |
The name of the task. |
|
Description
|
Description | string |
The description of the task. |
|
Task Created
|
Created | date-time |
Date and time when the task was created. |
|
Creator
|
Creator | creator | |
|
Assignee Id
|
AssigneeId | string |
The user Id to which the task is assigned. |
|
Assignee Name
|
AssigneeName | string |
The user name to which the task is assigned. |
|
Assignee Email
|
AssigneeEmail | string |
The user email to which the task is assigned. |
|
Calendar Event Id
|
CalendarEventId | string |
The Id of the Outlook calendar event. |
|
Calendar Event UID
|
CalendarEventUID | string |
The unique Id of the Outlook calendar event. |
|
Start Date Time
|
StartDateTime | date-time |
The start date and time of the task. |
|
End Date Time
|
EndDateTime | date-time |
The end date and time of the task. |
|
Deadline
|
Deadline | date-time |
The deadline of the task. |
|
Library
|
Library | array of libraryitem |
Collection of Library items of the task. |
|
Tags
|
Tags | array of tag |
Collection of tags of the task. |
|
ISOPlanner Task URL
|
Url | string |
The Url of this task in ISOPlanner. |
|
Hidden
|
Hidden | boolean |
Whether the task is hidden in user views. |
event
| Name | Path | Type | Description |
|---|---|---|---|
|
Org Unit Id
|
OrgUnitId | string |
The Id of the organizational unit. |
|
Event Id
|
EventId | integer |
The Id of the event. |
|
Event External Id
|
ExternalId | string |
The External Id of the event. |
|
Event Name
|
Name | string |
The name of the template. |
|
Event Description
|
Description | string |
The description of the template. |
|
Event Created
|
Created | date-time |
Date and time when the template was created. |
|
Creator
|
Creator | creator | |
|
Form Id
|
FormId | integer |
The form Id of the event. |
|
Status
|
Status | string |
Status of the event. |
|
Tags
|
Tags | array of tag |
Collection of Tags items of the event. |
|
Library
|
Library | array of libraryitem |
Collection of Library items of the event. |
|
First library item Id
|
FirstLibraryItemId | integer |
Id of the first library item. |
|
First library item Url
|
FirstLibraryItemUrl | string |
Url of the first library item. |
|
First library item name
|
FirstLibraryItemName | string |
Name of the first library item. |
|
Assignee email addresses
|
TaskAssigneeEmailAddresses | string |
Semicolon seperated email addresses of the assignees. |
|
Tasks
|
Tasks | array of task |
Collection of Subtasks of the event. |
|
ISOPlanner event URL
|
Url | string |
The Url of this event in ISOPlanner. |
|
Hidden
|
Hidden | boolean |
Whether the task is hidden in user views. |
libraryitem
| Name | Path | Type | Description |
|---|---|---|---|
|
Org Unit Id
|
OrgUnitId | string |
The Id of the organizational unit. |
|
Id
|
LibraryItemId | integer |
The Id of the Library item. |
|
Name
|
LibraryItemName | string |
The Name of the Library item. |
|
Url
|
LibraryItemUrl | string |
The Url of the Library item. |
|
LibraryItemOwner
|
LibraryItemOwner | owner | |
|
SharePoint Id
|
LibraryItemSPItemId | string |
The SharePoint Id of the Library item. |
|
SharePoint List Item Id
|
LibraryItemListItemId | string |
The SharePoint List Item Id of the Library item. |
|
SharePoint Drive Item Id
|
LibraryItemDriveItemId | string |
The SharePoint Drive Item Id of the Library item. |
|
SharePoint Page Id
|
LibraryItemPageItemId | string |
The SharePoint Page Id of the Library item. |
|
Category Id
|
LibraryCategoryId | integer |
The Category Id of the Library item. |
|
Category Name
|
LibraryCategoryName | string |
The Category Name of the Library item. |
|
Category Type
|
LibraryCategoryType | integer |
The Category Type of the Library item. |
|
Category SharePoint Site Id
|
LibraryCategorySiteId | string |
The Category SharePoint Site Id of the Library item. |
|
Category Url
|
LibraryCategoryUrl | string |
The Category Url of the Library item. |
|
SharePoint List Item Id
|
LibraryItemSPListItemId | integer |
The Id of the SharePoint List Item. |
|
SharePoint Item ETag
|
LibraryItemSPListETag | string |
The ETag of the SharePoint List Item. |
tag
| Name | Path | Type | Description |
|---|---|---|---|
|
Org Unit Id
|
OrgUnitId | string |
The Id of the organizational unit. |
|
Id
|
TagId | integer |
The Id of the tag. |
|
Name
|
TagName | string |
The Name of the tag. |
|
Value
|
TagValue | string |
The Value of the tag. |
|
Color
|
TagColor | string |
The Color of the tag. |
|
Info
|
TagInfo | string |
The Info of the tag. |
owner
| Name | Path | Type | Description |
|---|---|---|---|
|
Owner Id
|
UserId | string |
The Id of the owner. |
|
Owner Name
|
Name | string |
The name of the owner. |
|
Owner Email
|
string |
The email address of the owner. |
creator
| Name | Path | Type | Description |
|---|---|---|---|
|
Creator Id
|
UserId | string |
The Id of the creator. |
|
Creator Name
|
Name | string |
The name of the creator. |
|
Creator Email
|
string |
The email address of the creator. |
group
| Name | Path | Type | Description |
|---|---|---|---|
|
Group Id
|
GroupId | string |
The Id of the group. |
|
Group Name
|
Name | string |
The name of the group. |
|
Group Email
|
string |
The email address of the group. |
risk
| Name | Path | Type | Description |
|---|---|---|---|
|
Org Unit Id
|
OrgUnitId | string |
The Id of the organizational unit. |
|
Risk Id
|
RiskId | integer |
The Id of the risk. |
|
Code
|
Code | string |
The code of the risk. |
|
Name
|
Name | string |
The name of the risk. |
|
Risk State Id
|
RiskStateId | integer |
The Id of the risk state. |
|
Risk State
|
RiskState | string |
The risk state. |
|
Owner
|
Owner | owner | |
|
Group
|
Group | group | |
|
Risk description
|
Description | string |
The description risk. |
|
Asset description
|
AssetDescription | string |
The description of the related assets. |
|
Consequence
|
Analysis | string |
The consequence of the risk. |
|
Likelihood Start
|
LikelihoodStart | integer |
The likelihood of the risk (Start). |
|
Likelihood Current
|
LikelihoodCurrent | integer |
The likelihood of the risk (Current). |
|
Likelihood Goal
|
LikelihoodGoal | integer |
The likelihood of the risk (Goal). |
|
Impact Start
|
ImpactStart | integer |
The impact of the risk (Start). |
|
Impact Current
|
ImpactCurrent | integer |
The impact of the risk (Current). |
|
Impact Goal
|
ImpactGoal | integer |
The impact of the risk (Goal). |
|
Score Start
|
ScoreStart | integer |
The score of the risk (Start). |
|
Score Current
|
ScoreCurrent | integer |
The score of the risk (Current). |
|
Score Goal
|
ScoreGoal | integer |
The score of the risk (Goal). |
|
Treatment method
|
Method | integer |
The treatment method Id. |
|
Treatment strategy
|
Strategy | string |
The treatment strategy of the risk. |
|
ISOPlanner Risk URL
|
Url | string |
The Url of this risk in ISOPlanner. |
|
Tags
|
Tags | array of tag |
Collection of tags of the risk. |