Cyan Web API - Version 1


POST api/integrations

            Creates an Integration resource within a tenant.
            

Request Information

Parameters

NameDescriptionAdditional information
integrationRepresentation

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "integrationId": "0284ec4f-8e33-4a0e-9fdb-0e5c6632bdfe",
  "tenantId": "1a331fbe-933b-4048-b60c-c72f86134ff7",
  "applicationId": "939e8efc-87da-4ade-9dab-2afa759ade28",
  "integrationTypeId": "1d22af13-26a2-4e51-baed-9486ee8816ce",
  "integrationTypeLookupKey": "sample string 5",
  "name": "sample string 6",
  "description": "sample string 7",
  "createdDateUtc": "2026-09-11T10:56:59.460144+00:00",
  "updatedDateUtc": "2026-09-11T10:56:59.460144+00:00"
}

application/xml, text/xml

Sample:
<IntegrationRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2026-09-11T10:56:59.460144+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-11T10:56:59.460144+00:00</UpdatedDateUtc>
  <ApplicationId>939e8efc-87da-4ade-9dab-2afa759ade28</ApplicationId>
  <Description>sample string 7</Description>
  <IntegrationId>0284ec4f-8e33-4a0e-9fdb-0e5c6632bdfe</IntegrationId>
  <IntegrationTypeId>1d22af13-26a2-4e51-baed-9486ee8816ce</IntegrationTypeId>
  <IntegrationTypeLookupKey>sample string 5</IntegrationTypeLookupKey>
  <Name>sample string 6</Name>
  <TenantId>1a331fbe-933b-4048-b60c-c72f86134ff7</TenantId>
</IntegrationRepresentation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IntegrationRepresentation'.