Retrieve an Integration
get
/icsapis/v1/integrations/{code}/{version}
Retrieves an integration. Results include the extended metadata for the integration, but do not include the integration in its entirety (refer to the export API).
Request
Supported Media Types
- application/xml
- application/json
Path Parameters
- code
-
Type:
stringRequired:trueIntegration identifier- version
Type:stringRequired:trueIntegration version
Response
Supported Media Types
- application/json; charset=UTF-8
- application/xml; charset=UTF-8
200 Response
Successful operation
Body
Root Schema : ICSProjectResource
Type:
object- code
-
Type:
string - created
-
Type:
string(date-time) - createdBy
-
Type:
string - description
-
Type:
string - endPointURI
-
Type:
string - exportProjectName
-
Type:
string - icsFileArtifacts
-
Type:
objectICSFileArtifacts - icsFlowConfigContent
-
Type:
objectICSFlowConfigContent - icsFlowContent
-
Type:
objectICSFlowContent - lastUpdated
-
Type:
string(date-time) - lastUpdatedBy
-
Type:
string - links
-
Type:
arraylinksRequired:true - lockedBy
-
Type:
string - lockedDate
-
Type:
string(date-time) - lockedIntg
-
Type:
booleanDefault Value:false - mepType
-
Type:
string - mepTypeDescription
-
Type:
string - name
-
Type:
string - newIntg
-
Type:
booleanDefault Value:false - packageName
-
Type:
string - percentageComplete
-
Type:
number(double) - projectModelVersion
-
Type:
string - projectType
-
Type:
string - proxyWSDL
-
Type:
string - scheduleApplicable
-
Type:
booleanDefault Value:false - scheduleDefined
-
Type:
booleanDefault Value:false - sourceApplicationCode
-
Type:
string - sourceConnection
-
Type:
objectConnectionItem - status
-
Type:
string - targetApplicationCode
-
Type:
string - targetConnection
-
Type:
objectConnectionItem - tracingEnabled
-
Type:
booleanDefault Value:false - trackingInstanceName
-
Type:
string - trackingVariables
-
Type:
arraytrackingVariables - version
-
Type:
string
Nested Schema : ICSFileArtifacts
Type:
object- fileArtifacts
-
Type:
arrayfileArtifacts - links
-
Type:
arraylinks
Nested Schema : ICSFlowConfigContent
Type:
objectNested Schema : ICSFlowContent
Type:
objectNested 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 : trackingVariables
Type:
array-
Type:
objectTrackingVariableType
Nested Schema : fileArtifacts
Type:
array-
Type:
objectICSFileArtifact
Nested Schema : ICSFileArtifact
Type:
object- fileByteArray
-
Type:
arrayfileByteArray - fileType
-
Type:
string - links
-
Type:
arraylinks
Nested Schema : fileByteArray
Type:
array-
Type:
string(byte)
Nested Schema : Link
Type:
object- href
-
Type:
string - rel
-
Type:
string
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 : TrackingVariableType
Type:
object- description
-
Type:
string - messageContextRef
-
Type:
objectReferenceTypeRequired:true - name
-
Type:
stringRequired:true - primary
-
Type:
booleanDefault Value:false - property
-
Type:
arrayproperty - role
-
Type:
string - subRole
-
Type:
string - xpath
-
Type:
stringRequired:true
Nested Schema : ReferenceType
Type:
object- property
-
Type:
arrayproperty - refUri
-
Type:
string - role
-
Type:
string - subRole
-
Type:
string
Nested Schema : property
Type:
array-
Type:
objectPropertyType
Nested Schema : property
Type:
array-
Type:
objectPropertyType
Nested Schema : PropertyType
Type:
object- name
-
Type:
string - value
-
Type:
string
404 Response
Integration not found