Jump to

• Request
• Response
• Examples

Retrieve a Prompt Template in a Project

get

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

Returns details of a specific Prompt Template.

Request

Path Parameters

• id(required): string
  Prompt Template 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":"Prompt Template Name"
                },
                "status":{
                    "type":"string",
                    "description":"Status"
                },
                "description":{
                    "type":"string",
                    "description":"Prompt Template Description"
                },
                "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"
                },
                "content":{
                    "type":"string",
                    "description":"Content"
                },
                "code":{
                    "type":"string",
                    "description":"Code"
                },
                "version":{
                    "type":"string",
                    "description":"Version"
                },
                "mapped":{
                    "type":"boolean",
                    "description":"Mapped"
                },
                "usage":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Prompt Template Usage"
                },
                "lockedBy":{
                    "type":"string",
                    "description":"Locked By"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Locked Date"
                },
                "lockedFlag":{
                    "type":"boolean",
                    "description":"Locked Flag"
                },
                "projectId":{
                    "type":"string",
                    "description":"Project id"
                },
                "typeId":{
                    "type":"string",
                    "description":"Type id"
                }
            }
        }
    ]
}

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
• content: string
  Content
• created: string (date-time)
  Created Date
• createdBy: string
  Created By
• description: string
  Prompt Template Description
• 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
• mapped: boolean
  Mapped
• name: string
  Prompt Template Name
• projectId: string
  Project id
• status: string
  Status
• typeId: string
  Type id
• usage: integer (int32)
  Prompt Template Usage
• version: string
  Version

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Prompt Template Name"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "description":{
            "type":"string",
            "description":"Prompt Template Description"
        },
        "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"
        },
        "content":{
            "type":"string",
            "description":"Content"
        },
        "code":{
            "type":"string",
            "description":"Code"
        },
        "version":{
            "type":"string",
            "description":"Version"
        },
        "mapped":{
            "type":"boolean",
            "description":"Mapped"
        },
        "usage":{
            "type":"integer",
            "format":"int32",
            "description":"Prompt Template Usage"
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked By"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Locked Date"
        },
        "lockedFlag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "projectId":{
            "type":"string",
            "description":"Project id"
        },
        "typeId":{
            "type":"string",
            "description":"Type id"
        }
    }
}

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

404 Response

Prompt Template not found

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve a specific prompt template 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 prompt template ORDER_CREATION_PROMPT

This command retrieves the specified prompt template.

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/templates/ORDER_CREATION_PROMPT%7C01.00.0000?integrationInstance=service-instance

Back to Top