Retrieve Connections
get
/icsapis/v1/connections
Retrieves a list of connections.
Request
Supported Media Types
- application/xml
- application/json
Query Parameters
- orderBy
-
Type:
stringOrders results by name, last updated time or type.- q
Type:stringFilters results by name and status.
Response
Supported Media Types
- application/json; charset=UTF-8
- application/xml; charset=UTF-8
200 Response
Successful operation
Body
Root Schema : Connections
Type:
objectNested Schema : items
Type:
array-
Type:
objectConnectionItem
Nested Schema : ConnectionItem
Type:
object- appInstConnProperties
-
Type:
arrayappInstConnPropertiesRequired:true - appInstCredProperties
-
Type:
arrayappInstCredPropertiesRequired:true - appType
-
Type:
objectApplicationTypeResource - code
-
Type:
string - imageURL
-
Type:
string - links
-
Type:
arraylinksRequired:true - name
-
Type:
string - percentageComplete
-
Type:
number(double) - securityPolicy
-
Type:
stringAllowed Values:[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TOKEN_BASED", "NONE", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS" ] - status
-
Type:
string - supportsCache
-
Type:
booleanDefault Value:false
Nested Schema : appInstConnProperties
Type:
array-
Type:
objectConnectionProperty
Nested Schema : appInstCredProperties
Type:
array-
Type:
objectConnectionProperty
Nested Schema : ApplicationTypeResource
Type:
object- appTypeConnProperties
-
Type:
arrayappTypeConnProperties - appTypeCredProperties
-
Type:
arrayappTypeCredProperties - appTypeLargeIconUrl
-
Type:
string - appTypeMediumGrayIconUrl
-
Type:
string - appTypeMediumIconUrl
-
Type:
string - appTypeMediumWhiteIconUrl
-
Type:
string - appTypeName
-
Type:
string - appTypeSmallIconUrl
-
Type:
string - displayName
-
Type:
string - features
-
Type:
string - source
-
Type:
string - supportedSecurityPolicies
-
Type:
string - vedorInfo
-
Type:
objectVendorInfo
Nested Schema : ConnectionProperty
Type:
object- acceptableKeys
-
Type:
arrayacceptableKeys - attachment
-
Type:
objectAttachment - customProperties
-
Type:
arraycustomProperties - displayName
-
Type:
string - hasAttachment
-
Type:
booleanDefault Value:false - integrationRole
-
Type:
stringAllowed Values:[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ] - length
-
Type:
integer(int32) - propertyDescription
-
Type:
string - propertyGroup
-
Type:
stringAllowed Values:[ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "OTHER" ] - propertyName
-
Type:
string - propertyShortDesc
-
Type:
string - propertyType
-
Type:
stringAllowed Values:[ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE" ] - propertyValue
-
Type:
string - required
-
Type:
booleanDefault Value:false
Nested Schema : Attachment
Type:
object- attachmentName
-
Type:
string - attachmentPropertyName
-
Type:
string - decodedContent
-
Type:
string - decodedContentBytes
-
Type:
arraydecodedContentBytes - localFilePath
-
Type:
string
Nested Schema : customProperties
Type:
array-
Type:
objectConnectionProperty
Nested Schema : Key
Type:
object- displayName
-
Type:
string - keyName
-
Type:
string
Nested Schema : decodedContentBytes
Type:
array-
Type:
string(byte)
Nested Schema : appTypeConnProperties
Type:
array-
Type:
objectConnectionProperty
Nested Schema : appTypeCredProperties
Type:
array-
Type:
objectConnectionProperty
Nested Schema : VendorInfo
Type:
object- contactUS
-
Type:
string - description
-
Type:
string - documentationURL
-
Type:
string - name
-
Type:
string - releaseNotes
-
Type:
string - supportURL
-
Type:
string
Nested Schema : Link
Type:
object- href
-
Type:
string - rel
-
Type:
string
400 Response
Malformed parameters