Omni
App · 20 actions
Manage Omni dashboards, folders, and labels, and run saved queries.
Actions
| Action | What it does |
|---|---|
| Create and publish document | Create and publish a document in Omni. |
| Create folder | Create folder in Omni. |
| Create label | Create label in Omni. |
| Delete document | Delete document in Omni. |
| Delete folder | Delete folder in Omni. |
| Delete label | Delete label in Omni. |
| Get current identity and permissions | Get current identity and permissions in Omni. |
| Get document state | Read the published state or the specified draft in Omni. |
| Get folder | Get folder in Omni. |
| Get label | Get label in Omni. |
| List document queries | List document queries in Omni. |
| List documents | List documents in Omni. |
| List folders | List folders in Omni. |
| List labels | List labels in Omni. |
| List models | List models in Omni. |
| Publish document draft | Publish the main draft of an Omni document. |
| Run a saved document query | Run a saved document query in Omni. |
| Search dashboards and apps | Search dashboards and apps in Omni. |
| Update document draft | Apply changes to a draft of an Omni document. |
| Update folder | Update folder in Omni. |
Create and publish document
Create and publish a document in Omni.
Inputs
- Model
model_idtextRequired - Model ID.
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
Outputs
dataobject- The Omni response.
Example output
{
"data": {
"description": "example",
"identifier": "example",
"name": "example"
}
}Create folder
Create folder in Omni.
Inputs
- Name
nametextRequired - Name.
- Parent folder
parent_folder_idtext - Parent folder ID.
- Scope
scopetext - Scope.One of:
organization,restricted. Default:organization.
Outputs
dataobject- Response value.
Example output
{
"data": {
"breadcrumbRoot": false,
"id": "example",
"name": "example",
"ownerId": "example",
"path": "example",
"scope": "organization"
}
}Create label
Create label in Omni.
Inputs
- Name
nametextRequired - Name.
- Color
colortext - Color.
- Description
descriptiontext - Description.
- Verified
verifiedtrue/false - Verified.Default:
false. - Homepage
homepagetrue/false - Homepage.Default:
false.
Outputs
dataobject- Response value.
Example output
{
"data": {
"color": "example",
"description": "example",
"homepage": false,
"name": "example",
"usage_count": 1,
"verified": false
}
}Delete document
Delete document in Omni.
Inputs
- Document
document_idtextRequired - Document ID.
Outputs
dataobject- Response value.
Example output
{
"data": {
"success": false
}
}Delete folder
Delete folder in Omni.
Inputs
- Folder
folder_idtextRequired - Folder ID.
Outputs
dataobject- Response value.
Example output
{
"data": {
"success": false
}
}Delete label
Delete label in Omni.
Inputs
- Label name
label_nametextRequired - Label name.
Outputs
dataobject- The Omni response.
Example output
{
"data": {}
}Get current identity and permissions
Get current identity and permissions in Omni.
Inputs
- Model
model_idtext - Model ID.
Outputs
dataobject- Response value.
Example output
{
"data": {
"keyScope": "user",
"orgRole": "MEMBER",
"rolesByModel": {},
"rolesByModelTruncated": false,
"user": {
"id": "example",
"membershipId": "example"
}
}
}Get document state
Read the published state or the specified draft in Omni.
Inputs
- Document
document_idtextRequired - Document ID.
Outputs
dataobject- The Omni response.
Example output
{
"data": {
"controls": {},
"description": "example",
"modelId": "example",
"name": "example",
"queryPresentations": {},
"settings": {},
"workbookModelId": "example"
}
}Get folder
Get folder in Omni.
Inputs
- Folder
folder_idtextRequired - Folder ID.
Outputs
dataobject- Response value.
Example output
{
"data": {
"breadcrumbRoot": false,
"id": "example",
"labels": [],
"name": "example",
"path": "example",
"url": "example"
}
}Get label
Get label in Omni.
Inputs
- Label name
label_nametextRequired - Label name.
Outputs
dataobject- Response value.
Example output
{
"data": {
"color": "example",
"description": "example",
"homepage": false,
"name": "example",
"usage_count": 1,
"verified": false
}
}List document queries
List document queries in Omni.
Inputs
- Document
document_idtextRequired - Document ID.
Outputs
dataobject- Response value.
Example output
{
"data": {
"queries": []
}
}List documents
List documents in Omni.
Inputs
- Labels
labelstext - Labels.
- Folder
folder_idtext - Folder ID.
- Page size
page_sizenumber - Page size.From 1 to 100. Default:
20. - Sort field
sort_fieldtext - Sort field.One of:
favorites,lastViewedAt,name,updatedAt,visits. Default:name. - Sort direction
sort_directiontext - Sort direction.One of:
asc,desc. Default:desc. - Cursor
cursortext - Cursor.
Outputs
dataobject- Response value.
Example output
{
"data": {
"pageInfo": {
"hasNextPage": false,
"nextCursor": "example",
"pageSize": 1,
"totalRecords": 1
},
"records": []
}
}List folders
List folders in Omni.
Inputs
- Path
pathtext - Path.
- Scope
scopetext - Scope.One of:
organization,restricted. Default:organization. - Sort field
sort_fieldtext - Sort field.One of:
favorites,name,path. Default:name. - Sort direction
sort_directiontext - Sort direction.One of:
asc,desc. Default:desc. - Cursor
cursortext - Cursor.
- Page size
page_sizenumber - Page size.At least 1. Default:
20.
Outputs
dataobject- Response value.
Example output
{
"data": {
"pageInfo": {
"hasNextPage": false,
"nextCursor": "example",
"pageSize": 1,
"totalRecords": 1
},
"records": []
}
}List labels
List labels in Omni.
Inputs
None.
Outputs
dataobject- Response value.
Example output
{
"data": {
"labels": []
}
}List models
List models in Omni.
Inputs
- Connection
target_connection_idtext - Connection ID.
- Model kind
model_kindtext - Model kind.One of:
SCHEMA,SHARED,SHARED_EXTENSION(Shared extension),WORKBOOK,BRANCH,QUERY,TOPIC,FIELD_PICKER_TOPIC(Field picker topic). - Name
nametext - Name.
- Page size
page_sizenumber - Page size.From 1 to 100. Default:
20. - Sort direction
sort_directiontext - Sort direction.One of:
asc,desc. - Sort field
sort_fieldtext - Sort field.One of:
name,modelKind,connectionId,baseModelId,createdAt,updatedAt. Default:updatedAt. - Page cursor
cursortext - Page cursor.
Outputs
dataobject- Response value.
Example output
{
"data": {
"pageInfo": {
"hasNextPage": false,
"nextCursor": "example",
"pageSize": 1,
"totalRecords": 1
},
"records": []
}
}Publish document draft
Publish the main draft of an Omni document.
Inputs
- Document
document_idtextRequired - Document ID.
Outputs
dataobject- The Omni response.
Example output
{
"data": {
"description": "example",
"identifier": "example",
"name": "example"
}
}Run a saved document query
Run a saved document query in Omni.
Inputs
- Document
document_idtextRequired - Document ID.
- Query
query_idtextRequired - Query ID.
- Filters
filtersobject - Filters.
- Format results
format_resultstrue/false - Format results.Default:
true.
Outputs
datalist- Response value.
Example output
{
"data": []
}Search dashboards and apps
Search dashboards and apps in Omni.
Inputs
- Limit
limitnumber - Limit.At most 25. Default:
10. - Search query
qtextRequired - Q.
Outputs
dataobject- Response value.
Example output
{
"data": {
"results": []
}
}Update document draft
Apply changes to a draft of an Omni document.
Inputs
- Document
document_idtextRequired - Document ID.
- Name
nametext - Name.
- Description
descriptiontext - Description.
Outputs
dataobject- The Omni response.
Example output
{
"data": {
"description": "example",
"draftIdentifier": "example",
"identifier": "example",
"name": "example"
}
}Update folder
Update folder in Omni.
Inputs
- Folder
folder_idtextRequired - Folder ID.
- Name
nametext - Name.
Outputs
dataobject- Response value.
Example output
{
"data": {
"breadcrumbRoot": false,
"id": "example",
"name": "example",
"path": "example"
}
}