Dashboard API

For more details about Dashboard see For infos about Dashboard check Dashboard Big Picture

API usage guide

To access the OMN Dashboard REST API you can use basically any programming language that has support for the HTTP protocol. You can even use command line tools like curl to process REST requests.

Authentication

The OMN Dashboard REST API uses JSON Web Tokens (JWT) to secure the access. You have to provide a valid JWT in the authorization header to access the OMN Web REST API resources. To generate or debug JWTs you can use jwt.io.

curl header parameter
curl -H 'Authorization: Bearer <JWT-TOKEN>' ...

Error handling

For errors that can be handled by the client the REST API returns the http status code 4xx. The message contains a key that can be evaluated by the client. For all other errors, the http status code 5xx is returned.

Error-Response

{
  "statusCode": 404,
  "message": "Not found",
  "request": "/api/v1/dashboard/1/execute"
}

Version resource

The info resource provides version information about the OMN Dashboard REST API. This is a simple starting point to test your REST requests.

Table 1. Details

Resource path

/api/v1/dashboard/dashboardVersion

HTTP method

GET

Response type

application/json
Request:
curl -X GET 'http://<OMN-ADDRESS>/api/v1/dashboard/dashboardVersion' \
  -H 'Authorization: Bearer <JWT-TOKEN>'
Response:
{
    "apiVersion": "{project-version}",
    "processingTimeMillis": 13,
    "majorVersion": "{parsedversion-majorversion}",
    "minorVersion": "{parsedversion-minorversion}",
    "patchVersion": "{parsedversion-buildnumber}",
    "qualifier" : "{parsedversion-qualifier}",
    "buildDate": "{parsedversion-builddate}"
}

Query resource

The query REST-like resource handles execution of dashboard data queries.

Execute

The execute subresource provides structured data which can be used for different dashboard widgets (simple count, pie chart, bar graphs, tables, etc.).

Table 2. Details

Resource path

/api/v1/dashboard/query/{queryId}/execute

HTTP method

POST

Request type

application/json

Response type

depends on the executed query (see below)

By checking the response header field Content-Type the client can determine the type of the returned result.

The caller can provide parameters and meta parameters to query execution. While available parameters depend on the query, meta parameters are fixed for all queries, but some of them may be ignored during execution.

Table 3. Meta Parameters
Name Description Default value Example

count

Number of objects to be returned

10

 
{
 "metaParameters" : {
    "count" : 10
 }
}

sortAttribute

Attribute name to be sorted by

globalModificationDate

 
{
 "metaParameters" : {
    "sortAttribute" : "globalModificationDate"
 }
}

sortDirection

Sort direction (ASC or DESC)

DESC

 
{
 "metaParameters" : {
    "sortDirection" : "DESC"
 }
}

language

Localization culture

de_DE

 
{
 "metaParameters" : {
    "language" : "de_DE"
 }
}

Multiple meta parameters can be sent at the same time.

Table 4. Response types
Type Properties Example

Count data application/vnd.de.apollon.omn-dashboard.count+json

count - count value

exact - if count value is exact or not (if true it will indicate that there may be more data, could be indicated when displaying, e.g. with a "+" or a ">" sign)

countLabel - string describing what was counted

 
{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "count": 4711,
  "exact": true,
  "countLabel": "MAM Assets"
}

List of count data application/vnd.de.apollon.omn-dashboard.count-list+json

countItems - a list of individual items, each having:

label - string describing the item

count - count value of the item

exact - if count value is exact or not (if true it will indicate that there may be more data, could be indicated when displaying, e.g. with a "+" or a ">" sign)

also,

countLabel - string describing what was counted

 
{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "Image",
      "count" : 199,
      "exact": true
    },
    {
      "label": "Video",
      "count": 47,
      "exact": true
    },
    {
      "label" : "3D",
      "count": 11,
      "exact": true
    }
  ],
  "countLabel": "MAM Assets count by type"
}

List of objects application/vnd.de.apollon.omn-dashboard.object-list+json

objectItems - a list of individual items, each having a set of attributes

 
{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "objectItems": [
    {
      "globalIdentifier" : "db52f8b4-6425-4c5b-9adb-c8fa58392a79",
      "globalModificationDate" : "2020-08-12T21:00:00Z"
    },
    {
      "globalIdentifier" : "b950f87b-d5ff-4770-add4-af0838feb4e9",
      "globalModificationDate" : "2020-08-12T19:45:01Z"
    },
    {
      "globalIdentifier" : "abe6622e-a909-44f6-b438-02c7de0909d0",
      "globalModificationDate" : "2020-08-12T12:05:07Z"
    }
  ]
}

Value data application/vnd.de.apollon.omn-dashboard.value+json

value - value itself

type - type of the value (string, long, double, boolean, undefined)

 
{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "value": 1.5,
  "type": "double"
}

Attributes

The attributes subresource provides attributes (not parameters) list supported by the query.

Table 5. Details

Resource path

/api/v1/search/search/fields

HTTP method

GET

Response type

application/json
Table 6. Parameters
Name Description Default value Example

index

Index to get attributes for (ASSET, CHANNEL, PRODUCT, GLOBAL)

Applicable only to free-form queries (16, 17, 18)

GLOBAL

 
?index=GLOBAL

Each returned attribute has several properties:

Table 7. Properties
Name Description

fieldName

Attribute name

fieldType

Attribute type (string, long, double, boolean, date)

attrIdentifier

Attribute identifier used for queries based on this information

label

Label can be used for display or for translation

aggregatable

Whether the data can be aggregated on the attribute value (e.g. if you can count objects with different attribute values)

sortable

Whether the data can be sorted by the attribute value

Request:

curl -X GET 'https://<OMN-ADDRESS>/api/v1/search/search/fields?indexType=PRODUCT' \
  -H 'Authorization: Bearer <JWT Token>'

Response:

[
  {
    "fieldName": "WE_VKFAKTOR1",
    "label": "WE_VKFAKTOR1",
    "fieldType": "double",
    "aggregatable": false,
    "sortable": true,
    "multilingual": false,
    "attrIdentifier": "WE_VKFAKTOR1",
    "nestedFields": null
  }
]

Indexes

The indexes subresource provides indexes list supported by the query.

Table 8. Details

Resource path

/api/v1/dashboard/query/{queryId}/indexes

HTTP method

GET

Response type

application/json

Request:

curl -X GET 'https://<OMN-ADDRESS>/api/v1/dashboard/query/1/indexes' \
  -H 'Authorization: Bearer <JWT Token>'

Response:

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "indexes": [
    "ASSET",
    "CHANNEL",
    "PRODUCT",
    "GLOBAL"
  ]
}

Predefined query list

Count of assets (queryId: 1)

Returns simple count over all assets

Table 9. Details

Resource path

/api/v1/dashboard/query/1/execute

HTTP method

POST

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/1/execute' \
  -H 'Authorization: Bearer <JWT Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "count": 4711,
  "exact": true,
  "countLabel": "MAM Assets"
}

Count of assets by type (queryId: 2)

Returns a list of counts for assets grouped by type

Table 10. Details

Resource path

/api/v1/dashboard/query/2/execute

HTTP method

POST

Supported meta parameters: count, language

Use the meta parameter count to limit the maximal number of returned groups

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/2/execute' \
  -H 'Authorization: Bearer <JWT Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "metaParameters": {
    "count" : 3
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "Image",
      "count" : 199,
      "exact": true
    },
    {
      "label": "Video",
      "count": 47,
      "exact": true
    },
    {
      "label" : "3D",
      "count": 11,
      "exact": true
    }
  ],
  "countLabel": "MAM Assets count by type"
}

Count of channel objects by type (queryId: 3)

Returns a list of counts for channel objects by type

Table 11. Details

Resource path

/api/v1/dashboard/query/3/execute

HTTP method

POST

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/3/execute' \
  -H 'Authorization: Bearer <JWT Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "PM_Print_Section",
      "count" : 3,
      "exact": true
    },
    {
      "label": "PM_Print_Spread",
      "count": 13,
      "exact": true
    },
    {
      "label" : "PM_Print_Version",
      "count": 3,
      "exact": true
    }
  ],
  "countLabel": "Channel objects count by type"
}

Count of assets per root node (queryId: 4)

Returns a list of counts for assets by root node

Table 12. Details

Resource path

/api/v1/dashboard/query/4/execute

HTTP method

POST

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/4/execute' \
  -H 'Authorization: Bearer <JWT Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "MAM",
      "count" : 2567,
      "exact": true
    },
    {
      "label": "MAM_Upload",
      "count": 987,
      "exact": true
    },
    {
      "label" : "OnlineBriefing",
      "count": 50,
      "exact": true
    }
  ],
  "countLabel": "Assets count by root node"
}

Last modified products (queryId: 5)

Returns a list of products which has been last modified

Table 13. Details

Resource path

/api/v1/dashboard/query/5/execute

HTTP method

POST
Table 14. Parameters
Name Description Default value Example

resultAttributes

A list of strings with attributes to be returned

["globalIdentity", "globalModificationDate"]

 
{
  "parameters" : {
    "resultAttributes": [
      "globalIdentity",
      "globalModificationDate"
    ]
  }
}

Supported meta parameters: count, language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/5/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "resultAttributes": [
      "globalIdentity",
      "globalModificationDate"
    ]
  },
  "metaParameters": {
    "count" : 10,
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.object-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "objectItems": [
    {
      "globalIdentifier" : "db52f8b4-6425-4c5b-9adb-c8fa58392a79",
      "globalModificationDate" : "2020-08-12T21:00:00Z"
    },
    {
      "globalIdentifier" : "b950f87b-d5ff-4770-add4-af0838feb4e9",
      "globalModificationDate" : "2020-08-12T19:45:01Z"
    },
    {
      "globalIdentifier" : "abe6622e-a909-44f6-b438-02c7de0909d0",
      "globalModificationDate" : "2020-08-12T12:05:07Z"
    }
  ]
}

Assets count by size group (queryId: 6)

Returns a list of counts of assets by size groups

Table 15. Details

Resource path

/api/v1/dashboard/query/6/execute

HTTP method

POST

Pre-defined size groups:

< 1 MiB
1 MiB to 10 MiB
10 MiB to 100 MiB
100 MiB to 1 GiB
> 1 GiB

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/6/execute' \
  -H 'Authorization: Bearer <JWT Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "< 1 MiB",
      "count" : 1,
      "exact": true
    },
    {
      "label": "1 MiB to 1o MiB",
      "count": 2,
      "exact": true
    },
    {
      "label" : "10 MiB to 100 MiB",
      "count": 3,
      "exact": true
    },
    {
      "label" : "100 MiB to 1 GiB",
      "count": 4,
      "exact": true
    },
    {
      "label" : "> 1 GiB",
      "count": 5,
      "exact": true
    }
  ],
  "countLabel": "Assets count by size group"
}

Last modified assets (queryId: 7)

Returns a list of assets which has been last modified

Table 16. Details

Resource path

/api/v1/dashboard/query/7/execute

HTTP method

POST
Table 17. Parameters
Name Description Default value Example

resultAttributes

A list of strings with attributes to be returned

["globalIdentity", "globalModificationDate"]

 
{
  "parameters" : {
    "resultAttributes": [
      "globalIdentity",
      "globalModificationDate"
    ]
  }
}

rootNode

Root node configuration identifier (ISYObject~rootNodeConfiguration~identifier)

ignored

 
{
  "parameters" : {
    "rootNode": "MAM_Upload"
  }
}

Multiple parameters can be sent to the resource to specify the returned result set (see the request example below).

Supported meta parameters: count, language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/7/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "resultAttributes": [
      "globalIdentity",
      "globalModificationDate"
    ],
    "rootNode" : "MAM_Upload"
  },
  "metaParameters": {
    "count" : 20,
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.object-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "objectItems": [
    {
      "globalIdentifier" : "db52f8b4-6425-4c5b-9adb-c8fa58392a79",
      "globalModificationDate" : "2020-08-12T21:00:00Z"
    },
    {
      "globalIdentifier" : "b950f87b-d5ff-4770-add4-af0838feb4e9",
      "globalModificationDate" : "2020-08-12T19:45:01Z"
    },
    {
      "globalIdentifier" : "abe6622e-a909-44f6-b438-02c7de0909d0",
      "globalModificationDate" : "2020-08-12T12:05:07Z"
    }
  ]
}

PIM objects count by type (queryId: 8)

Returns a list of counts of PIM objects by type

Table 18. Details

Resource path

/api/v1/dashboard/query/8/execute

HTTP method

POST

Supported meta parameters: count, language

Use the meta parameter count to limit the maximal number of returned groups

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/8/execute' \
  -H 'Authorization: Bearer <JWT Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "metaParameters": {
    "count": 3
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "Product",
      "count" : 123,
      "exact": true
    },
    {
      "label": "Variation",
      "count": 35,
      "exact": true
    },
    {
      "label" : "Article",
      "count": 335,
      "exact": true
    }
  ],
  "countLabel": "Products count by type"
}

MAM upload activity (queryId: 9)

Returns a list of counts of MAM uploads by time period

Table 19. Details

Resource path

/api/v1/dashboard/query/9/execute

HTTP method

POST
Table 20. Parameters
Name Description Default value Example

timePeriod

Time period (day, month, week, quarter, year)

day

 
{
  "parameters" : {
    "timePeriod": "day"
  }
}

Supported meta parameters: count, language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/9/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "timePeriod": "day"
  },
  "metaParameters" : {
    "count" : 10,
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "2020-08-10",
      "count" : 123,
      "exact": true
    },
    {
      "label": "2020-08-03",
      "count": 35,
      "exact": true
    },
    {
      "label" : "2020-07-27",
      "count": 335,
      "exact": true
    }
  ],
  "countLabel": "MAM uploads per week"
}

Statistic of Asset Objects by specific attribute (queryId: 10)

Returns a list of counts of Assets by specific attribute

Table 21. Details

Resource path

/api/v1/dashboard/query/10/execute

HTTP method

POST
Table 22. Parameters
Name Description Default value Example

attribute

Attribute to aggregate on

globalObjectType

 
{
 "parameters" : {
    "attribute" : "globalObjectType"
 }
}

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/10/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "attribute" : "globalObjectType"
  },
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "IMG",
      "count" : 123,
      "exact": true
    },
    {
      "label": "MS",
      "count": 2,
      "exact": true
    }
  ],
  "countLabel": "Assets"
}

Statistic of Channel Objects by specific attribute (queryId: 11)

Returns a list of counts of Channels by specific attribute

Table 23. Details

Resource path

/api/v1/dashboard/query/11/execute

HTTP method

POST
Table 24. Parameters
Name Description Default value Example

attribute

Attribute to aggregate on

globalObjectType

 
{
 "parameters" : {
    "attribute" : "globalObjectType"
 }
}

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/11/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "attribute" : "globalObjectType"
  },
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "IMG",
      "count" : 123,
      "exact": true
    },
    {
      "label": "MS",
      "count": 2,
      "exact": true
    }
  ],
  "countLabel": "Channels"
}

Statistic of Product Objects by specific attribute (queryId: 12)

Returns a list of counts of Products by specific attribute

Table 25. Details

Resource path

/api/v1/dashboard/query/12/execute

HTTP method

POST
Table 26. Parameters
Name Description Default value Example

attribute

Attribute to aggregate on

globalObjectType

 
{
 "parameters" : {
    "attribute" : "globalObjectType"
 }
}

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/12/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "attribute" : "globalObjectType"
  },
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "IMG",
      "count" : 123,
      "exact": true
    },
    {
      "label": "MS",
      "count": 2,
      "exact": true
    }
  ],
  "countLabel": "Products"
}

Asset Objects by specific attribute value (queryId: 13)

Returns a list of Assets with specific attribute value

Table 27. Details

Resource path

/api/v1/dashboard/query/13/execute

HTTP method

POST
Table 28. Parameters
Name Description Default value Example

resultAttributes

A list of strings with attributes to be returned

["globalIdentity"]

 
{
  "parameters" : {
    "resultAttributes": [
      "globalIdentity"
    ]
  }
}

attributeValues

Attribute values to compare (each attribute may have a single value or a list of values)

ignored

 
{
 "parameters" : {
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
 }
}

Supported meta parameters: count, sortAttribute, sortDirection, language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/13/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "resultAttributes" : [
      "globalIdentity",
      "globalObjectType",
      "globalCreationDate"
    ],
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
  },
  "metaParameters": {
    "count" : 10,
    "sortAttribute" : "globalCreationDate",
    "sortDirection" : "DESC",
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.object-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "objectItems": [
    {
      "globalIdentifier" : "db52f8b4-6425-4c5b-9adb-c8fa58392a79",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T21:00:00Z"
    },
    {
      "globalIdentifier" : "b950f87b-d5ff-4770-add4-af0838feb4e9",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T19:45:01Z"
    },
    {
      "globalIdentifier" : "abe6622e-a909-44f6-b438-02c7de0909d0",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T12:05:07Z"
    }
  ]
}

Channel Objects by specific attribute value (queryId: 14)

Returns a list of Channels with specific attribute value

Table 29. Details

Resource path

/api/v1/dashboard/query/14/execute

HTTP method

POST
Table 30. Parameters
Name Description Default value Example

resultAttributes

A list of strings with attributes to be returned

["globalIdentity"]

 
{
  "parameters" : {
    "resultAttributes": [
      "globalIdentity"
    ]
  }
}

attributeValues

Attribute values to compare (each attribute may have a single value or a list of values)

ignored

 
{
 "parameters" : {
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
 }
}

Supported meta parameters: count, sortAttribute, sortDirection, language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/14/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "resultAttributes" : [
      "globalIdentity",
      "globalObjectType",
      "globalCreationDate"
    ],
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
  },
  "metaParameters": {
    "count" : 10,
    "sortAttribute" : "globalCreationDate",
    "sortDirection" : "DESC",
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.object-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "objectItems": [
    {
      "globalIdentifier" : "db52f8b4-6425-4c5b-9adb-c8fa58392a79",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T21:00:00Z"
    },
    {
      "globalIdentifier" : "b950f87b-d5ff-4770-add4-af0838feb4e9",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T19:45:01Z"
    },
    {
      "globalIdentifier" : "abe6622e-a909-44f6-b438-02c7de0909d0",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T12:05:07Z"
    }
  ]
}

Product Objects by specific attribute value (queryId: 15)

Returns a list of Products with specific attribute value

Table 31. Details

Resource path

/api/v1/dashboard/query/15/execute

HTTP method

POST
Table 32. Parameters
Name Description Default value Example

resultAttributes

A list of strings with attributes to be returned

["globalIdentity"]

 
{
  "parameters" : {
    "resultAttributes": [
      "globalIdentity"
    ]
  }
}

attributeValues

Attribute values to compare (each attribute may have a single value or a list of values)

ignored

 
{
 "parameters" : {
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
 }
}

Supported meta parameters: count, sortAttribute, sortDirection, language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/15/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "resultAttributes" : [
      "globalIdentity",
      "globalObjectType",
      "globalCreationDate"
    ],
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
  },
  "metaParameters": {
    "count" : 10,
    "sortAttribute" : "globalCreationDate",
    "sortDirection" : "DESC",
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.object-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "objectItems": [
    {
      "globalIdentifier" : "db52f8b4-6425-4c5b-9adb-c8fa58392a79",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T21:00:00Z"
    },
    {
      "globalIdentifier" : "b950f87b-d5ff-4770-add4-af0838feb4e9",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T19:45:01Z"
    },
    {
      "globalIdentifier" : "abe6622e-a909-44f6-b438-02c7de0909d0",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T12:05:07Z"
    }
  ]
}

Count of objects by query (queryId: 16)

Returns count of objects passing specific filter (query string)

Table 33. Details

Resource path

/api/v1/dashboard/query/16/execute

HTTP method

POST
Table 34. Parameters
Name Description Default value Example

index

Index to query (ASSET, CHANNEL, PRODUCT, GLOBAL)

GLOBAL

 
{
  "parameters" : {
    "index": "GLOBAL"
  }
}

queryString

Filter (query string) as Lucene Query, see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax

default field is globalName

*

 
{
 "parameters" : {
    "queryString" : "globalObjectType:IMG AND globalModificationDate:{* TO 2012-01-01}"
 }
}

Supported meta parameters: none

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/16/execute' \
  -H 'Authorization: Bearer <JWT Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "parameters" : {
    "index" : "ASSET",
    "queryString" : "globalObjectType:IMG AND globalModificationDate:{* TO 2012-01-01}"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "count": 4711,
  "exact": true,
  "countLabel": "Objects"
}

Count of objects by query and grouped by specific attribute (queryId: 17)

Returns a list of counts of objects passing specific filter (query string) by specific attribute

Table 35. Details

Resource path

/api/v1/dashboard/query/17/execute

HTTP method

POST
Table 36. Parameters
Name Description Default value Example

index

Index to query (ASSET, CHANNEL, PRODUCT, GLOBAL)

GLOBAL

 
{
  "parameters" : {
    "index": "GLOBAL"
  }
}

queryString

Filter (query string) as Lucene Query, see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax

default field is globalName

*

 
{
 "parameters" : {
    "queryString" : "globalObjectType:IMG AND globalModificationDate:{* TO 2012-01-01}"
 }
}

attribute

Attribute to aggregate on

globalObjectType

 
{
 "parameters" : {
    "attribute" : "globalObjectType"
 }
}

Supported meta parameters: none

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/17/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "index" : "ASSET",
    "queryString" : "globalObjectType:IMG AND globalModificationDate:{* TO 2012-01-01}",
    "attribute" : "globalObjectType"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "IMG",
      "count" : 123,
      "exact": true
    },
    {
      "label": "MS",
      "count": 2,
      "exact": true
    }
  ],
  "countLabel": "Objects"
}

List of objects by query (queryId: 18)

Returns a list of objects passing specific filter (query string)

Table 37. Details

Resource path

/api/v1/dashboard/query/18/execute

HTTP method

POST
Table 38. Parameters
Name Description Default value Example

index

Index to query (ASSET, CHANNEL, PRODUCT, GLOBAL)

GLOBAL

 
{
  "parameters" : {
    "index": "GLOBAL"
  }
}

queryString

Filter (query string) as Lucene Query, see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax

default field is globalName

*

 
{
 "parameters" : {
    "queryString" : "globalObjectType:IMG AND (globalModificationDate:{* TO 2012-01-01}"
 }
}

Supported meta parameters: count, sortAttribute, sortDirection

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/18/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "index" : "ASSET",
    "queryString" : "globalObjectType:IMG AND globalModificationDate:{* TO 2012-01-01}"
  },
  "metaParameters": {
    "count" : 10,
    "sortAttribute" : "globalCreationDate",
    "sortDirection" : "DESC"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.object-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "objectItems": [
    {
      "globalIdentifier" : "db52f8b4-6425-4c5b-9adb-c8fa58392a79",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T21:00:00Z"
    },
    {
      "globalIdentifier" : "b950f87b-d5ff-4770-add4-af0838feb4e9",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T19:45:01Z"
    },
    {
      "globalIdentifier" : "abe6622e-a909-44f6-b438-02c7de0909d0",
      "globalObjectType" : "IMG",
      "globalCreationDate" : "2020-08-12T12:05:07Z"
    }
  ]
}

Count objects in index by specific attribute value (queryId: 19)

Returns a count of object in a specific index with specific attribute value

Table 39. Details

Resource path

/api/v1/dashboard/query/19/execute

HTTP method

POST
Table 40. Parameters
Name Description Default value Example

index

Index to query (ASSET, CHANNEL, PRODUCT, GLOBAL)

GLOBAL

 
{
  "parameters" : {
    "index": "GLOBAL"
  }
}

attributeValues

Attribute values to compare (each attribute may have a single value or a list of values)

ignored

 
{
 "parameters" : {
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
 }
}

Supported meta parameters: language

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/19/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "index" : "ASSET",
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
  },
  "metaParameters": {
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "count": 4711,
  "exact": true,
  "countLabel": "Objects"
}

Count objects in index by specific attribute value grouped by specific attribute (queryId: 20)

Returns a list of counts for objects in a specific index with specific attribute value grouped by specific attribute

Table 41. Details

Resource path

/api/v1/dashboard/query/20/execute

HTTP method

POST
Table 42. Parameters
Name Description Default value Example

index

Index to query (ASSET, CHANNEL, PRODUCT, GLOBAL)

GLOBAL

 
{
  "parameters" : {
    "index": "GLOBAL"
  }
}

attributeValues

Attribute values to compare (each attribute may have a single value or a list of values)

ignored

 
{
 "parameters" : {
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
 }
}

attribute

Attribute to aggregate on

globalObjectType

 
{
 "parameters" : {
    "attribute" : "globalObjectType"
 }
}

Supported meta parameters: count, language

Use the meta parameter count to limit the maximal number of returned groups

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/20/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "index" : "ASSET",
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    },
    "attribute" : "globalObjectType"
  },
  "metaParameters": {
    "count" : 3
    "language" : "de_DE"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.count-list+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "countItems": [
    {
      "label" : "Image",
      "count" : 199,
      "exact": true
    },
    {
      "label": "Video",
      "count": 47,
      "exact": true
    },
    {
      "label" : "3D",
      "count": 11,
      "exact": true
    }
  ],
  "countLabel": "Objects"
}

Average value of objects attribute in index by specific attribute value (queryId: 21)

Returns average value of an attribute for objects in a specific index with specific attribute value

Table 43. Details

Resource path

/api/v1/dashboard/query/21/execute

HTTP method

POST
Table 44. Parameters
Name Description Default value Example

index

Index to query (ASSET, CHANNEL, PRODUCT, GLOBAL)

GLOBAL

 
{
  "parameters" : {
    "index": "GLOBAL"
  }
}

attributeValues

Attribute values to compare (each attribute may have a single value or a list of values)

ignored

 
{
 "parameters" : {
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    }
 }
}

attribute

Attribute to calculate average value from

null (will return null value)

 
{
 "parameters" : {
    "attribute" : "ISYObject~size"
 }
}

Supported meta parameters: none

Request:

curl -X POST 'https://<OMN-ADDRESS>/api/v1/dashboard/query/21/execute' \
-H 'Authorization: Bearer <JWT Token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  "parameters" : {
    "index" : "ASSET",
    "attributeValues" : {
        "globalObjectType": "IMG",
        "ISYObject~rootNodeConfiguration~identifier": ["MAM", "MAM_Upload"]
    },
    "attribute" : "ISYObject~size"
  }
}'

Response:

Content-Type: application/vnd.de.apollon.omn-dashboard.value+json

{
  "apiVersion": "{project-version}",
  "processingTimeMillis": 0,
  "value": 1.5,
  "type": "double"
}

Welcome to the AI Chat!

Write a prompt to get started...