Jump to

• Request
• Response
• Examples

Get all service AI agent metrics using advanced query

post

/api/boss/data/objects/ora/cxServiceCore/common/v1/serviceAIAgentMetrics/$query

Request

Query Parameters

• $effectiveDate: string(date)
  Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_query"
        },
        {
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"object",
                    "description":"Values to be applied in a parameterized filter specific to the view."
                }
            }
        }
    ]
}

Nested Schema : schema

Match All

Show Source

• object schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__item_query"
        },
        {
            "type":"object",
            "properties":{
                "collection":{
                    "type":"object",
                    "description":"Defines query criteria that can be applied on a resource collection.",
                    "properties":{
                        "filter":{
                            "type":"string",
                            "description":"The resource collection will be queried using the specified filter condition."
                        },
                        "limit":{
                            "type":"integer",
                            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                        },
                        "offset":{
                            "type":"integer",
                            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                        },
                        "includeTotalItems":{
                            "type":"boolean",
                            "description":"Specifies whether the server should estimate the total number of records for a given query and include the count in the response."
                        },
                        "sortBy":{
                            "type":"array",
                            "description":"Orders a resource collection based on the specified fields.",
                            "items":{
                                "oneOf":[
                                    {
                                        "type":"string",
                                        "description":"Name of field based on which sorting will happen. Order is ascending."
                                    },
                                    {
                                        "type":"object",
                                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                                    }
                                ]
                            }
                        },
                        "privilege":{
                            "type":"string",
                            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                        }
                    },
                    "additionalProperties":false
                }
            }
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• accessors: object accessors
  Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
• fields: array fields
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• subTypes: object subTypes
  Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

{
    "type":"object",
    "properties":{
        "fields":{
            "type":"array",
            "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
            "items":{
                "type":"string"
            }
        },
        "subTypes":{
            "type":"object",
            "description":"Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base."
        },
        "accessors":{
            "type":"object",
            "description":"Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• collection: object collection
  Defines query criteria that can be applied on a resource collection.

{
    "type":"object",
    "properties":{
        "collection":{
            "type":"object",
            "description":"Defines query criteria that can be applied on a resource collection.",
            "properties":{
                "filter":{
                    "type":"string",
                    "description":"The resource collection will be queried using the specified filter condition."
                },
                "limit":{
                    "type":"integer",
                    "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                },
                "offset":{
                    "type":"integer",
                    "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                },
                "includeTotalItems":{
                    "type":"boolean",
                    "description":"Specifies whether the server should estimate the total number of records for a given query and include the count in the response."
                },
                "sortBy":{
                    "type":"array",
                    "description":"Orders a resource collection based on the specified fields.",
                    "items":{
                        "oneOf":[
                            {
                                "type":"string",
                                "description":"Name of field based on which sorting will happen. Order is ascending."
                            },
                            {
                                "type":"object",
                                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                            }
                        ]
                    }
                },
                "privilege":{
                    "type":"string",
                    "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                }
            },
            "additionalProperties":false
        }
    }
}

Nested Schema : type

Type: object

Show Source

• parameters: object parameters
  Values to be applied in a parameterized filter specific to the view.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "description":"Values to be applied in a parameterized filter specific to the view."
        }
    }
}

Nested Schema : accessors

Type: object

Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.

Nested Schema : fields

Type: array

Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
    "items":{
        "type":"string"
    }
}

Nested Schema : subTypes

Type: object

Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

Nested Schema : collection

Type: object

Defines query criteria that can be applied on a resource collection.

Show Source

• filter: string
  The resource collection will be queried using the specified filter condition.
• includeTotalItems: boolean
  Specifies whether the server should estimate the total number of records for a given query and include the count in the response.
• limit: integer
  Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
• offset: integer
  Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
• privilege: string
  Represents the privilege or action required to check for while serving a request to access a resource.
• sortBy: array sortBy
  Orders a resource collection based on the specified fields.

{
    "type":"object",
    "description":"Defines query criteria that can be applied on a resource collection.",
    "properties":{
        "filter":{
            "type":"string",
            "description":"The resource collection will be queried using the specified filter condition."
        },
        "limit":{
            "type":"integer",
            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
        },
        "offset":{
            "type":"integer",
            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
        },
        "includeTotalItems":{
            "type":"boolean",
            "description":"Specifies whether the server should estimate the total number of records for a given query and include the count in the response."
        },
        "sortBy":{
            "type":"array",
            "description":"Orders a resource collection based on the specified fields.",
            "items":{
                "oneOf":[
                    {
                        "type":"string",
                        "description":"Name of field based on which sorting will happen. Order is ascending."
                    },
                    {
                        "type":"object",
                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                    }
                ]
            }
        },
        "privilege":{
            "type":"string",
            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
        }
    },
    "additionalProperties":false
}

Nested Schema : sortBy

Type: array

Orders a resource collection based on the specified fields.

Show Source

• Array of: items

{
    "type":"array",
    "description":"Orders a resource collection based on the specified fields.",
    "items":{
        "oneOf":[
            {
                "type":"string",
                "description":"Name of field based on which sorting will happen. Order is ascending."
            },
            {
                "type":"object",
                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
            }
        ]
    }
}

Nested Schema : items

Match One Schema

Show Source

• string
  Name of field based on which sorting will happen. Order is ascending.
• object type
  Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

{
    "oneOf":[
        {
            "type":"string",
            "description":"Name of field based on which sorting will happen. Order is ascending."
        },
        {
            "type":"object",
            "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
        }
    ]
}

Nested Schema : type

Type: object

Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order.

Nested Schema : parameters

Type: object

Values to be applied in a parameterized filter specific to the view.

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : serviceAIAgentMetrics_view-default

Match All

Show Source

• object __collection_context
• object serviceAIAgentMetrics_view-default-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_context"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/serviceAIAgentMetrics_item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean
• totalItems: object totalItems

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        },
        "totalItems":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"integer"
                },
                "qualifier":{
                    "type":"string",
                    "enum":[
                        "eq",
                        "gt",
                        "est",
                        "err"
                    ]
                }
            }
        }
    }
}

Nested Schema : serviceAIAgentMetrics_view-default-allOf[1]

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceAIAgentMetrics_item-response"
            }
        }
    }
}

Nested Schema : totalItems

Type: object

Show Source

• qualifier: string
  Allowed Values: [ "eq", "gt", "est", "err" ]
• value: integer

{
    "type":"object",
    "properties":{
        "value":{
            "type":"integer"
        },
        "qualifier":{
            "type":"string",
            "enum":[
                "eq",
                "gt",
                "est",
                "err"
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: oraCxServiceCoreCommon.ServiceAIAgentMetric_item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceAIAgentMetrics_item-response"
    }
}

Nested Schema : oraCxServiceCoreCommon.ServiceAIAgentMetric_item-response

Match All

Show Source

• allOf oraCxServiceCoreCommon.ServiceAIAgentMetric_item
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceAIAgentMetric_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : oraCxServiceCoreCommon.ServiceAIAgentMetric_item

Match All

The service AI agent metric contains information about invocation of AI agents and the subsequent interaction of humans with AI's recommendations.

Show Source

• object oraCxServiceCoreCommon.ServiceAIAgentMetric_item-fields
• object Service AI Agent Metric
  Title: Service AI Agent Metric

  The service AI agent metric contains information about invocation of AI agents and the subsequent interaction of humans with AI's recommendations.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ServiceAIAgentMetric_item-fields"
        },
        {
            "type":"object",
            "title":"Service AI Agent Metric",
            "x-hints":{
                "titlePlural":"Service AI Agent Metrics",
                "qualifiedTitle":"Service AI Agent Metric",
                "qualifiedTitlePlural":"Service AI Agent Metrics"
            },
            "description":"The service AI agent metric contains information about invocation of AI agents and the subsequent interaction of humans with AI's recommendations."
        }
    ]
}

Nested Schema : oraCxServiceCoreCommon.ServiceAIAgentMetric_item-fields

Type: object

Show Source

• agentCode: string
  Title: Agent Code

  The code for the agent of the service AI agent metric.
• agentTeamCode: string
  Title: Agent Team Code

  The code for the agent team of the service AI agent metric.
• agentTeamVersion: string (big-integer)
  Title: Agent Team Version

  The code for the agent team version of the service AI agent metric.
• agentVersion: string (big-integer)
  Title: Agent Version

  The agent version of the service AI agent metric.
• confidenceScore: integer (int32)
  Title: Confidence Score

  The confidence score of the service AI agent metric.
• confidenceScoreCode: confidenceScoreCode
• conversationNumber: string
  Title: Conversation Number

  The conversation number associated with the service AI agent metric.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• humanInLoopFlag: boolean
  Title: Human in Loop Flag

  Default Value: false

  The human in loop flag of the service AI agent metric.
• id: string (big-integer)
  Title: ID

  Read Only: true

  The unique identifier of the service AI agent metric.
• jobExecutionNumber: string
  Title: Job Execution Number

  The job execution number of the service AI agent metric.
• number: string
  Title: Number

  Read Only: true

  The number of the service AI agent metric.
• objectReferenceNumber: string
  Title: Object Reference Number

  The object reference number of the service AI agent metric.
• objectType: objectType
• outcomeObjectIdentifier: string (big-integer)
  Title: Outcome Object Identifier

  The outcome object identifier of the service AI agent metric.
• outcomeType: outcomeType
• recommendationDisplayFlag: boolean
  Title: Recommendation Display Flag

  Default Value: false

  The recommendation display flag of the service AI agent metric.
• serviceWorkflow: serviceWorkflow
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.
• userDecision: userDecision
• userFeedback: userFeedback
• userFeedbackComment: string
  Title: User Feedback Comment

  The user feedback comment of the service AI agent metric.
• userFeedbackRating: integer (int32)
  Title: User Feedback Rating

  The user feedback rating of the service AI agent metric.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"ID",
            "description":"The unique identifier of the service AI agent metric."
        },
        "number":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Number",
            "description":"The number of the service AI agent metric."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "agentTeamCode":{
            "type":"string",
            "x-searchable":true,
            "title":"Agent Team Code",
            "description":"The code for the agent team of the service AI agent metric."
        },
        "agentTeamVersion":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "title":"Agent Team Version",
            "description":"The code for the agent team version of the service AI agent metric."
        },
        "agentCode":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "title":"Agent Code",
            "description":"The code for the agent of the service AI agent metric."
        },
        "agentVersion":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "title":"Agent Version",
            "description":"The agent version of the service AI agent metric."
        },
        "objectReferenceNumber":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "title":"Object Reference Number",
            "description":"The object reference number of the service AI agent metric."
        },
        "jobExecutionNumber":{
            "type":"string",
            "x-searchable":true,
            "title":"Job Execution Number",
            "description":"The job execution number of the service AI agent metric."
        },
        "humanInLoopFlag":{
            "type":"boolean",
            "default":false,
            "title":"Human in Loop Flag",
            "description":"The human in loop flag of the service AI agent metric."
        },
        "recommendationDisplayFlag":{
            "type":"boolean",
            "default":false,
            "title":"Recommendation Display Flag",
            "description":"The recommendation display flag of the service AI agent metric."
        },
        "confidenceScoreCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Confidence Score Code",
                    "description":"The code for the confidence score of the service AI agent metric."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreCommon.ConfidenceScoreCode_enum"
                }
            ]
        },
        "confidenceScore":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "title":"Confidence Score",
            "description":"The confidence score of the service AI agent metric."
        },
        "userFeedbackRating":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "title":"User Feedback Rating",
            "description":"The user feedback rating of the service AI agent metric."
        },
        "userFeedbackComment":{
            "type":"string",
            "nullable":true,
            "title":"User Feedback Comment",
            "description":"The user feedback comment of the service AI agent metric."
        },
        "outcomeObjectIdentifier":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "x-searchable":true,
            "title":"Outcome Object Identifier",
            "description":"The outcome object identifier of the service AI agent metric."
        },
        "conversationNumber":{
            "type":"string",
            "nullable":true,
            "title":"Conversation Number",
            "description":"The conversation number associated with the service AI agent metric."
        },
        "objectType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Object Type Code",
                    "description":"The code for the object type of the service AI agent metric.",
                    "x-searchable":true
                }
            ]
        },
        "userDecision":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"User Decision Code",
                    "description":"The code for the user decision of the service AI agent metric.",
                    "x-searchable":true
                }
            ]
        },
        "userFeedback":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"User Feedback Code",
                    "description":"The code for the user feedback of the service AI agent metric.",
                    "x-searchable":true
                }
            ]
        },
        "outcomeType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Outcome Type Code",
                    "description":"The code for the outcome type of the service AI agent metric.",
                    "x-searchable":true
                }
            ]
        },
        "serviceWorkflow":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.Workflow_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Service Workflow",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "id"
    ],
    "x-alternateKeys":{
        "numberAltKey":[
            "number"
        ]
    }
}

Nested Schema : Service AI Agent Metric

Type: object

Title: Service AI Agent Metric

The service AI agent metric contains information about invocation of AI agents and the subsequent interaction of humans with AI's recommendations.

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string",
            "x-searchable":true
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : confidenceScoreCode

Match All

The code for the confidence score of the service AI agent metric.

Show Source

• string
  Title: Confidence Score Code

  The code for the confidence score of the service AI agent metric.
• string
  Allowed Values: [ "ORA_SVC_COSINE", "ORA_SVC_JACCARD" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Confidence Score Code",
            "description":"The code for the confidence score of the service AI agent metric."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreCommon.ConfidenceScoreCode_enum"
        }
    ]
}

Nested Schema : objectType

Match All

The code for the object type of the service AI agent metric.

Show Source

• allOf oraCommonAppsInfraObjects.StandardLookupCode_item-fields
• object __busObj_context
• object Object Type Code
  Title: Object Type Code

  The code for the object type of the service AI agent metric.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Object Type Code",
            "description":"The code for the object type of the service AI agent metric.",
            "x-searchable":true
        }
    ]
}

Nested Schema : outcomeType

Match All

The code for the outcome type of the service AI agent metric.

Show Source

• allOf oraCommonAppsInfraObjects.StandardLookupCode_item-fields
• object __busObj_context
• object Outcome Type Code
  Title: Outcome Type Code

  The code for the outcome type of the service AI agent metric.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Outcome Type Code",
            "description":"The code for the outcome type of the service AI agent metric.",
            "x-searchable":true
        }
    ]
}

Nested Schema : serviceWorkflow

Match All

Show Source

• object oraCxServiceCoreWorkflow.Workflow_item-fields
• object __busObj_context
• object Service Workflow
  Title: Service Workflow

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.Workflow_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Service Workflow",
            "x-searchable":true
        }
    ]
}

Nested Schema : userDecision

Match All

The code for the user decision of the service AI agent metric.

Show Source

• allOf oraCommonAppsInfraObjects.StandardLookupCode_item-fields
• object __busObj_context
• object User Decision Code
  Title: User Decision Code

  The code for the user decision of the service AI agent metric.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"User Decision Code",
            "description":"The code for the user decision of the service AI agent metric.",
            "x-searchable":true
        }
    ]
}

Nested Schema : userFeedback

Match All

The code for the user feedback of the service AI agent metric.

Show Source

• allOf oraCommonAppsInfraObjects.StandardLookupCode_item-fields
• object __busObj_context
• object User Feedback Code
  Title: User Feedback Code

  The code for the user feedback of the service AI agent metric.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"User Feedback Code",
            "description":"The code for the user feedback of the service AI agent metric.",
            "x-searchable":true
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields

Match All

Show Source

• allOf oraCommonAppsInfraObjects.StandardLookupCode_abstract-item
• object oraCommonAppsInfraObjects.StandardLookupCode_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupCode_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "lookupType":{
                    "title":"Lookup Type ID",
                    "description":"The unique identifier of the Lookup Type.",
                    "type":"string"
                },
                "lookupCategoryId":{
                    "title":"Lookup Category",
                    "description":"The lookup category of the Lookup Code.",
                    "type":"string"
                },
                "lookupCode":{
                    "title":"Lookup Code ID",
                    "description":"The unique identifier of the Lookup Code.",
                    "type":"string"
                },
                "meaning":{
                    "title":"Lookup Code Meaning",
                    "description":"The translated meaning of the Lookup Code.",
                    "type":"string"
                },
                "description":{
                    "title":"Lookup Code Description",
                    "description":"The translated description of the Lookup Code.",
                    "type":"string"
                },
                "enabledFlag":{
                    "title":"Lookup Code Enabled",
                    "description":"The enabled flag of the Lookup Code.",
                    "type":"boolean"
                },
                "startDateActive":{
                    "title":"Start Date Active",
                    "description":"The active start date of the Lookup Code.",
                    "type":"string"
                },
                "endDateActive":{
                    "title":"End Date Active",
                    "description":"The active end date of the Lookup Code.",
                    "type":"string"
                },
                "displaySequence":{
                    "title":"Display Sequence",
                    "description":"The display sequence of the Lookup Code.",
                    "type":"string"
                },
                "tag":{
                    "title":"Lookup Tag",
                    "description":"The tag value of the Lookup Code.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "$sourceLang":{
                    "title":"Source Language",
                    "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item

Match All

Show Source

• object oraCommonAppsInfraObjects.StandardLookupCode_abstract-item-allOf[0]
• object oraCommonAppsInfraObjects.LookupCode_abstract-item

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "owningType":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupType_item-fields"
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        },
                        {
                            "type":"object",
                            "title":"Standard Lookup Type",
                            "description":"The standard lookup types list of values resource is used to query the list of standard lookup types.",
                            "x-searchable":true
                        }
                    ]
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupCode_abstract-item"
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item-allOf[0]

Type: object

Show Source

• owningType: owningType

{
    "type":"object",
    "properties":{
        "owningType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupType_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Standard Lookup Type",
                    "description":"The standard lookup types list of values resource is used to query the list of standard lookup types.",
                    "x-searchable":true
                }
            ]
        }
    }
}

Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item

Type: object

Show Source

• $sourceLang: string
  Read Only: true
• createdBy: string
  Read Only: true
• description: string
  Read Only: true
• displaySequence: string (big-integer)
  Read Only: true
• enabledFlag: boolean
  Read Only: true
• endDateActive: string (date)
  Read Only: true
• lookupCategoryId: string (big-integer)
  Read Only: true
• lookupCode: string
  Read Only: true
• lookupType: string
  Read Only: true
• meaning: string
  Read Only: true
• startDateActive: string (date)
  Read Only: true
• tag: string
  Read Only: true
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "lookupType":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "lookupCategoryId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "lookupCode":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "meaning":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "enabledFlag":{
            "type":"boolean",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "startDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "endDateActive":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "displaySequence":{
            "type":"string",
            "format":"big-integer",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "tag":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        }
    },
    "x-primaryKey":[
        "lookupType",
        "lookupCode"
    ]
}

Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields-allOf[1]

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  The language in which the values of the translatable columns were created, updated, or copied from.
• createdBy: string
  Title: Created By

  The user who created the record.
• description: string
  Title: Lookup Code Description

  The translated description of the Lookup Code.
• displaySequence: string
  Title: Display Sequence

  The display sequence of the Lookup Code.
• enabledFlag: boolean
  Title: Lookup Code Enabled

  The enabled flag of the Lookup Code.
• endDateActive: string
  Title: End Date Active

  The active end date of the Lookup Code.
• lookupCategoryId: string
  Title: Lookup Category

  The lookup category of the Lookup Code.
• lookupCode: string
  Title: Lookup Code ID

  The unique identifier of the Lookup Code.
• lookupType: string
  Title: Lookup Type ID

  The unique identifier of the Lookup Type.
• meaning: string
  Title: Lookup Code Meaning

  The translated meaning of the Lookup Code.
• startDateActive: string
  Title: Start Date Active

  The active start date of the Lookup Code.
• tag: string
  Title: Lookup Tag

  The tag value of the Lookup Code.
• timeCreated: string
  Title: Created On

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "lookupType":{
            "title":"Lookup Type ID",
            "description":"The unique identifier of the Lookup Type.",
            "type":"string"
        },
        "lookupCategoryId":{
            "title":"Lookup Category",
            "description":"The lookup category of the Lookup Code.",
            "type":"string"
        },
        "lookupCode":{
            "title":"Lookup Code ID",
            "description":"The unique identifier of the Lookup Code.",
            "type":"string"
        },
        "meaning":{
            "title":"Lookup Code Meaning",
            "description":"The translated meaning of the Lookup Code.",
            "type":"string"
        },
        "description":{
            "title":"Lookup Code Description",
            "description":"The translated description of the Lookup Code.",
            "type":"string"
        },
        "enabledFlag":{
            "title":"Lookup Code Enabled",
            "description":"The enabled flag of the Lookup Code.",
            "type":"boolean"
        },
        "startDateActive":{
            "title":"Start Date Active",
            "description":"The active start date of the Lookup Code.",
            "type":"string"
        },
        "endDateActive":{
            "title":"End Date Active",
            "description":"The active end date of the Lookup Code.",
            "type":"string"
        },
        "displaySequence":{
            "title":"Display Sequence",
            "description":"The display sequence of the Lookup Code.",
            "type":"string"
        },
        "tag":{
            "title":"Lookup Tag",
            "description":"The tag value of the Lookup Code.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "$sourceLang":{
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
            "type":"string"
        }
    }
}

Nested Schema : Object Type Code

Type: object

Title: Object Type Code

The code for the object type of the service AI agent metric.

Nested Schema : owningType

Match All

The standard lookup types list of values resource is used to query the list of standard lookup types.

Show Source

• allOf oraCommonAppsInfraObjects.StandardLookupType_item-fields
• object __busObj_context
• object Standard Lookup Type
  Title: Standard Lookup Type

  The standard lookup types list of values resource is used to query the list of standard lookup types.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.StandardLookupType_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Standard Lookup Type",
            "description":"The standard lookup types list of values resource is used to query the list of standard lookup types.",
            "x-searchable":true
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields

Match All

Show Source

• object oraCommonAppsInfraObjects.LookupType_abstract-item
• object oraCommonAppsInfraObjects.StandardLookupType_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupType_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "lookupType":{
                    "title":"Lookup Type ID",
                    "description":"The unique identifier of the Lookup Type.",
                    "type":"string"
                },
                "lookupCategoryId":{
                    "title":"Lookup Category",
                    "description":"The lookup category of the Lookup Code.",
                    "type":"string"
                },
                "meaning":{
                    "title":"Lookup Type Meaning",
                    "description":"The translated meaning of the Lookup Type.",
                    "type":"string"
                },
                "description":{
                    "title":"Lookup Type Description",
                    "description":"The translated description of the Lookup Type.",
                    "type":"string"
                },
                "configurationLevel":{
                    "title":"Configuration Level",
                    "description":"The configuration level of the Lookup Type.",
                    "type":"string"
                },
                "restAccessSecured":{
                    "title":"REST Access Secured",
                    "description":"The rest access secured value of the Lookup Type.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "$sourceLang":{
                    "title":"Source Language",
                    "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.LookupType_abstract-item

Type: object

Show Source

• $sourceLang: string
  Read Only: true
• configurationLevel: configurationLevel
• createdBy: string
  Read Only: true
• description: string
  Read Only: true
• lookupCategoryId: string (big-integer)
  Read Only: true
• lookupType: string
  Read Only: true
• meaning: string
  Read Only: true
• restAccessSecured: restAccessSecured
• taxonomyNode: taxonomyNode
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "lookupType":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "lookupCategoryId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "meaning":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "nullable":true,
            "readOnly":true
        },
        "configurationLevel":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"https://static.oracle.com/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupTypeConfigurationLevel_enum"
                }
            ]
        },
        "restAccessSecured":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"https://static.oracle.com/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupTypeRestAccessSecured_enum"
                }
            ]
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "taxonomyNode":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Taxonomy Node",
                    "description":"The taxonomy node list of values resource is used to query the taxonomy nodes.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "lookupType"
    ]
}

Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields-allOf[1]

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  The language in which the values of the translatable columns were created, updated, or copied from.
• configurationLevel: string
  Title: Configuration Level

  The configuration level of the Lookup Type.
• createdBy: string
  Title: Created By

  The user who created the record.
• description: string
  Title: Lookup Type Description

  The translated description of the Lookup Type.
• lookupCategoryId: string
  Title: Lookup Category

  The lookup category of the Lookup Code.
• lookupType: string
  Title: Lookup Type ID

  The unique identifier of the Lookup Type.
• meaning: string
  Title: Lookup Type Meaning

  The translated meaning of the Lookup Type.
• restAccessSecured: string
  Title: REST Access Secured

  The rest access secured value of the Lookup Type.
• timeCreated: string
  Title: Created On

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "lookupType":{
            "title":"Lookup Type ID",
            "description":"The unique identifier of the Lookup Type.",
            "type":"string"
        },
        "lookupCategoryId":{
            "title":"Lookup Category",
            "description":"The lookup category of the Lookup Code.",
            "type":"string"
        },
        "meaning":{
            "title":"Lookup Type Meaning",
            "description":"The translated meaning of the Lookup Type.",
            "type":"string"
        },
        "description":{
            "title":"Lookup Type Description",
            "description":"The translated description of the Lookup Type.",
            "type":"string"
        },
        "configurationLevel":{
            "title":"Configuration Level",
            "description":"The configuration level of the Lookup Type.",
            "type":"string"
        },
        "restAccessSecured":{
            "title":"REST Access Secured",
            "description":"The rest access secured value of the Lookup Type.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "$sourceLang":{
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
            "type":"string"
        }
    }
}

Nested Schema : Standard Lookup Type

Type: object

Title: Standard Lookup Type

The standard lookup types list of values resource is used to query the list of standard lookup types.

Nested Schema : configurationLevel

Match All

Show Source

• string
  Read Only: true
• string
  Allowed Values: [ "E", "S", "U" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"https://static.oracle.com/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupTypeConfigurationLevel_enum"
        }
    ]
}

Nested Schema : restAccessSecured

Match All

Show Source

• string
  Read Only: true
• string
  Allowed Values: [ "ANON", "AUTH", "SECURE" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"https://static.oracle.com/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.LookupTypeRestAccessSecured_enum"
        }
    ]
}

Nested Schema : taxonomyNode

Match All

The taxonomy node list of values resource is used to query the taxonomy nodes.

Show Source

• allOf oraCommonAppsInfraObjects.TaxonomyNode_item-fields
• object __busObj_context
• object Taxonomy Node
  Title: Taxonomy Node

  The taxonomy node list of values resource is used to query the taxonomy nodes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Taxonomy Node",
            "description":"The taxonomy node list of values resource is used to query the taxonomy nodes.",
            "x-searchable":true
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields

Match All

Show Source

• object oraCommonAppsInfraObjects.TaxonomyNode_abstract-item
• object oraCommonAppsInfraObjects.TaxonomyNode_item-fields-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_abstract-item"
        },
        {
            "type":"object",
            "properties":{
                "moduleGUID":{
                    "title":"Module GUID",
                    "description":"The unique identifier of the taxonomy node.",
                    "type":"string"
                },
                "moduleName":{
                    "title":"Module Name",
                    "description":"The descriptive name of the taxonomy node.",
                    "type":"string"
                },
                "moduleType":{
                    "title":"Module Type",
                    "description":"The type of the taxonomy node.",
                    "type":"string"
                },
                "moduleKey":{
                    "title":"Module Key",
                    "description":"The unique identifier of the module.",
                    "type":"string"
                },
                "alternativeId":{
                    "title":"Alternative ID",
                    "description":"The alternative identifier of the taxonomy node.",
                    "type":"string"
                },
                "productLine":{
                    "title":"Product Line",
                    "description":"The product line of the taxonomy node.",
                    "type":"string"
                },
                "seedDataAllowedFlag":{
                    "title":"Seed Data Allowed Flag",
                    "description":"Indicates if seed data is allowed or not.",
                    "type":"boolean"
                },
                "usageType":{
                    "title":"Usage Type",
                    "description":"The usage type of the taxonomy node.",
                    "type":"string"
                },
                "timeUpdated":{
                    "title":"Last Updated Date",
                    "description":"The date and time when the record was last updated.",
                    "type":"string"
                },
                "updatedBy":{
                    "title":"Last Updated By",
                    "description":"The user who last updated the record.",
                    "type":"string"
                },
                "timeCreated":{
                    "title":"Created On",
                    "description":"The date and time when the record was created.",
                    "type":"string"
                },
                "createdBy":{
                    "title":"Created By",
                    "description":"The user who created the record.",
                    "type":"string"
                },
                "userModuleName":{
                    "title":"User Module Name",
                    "description":"The translated visible name of the taxonomy node.",
                    "type":"string"
                },
                "$sourceLang":{
                    "title":"Source Language",
                    "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
                    "type":"string"
                },
                "description":{
                    "title":"Module Description",
                    "description":"The translated description of the taxonomy node.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_abstract-item

Type: object

Show Source

• $sourceLang: string
  Read Only: true
• alternativeId: string (big-integer)
  Read Only: true
• createdBy: string
  Read Only: true
• description: string
  Read Only: true
• hierarchySource: hierarchySource
• moduleGUID: string
  Read Only: true
• moduleKey: string
  Read Only: true
• moduleName: string
  Read Only: true
• moduleType: moduleType
• productLine: string (big-integer)
  Read Only: true
• seedDataAllowedFlag: boolean
  Read Only: true

  Default Value: false
• timeCreated: string (date-time)
  Read Only: true
• timeUpdated: string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true
• usageType: string
  Read Only: true

  Maximum Length: 30
• userModuleName: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "moduleGUID":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "moduleName":{
            "type":"string",
            "readOnly":true
        },
        "moduleType":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"https://static.oracle.com/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                            "name":"transformEnumExtensions"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.ModuleType_enum"
                }
            ]
        },
        "moduleKey":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "alternativeId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "productLine":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "seedDataAllowedFlag":{
            "type":"boolean",
            "default":false,
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "usageType":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "maxLength":30
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "userModuleName":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "$sourceLang":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "hierarchySource":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Taxonomy Hierarchy",
                    "description":"The taxonomy hierarchy represents relationships between taxonomy nodes.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "moduleGUID"
    ],
    "x-alternateKeys":{
        "altKeyAlt":[
            "moduleType",
            "alternativeId"
        ],
        "altKeyModule":[
            "moduleType",
            "moduleKey"
        ]
    }
}

Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields-allOf[1]

Type: object

Show Source

• $sourceLang: string
  Title: Source Language

  The language in which the values of the translatable columns were created, updated, or copied from.
• alternativeId: string
  Title: Alternative ID

  The alternative identifier of the taxonomy node.
• createdBy: string
  Title: Created By

  The user who created the record.
• description: string
  Title: Module Description

  The translated description of the taxonomy node.
• moduleGUID: string
  Title: Module GUID

  The unique identifier of the taxonomy node.
• moduleKey: string
  Title: Module Key

  The unique identifier of the module.
• moduleName: string
  Title: Module Name

  The descriptive name of the taxonomy node.
• moduleType: string
  Title: Module Type

  The type of the taxonomy node.
• productLine: string
  Title: Product Line

  The product line of the taxonomy node.
• seedDataAllowedFlag: boolean
  Title: Seed Data Allowed Flag

  Indicates if seed data is allowed or not.
• timeCreated: string
  Title: Created On

  The date and time when the record was created.
• timeUpdated: string
  Title: Last Updated Date

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  The user who last updated the record.
• usageType: string
  Title: Usage Type

  The usage type of the taxonomy node.
• userModuleName: string
  Title: User Module Name

  The translated visible name of the taxonomy node.

{
    "type":"object",
    "properties":{
        "moduleGUID":{
            "title":"Module GUID",
            "description":"The unique identifier of the taxonomy node.",
            "type":"string"
        },
        "moduleName":{
            "title":"Module Name",
            "description":"The descriptive name of the taxonomy node.",
            "type":"string"
        },
        "moduleType":{
            "title":"Module Type",
            "description":"The type of the taxonomy node.",
            "type":"string"
        },
        "moduleKey":{
            "title":"Module Key",
            "description":"The unique identifier of the module.",
            "type":"string"
        },
        "alternativeId":{
            "title":"Alternative ID",
            "description":"The alternative identifier of the taxonomy node.",
            "type":"string"
        },
        "productLine":{
            "title":"Product Line",
            "description":"The product line of the taxonomy node.",
            "type":"string"
        },
        "seedDataAllowedFlag":{
            "title":"Seed Data Allowed Flag",
            "description":"Indicates if seed data is allowed or not.",
            "type":"boolean"
        },
        "usageType":{
            "title":"Usage Type",
            "description":"The usage type of the taxonomy node.",
            "type":"string"
        },
        "timeUpdated":{
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated.",
            "type":"string"
        },
        "updatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the record.",
            "type":"string"
        },
        "timeCreated":{
            "title":"Created On",
            "description":"The date and time when the record was created.",
            "type":"string"
        },
        "createdBy":{
            "title":"Created By",
            "description":"The user who created the record.",
            "type":"string"
        },
        "userModuleName":{
            "title":"User Module Name",
            "description":"The translated visible name of the taxonomy node.",
            "type":"string"
        },
        "$sourceLang":{
            "title":"Source Language",
            "description":"The language in which the values of the translatable columns were created, updated, or copied from.",
            "type":"string"
        },
        "description":{
            "title":"Module Description",
            "description":"The translated description of the taxonomy node.",
            "type":"string"
        }
    }
}

Nested Schema : Taxonomy Node

Type: object

Title: Taxonomy Node

The taxonomy node list of values resource is used to query the taxonomy nodes.

Nested Schema : hierarchySource

Match All

The taxonomy hierarchy represents relationships between taxonomy nodes.

Show Source

• object oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields
• object __busObj_context
• object Taxonomy Hierarchy
  Title: Taxonomy Hierarchy

  The taxonomy hierarchy represents relationships between taxonomy nodes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Taxonomy Hierarchy",
            "description":"The taxonomy hierarchy represents relationships between taxonomy nodes.",
            "x-searchable":true
        }
    ]
}

Nested Schema : moduleType

Match All

Show Source

• string
  Read Only: true
• string
  Allowed Values: [ "APPLICATION", "LBA", "PAGE", "PRODUCT_LINE", "DELIVERY_ROOT", "FAMILY" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"https://static.oracle.com/cdn/boss/2604.926.260350027/js/transforms/metadata-transformer-jet-plugin.js",
                    "name":"transformEnumExtensions"
                }
            }
        },
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.ModuleType_enum"
        }
    ]
}

Nested Schema : oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• sourceModuleGUID: string
  Title: Source Module GUID

  Read Only: true

  The unique identifier of the source taxonomy node.
• sourceNode: sourceNode
• targetModuleGUID: string
  Title: Target Module GUID

  Read Only: true

  The unique identifier of the target taxonomy node.
• targetNode: targetNode
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{
    "type":"object",
    "properties":{
        "sourceModuleGUID":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Source Module GUID",
            "description":"The unique identifier of the source taxonomy node."
        },
        "targetModuleGUID":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Target Module GUID",
            "description":"The unique identifier of the target taxonomy node."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "sourceNode":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Taxonomy Node",
                    "description":"The taxonomy node list of values resource is used to query the taxonomy nodes.",
                    "x-searchable":true
                }
            ]
        },
        "targetNode":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Taxonomy Node",
                    "description":"The taxonomy node list of values resource is used to query the taxonomy nodes.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "sourceModuleGUID",
        "targetModuleGUID"
    ]
}

Nested Schema : Taxonomy Hierarchy

Type: object

Title: Taxonomy Hierarchy

The taxonomy hierarchy represents relationships between taxonomy nodes.

Nested Schema : sourceNode

Match All

The taxonomy node list of values resource is used to query the taxonomy nodes.

Show Source

• allOf oraCommonAppsInfraObjects.TaxonomyNode_item-fields
• object __busObj_context
• object Taxonomy Node
  Title: Taxonomy Node

  The taxonomy node list of values resource is used to query the taxonomy nodes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Taxonomy Node",
            "description":"The taxonomy node list of values resource is used to query the taxonomy nodes.",
            "x-searchable":true
        }
    ]
}

Nested Schema : targetNode

Match All

The taxonomy node list of values resource is used to query the taxonomy nodes.

Show Source

• allOf oraCommonAppsInfraObjects.TaxonomyNode_item-fields
• object __busObj_context
• object Taxonomy Node
  Title: Taxonomy Node

  The taxonomy node list of values resource is used to query the taxonomy nodes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TaxonomyNode_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Taxonomy Node",
            "description":"The taxonomy node list of values resource is used to query the taxonomy nodes.",
            "x-searchable":true
        }
    ]
}

Nested Schema : Taxonomy Node

Type: object

Title: Taxonomy Node

The taxonomy node list of values resource is used to query the taxonomy nodes.

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

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

Nested Schema : Taxonomy Node

Type: object

Title: Taxonomy Node

The taxonomy node list of values resource is used to query the taxonomy nodes.

Nested Schema : Outcome Type Code

Type: object

Title: Outcome Type Code

The code for the outcome type of the service AI agent metric.

Nested Schema : oraCxServiceCoreWorkflow.Workflow_item-fields

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• name: string
  Title: Workflow Instance Name

  The name of the workflow instance.
• objectEntityName: string
  Title: Object Entity Name

  The name of the parent entity object associated with the workflow.
• objectEntityNameCode: objectEntityNameCode
• objectId: string (big-integer)
  Title: Object ID

  The unique identifier of the object associated with the workflow.
• orderNumber: string (big-integer)
  Title: Order Number

  The order of display for the workflow within the parent context.
• parentEntityName: string
  Title: Parent Entity Name

  The parent entity name associated with the workflow.
• parentEntityNameCode: parentEntityNameCode
• statusCode: statusCode
• statusDetails: string
  Title: Status Details

  The explanation of the error status of the workflow.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.
• workflowId: string (big-integer)
  Title: Workflow ID

  Read Only: true

  The unique identifier of the workflow.
• workflowNumber: string
  Title: Workflow Number

  The alternate unique identifier of the workflow.
• workflowTemplate: workflowTemplate

{
    "type":"object",
    "properties":{
        "workflowId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Workflow ID",
            "description":"The unique identifier of the workflow."
        },
        "orderNumber":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Order Number",
            "description":"The order of display for the workflow within the parent context."
        },
        "statusCode":{
            "allOf":[
                {
                    "type":"string",
                    "x-searchable":true,
                    "x-sortable":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Status",
                    "description":"Code that indicates the status of workflow."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.WorkflowStatusCode_enum"
                }
            ]
        },
        "workflowNumber":{
            "type":"string",
            "x-defaultExpression":"$fields[\"workflowId\"]",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Workflow Number",
            "description":"The alternate unique identifier of the workflow."
        },
        "objectEntityName":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Object Entity Name",
            "description":"The name of the parent entity object associated with the workflow."
        },
        "objectEntityNameCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Object Entity Name",
                    "description":"The name of the parent entity object associated with the workflow."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ObjectEntityNameCode_enum"
                }
            ]
        },
        "parentEntityName":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Parent Entity Name",
            "description":"The parent entity name associated with the workflow."
        },
        "parentEntityNameCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Parent Entity Name",
                    "description":"The parent entity name associated with the workflow."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ParentEntityNameCode_enum"
                }
            ]
        },
        "objectId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Object ID",
            "description":"The unique identifier of the object associated with the workflow."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Workflow Instance Name",
            "description":"The name of the workflow instance."
        },
        "statusDetails":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Status Details",
            "description":"The explanation of the error status of the workflow."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "workflowTemplate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.WorkflowTemplate_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Workflow Template",
                    "description":"The workflow template associated to the workflow.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "workflowId"
    ],
    "x-alternateKeys":{
        "workflowNumberAltKey":[
            "workflowNumber"
        ]
    }
}

Nested Schema : Service Workflow

Type: object

Title: Service Workflow

Nested Schema : objectEntityNameCode

Match All

The name of the parent entity object associated with the workflow.

Show Source

• string
  Title: Object Entity Name

  Read Only: true

  The name of the parent entity object associated with the workflow.
• string
  Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case", "CustomerWorkOrder", "srMilestone", "messages", "CaseMessage" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Object Entity Name",
            "description":"The name of the parent entity object associated with the workflow."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ObjectEntityNameCode_enum"
        }
    ]
}

Nested Schema : parentEntityNameCode

Match All

The parent entity name associated with the workflow.

Show Source

• string
  Title: Parent Entity Name

  Read Only: true

  The parent entity name associated with the workflow.
• string
  Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Parent Entity Name",
            "description":"The parent entity name associated with the workflow."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ParentEntityNameCode_enum"
        }
    ]
}

Nested Schema : statusCode

Match All

Code that indicates the status of workflow.

Show Source

• string
  Title: Status

  Code that indicates the status of workflow.
• string
  Allowed Values: [ "ORA_SVC_COMPLETED", "ORA_SVC_CREATE", "ORA_SVC_CREATED", "ORA_SVC_CREATE_AND_INITIATE", "ORA_SVC_ERROR", "ORA_SVC_INITIATE", "ORA_SVC_INITIATING", "ORA_SVC_IN_PROGRESS", "ORA_SVC_PARTIALLY_COMPLETED" ]

{
    "allOf":[
        {
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Status",
            "description":"Code that indicates the status of workflow."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.WorkflowStatusCode_enum"
        }
    ]
}

Nested Schema : workflowTemplate

Match All

The workflow template associated to the workflow.

Show Source

• object oraCxServiceCoreWorkflow.WorkflowTemplate_item-fields
• object __busObj_context
• object Workflow Template
  Title: Workflow Template

  The workflow template associated to the workflow.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.WorkflowTemplate_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Workflow Template",
            "description":"The workflow template associated to the workflow.",
            "x-searchable":true
        }
    ]
}

Nested Schema : oraCxServiceCoreWorkflow.WorkflowTemplate_item-fields

Type: object

Show Source

• condition: condition
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• createdByUser: string
  Title: Created by User

  The user who created the record through domain-specific language service.
• description: string
  Title: Description

  The description of the workflow template.
• domainSpecificLanguage: string (long-text)
  Title: Domain Specific Language

  A domain-specific language representation of the workflow template.
• enabledFlag: boolean
  Title: Enabled

  Default Value: false

  Indicates whether the workflow template is enabled.
• endDate: string (date-time)
  Title: End Date

  The date at which the workflow template is effective.
• lastUpdatedByUser: string
  Title: Last Updated by User

  The user who last updated the record through domain-specific language service.
• name: string
  Title: Automation Rules Template Name

  The name of the workflow template.
• objectEntityName: string
  Title: Object Entity Name

  The entity name of the object for which workflow template is created.
• objectEntityNameCode: objectEntityNameCode
• parentEntityName: string
  Title: Parent Entity Name

  The parent entity name associated with the workflow template.
• parentEntityNameCode: parentEntityNameCode
• publishedFlag: boolean
  Title: Published

  Default Value: false

  Indicates whether a workflow template is published for runtime use.
• startDate: string (date-time)
  Title: Start Date

  The date from which the workflow template is effective.
• stripeCode: stripeCode
• templateCategory: string
  Title: Template Category

  The template category associated with the workflow template.
• templateId: string (big-integer)
  Title: Template ID

  Read Only: true

  The unique identifier of the workflow template.
• templateNumber: string
  Title: Template Number

  Maximum Length: 30

  The reference number of the workflow template.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.
• workflowTemplateCategoryCode: workflowTemplateCategoryCode

{
    "type":"object",
    "properties":{
        "templateId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Template ID",
            "description":"The unique identifier of the workflow template."
        },
        "stripeCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "x-searchable":true,
                    "x-sortable":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Stripe Code",
                    "description":"The application context of the workflow template."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.StripeCode_enum"
                }
            ]
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Automation Rules Template Name",
            "description":"The name of the workflow template."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Description",
            "description":"The description of the workflow template."
        },
        "workflowTemplateCategoryCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "x-searchable":true,
                    "x-sortable":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Workflow Template Category",
                    "description":"The workflow template category with which the template is associated."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.WorkflowTemplatesCategoryCode_enum"
                }
            ]
        },
        "objectEntityName":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Object Entity Name",
            "description":"The entity name of the object for which workflow template is created."
        },
        "objectEntityNameCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Object Entity Name",
                    "description":"The entity name of the object for which workflow template is created."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ObjectEntityNameCode_enum"
                }
            ]
        },
        "parentEntityName":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Parent Entity Name",
            "description":"The parent entity name associated with the workflow template."
        },
        "parentEntityNameCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Parent Entity Name",
                    "description":"The parent entity name associated with the workflow template."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ParentEntityNameCode_enum"
                }
            ]
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Start Date",
            "description":"The date from which the workflow template is effective."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"End Date",
            "description":"The date at which the workflow template is effective."
        },
        "templateNumber":{
            "type":"string",
            "x-defaultExpression":"$fields[\"templateId\"]",
            "x-searchable":true,
            "x-sortable":true,
            "maxLength":30,
            "title":"Template Number",
            "description":"The reference number of the workflow template."
        },
        "enabledFlag":{
            "type":"boolean",
            "default":false,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Enabled",
            "description":"Indicates whether the workflow template is enabled."
        },
        "domainSpecificLanguage":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "x-searchable":true,
            "title":"Domain Specific Language",
            "description":"A domain-specific language representation of the workflow template."
        },
        "createdByUser":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Created by User",
            "description":"The user who created the record through domain-specific language service."
        },
        "lastUpdatedByUser":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Last Updated by User",
            "description":"The user who last updated the record through domain-specific language service."
        },
        "publishedFlag":{
            "type":"boolean",
            "default":false,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Published",
            "description":"Indicates whether a workflow template is published for runtime use."
        },
        "templateCategory":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Template Category",
            "description":"The template category associated with the workflow template."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        },
        "condition":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.Condition_item-fields"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                },
                {
                    "type":"object",
                    "title":"Condition",
                    "description":"The condition for the workflow template.",
                    "x-searchable":true
                }
            ]
        }
    },
    "x-primaryKey":[
        "templateId"
    ],
    "x-alternateKeys":{
        "templateNumberAltKey":[
            "templateNumber"
        ]
    }
}

Nested Schema : Workflow Template

Type: object

Title: Workflow Template

The workflow template associated to the workflow.

Nested Schema : condition

Match All

The condition for the workflow template.

Show Source

• object oraCxServiceCoreWorkflow.Condition_item-fields
• object __busObj_context
• object Condition
  Title: Condition

  The condition for the workflow template.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.Condition_item-fields"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "title":"Condition",
            "description":"The condition for the workflow template.",
            "x-searchable":true
        }
    ]
}

Nested Schema : objectEntityNameCode

Match All

The entity name of the object for which workflow template is created.

Show Source

• string
  Title: Object Entity Name

  Read Only: true

  The entity name of the object for which workflow template is created.
• string
  Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case", "CustomerWorkOrder", "srMilestone", "messages", "CaseMessage" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Object Entity Name",
            "description":"The entity name of the object for which workflow template is created."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ObjectEntityNameCode_enum"
        }
    ]
}

Nested Schema : parentEntityNameCode

Match All

The parent entity name associated with the workflow template.

Show Source

• string
  Title: Parent Entity Name

  Read Only: true

  The parent entity name associated with the workflow template.
• string
  Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Parent Entity Name",
            "description":"The parent entity name associated with the workflow template."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ParentEntityNameCode_enum"
        }
    ]
}

Nested Schema : stripeCode

Match All

The application context of the workflow template.

Show Source

• string
  Title: Stripe Code

  The application context of the workflow template.
• string
  Allowed Values: [ "ORA_SVC_CRM", "ORA_SVC_HRHD", "ORA_SVC_ISR" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Stripe Code",
            "description":"The application context of the workflow template."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.StripeCode_enum"
        }
    ]
}

Nested Schema : workflowTemplateCategoryCode

Match All

The workflow template category with which the template is associated.

Show Source

• string
  Title: Workflow Template Category

  The workflow template category with which the template is associated.
• string

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Workflow Template Category",
            "description":"The workflow template category with which the template is associated."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.WorkflowTemplatesCategoryCode_enum"
        }
    ]
}

Nested Schema : oraCxServiceCoreWorkflow.Condition_item-fields

Type: object

Show Source

• condition: string
  Title: Condition

  The expression for the condition.
• conditionId: string (big-integer)
  Title: Condition ID

  Read Only: true

  The unique identifier of the condition.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• createdByUser: string
  Title: Created by User

  The user who created the record through domain-specific language service.
• lastUpdatedByUser: string
  Title: Last Updated by User

  The user who last updated the record through domain-specific language service.
• name: string
  Title: Condition Name

  The name of the condition.
• objectType: string
  Title: Object Type

  The type of object that the condition can be applied to.
• objectTypeCode: objectTypeCode
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.
• usageTypeCode: usageTypeCode

{
    "type":"object",
    "properties":{
        "conditionId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Condition ID",
            "description":"The unique identifier of the condition."
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Condition Name",
            "description":"The name of the condition."
        },
        "condition":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Condition",
            "description":"The expression for the condition."
        },
        "objectType":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Object Type",
            "description":"The type of object that the condition can be applied to."
        },
        "objectTypeCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "readOnly":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Object Type",
                    "description":"The type of object that the condition can be applied to."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ObjectEntityNameCode_enum"
                }
            ]
        },
        "usageTypeCode":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "x-searchable":true,
                    "x-sortable":true,
                    "x-oj":{
                        "transform":{
                            "path":"boss/EnumMetadataTransforms",
                            "name":"transformEnumExtensions"
                        }
                    },
                    "title":"Usage Type",
                    "description":"The code that indicates the usage type of the condition."
                },
                {
                    "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ConditionUsageTypeCode_enum"
                }
            ]
        },
        "createdByUser":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Created by User",
            "description":"The user who created the record through domain-specific language service."
        },
        "lastUpdatedByUser":{
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Last Updated by User",
            "description":"The user who last updated the record through domain-specific language service."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created On",
            "description":"The date and time when the record was created."
        },
        "createdBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated Date",
            "description":"The date and time when the record was last updated."
        },
        "updatedBy":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "readOnly":true,
            "title":"Last Updated By",
            "description":"The user who last updated the record."
        }
    },
    "x-primaryKey":[
        "conditionId"
    ]
}

Nested Schema : Condition

Type: object

Title: Condition

The condition for the workflow template.

Nested Schema : objectTypeCode

Match All

The type of object that the condition can be applied to.

Show Source

• string
  Title: Object Type

  Read Only: true

  The type of object that the condition can be applied to.
• string
  Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case", "CustomerWorkOrder", "srMilestone", "messages", "CaseMessage" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Object Type",
            "description":"The type of object that the condition can be applied to."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ObjectEntityNameCode_enum"
        }
    ]
}

Nested Schema : usageTypeCode

Match All

The code that indicates the usage type of the condition.

Show Source

• string
  Title: Usage Type

  The code that indicates the usage type of the condition.
• string
  Allowed Values: [ "ORA_SVC_ACTION", "ORA_SVC_TEMPLATE" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "x-oj":{
                "transform":{
                    "path":"boss/EnumMetadataTransforms",
                    "name":"transformEnumExtensions"
                }
            },
            "title":"Usage Type",
            "description":"The code that indicates the usage type of the condition."
        },
        {
            "$ref":"#/components/schemas/oraCxServiceCoreWorkflow.ConditionUsageTypeCode_enum"
        }
    ]
}

Nested Schema : User Decision Code

Type: object

Title: User Decision Code

The code for the user decision of the service AI agent metric.

Nested Schema : User Feedback Code

Type: object

Title: User Feedback Code

The code for the user feedback of the service AI agent metric.

Back to Top

Examples

The following example shows how to get all service AI agent metrics using advanced query by submitting a POST request on the REST resource using cURL.

cURL Command

curl --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1/$en-US/serviceAIAgentMetrics/$query' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \

Example of Resquest Body

The following shows the contents of the response body in JSON format.

{
    "fields": [
        "id",
        "number",
        "agentTeamCode",
        "agentTeamVersion",
        "agentCode",
        "agentVersion",
        "jobExecutionNumber",
        "humanInLoopFlag",
        "recommendationDisplayFlag",
        "confidenceScore",
        "timeCreated"
    ],
    "collection": {
        "sortBy": [
            {"timeUpdated": "desc"}
        ],
        "limit": 2,
        "filter": "agentTeamCode='\''ORA_SERVICE_REQUEST_SIMILARITY_ADVISOR_RA'\''"
    }
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "items": [
        {
            "id": "300100673134607",
            "number": "CDRM_0000043731",
            "agentTeamCode": "ORA_SERVICE_REQUEST_SIMILARITY_ADVISOR_RA",
            "agentTeamVersion": "1",
            "agentCode": null,
            "agentVersion": null,
            "jobExecutionNumber": "b2fe2b84-aad6-4050-a54f-45821c6ac3bb",
            "humanInLoopFlag": false,
            "recommendationDisplayFlag": false,
            "confidenceScore": null,
            "timeCreated": "2026-08-07T10:03:33.604965Z",
            "$id": "CDRM_0000043731",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1/$en-US/serviceAIAgentMetrics/CDRM_0000043731"
                    }
                }
            }
        },
        {
            "id": "300100673118877",
            "number": "CDRM_0000043697",
            "agentTeamCode": "ORA_SERVICE_REQUEST_SIMILARITY_ADVISOR_RA",
            "agentTeamVersion": "1",
            "agentCode": null,
            "agentVersion": null,
            "jobExecutionNumber": "308dab96-5376-4787-a7f8-6945b55d240d",
            "humanInLoopFlag": false,
            "recommendationDisplayFlag": false,
            "confidenceScore": null,
            "timeCreated": "2026-08-07T08:20:05.169762Z",
            "$id": "CDRM_0000043697",
            "$context": {
                "etag": "1",
                "links": {
                    "$self": {
                        "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1/$en-US/serviceAIAgentMetrics/CDRM_0000043697"
                    }
                }
            }
        }
    ],
    "hasMore": true
}

Back to Top