DataService API v2 — QueryingData

Base URL

https://demo.avaplace.com/api/asol/ds

Authentication

OAuth2 Bearer token required (scope: apiim)
See DataService-API.md for token acquisition

Overview

QueryingData endpoints provide access to processed, filtered, and transformed data based on integration configuration. Results can be navigated via paging or by direct result/item lookups.

Endpoints

/api/v2/QueryingData/GetData — Query processed data with filters
/api/v2/QueryingData/GetData/{resultId} — Get result details
/api/v2/QueryingData/GetData/{resultId}/{itemId} — Get result item details
/api/v2/QueryingData/GetData/ReferencedByFK — Query with foreign-key reference filters
/api/v2/QueryingData/GetData/FilteredByAK — Query with alternate-key filters

Query Parameters: `/api/v2/QueryingData/GetData` (GET)

Parameter	Type	Required	Description
`ModelId`	string (uuid)	No	Identifier of the data-model to query
`SourceId`	string (uuid)	No	Data-source filter (for source-specific queries)
`clientId`	string	No	Client/tenant identifier
`operationId`	string	No	Operation context identifier
`Offset`	integer	No	Pagination offset (0-based)
`Limit`	integer	No	Maximum number of records to return
`IncludeDeleted`	boolean	No	Include soft-deleted records in results
`MandantCode`	string	No	Mandant/tenant code filter
`RecordId`	string	No	Exact record identifier lookup
`ExternalId`	string	No	External system record identifier
`ReferenceId`	string	No	Reference identifier filter
`ModifiedFrom`	string (ISO 8601)	No	Include records modified from this timestamp
`ModifiedTo`	string (ISO 8601)	No	Include records modified until this timestamp
`IncludeLookupProperties`	boolean	No	Expand lookup field values instead of IDs
`ScenarioId`	string	No	Business scenario filter
`FeatureId`	string	No	Feature context identifier
`SelfSourceOnly`	boolean	No	Only include records from same source
`PublisherSourceId`	string	No	Filter by publisher source
`options`	string	No	Serialized query options (e.g., field selections, advanced filters)

Response Schema

Query results are returned as JObjectCollectionResult — a dynamic JSON object collection. The actual schema depends on the data-model structure:

{
  "hasData": true,
  "items": [
    {
      "id": "<uuid>",
      "externalId": "<string>",
      "referenceId": "<string>",
      "createdAt": "2024-01-01T10:00:00Z",
      "modifiedAt": "2024-01-01T10:00:00Z",
      "isDeleted": false,
      "fields": {
        "<fieldName>": "<value>",
        "<lookupFieldName>": {
          "id": "<uuid>",
          "displayValue": "<string>"
        }
      },
      "data": {}
    }
  ],
  "offset": 0,
  "limit": 50,
  "total": 125
}

Examples

Query data from model (basic filtering)

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData?ModelId=<modelId>&Offset=0&Limit=50&IncludeDeleted=false" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData'
$params = @{
    ModelId        = '<modelId>'
    Offset         = 0
    Limit          = 50
    IncludeDeleted = $false
}

$uri = $uri + '?' + (($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$($_.Value)" }) -join '&')

Invoke-RestMethod -Method Get `
  -Uri $uri `
  -Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }

Postman

Method: GET
URL: {{baseUrl}}/api/v2/QueryingData/GetData
Params:
- ModelId=<modelId>
- Offset=0
- Limit=50
- IncludeDeleted=false
Authorization: Bearer Token

Query with date range filter (modified records)

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData?ModelId=<modelId>&ModifiedFrom=2024-01-01T00:00:00Z&ModifiedTo=2024-01-31T23:59:59Z&Offset=0&Limit=50" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData?ModelId=<modelId>&ModifiedFrom=2024-01-01T00:00:00Z&ModifiedTo=2024-01-31T23:59:59Z&Offset=0&Limit=50'

Invoke-RestMethod -Method Get `
  -Uri $uri `
  -Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }

Query with lookup property expansion

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData?ModelId=<modelId>&IncludeLookupProperties=true&Offset=0&Limit=50" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData?ModelId=<modelId>&IncludeLookupProperties=true&Offset=0&Limit=50'

Invoke-RestMethod -Method Get `
  -Uri $uri `
  -Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }

Get specific result by ID

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/<resultId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/<resultId>'

Invoke-RestMethod -Method Get `
  -Uri $uri `
  -Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }

Get specific result item

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/<resultId>/<itemId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/<resultId>/<itemId>'

Invoke-RestMethod -Method Get `
  -Uri $uri `
  -Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }

Query with foreign-key reference filter

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/ReferencedByFK?ModelId=<modelId>&<fieldName>=<referencedId>&Offset=0&Limit=50" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/ReferencedByFK?ModelId=<modelId>&<fieldName>=<referencedId>&Offset=0&Limit=50'

Invoke-RestMethod -Method Get `
  -Uri $uri `
  -Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }

Query with alternate-key filter

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/FilteredByAK?ModelId=<modelId>&<akFieldName>=<akValue>&Offset=0&Limit=50" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/QueryingData/GetData/FilteredByAK?ModelId=<modelId>&<akFieldName>=<akValue>&Offset=0&Limit=50'

Invoke-RestMethod -Method Get `
  -Uri $uri `
  -Headers @{ Authorization = "Bearer $accessToken"; Accept = 'application/json' }

References

DataService REST API
SourcingData API — Complementary data publishing
DataModels API — Model structure definitions

Overview​

Endpoints​

Query Parameters: /api/v2/QueryingData/GetData (GET)​

Response Schema​

Examples​

Query data from model (basic filtering)​

curl​

PowerShell​

Postman​

Query with date range filter (modified records)​

curl​

PowerShell​

Query with lookup property expansion​

curl​

PowerShell​

Get specific result by ID​

curl​

PowerShell​

Get specific result item​

curl​

PowerShell​

Query with foreign-key reference filter​

curl​

PowerShell​

Query with alternate-key filter​

curl​

PowerShell​

References​

Overview

Endpoints

Query Parameters: `/api/v2/QueryingData/GetData` (GET)

Response Schema

Examples

Query data from model (basic filtering)

curl

PowerShell

Postman

Query with date range filter (modified records)

curl

PowerShell

Query with lookup property expansion

curl

PowerShell

Get specific result by ID

curl

PowerShell

Get specific result item

curl

PowerShell

Query with foreign-key reference filter

curl

PowerShell

Query with alternate-key filter

curl

PowerShell

References