Cyan Web API - Version 1

GET api/integrationSettings?{integrationId}

            Gets IntegrationSettings for a specific Integration.

Request Information

Parameters

Name	Description	Additional information
integrationId	No documentation available.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "integrationSettingId": "513dc1a2-f04f-4ec1-869f-bebdc38a7990",
    "integrationId": "ae1938f1-35fc-415d-b733-0d45bfa3ee41",
    "key": "sample string 3",
    "value": "sample string 4",
    "description": "sample string 5",
    "dataTypeLookupKey": "sample string 6",
    "createdDateUtc": "2025-07-05T15:55:28.2877912+00:00",
    "updatedDateUtc": "2025-07-05T15:55:28.2877912+00:00"
  },
  {
    "integrationSettingId": "513dc1a2-f04f-4ec1-869f-bebdc38a7990",
    "integrationId": "ae1938f1-35fc-415d-b733-0d45bfa3ee41",
    "key": "sample string 3",
    "value": "sample string 4",
    "description": "sample string 5",
    "dataTypeLookupKey": "sample string 6",
    "createdDateUtc": "2025-07-05T15:55:28.2877912+00:00",
    "updatedDateUtc": "2025-07-05T15:55:28.2877912+00:00"
  },
  {
    "integrationSettingId": "513dc1a2-f04f-4ec1-869f-bebdc38a7990",
    "integrationId": "ae1938f1-35fc-415d-b733-0d45bfa3ee41",
    "key": "sample string 3",
    "value": "sample string 4",
    "description": "sample string 5",
    "dataTypeLookupKey": "sample string 6",
    "createdDateUtc": "2025-07-05T15:55:28.2877912+00:00",
    "updatedDateUtc": "2025-07-05T15:55:28.2877912+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfIntegrationSettingRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <IntegrationSettingRepresentation>
    <CreatedDateUtc>2025-07-05T15:55:28.2877912+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:55:28.2877912+00:00</UpdatedDateUtc>
    <DataTypeLookupKey>sample string 6</DataTypeLookupKey>
    <Description>sample string 5</Description>
    <IntegrationId>ae1938f1-35fc-415d-b733-0d45bfa3ee41</IntegrationId>
    <IntegrationSettingId>513dc1a2-f04f-4ec1-869f-bebdc38a7990</IntegrationSettingId>
    <Key>sample string 3</Key>
    <Value>sample string 4</Value>
  </IntegrationSettingRepresentation>
  <IntegrationSettingRepresentation>
    <CreatedDateUtc>2025-07-05T15:55:28.2877912+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:55:28.2877912+00:00</UpdatedDateUtc>
    <DataTypeLookupKey>sample string 6</DataTypeLookupKey>
    <Description>sample string 5</Description>
    <IntegrationId>ae1938f1-35fc-415d-b733-0d45bfa3ee41</IntegrationId>
    <IntegrationSettingId>513dc1a2-f04f-4ec1-869f-bebdc38a7990</IntegrationSettingId>
    <Key>sample string 3</Key>
    <Value>sample string 4</Value>
  </IntegrationSettingRepresentation>
  <IntegrationSettingRepresentation>
    <CreatedDateUtc>2025-07-05T15:55:28.2877912+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:55:28.2877912+00:00</UpdatedDateUtc>
    <DataTypeLookupKey>sample string 6</DataTypeLookupKey>
    <Description>sample string 5</Description>
    <IntegrationId>ae1938f1-35fc-415d-b733-0d45bfa3ee41</IntegrationId>
    <IntegrationSettingId>513dc1a2-f04f-4ec1-869f-bebdc38a7990</IntegrationSettingId>
    <Key>sample string 3</Key>
    <Value>sample string 4</Value>
  </IntegrationSettingRepresentation>
</ArrayOfIntegrationSettingRepresentation>