Jump to

• Request
• Response

Get a prompt

get

/hcmRestApi/resources/11.13.18.05/hcmPrompts/{hcmPromptsUniqID}

Request

Path Parameters

• hcmPromptsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PromptCode and UsecaseId ---for the AI Prompts resource and used to uniquely identify an instance of AI Prompts. The client should not generate the hash key value. Instead, the client should query on the AI Prompts collection resource with a filter on the primary key values in order to navigate to a specific instance of AI Prompts.
  
  For example: hcmPrompts?q=PromptCode=<value1>;UsecaseId=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hcmPrompts-item-response

Type: object

Show Source

• AvailableTokens: string
  Read Only: true

  Maximum Length: 2000

  List of tokens that can be used when the prompt is overridden.
• BoHierarchyClasspath: string
  Read Only: true

  Maximum Length: 200

  List of business objects hierarchies that can be used with the prompt.
• Configurable: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the prompt is configurable. Default value is Y. Valid values are Y and N.
• Description: string
  Read Only: true

  Maximum Length: 4000

  Description of the seeded prompt.
• EnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the seeded prompt is active. Default value is Y. Valid values are Y and N.
• ExtraProperties: string
  Read Only: true

  Maximum Length: 4000

  Additional properties for routing prompt execution requests to the correct resource.
• Family: string
  Read Only: true

  Maximum Length: 80

  Product family of the prompt.
• Label: string
  Read Only: true

  Maximum Length: 200

  Display label for the seeded prompt.
• LanguageOptIn: string
  Read Only: true

  Maximum Length: 4000

  Specifies the language of the prompt response.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModelCode: string
  Read Only: true

  Maximum Length: 255

  Code for a large language model.
• ModelProvider: string
  Read Only: true

  Maximum Length: 80

  Short name for a large language model provider.
• ModelVersion: string
  Read Only: true

  Maximum Length: 80

  Version of a large language model.
• ModuleId: string
  Read Only: true

  Maximum Length: 32

  Identifier for an application module.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Version number of the seeded object.
• PersistData: string
  Read Only: true

  Maximum Length: 1

  Indicates if the framework can persist the prompt model response. Default value is N. Valid values are Y and N.
• Product: string
  Read Only: true

  Maximum Length: 100

  Short name for a product.
• Prompt: string
  Read Only: true

  Maximum Length: 2000

  Text of the seeded prompt.
• PromptCode: string
  Read Only: true

  Maximum Length: 100

  Code for a seeded prompt.
• PromptTmpl: string (byte)
  Read Only: true

  Short name for the seeded prompt template.
• PromptTmplAiId: string
  Read Only: true

  Maximum Length: 32

  Identifier for a seeded prompt template.
• PromptTmplVersion: integer (int32)
  Read Only: true

  Version number of a seeded prompt template.
• UsecaseId: string
  Read Only: true

  Maximum Length: 100

  Identifier for a seeded use case.

{
    "type":"object",
    "properties":{
        "AvailableTokens":{
            "maxLength":2000,
            "type":"string",
            "description":"List of tokens that can be used when the prompt is overridden.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BoHierarchyClasspath":{
            "maxLength":200,
            "type":"string",
            "description":"List of business objects hierarchies that can be used with the prompt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Configurable":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the prompt is configurable. Default value is Y. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the seeded prompt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the seeded prompt is active. Default value is Y. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtraProperties":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional properties for routing prompt execution requests to the correct resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Family":{
            "maxLength":80,
            "type":"string",
            "description":"Product family of the prompt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Label":{
            "maxLength":200,
            "type":"string",
            "description":"Display label for the seeded prompt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LanguageOptIn":{
            "maxLength":4000,
            "type":"string",
            "description":"Specifies the language of the prompt response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code for a large language model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelProvider":{
            "maxLength":80,
            "type":"string",
            "description":"Short name for a large language model provider.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelVersion":{
            "maxLength":80,
            "type":"string",
            "description":"Version of a large language model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Identifier for an application module.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the seeded object.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PersistData":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the framework can persist the prompt model response. Default value is N. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Product":{
            "maxLength":100,
            "type":"string",
            "description":"Short name for a product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Prompt":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the seeded prompt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromptCode":{
            "maxLength":100,
            "type":"string",
            "description":"Code for a seeded prompt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromptTmpl":{
            "type":"string",
            "description":"Short name for the seeded prompt template.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromptTmplAiId":{
            "maxLength":32,
            "type":"string",
            "description":"Identifier for a seeded prompt template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromptTmplVersion":{
            "type":"integer",
            "description":"Version number of a seeded prompt template.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "UsecaseId":{
            "maxLength":100,
            "type":"string",
            "description":"Identifier for a seeded use case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

fetchBoHierarchy

Operation: /hcmRestApi/resources/11.13.18.05/hcmPrompts/{hcmPromptsUniqID}/action/fetchBoHierarchy

Parameters:

• hcmPromptsUniqID: $request.path.hcmPromptsUniqID

Get all the business objects registered for a seeded prompt.

Back to Top