Jump to

• Request
• Response
• Examples

Retrieve an Agent Tool in a Project

get

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

Returns details of a specific Agent Tool.

Request

Path Parameters

• id(required): string
  Agent Tool identifier
• projectId(required): string
  Project identifier

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : ToolRs

Match All

Show Source

• allOf ToolListRs
• object 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"
                }
            }
        }
    ]
}

Nested Schema : ToolListRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object 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"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

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

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

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

Nested Schema : ToolListRs-allOf[2]

Type: object

Show Source

• code: string
  Tool code
• connection: object ToolConnectionRs
• created: string (date-time)
  Created
• createdBy: string
  Created By
• description: string
  Tool description
• integration: object ToolIntegrationRs
• lastUpdated: string (date-time)
  Last Updated
• lastUpdatedBy: string
  Last Updated By
• name: string
  Tool name
• projectId: string
  Project id which tool is part of
• status: string
  Tool Status
• type: string
  Tool type

{
    "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"
        }
    }
}

Nested Schema : ToolRs-allOf[1]

Type: object

Show Source

• annotations: object annotations
  Additional Properties Allowed: additionalProperties

  Annotations for the tool
• endpointUrl: string
  Endpoint url for the tool
• guidelines: string
  Guidelines for the tool
• parameters: object parameters
  Additional Properties Allowed: true

  Json node for the tool

{
    "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"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• 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"
        }
    }
}

Nested Schema : ToolConnectionRs

Type: object

Show Source

• adapterName: string
• artifactLocation: string
• id: string
• name: string
• status: string

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

Nested Schema : ToolIntegrationRs

Type: object

Show Source

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

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

Nested Schema : annotations

Type: object

Additional Properties Allowed

Show Source

• boolean

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

Annotations for the tool

Nested Schema : parameters

Type: object

Additional Properties Allowed: true

Json node for the tool

404 Response

Agent Tool not found

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve a specific agent tool by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Retrieve agent tool CREATE_ORDER_TOOL

This command retrieves the specified agent 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

Back to Top