接続の取得
get
/icsapis/v1/connections/{code}
接続を取得します。結果には接続の拡張メタデータが含まれますが、接続そのものの全体は含まれません。
リクエスト
サポートされるメディア・タイプ
- application/xml
- application/json
パス・パラメータ
- code
-
型:
string
必須:true
接続識別子
レスポンス
サポートされるメディア・タイプ
- application/json; charset=UTF-8
- application/xml; charset=UTF-8
200レスポンス
操作の成功
本文
ルート・スキーマ : ConnectionItem
型:
object
- appInstConnProperties
-
型:
array
appInstConnProperties必須:true
- appInstCredProperties
-
型:
array
appInstCredProperties必須:true
- appType
-
型:
object
ApplicationTypeResource - code
-
型:
string
- imageURL
-
型:
string
- links
-
型:
array
links必須:true
- name
-
型:
string
- percentageComplete
-
型:
number
(double
) - securityPolicy
-
型:
string
許可される値:[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TOKEN_BASED", "NONE", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS" ]
- status
-
型:
string
- supportsCache
-
型:
boolean
デフォルト値:false
ネストされたスキーマ : appInstConnProperties
型:
array
-
型:
object
ConnectionProperty
ネストされたスキーマ : appInstCredProperties
型:
array
-
型:
object
ConnectionProperty
ネストされたスキーマ : ApplicationTypeResource
型:
object
- appTypeConnProperties
-
型:
array
appTypeConnProperties - appTypeCredProperties
-
型:
array
appTypeCredProperties - appTypeLargeIconUrl
-
型:
string
- appTypeMediumGrayIconUrl
-
型:
string
- appTypeMediumIconUrl
-
型:
string
- appTypeMediumWhiteIconUrl
-
型:
string
- appTypeName
-
型:
string
- appTypeSmallIconUrl
-
型:
string
- displayName
-
型:
string
- features
-
型:
string
- source
-
型:
string
- supportedSecurityPolicies
-
型:
string
- vedorInfo
-
型:
object
VendorInfo
ネストされたスキーマ : ConnectionProperty
型:
object
- acceptableKeys
-
型:
array
acceptableKeys - attachment
-
型:
object
Attachment - customProperties
-
型:
array
customProperties - displayName
-
型:
string
- hasAttachment
-
型:
boolean
デフォルト値:false
- integrationRole
-
型:
string
許容される値:[ "SOURCE"、"TARGET"、"SOURCE_AND_TARGET" ]
- length
-
型:
integer
(int32
) - propertyDescription
-
型:
string
- propertyGroup
-
型:
string
許容される値:[ "CREDENTIALS"、"SOURCE_ARTIFACTS"、"CONNECTION_PROPS"、"OTHER" ]
- propertyName
-
型:
string
- propertyShortDesc
-
型:
string
- propertyType
-
型:
string
許容される値:[ "STRING"、"NUMBER"、"URL"、"WSDL_URL"、"XSD_URL"、"WADL_URL"、"FILE"、"PASSWORD"、"URL_OR_FILE"、"LIST"、"MAP"、"TEXT"、"CHOICE" ]
- propertyValue
-
型:
string
- required
-
型:
boolean
デフォルト値:false
ネストされたスキーマ : Attachment
型:
object
- attachmentName
-
型:
string
- attachmentPropertyName
-
型:
string
- decodedContent
-
型:
string
- decodedContentBytes
-
型:
array
decodedContentBytes - localFilePath
-
型:
string
ネストされたスキーマ : customProperties
型:
array
-
型:
object
ConnectionProperty
ネストされたスキーマ : Key
型:
object
- displayName
-
型:
string
- keyName
-
型:
string
ネストされたスキーマ : decodedContentBytes
型:
array
-
型:
string
(byte
)
ネストされたスキーマ : appTypeConnProperties
型:
array
-
型:
object
ConnectionProperty
ネストされたスキーマ : appTypeCredProperties
型:
array
-
型:
object
ConnectionProperty
ネストされたスキーマ : VendorInfo
型:
object
- contactUS
-
型:
string
- description
-
型:
string
- documentationURL
-
型:
string
- name
-
型:
string
- releaseNotes
-
型:
string
- supportURL
-
型:
string
ネストされたスキーマ : Link
型:
object
- href
-
型:
string
- rel
-
型:
string
404レスポンス
接続が見つかりません