DataService API v2 — IntegrationProfiles
Base URL
https://demo.avaplace.com/api/asol/ds
Authentication
- OAuth2 Bearer token required (scope:
apiim) - See DataService-API.md for token acquisition
Overview
Integration profiles represent selected application/scenario/feature configuration, typically used for filtering and processing.
Endpoints
-
/api/v2/IntegrationProfiles— List profiles (filters + paging) -
/api/v2/IntegrationProfiles/{profileId}— Get profile -
/api/v2/IntegrationProfiles/{profileId}/AvailableFeatures— RequiressourceId -
/api/v2/IntegrationProfiles/{profileId}/AvailableModels— RequiressourceId -
/api/v2/IntegrationProfiles/Current— Current profile -
/api/v2/IntegrationProfiles/Current/AvailableFeatures— RequiressourceId -
/api/v2/IntegrationProfiles/Current/AvailableModels— RequiressourceId
Query Parameters: /api/v2/IntegrationProfiles (GET)
| Parameter | Type | Required | Description |
|---|---|---|---|
IsSelected | boolean | No | Filter by selected integration-profile |
Offset | integer | No | Pagination offset |
Limit | integer | No | Maximum number of results |
Released | boolean | No | Include released profiles |
Unreleased | boolean | No | Include unreleased profiles |
Deleted | boolean | No | Include deleted profiles |
Undeleted | boolean | No | Include non-deleted profiles |
Query Parameters: /api/v2/IntegrationProfiles/{profileId}/AvailableFeatures (GET)
| Parameter | Type | Required | Description |
|---|---|---|---|
profileId | string | Yes (path) | The identifier of integration-profile |
sourceId | string (uuid) | Yes (query) | The data-source identifier (mandatory) |
Query Parameters: /api/v2/IntegrationProfiles/{profileId}/AvailableModels (GET)
| Parameter | Type | Required | Description |
|---|---|---|---|
profileId | string | Yes (path) | The identifier of integration-profile |
sourceId | string (uuid) | Yes (query) | The data-source identifier (mandatory) |
Query Parameters: /api/v2/IntegrationProfiles/Current (GET)
| Parameter | Type | Required | Description |
|---|---|---|---|
sourceId | string (uuid) | No | The data-source identifier filter (optional) |
Query Parameters: /api/v2/IntegrationProfiles/Current/AvailableFeatures (GET)
| Parameter | Type | Required | Description |
|---|---|---|---|
sourceId | string (uuid) | Yes | The data-source identifier (mandatory) |
Query Parameters: /api/v2/IntegrationProfiles/Current/AvailableModels (GET)
| Parameter | Type | Required | Description |
|---|---|---|---|
sourceId | string (uuid) | Yes | The data-source identifier (mandatory) |
Examples
List integration profiles
curl
curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationProfiles?Offset=0&Limit=50&IsSelected=true" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"
PowerShell
$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationProfiles?Offset=0&Limit=50&IsSelected=true'
Invoke-RestMethod -Method Get `
-Uri $uri `
-Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }
Postman
- Method:
GET - URL:
{{baseUrl}}/api/v2/IntegrationProfiles - Params:
Offset=0,Limit=50,IsSelected=true - Authorization: Bearer Token
Get current profile with available features
curl
curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationProfiles/Current/AvailableFeatures?sourceId=<sourceId>" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"
PowerShell
$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationProfiles/Current/AvailableFeatures?sourceId=<sourceId>'
Invoke-RestMethod -Method Get `
-Uri $uri `
-Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }
Postman
- Method:
GET - URL:
{{baseUrl}}/api/v2/IntegrationProfiles/Current/AvailableFeatures - Params:
sourceId=<sourceId> - Authorization: Bearer Token