Omni

App · 20 actions

Manage Omni dashboards, folders, and labels, and run saved queries.

Actions

ActionWhat it does
Create and publish documentCreate and publish a document in Omni.
Create folderCreate folder in Omni.
Create labelCreate label in Omni.
Delete documentDelete document in Omni.
Delete folderDelete folder in Omni.
Delete labelDelete label in Omni.
Get current identity and permissionsGet current identity and permissions in Omni.
Get document stateRead the published state or the specified draft in Omni.
Get folderGet folder in Omni.
Get labelGet label in Omni.
List document queriesList document queries in Omni.
List documentsList documents in Omni.
List foldersList folders in Omni.
List labelsList labels in Omni.
List modelsList models in Omni.
Publish document draftPublish the main draft of an Omni document.
Run a saved document queryRun a saved document query in Omni.
Search dashboards and appsSearch dashboards and apps in Omni.
Update document draftApply changes to a draft of an Omni document.
Update folderUpdate folder in Omni.

Create and publish document

Create and publish a document in Omni.

Inputs

Modelmodel_idtextRequired
Model ID.
NamenametextRequired
Name.
Descriptiondescriptiontext
Description.

Outputs

dataobject
The Omni response.
Example output
{
  "data": {
    "description": "example",
    "identifier": "example",
    "name": "example"
  }
}

Create folder

Create folder in Omni.

Inputs

NamenametextRequired
Name.
Parent folderparent_folder_idtext
Parent folder ID.
Scopescopetext
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

NamenametextRequired
Name.
Colorcolortext
Color.
Descriptiondescriptiontext
Description.
Verifiedverifiedtrue/false
Verified.Default: false.
Homepagehomepagetrue/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

Documentdocument_idtextRequired
Document ID.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "success": false
  }
}

Delete folder

Delete folder in Omni.

Inputs

Folderfolder_idtextRequired
Folder ID.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "success": false
  }
}

Delete label

Delete label in Omni.

Inputs

Label namelabel_nametextRequired
Label name.

Outputs

dataobject
The Omni response.
Example output
{
  "data": {}
}

Get current identity and permissions

Get current identity and permissions in Omni.

Inputs

Modelmodel_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

Documentdocument_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

Folderfolder_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 namelabel_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

Documentdocument_idtextRequired
Document ID.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "queries": []
  }
}

List documents

List documents in Omni.

Inputs

Labelslabelstext
Labels.
Folderfolder_idtext
Folder ID.
Page sizepage_sizenumber
Page size.From 1 to 100. Default: 20.
Sort fieldsort_fieldtext
Sort field.One of: favorites, lastViewedAt, name, updatedAt, visits. Default: name.
Sort directionsort_directiontext
Sort direction.One of: asc, desc. Default: desc.
Cursorcursortext
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

Pathpathtext
Path.
Scopescopetext
Scope.One of: organization, restricted. Default: organization.
Sort fieldsort_fieldtext
Sort field.One of: favorites, name, path. Default: name.
Sort directionsort_directiontext
Sort direction.One of: asc, desc. Default: desc.
Cursorcursortext
Cursor.
Page sizepage_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

Connectiontarget_connection_idtext
Connection ID.
Model kindmodel_kindtext
Model kind.One of: SCHEMA, SHARED, SHARED_EXTENSION (Shared extension), WORKBOOK, BRANCH, QUERY, TOPIC, FIELD_PICKER_TOPIC (Field picker topic).
Namenametext
Name.
Page sizepage_sizenumber
Page size.From 1 to 100. Default: 20.
Sort directionsort_directiontext
Sort direction.One of: asc, desc.
Sort fieldsort_fieldtext
Sort field.One of: name, modelKind, connectionId, baseModelId, createdAt, updatedAt. Default: updatedAt.
Page cursorcursortext
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

Documentdocument_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

Documentdocument_idtextRequired
Document ID.
Queryquery_idtextRequired
Query ID.
Filtersfiltersobject
Filters.
Format resultsformat_resultstrue/false
Format results.Default: true.

Outputs

datalist
Response value.
Example output
{
  "data": []
}

Search dashboards and apps

Search dashboards and apps in Omni.

Inputs

Limitlimitnumber
Limit.At most 25. Default: 10.
Search queryqtextRequired
Q.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "results": []
  }
}

Update document draft

Apply changes to a draft of an Omni document.

Inputs

Documentdocument_idtextRequired
Document ID.
Namenametext
Name.
Descriptiondescriptiontext
Description.

Outputs

dataobject
The Omni response.
Example output
{
  "data": {
    "description": "example",
    "draftIdentifier": "example",
    "identifier": "example",
    "name": "example"
  }
}

Update folder

Update folder in Omni.

Inputs

Folderfolder_idtextRequired
Folder ID.
Namenametext
Name.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "breadcrumbRoot": false,
    "id": "example",
    "name": "example",
    "path": "example"
  }
}

On this page