機械翻訳について

移動先

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

プロジェクト内のエージェント・ツールの取得

get

/ic/api/integration/v1/projects/{projectId}/ai/tools/{id}

特定のエージェント・ツールの詳細を返します。

リクエスト

パス・パラメータ

• id(required): string
  エージェント・ツール識別子
• projectId(required): string
  プロジェクト識別子

問合せパラメータ

• integrationInstance(required): string
  これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。

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

トップに戻る

レスポンス

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

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

200レスポンス

操作の成功

本文()

ルート・スキーマ: ToolRs

すべてに一致

ソースを表示

• allOf ToolListRs
• オブジェクト ToolRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ToolListRs"
        },
        {
            "type":"object",
            "properties":{
                "guidelines":{
                    "type":"string",
                    "description":"Guidelines for the tool"
                },
                "parameters":{
                    "type":"object",
                    "additionalProperties":true,
                    "description":"Json node for the tool"
                },
                "annotations":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"boolean"
                    },
                    "description":"Annotations for the tool"
                },
                "endpointUrl":{
                    "type":"string",
                    "description":"Endpoint url for the tool"
                }
            }
        }
    ]
}

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

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• オブジェクト ToolListRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Tool name"
                },
                "code":{
                    "type":"string",
                    "description":"Tool code"
                },
                "type":{
                    "type":"string",
                    "description":"Tool type"
                },
                "status":{
                    "type":"string",
                    "description":"Tool Status"
                },
                "description":{
                    "type":"string",
                    "description":"Tool description"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Created"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Created By"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"Last Updated By"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Last Updated"
                },
                "projectId":{
                    "type":"string",
                    "description":"Project id which tool is part of"
                },
                "integration":{
                    "$ref":"#/components/schemas/ToolIntegrationRs",
                    "description":"Integration in use for the tool"
                },
                "connection":{
                    "$ref":"#/components/schemas/ToolConnectionRs",
                    "description":"Connection in use for the tool"
                }
            }
        }
    ]
}

ネストされたスキーマ : 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"
        }
    }
}

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

型: object

ソースを表示

• code: string
  ツールコード
• 接続: オブジェクト ToolConnectionRs
• created: string (date-time)
  作成
• createdBy: string
  作成者
• description: string
  ツールの説明
• 統合: オブジェクト ToolIntegrationRs
• lastUpdated: string (date-time)
  最終更新
• lastUpdatedBy: string
  最終更新者
• name: string
  ツール名
• projectId: string
  ツールが属するプロジェクトID
• status: string
  ツールのステータス
• type: string
  ツール・タイプ

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Tool name"
        },
        "code":{
            "type":"string",
            "description":"Tool code"
        },
        "type":{
            "type":"string",
            "description":"Tool type"
        },
        "status":{
            "type":"string",
            "description":"Tool Status"
        },
        "description":{
            "type":"string",
            "description":"Tool description"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Created"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Last Updated By"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Last Updated"
        },
        "projectId":{
            "type":"string",
            "description":"Project id which tool is part of"
        },
        "integration":{
            "$ref":"#/components/schemas/ToolIntegrationRs",
            "description":"Integration in use for the tool"
        },
        "connection":{
            "$ref":"#/components/schemas/ToolConnectionRs",
            "description":"Connection in use for the tool"
        }
    }
}

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

型: object

ソースを表示

• 注釈: オブジェクト 注釈
  許可される追加のプロパティ: additionalProperties

  ツールの注釈
• endpointUrl: 文字列
  ツールのエンドポイントURL
• ガイドライン: 文字列
  ツールのガイドライン
• parameters: object parameters
  追加プロパティを指定可能: true

  ツールのJsonノード

{
    "type":"object",
    "properties":{
        "guidelines":{
            "type":"string",
            "description":"Guidelines for the tool"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":true,
            "description":"Json node for the tool"
        },
        "annotations":{
            "type":"object",
            "additionalProperties":{
                "type":"boolean"
            },
            "description":"Annotations for the tool"
        },
        "endpointUrl":{
            "type":"string",
            "description":"Endpoint url for the tool"
        }
    }
}

ネストされたスキーマ: 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"
        }
    }
}

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

型: object

ソースを表示

• adapterName: 文字列
• artifactLocation: 文字列
• id: string
• name: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "artifactLocation":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "adapterName":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• id: string
• name: string
• projectCode: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "projectCode":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

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

型: object

使用可能なその他のプロパティ

ソースを表示

• boolean

{
    "type":"object",
    "additionalProperties":{
        "type":"boolean"
    },
    "description":"Annotations for the tool"
}

ツールの注釈

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

型: object

追加プロパティを指定可能: true

ツールのJsonノード

404レスポンス

エージェント・ツールが見つかりません

500レスポンス

サーバー・エラー

トップに戻る

例

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

例: エージェント・ツールCREATE_ORDER_TOOLの取得

このコマンドは、指定されたエージェント・ツールを取得します。

curl -X GET -H 'Authorization: Bearer access_token' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/ai/tools/CREATE_ORDER_TOOL?integrationInstance=service-instance

先頭に戻る