Compartilhar via


Jedox OData Hub

Connect to your Jedox OData Hub. Fetch data from the Olap server, stream data from the Integrator server or execute loads and jobs.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Jedox Support
URL https://support.jedox.com/
Email support@jedox.com
Connector Metadata
Publisher Jedox
Website https://jedox.com
Privacy Policy https://www.jedox.com/en/trust/data-protection-policy/
Categories Business Intelligence;Data

The Jedox OData Hub gives you access to Jedox data, allowing you to integrate Jedox databases and Integrator jobs in your automation and apps.

Prerequisites

In order to use this connector you will need either a Jedox Cloud Instance with an active OData Hub. If you don't have a Jedox Instance or OData Hub, you can create a free 30 days Jedox Trial.

How to get credentials

To use this connector, you need to use the username and password as for your Jedox Instance. If the Jedox instance uses Single Sign-on (SSO) or you are using a trial cloud instance, you will need to create a new account under Administration.

Get started with your connector

When using the connector for the first time, you will be promted to create a new connection. You can freely choose the connection name. For “OData Hub URL”, enter the full URL to Jedox OData Hub:

https://odata.{InstanceId}.cloud.jedox.com

For Jedox Cloud Trials, the URL should look like this:

https://trialXXX.odata2.cloud.jedox.com

Enter your username and password and click Create.

A full getting started guide can be found in the Jedox Knowledgebase

Known issues and limitations

  • The Jedox OData Hub connector requires a Jedox version of 21.3 or higher.
  • The Jedox OData Hub connector currently does not support Single Sign-On (SSO).

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
OData Hub URL string Provide the URL of the OData Hub instance. True
Username securestring Username for your cloud instance True
Password securestring Password for your cloud instance True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get cube by ID

Get the cube with the given ID in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. #_Years to ATT_Years.

Get cube cells

Get the cells from a cube. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties.

Get cubes

Get a list of cubes in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. #_Years to ATT_Years.

Get database by id

Get the database with the given ID.

Get databases

Get a list of databases found in the server. System and config databases are excluded from the list, but can be requested by providing the ID.

Get dimension by ID

Get the dimension with the given ID in the given database.

Get dimensions

Get a list of dimensions in the given database.

Get element by ID

Returns the element with the given ID in the given dimension.

Get elements

Get a list of elements in the given dimension.

Get extract by Name

Get the extract with the given name in the given integrator project.

Get extract rows

Stream the rows of the extract with the given name in the given integrator project.

Get extracts

Get a list of extracts in the given integrator project.

Get Integrator project by name

Get the integrator project with the given name.

Get Integrator project group by identifier

Get the project group with the given ID.

Get Integrator project groups

Get a list of integrator project groups found in the server.

Get Integrator projects

Get a list of integrator projects found in the server.

Get job by name

Get the jobs with the given name in the given integrator project.

Get jobs

Get a list of jobs in the given integrator project.

Get load by name

Get the transform with the given name in the given integrator project.

Get loads

Get a list of loads in the given integrator project.

Get stored view by ID

Get the view with the given ID in the given database.

Get stored view cells

Get all cells from a view. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties.

Get stored views

Get a list of stored views in the given database.

Get transform by name

Get the transform with the given name in the given integrator project.

Get transform Rows

Stream the rows of the transform with the given name in the given integrator project.

Get transforms

Get a list of transforms in the given integrator project.

Run job

Run the job with the given name in the given integrator project. The execution will be added to the queue.

Run job with variables

Run the job with the given name in the given integrator project. The execution will be added to the queue.

Run load

Run the load with the given name in the given integrator project. The execution will be added to the queue.

Run load with variables

Run the load with the given name in the given integrator project. The execution will be added to the queue.

Get cube by ID

Get the cube with the given ID in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. #_Years to ATT_Years.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Cube Id
CubeId True integer

Numeric ID of the cube

Returns

Body
Cube

Get cube cells

Get the cells from a cube. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Cube Id
CubeId True integer

Numeric ID of the cube

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Currently the /Cells functions only support basic operations. Complex formulas might return an invalid result. For complex filtering, please use Views.

Base Elements Only
baseonly boolean

If set to true, the result will only contain base elements. If set to false, it will also contain consolidated elements.

Use Rules
userules boolean

If set to true, rules will be applied to the resulting cells.

Supress Zeros
zerosupression boolean

If set to true, numeric cells with a value of 0 and empty string cells will be removed from the result.

Disable Paging
disablepaging boolean

If set to true, the service will return the entire result instead of a single page. With this option set to true, the response might take multiple minutes depending on the cube's size.

Returns

The outputs of this operation are dynamic.

Get cubes

Get a list of cubes in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. #_Years to ATT_Years.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value CubeArray

Get database by id

Get the database with the given ID.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Returns

Body
Database

Get databases

Get a list of databases found in the server. System and config databases are excluded from the list, but can be requested by providing the ID.

Parameters

Name Key Required Type Description
Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value DatabaseArray

Get dimension by ID

Get the dimension with the given ID in the given database.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Dimension Id
DimensionId True integer

Numeric ID of the dimension

Returns

Body
Dimension

Get dimensions

Get a list of dimensions in the given database.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value DimensionArray

Get element by ID

Returns the element with the given ID in the given dimension.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Dimension Id
DimensionId True integer

Numeric ID of the dimension

Element Id
ElementId True integer

Numeric ID of the element

Returns

Body
Element

Get elements

Get a list of elements in the given dimension.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Dimension Id
DimensionId True integer

Numeric ID of the dimension

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value ElementArray

Get extract by Name

Get the extract with the given name in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Extract Name
ExtractName True string

The name of the extract

Returns

Get extract rows

Stream the rows of the extract with the given name in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Extract Name
ExtractName True string

The name of the extract

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

The outputs of this operation are dynamic.

Get extracts

Get a list of extracts in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value IntegratorComponentArray

Get Integrator project by name

Get the integrator project with the given name.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Returns

Get Integrator project group by identifier

Get the project group with the given ID.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Returns

Get Integrator project groups

Get a list of integrator project groups found in the server.

Parameters

Name Key Required Type Description
Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value IntegratorProjectGroupArray

Get Integrator projects

Get a list of integrator projects found in the server.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value IntegratorProjectArray

Get job by name

Get the jobs with the given name in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Job Name
JobName True string

The name of the job

Returns

Get jobs

Get a list of jobs in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value IntegratorComponentArray

Get load by name

Get the transform with the given name in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Load Name
LoadName True string

The name of the load

Returns

Get loads

Get a list of loads in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value IntegratorComponentArray

Get stored view by ID

Get the view with the given ID in the given database.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

View Id
ViewId True uuid

UUID of the view

Returns

Body
View

Get stored view cells

Get all cells from a view. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

View Id
ViewId True uuid

UUID of the view

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Currently the /Cells functions only support basic operations. Complex formulas might return an invalid result.

Base Elements Only
baseonly boolean

If set to true, the result will only contain base elements. If set to false, it will also contain consolidated elements.

Use Rules
userules boolean

If set to true, rules will be applied to the resulting cells.

Supress Zeros
zerosupression boolean

If set to true, numeric cells with a value of 0 and empty string cells will be removed from the result.

Disable Paging
disablepaging boolean

If set to true, the service will return the entire result instead of a single page. With this option set to true, the response might take multiple minutes depending on the view's size.

Returns

The outputs of this operation are dynamic.

Get stored views

Get a list of stored views in the given database.

Parameters

Name Key Required Type Description
Database Id
DatabaseId True integer

Numeric ID of the database

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value ViewArray

Get transform by name

Get the transform with the given name in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Transform Name
TransformName True string

The name of the transform

Returns

Get transform Rows

Stream the rows of the transform with the given name in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Transform Name
TransformName True string

The name of the transform

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

The outputs of this operation are dynamic.

Get transforms

Get a list of transforms in the given integrator project.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Top Count
$top integer

Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.

Skip Count
$skip integer

Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.

Filter
$filter string

The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.

Returns

Name Path Type Description
value
value IntegratorComponentArray

Run job

Run the job with the given name in the given integrator project. The execution will be added to the queue.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Job Name
JobName True string

The name of the job

Returns

Run job with variables

Run the job with the given name in the given integrator project. The execution will be added to the queue.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Job Name
JobName True string

The name of the job

Variables
Variables True string

Variable names and values seperated by an equal sign. If a variable is omitted, the default value will be used. Multiple variables must be seperated by commas. Example: Variables='SourceDB=Demo,TargetDB=Biker'

Returns

Run load

Run the load with the given name in the given integrator project. The execution will be added to the queue.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Load Name
LoadName True string

The name of the load

Returns

Run load with variables

Run the load with the given name in the given integrator project. The execution will be added to the queue.

Parameters

Name Key Required Type Description
Group Identifier
GroupIdentifier True string

The identifier of the Integrator project group

Project Name
ProjectName True string

The name of the Integrator project

Load Name
LoadName True string

The name of the load

Variables
Variables True string

Variable names and values seperated by an equal sign. If a variable is omitted, the default value will be used. Multiple variables must be seperated by commas. Example: Variables='SourceDB=Demo,TargetDB=Biker'

Returns

Definitions

Cube

Name Path Type Description
FilledCellCount
FilledCellCount integer
Id
Id integer
Name
Name string
Type
Type string

CubeArray

Name Path Type Description
Items
Cube

Database

Name Path Type Description
CubeCount
CubeCount integer
DimensionCount
DimensionCount integer
Id
Id integer
Name
Name string
Type
Type string

DatabaseArray

Name Path Type Description
Items
Database

Dimension

Name Path Type Description
ElementCount
ElementCount integer
Id
Id integer
Name
Name string
Type
Type string

DimensionArray

Name Path Type Description
Items
Dimension

Element

Name Path Type Description
Id
Id integer
Name
Name string
Position
Position integer
Type
Type string
Weight
Weight float

ElementArray

Name Path Type Description
Items
Element

IntegratorComponent

Name Path Type Description
Description
Description string
ModificationDate
ModificationDate date-time
Name
Name string
Type
Type string

IntegratorComponentArray

Name Path Type Description
Items
IntegratorComponent

IntegratorProject

Name Path Type Description
Description
Description string
ModificationDate
ModificationDate date-time
Name
Name string
Version
Version string

IntegratorProjectArray

Name Path Type Description
Items
IntegratorProject

IntegratorProjectGroup

Name Path Type Description
Description
Description string
Developer
Developer string
FriendlyName
FriendlyName string
Id
Id string
Name
Name string
Namespace
Namespace string
Version
Version string

IntegratorProjectGroupArray

Name Path Type Description
Items
IntegratorProjectGroup

IntegratorRunResult

Name Path Type Description
errors
errors integer
executionType
executionType string
id
id integer
startDate
startDate date-time
status
status string
traceAvailable
traceAvailable boolean
warnings
warnings integer

View

Name Path Type Description
CreationDate
CreationDate date-time
CubeId
CubeId integer
CubeName
CubeName string
Description
Description string
FriendlyName
FriendlyName string
Global
Global boolean
Id
Id uuid
UserName
UserName string

ViewArray

Name Path Type Description
Items
View