DataService API v2 — IntegrationAgents

Base URL

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

Authentication

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

---

Overview

What it covers

• Centralized metadata settings for the integration agent (agent/source/consumer)
• Patch settings / transformations / supported features
• Configure MessageGateway consumer
• Status history + set status

Endpoints

• /api/v2/IntegrationAgents/Settings — Get settings (SourceId, clientId optional)

• /api/v2/IntegrationAgents/Settings — Patch settings

• /api/v2/IntegrationAgents/Transformations — Get transformation settings

• /api/v2/IntegrationAgents/Transformations — Patch transformations (returns 204)

• /api/v2/IntegrationAgents/SupportedFeatures — Get supported features

• /api/v2/IntegrationAgents/SupportedFeatures — Patch supported features (returns 204)

• /api/v2/IntegrationAgents/ConfigureConsumer — Configure consumer (returns 204)

• /api/v2/IntegrationAgents/Statuses — Status history

• /api/v2/IntegrationAgents/Statuses — Set status (returns 204)

---

Query Parameters: /api/v2/IntegrationAgents/Settings (GET, PATCH)

Parameter	Type	Required	Description
SourceId	string (uuid)	No	The identifier of the data-source (optional)
clientId	string	No	The client identifier (optional)

---

Request Body: /api/v2/IntegrationAgents/Settings (PATCH)

Schema: IntegrationAgentPatchModel

Property	Type	Required	Description
agentDefinition	IntegrationAgentPatchSettings	No	Data agent registration settings
sourceDefinition	IntegrationSourcePatchSettings	No	Data source integration settings

IntegrationAgentPatchSettings:

Property	Type	Description
description	string	The description of data agent
customProperties	array[key-value]	Custom properties

IntegrationSourcePatchSettings:

Property	Type	Description
description	string	Data-source description
customProperties	array[key-value]	Custom properties
consumerType	string	Consumer type: None, Grpc, Webhook
consumerWebhookUrl	string	Web-hook URL assigned to data-source

---

Examples

Get integration agent settings

curl

curl -X GET "https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationAgents/Settings?SourceId=<sourceId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationAgents/Settings?SourceId=<sourceId>'

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

Postman

• Method: GET
• URL: {{baseUrl}}/api/v2/IntegrationAgents/Settings
• Params: SourceId=<sourceId>
• Authorization: Bearer Token

---

Patch integration agent settings

curl

curl -X PATCH "https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationAgents/Settings?SourceId=<sourceId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "agentDefinition": {
      "description": "Updated agent description",
      "customProperties": [
        { "key": "version", "value": "2.1" }
      ]
    },
    "sourceDefinition": {
      "description": "Updated source description",
      "consumerType": "Webhook",
      "consumerWebhookUrl": "https://example.com/webhook"
    }
  }'

PowerShell

$uri = 'https://demo.avaplace.com/api/asol/ds/api/v2/IntegrationAgents/Settings?SourceId=<sourceId>'

$body = @{
  agentDefinition = @{
    description      = 'Updated agent description'
    customProperties = @(@{ key = 'version'; value = '2.1' })
  }
  sourceDefinition = @{
    description         = 'Updated source description'
    consumerType        = 'Webhook'
    consumerWebhookUrl  = 'https://example.com/webhook'
  }
} | ConvertTo-Json -Depth 10

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

Postman

• Method: PATCH
• URL: {{baseUrl}}/api/v2/IntegrationAgents/Settings
• Params: SourceId=<sourceId>
• Authorization: Bearer Token
• Body → raw → JSON: same payload as above

---

References

• DataService REST API
• IntegrationProfiles API