Jump to

• Request
• Response
• Examples

Retrieve an Agent Pattern in a Project

get

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

Returns details of a specific Agent Pattern.

Request

Path Parameters

• id(required): string
  Agent Pattern 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 : schema

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Pattern Name"
                },
                "description":{
                    "type":"string",
                    "description":"Pattern Description"
                },
                "status":{
                    "type":"string",
                    "description":"Pattern Status"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"Last Updated By"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Last Updated"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Created Date"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Created By"
                },
                "code":{
                    "type":"string",
                    "description":"Code"
                },
                "version":{
                    "type":"string",
                    "description":"Version"
                },
                "updateBy":{
                    "type":"string",
                    "description":"Updated By"
                },
                "createdDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Created Date"
                },
                "updatedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Updated Date"
                },
                "patternRoles":{
                    "type":"array",
                    "description":"Pattern Roles",
                    "items":{
                        "$ref":"#/components/schemas/PatternRoles"
                    }
                },
                "dependencies":{
                    "$ref":"#/components/schemas/PatternDependencies",
                    "description":"Pattern Dependencies"
                },
                "usageCount":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Usage Count"
                },
                "projectId":{
                    "type":"string",
                    "description":"Automation id"
                },
                "lockedBy":{
                    "type":"string",
                    "description":"Locked By"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Locked Date"
                },
                "lockedFlag":{
                    "type":"boolean",
                    "description":"Locked Flag"
                },
                "id":{
                    "type":"string",
                    "description":"Pattern id"
                },
                "recipeSource":{
                    "$ref":"#/components/schemas/RecipeSource",
                    "description":"Recipe Source (System or Source)"
                },
                "maxIteration":{
                    "type":"integer",
                    "format":"int32"
                },
                "guidelines":{
                    "type":"string"
                }
            }
        }
    ]
}

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 : type

Type: object

Show Source

• code: string
  Code
• created: string (date-time)
  Created Date
• createdBy: string
  Created By
• createdDate: string (date-time)
  Created Date
• dependencies: object PatternDependencies
• description: string
  Pattern Description
• guidelines: string
• id: string
  Pattern id
• lastUpdated: string (date-time)
  Last Updated
• lastUpdatedBy: string
  Last Updated By
• lockedBy: string
  Locked By
• lockedDate: string (date-time)
  Locked Date
• lockedFlag: boolean
  Locked Flag
• maxIteration: integer (int32)
• name: string
  Pattern Name
• patternRoles: array patternRoles
  Pattern Roles
• projectId: string
  Automation id
• recipeSource: string
  Allowed Values: [ "System", "Store" ]

  Source of the recipe.

  Example: System
• status: string
  Pattern Status
• updateBy: string
  Updated By
• updatedDate: string (date-time)
  Updated Date
• usageCount: integer (int32)
  Usage Count
• version: string
  Version

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Pattern Name"
        },
        "description":{
            "type":"string",
            "description":"Pattern Description"
        },
        "status":{
            "type":"string",
            "description":"Pattern Status"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Last Updated By"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Last Updated"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Created Date"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "code":{
            "type":"string",
            "description":"Code"
        },
        "version":{
            "type":"string",
            "description":"Version"
        },
        "updateBy":{
            "type":"string",
            "description":"Updated By"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time",
            "description":"Created Date"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Updated Date"
        },
        "patternRoles":{
            "type":"array",
            "description":"Pattern Roles",
            "items":{
                "$ref":"#/components/schemas/PatternRoles"
            }
        },
        "dependencies":{
            "$ref":"#/components/schemas/PatternDependencies",
            "description":"Pattern Dependencies"
        },
        "usageCount":{
            "type":"integer",
            "format":"int32",
            "description":"Usage Count"
        },
        "projectId":{
            "type":"string",
            "description":"Automation id"
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked By"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Locked Date"
        },
        "lockedFlag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "id":{
            "type":"string",
            "description":"Pattern id"
        },
        "recipeSource":{
            "$ref":"#/components/schemas/RecipeSource",
            "description":"Recipe Source (System or Source)"
        },
        "maxIteration":{
            "type":"integer",
            "format":"int32"
        },
        "guidelines":{
            "type":"string"
        }
    }
}

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 : PatternDependencies

Type: object

Show Source

• integrations: array integrations
  Integration id's
• primaryIntegration: object Integration
• project: object PatternDependencyProject

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/PatternDependencyProject",
            "description":"Recipe Details"
        },
        "integrations":{
            "type":"array",
            "description":"Integration id's",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        },
        "primaryIntegration":{
            "$ref":"#/components/schemas/Integration",
            "description":"Primary Integration id"
        }
    }
}

Nested Schema : patternRoles

Type: array

Pattern Roles

Show Source

• Array of: object PatternRoles

{
    "type":"array",
    "description":"Pattern Roles",
    "items":{
        "$ref":"#/components/schemas/PatternRoles"
    }
}

Nested Schema : integrations

Type: array

Integration id's

Show Source

• Array of: object Integration

{
    "type":"array",
    "description":"Integration id's",
    "items":{
        "$ref":"#/components/schemas/Integration"
    }
}

Nested Schema : Integration

Type: object

Show Source

• code: string
  Integration Code
• name: string
  Integration Name
• status: string
  Integration Status
• type: string
  Integration Type
• version: string
  Integration Version

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Integration Code"
        },
        "version":{
            "type":"string",
            "description":"Integration Version"
        },
        "name":{
            "type":"string",
            "description":"Integration Name"
        },
        "status":{
            "type":"string",
            "description":"Integration Status"
        },
        "type":{
            "type":"string",
            "description":"Integration Type"
        }
    }
}

Nested Schema : PatternDependencyProject

Type: object

Show Source

• acceleratorId: string
• acceleratorLabel: string
• id: string

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

Nested Schema : PatternRoles

Type: object

Show Source

• connectionList: array connectionList
• guidelines: string
• maxIteration: integer (int32)
• role: string
• temperature: string

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "temperature":{
            "type":"string"
        },
        "maxIteration":{
            "type":"integer",
            "format":"int32"
        },
        "guidelines":{
            "type":"string"
        },
        "connectionList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PatternRoleConnection"
            }
        }
    }
}

Nested Schema : connectionList

Type: array

Show Source

• Array of: object PatternRoleConnection

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

Nested Schema : PatternRoleConnection

Type: object

Show Source

• adapterType: string
• connectionId: string
• llmModel: string
• name: string
• status: string

{
    "type":"object",
    "properties":{
        "connectionId":{
            "type":"string"
        },
        "adapterType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "llmModel":{
            "type":"string"
        }
    }
}

404 Response

Agent Pattern not found

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve a specific agent pattern in a project 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 pattern ORDER_PROCESSING_PATTERN in project TEST_PROJECT

This command retrieves the specified agent pattern in the specified project.

The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).

curl -X GET -H 'Authorization: Bearer access_token' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/ai/patterns/ORDER_PROCESSING_PATTERN%7C01.00.0000?integrationInstance=service-instance

Back to Top