機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

ルックアップの取得

get

/ic/api/integration/v1/lookups/{name}

指定された名前のルックアップに関する詳細情報を取得します。

リクエスト

パス・パラメータ

• name(required): string
  ルックアップ名

問合せパラメータ

• expand: string
  関連リソースを追加してルックアップ・リソースを展開します。
• integrationInstance(required): string
  これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json; charset=utf-8, application/vnd.oracle.resource+json,type=singular

200レスポンス

操作の成功

本文()

ルート・スキーマ : LookupRs

型: object

ソースを表示

• adapters: array adapters
  アダプタ・リスト
• columns: array columns
  列リスト
• created: string (date-time)
  作成日
• created-by: string
  作成者
• description: string
  参照摘要
• keywords: string
  キーワード
• last-updated: string (date-time)
  最終更新
• last-updated-by: string
  最終更新者
• locked-by: string
  ロック者
• locked-date: string (date-time)
  ロック日
• locked-dvm-flag: boolean
  ロック済DVMフラグ
• locked-flag: boolean
  ロック・フラグ
• name: string
  Lookup Name
• resource-path: string
  リソース・パス
• row-count: integer (int32)
  ルックアップ行数
• rows: array rows
  行リスト
• rows-as-array: array rows-as-array
• status: string
  参照ステータス
• usage: integer (int32)
  参照使用法
• usage-active: integer (int32)
  ルックアップ有効使用

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Lookup Name"
        },
        "description":{
            "type":"string",
            "description":"Lookup Description"
        },
        "row-count":{
            "type":"integer",
            "description":"Lookup Row Count",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"Lookup Status"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-updated":{
            "type":"string",
            "description":"Last Updated",
            "format":"date-time"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "locked-dvm-flag":{
            "type":"boolean",
            "description":"Locked DVM Flag"
        },
        "columns":{
            "type":"array",
            "description":"Column List",
            "items":{
                "type":"string"
            }
        },
        "created":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "adapters":{
            "type":"array",
            "description":"Adapter List",
            "items":{
                "$ref":"#/components/schemas/AdapterTypeRs"
            }
        },
        "usage":{
            "type":"integer",
            "description":"Lookup Usage",
            "format":"int32"
        },
        "usage-active":{
            "type":"integer",
            "description":"Lookup Active Usage",
            "format":"int32"
        },
        "rows":{
            "type":"array",
            "description":"Row List",
            "items":{
                "$ref":"#/components/schemas/SuiteLookupRowData"
            }
        },
        "rows-as-array":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "resource-path":{
            "type":"string",
            "description":"Resource Path"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        }
    }
}

ネストされたスキーマ : adapters

型: array

アダプタ・リスト

ソースを表示

• Array of: AdapterTypeRs

{
    "type":"array",
    "description":"Adapter List",
    "items":{
        "$ref":"#/components/schemas/AdapterTypeRs"
    }
}

ネストされたスキーマ: columns

型: array

列リスト

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Column List",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: rows

型: array

行リスト

ソースを表示

• Array of: object SuiteLookupRowData

{
    "type":"array",
    "description":"Row List",
    "items":{
        "$ref":"#/components/schemas/SuiteLookupRowData"
    }
}

ネストされたスキーマ : rows-as-array

型: array

ソースを表示

• Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : AdapterTypeRs

すべてに一致

ソースを表示

• allOf AdapterTypeBaseRs
• allOf IdRs
• object GenericRestRs
• object AdapterTypeRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AdapterTypeBaseRs"
        },
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "otherVersions":{
                    "type":"string"
                },
                "customSecurityPolicyDescription":{
                    "type":"string"
                },
                "oAuth3LeggedSupport":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SecurityPolicy"
                    }
                },
                "genericAuthSupport":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SecurityPolicy"
                    }
                },
                "testKey":{
                    "type":"string"
                },
                "validateAndTestKey":{
                    "type":"string"
                },
                "testMessage":{
                    "type":"string"
                },
                "validateAndTestMessage":{
                    "type":"string"
                },
                "infoMessage":{
                    "type":"string"
                },
                "wsdlvalidation":{
                    "type":"boolean"
                },
                "vendorInfo":{
                    "$ref":"#/components/schemas/AdapterVendorInfo"
                },
                "supportedSecurityPolicies":{
                    "type":"string"
                },
                "features":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "integrationRole":{
                    "$ref":"#/components/schemas/AdapterIntegrationRole"
                },
                "defaultSecurityPolicies":{
                    "type":"string"
                },
                "icons":{
                    "$ref":"#/components/schemas/AdapterIconsRs"
                }
            }
        }
    ]
}

ネストされたスキーマ : AdapterTypeBaseRs

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object AdapterTypeBaseRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : IdRs

すべてに一致

ソースを表示

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : GenericRestRs

型: object

ソースを表示

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

ネストされたスキーマ : IdRs-allOf[1]

型: object

ソースを表示

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : AdapterTypeBaseRs-allOf[2]

型: object

ソースを表示

• displayName: string
• name: string
• type: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : AdapterTypeRs-allOf[3]

型: object

ソースを表示

• customSecurityPolicyDescription: string
• defaultSecurityPolicies: string
• description: string
• features: string
• genericAuthSupport: array genericAuthSupport
• icons: object AdapterIconsRs
• infoMessage: string
• integrationRole: string
  許容値: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• oAuth3LeggedSupport: array oAuth3LeggedSupport
• otherVersions: string
• supportedSecurityPolicies: string
• testKey: string
• testMessage: string
• validateAndTestKey: string
• validateAndTestMessage: string
• vendorInfo: object AdapterVendorInfo
• version: string
• wsdlvalidation: boolean

{
    "type":"object",
    "properties":{
        "otherVersions":{
            "type":"string"
        },
        "customSecurityPolicyDescription":{
            "type":"string"
        },
        "oAuth3LeggedSupport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicy"
            }
        },
        "genericAuthSupport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicy"
            }
        },
        "testKey":{
            "type":"string"
        },
        "validateAndTestKey":{
            "type":"string"
        },
        "testMessage":{
            "type":"string"
        },
        "validateAndTestMessage":{
            "type":"string"
        },
        "infoMessage":{
            "type":"string"
        },
        "wsdlvalidation":{
            "type":"boolean"
        },
        "vendorInfo":{
            "$ref":"#/components/schemas/AdapterVendorInfo"
        },
        "supportedSecurityPolicies":{
            "type":"string"
        },
        "features":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "integrationRole":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        },
        "defaultSecurityPolicies":{
            "type":"string"
        },
        "icons":{
            "$ref":"#/components/schemas/AdapterIconsRs"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

ネストされたスキーマ : SuiteLink

型: object

ソースを表示

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : genericAuthSupport

型: array

ソースを表示

• Array of: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicy"
    }
}

ネストされたスキーマ : AdapterIconsRs

型: object

ソースを表示

• large-icon-url: string
• medium-gray-icon-url: string
• medium-icon-url: string
• medium-white-icon-url: string
• small-icon-url: string

{
    "type":"object",
    "properties":{
        "small-icon-url":{
            "type":"string"
        },
        "medium-icon-url":{
            "type":"string"
        },
        "large-icon-url":{
            "type":"string"
        },
        "medium-gray-icon-url":{
            "type":"string"
        },
        "medium-white-icon-url":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : oAuth3LeggedSupport

型: array

ソースを表示

• Array of: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicy"
    }
}

ネストされたスキーマ : AdapterVendorInfo

型: object

ソースを表示

• contact-us: string
• description: string
• documentation-url: string
• name: string
• release-notes: string
• support-url: string

{
    "type":"object",
    "properties":{
        "support-url":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "contact-us":{
            "type":"string"
        },
        "documentation-url":{
            "type":"string"
        },
        "release-notes":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : SuiteLookupRowData

型: object

ソースを表示

• row-data: array row-data

{
    "type":"object",
    "properties":{
        "row-data":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ : row-data

型: array

ソースを表示

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404レスポンス

ルックアップが見つかりません

500レスポンス

サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、ルックアップに関する詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: ルックアップに使用されているアダプタの詳細を含む参照国の詳細を取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=adapter" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/lookups/Country?integrationInstance=service-instance

例: ルックアップ国の詳細の取得

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/lookups/Country?integrationInstance=service-instance

レスポンス本文:

JSON形式のレスポンス本文のコンテンツの例を次に示します。

                   {
                       "columns": [
                         "osc",
                         "rightnow"
                       ],
                       "description": "Add Description",
                       "lastUpdated": "2017-01-11T13:54:05.100+0000",
                       "lastUpdatedBy": "jstein",
                       "links": [
                         {
                           "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country",
                           "rel": "self"
                         },
                         {
                           "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country",
                           "rel": "canonical"
                         }
                       ],
                       "lockedDVMFlag": false,
                       "name": "Country",
                       "rowCount": 2,
                       "status": "CONFIGURED"
                     }

                  {
                     "columns":    [
                        "D1",
                        "D2"
                     ],
                     "lastUpdated": "2016-12-18T15:50:26.964+0000",
                     "lastUpdatedBy": "jstein",
                     "links":    [
                              {
                           "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country",
                           "rel": "self"
                        },
                              {
                           "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country",
                           "rel": "canonical"
                        }
                     ],
                     "lockedDVMFlag": false,
                     "name": "Country",
                     "rowCount": 2,
                     "status": "CONFIGURED"
                  }

先頭に戻る