Skip to content

Commit

Permalink
release: add new optimize version
Browse files Browse the repository at this point in the history
  • Loading branch information
@pepopowitz
pepopowitz committed Feb 7, 2025
1 parent 1907a91 commit 6d12e6f
Show file tree
Hide file tree
Showing 212 changed files with 12,107 additions and 1 deletion.
59 changes: 59 additions & 0 deletions ...ed_docs/version-3.15.0/apis-tools/optimize-api/configuration/disable-sharing.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
id: disable-sharing
title: "Disable sharing"
description: "The REST API to disable sharing"
---

This API allows users to disable the sharing functionality for all reports and dashboards in Optimize. Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).

When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.

## Method & HTTP target resource

POST `api/public/share/disable`

## Request headers

The following request headers must be provided with every request:

| Header | Constraints | Value |
| -------------- | ----------- | ------------------------------------------------------- |
| Authentication | REQUIRED | See [authentication](../optimize-api-authentication.md) |

## Query parameters

No query parameters necessary.

## Request body

An empty request body should be sent.

## Response codes

Possible HTTP Response Status codes:

| Code | Description |
| ---- | --------------------------------------------------------------------------------------------------------------------------- |
| 204 | Request successful. |
| 401 | Secret incorrect or missing in HTTP Header. See [authentication](../optimize-api-authentication.md) on how to authenticate. |
| 500 | Some error occurred while processing the request, best check the Optimize log. |

## Example

### Disable sharing

POST `api/public/share/disable`

#### Request header

`Authorization: Bearer mySecret`

#### Response

Status 204 (Successful)

#### Response content

```
no content
```
59 changes: 59 additions & 0 deletions ...ned_docs/version-3.15.0/apis-tools/optimize-api/configuration/enable-sharing.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
id: enable-sharing
title: "Enable sharing"
description: "The REST API to enable sharing"
---

This API allows users to enable the sharing functionality for all reports and dashboards in Optimize. Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).

If sharing had been previously enabled and then disabled, re-enabling sharing will allow users to access previously shared URLs under the same address as before. Calling this endpoint when sharing is already enabled will have no effect.

## Method & HTTP target resource

POST `api/public/share/enable`

## Request headers

The following request headers must be provided with every request:

| Header | Constraints | Value |
| -------------- | ----------- | ------------------------------------------------------- |
| Authentication | REQUIRED | See [authentication](../optimize-api-authentication.md) |

## Query parameters

No query parameters necessary.

## Request body

An empty request body should be sent.

## Response codes

Possible HTTP Response Status codes:

| Code | Description |
| ---- | --------------------------------------------------------------------------------------------------------------------------- |
| 204 | Request successful. |
| 401 | Secret incorrect or missing in HTTP Header. See [authentication](../optimize-api-authentication.md) on how to authenticate. |
| 500 | Some error occurred while processing the request, best check the Optimize log. |

## Example

### Enable sharing

POST `api/public/share/enable`

#### Request header

`Authorization: Bearer mySecret`

#### Response

Status 204 (Successful)

#### Response content

```
no content
```
64 changes: 64 additions & 0 deletions ...ioned_docs/version-3.15.0/apis-tools/optimize-api/dashboard/delete-dashboard.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: delete-dashboard
title: "Delete dashboards"
description: "The REST API to delete dashboards from Optimize."
---

The dashboards deletion API allows you to delete dashboards by ID from Optimize.

:::note Heads up!
The deletion of a dashboard does not affect the referenced reports.
:::

## Method & HTTP target resource

DELETE `/api/public/dashboard/{dashboard-ID}`

Where `dashboard-ID` is the ID of the dashboard you wish to delete.

## Request headers

The following request headers have to be provided with every delete request:

| Header | Constraints | Value |
| -------------- | ----------- | ------------------------------------------------------- |
| Authentication | REQUIRED | See [authentication](../optimize-api-authentication.md) |

## Query parameters

No query parameters available.

## Request body

No request body is required.

## Result

No response body.

## Response codes

Possible HTTP Response status codes:

| Code | Description |
| ---- | --------------------------------------------------------------------------------------------------------------------------- |
| 204 | Request successful. |
| 401 | Secret incorrect or missing in HTTP Header. See [authentication](../optimize-api-authentication.md) on how to authenticate. |
| 404 | The requested dashboard was not found, please check the provided dashboard-ID. |
| 500 | Some error occurred while processing the request, best check the Optimize log. |

## Example

### Delete a dashboard

Let's assume you want to delete a dashboard with the ID `e6c5abb1-6a18-44e7-8480-d562d511ba62`, this is what it would look like:

DELETE `/api/public/dashboard/e6c5aaa1-6a18-44e7-8480-d562d511ba62`

#### Request header

`Authorization: Bearer mySecret`

#### Response

Status 204.
136 changes: 136 additions & 0 deletions ...ersion-3.15.0/apis-tools/optimize-api/dashboard/export-dashboard-definitions.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
id: export-dashboard-definitions
title: "Export dashboard definitions"
description: "The REST API to export dashboard definitions."
---

This API allows users to export dashboard definitions which can later be imported into another Optimize system. Note that exporting a dashboard also exports all reports contained within the dashboard. The dashboards to be exported may be within a Collection or private entities, the API has access to both.

The obtained list of entity exports can be imported into other Optimize systems either using the dedicated [import API](../import-entities.md) or [via UI](components/userguide/additional-features/export-import.md#importing-entities).

## Method & HTTP target resource

POST `/api/public/export/dashboard/definition/json`

## Request headers

The following request headers have to be provided with every request:

| Header | Constraints | Value |
| -------------- | ----------- | --------------------------------------------------- |
| Authentication | REQUIRED | [Authentication](../optimize-api-authentication.md) |

## Query parameters

No query parameters available.

## Request body

The request body should contain a JSON array of dashboard IDs to be exported.

## Result

The response contains a list of exported dashboard definitions as well as all report definitions contained within the dashboards.

## Response codes

Possible HTTP response status codes:

| Code | Description |
| ---- | --------------------------------------------------------------------------------------------------------------------------- |
| 204 | Request successful. |
| 401 | Secret incorrect or missing in HTTP Header. See [authentication](../optimize-api-authentication.md) on how to authenticate. |
| 404 | At least one of the given dashboard IDs does not exist. |
| 500 | Some error occurred while processing the request, best check the Optimize log. |

## Example

### Export two dashboards

Assuming you want to export the two dashboards with IDs `123` and `456` and have configured the accessToken `mySecret`, this is what it would look like:

POST `/api/public/export/dashboard/definition/json`

#### Request header

`Authorization: Bearer mySecret`

#### Request body

```
[ "123", "456" ]
```

#### Response

Status 200.

#### Response content

The response contains the two exported dashboard definitions as well as all three process reports contained within the two dashboards.

```
[
{
"id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
"exportEntityType": "single_process_report",
"name": "Number: Process instance duration",
"description": "This report shows the average instance duration",
"sourceIndexVersion": 11,
"collectionId": null,
"data": {...}
},
{
"id": "625c2411-b95f-4442-936b-1976b9511d4a",
"exportEntityType": "single_process_report",
"name": "Heatmap: Flownode count",
"description": "This report shows a heatmap of the number of instances",
"sourceIndexVersion": 11,
"collectionId": null,
"data": {...}
},
{
"id": "94a7252e-d5c3-45ea-9906-75271cc0cac2",
"exportEntityType": "single_process_report",
"name": "Data Table: User task count",
"description": "This report shows number of user tasks",
"sourceIndexVersion": 11,
"collectionId": null,
"data": {...}
},
{
"id": "123",
"exportEntityType": "dashboard",
"name": "Dashboard 1",
"description": "A dashboard showing possible automation candidates",
"sourceIndexVersion": 8,
"reports": [
{
"id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
...
},
{
"id": "625c2411-b95f-4442-936b-1976b9511d4a",
...
}
],
"availableFilters": [...],
"collectionId": null
},
{
"id": "456",
"exportEntityType": "dashboard",
"name": "Dashboard 2",
"description": "A dashboard showing user task data",
"sourceIndexVersion": 8,
"reports": [
{
"id": "94a7252e-d5c3-45ea-9906-75271cc0cac2",
...
}
],
"availableFilters": [...],
"collectionId": null
}
]
```
74 changes: 74 additions & 0 deletions ...oned_docs/version-3.15.0/apis-tools/optimize-api/dashboard/get-dashboard-ids.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
id: get-dashboard-ids
title: "Get dashboard IDs"
description: "The REST API to retrieve all dashboard IDs in a given collection."
---

This API allows users to retrieve all dashboard IDs from a given collection.

## Method & HTTP target resource

GET `/api/public/dashboard`

## Request headers

The following request headers have to be provided with every request:

| Header | Constraints | Value |
| -------------- | ----------- | --------------------------------------------------- |
| Authentication | REQUIRED | [Authentication](../optimize-api-authentication.md) |

## Query parameters

The following query parameters have to be provided with every request:

| Parameter | Constraints | Value |
| ------------ | ----------- | ----------------------------------------------------------------- |
| collectionId | REQUIRED | The ID of the collection for which to retrieve the dashboard IDs. |

## Request body

No request body is required.

## Result

The response contains a list of IDs of the dashboards existing in the collection with the given collection ID.

## Response codes

Possible HTTP response status codes:

| Code | Description |
| ---- | --------------------------------------------------------------------------------------------------------------------------- |
| 200 | Request successful. |
| 401 | Secret incorrect or missing in HTTP Header. See [authentication](../optimize-api-authentication.md) on how to authenticate. |
| 500 | Some error occurred while processing the request, best check the Optimize log. |

## Example

### Retrieve all dashboard IDs from a collection

Assuming you want to retrieve all dashboard IDs in the collection with the ID `1234` and have configured the accessToken `mySecret`, this is what it would look like:

GET `/api/public/dashboard?collectionId=1234`

#### Request header

`Authorization: Bearer mySecret`

#### Response

Status 200.

#### Response content

```
[
{
"id": "9b0eb845-e8ed-4824-bd85-8cd69038f2f5"
},
{
"id": "1a866c7c-563e-4f6b-adf1-c4648531f7d4"
}
]
```
Loading

0 comments on commit 6d12e6f

Please sign in to comment.