1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Service AI Agent Metrics (Spectra)

Get a service AI agent metric using advanced query

post

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

Request

Path Parameters
Query Parameters
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • accessors
    Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
  • fields
    Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • 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.
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
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.
Back to Top

Response

Default Response

A single item response
Body ()
Root Schema : oraCxServiceCoreCommon.ServiceAIAgentMetric_item-response
Match All
Show Source
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
Nested Schema : oraCxServiceCoreCommon.ServiceAIAgentMetric_item-fields
Type: object
Show Source
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
Nested Schema : confidenceScoreCode
Match All
The code for the confidence score of the service AI agent metric.
Show Source
  • Title: Confidence Score Code
    The code for the confidence score of the service AI agent metric.
  • Allowed Values: [ "ORA_SVC_COSINE", "ORA_SVC_JACCARD" ]
Nested Schema : objectType
Match All
The code for the object type of the service AI agent metric.
Show Source
Nested Schema : outcomeType
Match All
The code for the outcome type of the service AI agent metric.
Show Source
Nested Schema : serviceWorkflow
Match All
Show Source
Nested Schema : userDecision
Match All
The code for the user decision of the service AI agent metric.
Show Source
Nested Schema : userFeedback
Match All
The code for the user feedback of the service AI agent metric.
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupCode_item-fields-allOf[1]
Type: object
Show Source
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
Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupType_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.StandardLookupType_item-fields-allOf[1]
Type: object
Show Source
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
Nested Schema : restAccessSecured
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "ANON", "AUTH", "SECURE" ]
Nested Schema : taxonomyNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.TaxonomyNode_item-fields-allOf[1]
Type: object
Show Source
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
Nested Schema : moduleType
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "APPLICATION", "LBA", "PAGE", "PRODUCT_LINE", "DELIVERY_ROOT", "FAMILY" ]
Nested Schema : oraCommonAppsInfraObjects.TaxonomyHierarchy_item-fields
Type: object
Show Source
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
Nested Schema : targetNode
Match All
The taxonomy node list of values resource is used to query the taxonomy nodes.
Show Source
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
Nested Schema : links
Type: object
Read Only: true
Show Source
Nested Schema : $self
Type: object
Show Source
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
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
  • Title: Object Entity Name
    Read Only: true
    The name of the parent entity object associated with the workflow.
  • Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case", "CustomerWorkOrder", "srMilestone", "messages", "CaseMessage" ]
Nested Schema : parentEntityNameCode
Match All
The parent entity name associated with the workflow.
Show Source
  • Title: Parent Entity Name
    Read Only: true
    The parent entity name associated with the workflow.
  • Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case" ]
Nested Schema : statusCode
Match All
Code that indicates the status of workflow.
Show Source
  • Title: Status
    Code that indicates the status of workflow.
  • 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" ]
Nested Schema : workflowTemplate
Match All
The workflow template associated to the workflow.
Show Source
Nested Schema : oraCxServiceCoreWorkflow.WorkflowTemplate_item-fields
Type: object
Show Source
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
Nested Schema : objectEntityNameCode
Match All
The entity name of the object for which workflow template is created.
Show Source
  • Title: Object Entity Name
    Read Only: true
    The entity name of the object for which workflow template is created.
  • Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case", "CustomerWorkOrder", "srMilestone", "messages", "CaseMessage" ]
Nested Schema : parentEntityNameCode
Match All
The parent entity name associated with the workflow template.
Show Source
  • Title: Parent Entity Name
    Read Only: true
    The parent entity name associated with the workflow template.
  • Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case" ]
Nested Schema : stripeCode
Match All
The application context of the workflow template.
Show Source
  • Title: Stripe Code
    The application context of the workflow template.
  • Allowed Values: [ "ORA_SVC_CRM", "ORA_SVC_HRHD", "ORA_SVC_ISR" ]
Nested Schema : workflowTemplateCategoryCode
Match All
The workflow template category with which the template is associated.
Show Source
  • Title: Workflow Template Category
    The workflow template category with which the template is associated.
Nested Schema : oraCxServiceCoreWorkflow.Condition_item-fields
Type: object
Show Source
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
  • Title: Object Type
    Read Only: true
    The type of object that the condition can be applied to.
  • Allowed Values: [ "ServiceRequest", "HRHelpDeskRequest", "InternalServiceRequest", "Case", "CustomerWorkOrder", "srMilestone", "messages", "CaseMessage" ]
Nested Schema : usageTypeCode
Match All
The code that indicates the usage type of the condition.
Show Source
  • Title: Usage Type
    The code that indicates the usage type of the condition.
  • Allowed Values: [ "ORA_SVC_ACTION", "ORA_SVC_TEMPLATE" ]
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.
Links
$self
Parameters:
  • serviceAIAgentMetrics_id: $request.path.serviceAIAgentMetrics_id
objectType
Parameters:
  • standardLookupCodes_id: $response.body#/objectType/$id
The code for the object type of the service AI agent metric.
outcomeType
Parameters:
  • standardLookupCodes_id: $response.body#/outcomeType/$id
The code for the outcome type of the service AI agent metric.
serviceWorkflow
Parameters:
  • workflows_id: $response.body#/serviceWorkflow/$id
userDecision
Parameters:
  • standardLookupCodes_id: $response.body#/userDecision/$id
The code for the user decision of the service AI agent metric.
userFeedback
Parameters:
  • standardLookupCodes_id: $response.body#/userFeedback/$id
The code for the user feedback of the service AI agent metric.
Back to Top

Examples

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

cURL Command

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

Example of Request Body

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

{
    "fields": [
        "id",
        "number",
        "agentTeamCode",
        "agentTeamVersion",
        "agentCode",
        "agentVersion",
        "objectReferenceNumber",
        "jobExecutionNumber",
        "confidenceScore",
        "userFeedbackRating"
    ]
}

Example of Response Body

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

{
    "id": "300100673118877",
    "number": "CDRM_0000043697",
    "agentTeamCode": "ORA_SERVICE_REQUEST_SIMILARITY_ADVISOR_RA",
    "agentTeamVersion": "1",
    "agentCode": null,
    "agentVersion": null,
    "objectReferenceNumber": null,
    "jobExecutionNumber": "308dab96-5376-4787-a7f8-6945b55d240d",
    "confidenceScore": null,
    "userFeedbackRating": null,
    "$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"
            }
        }
    }
}
Back to Top