Jump to

• Request
• Response

Fetch Instance Recommendation

post

/rpa/v1/instances/{instanceId}/recommendation

Gets the instance recommendation.

Request

Path Parameters

• instanceId(required): string
  unique Instance identifier

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• category(required): string
  Type of recommendation (e.g., locator)
• context: string
  Optional developer-provided note or context
• originalValue(required): string
  The original XPath or locator to improve
• source(required): string
  The HTML or DOM source to analyze

{
    "type":"object",
    "required":[
        "category",
        "source",
        "originalValue"
    ],
    "properties":{
        "category":{
            "type":"string",
            "description":"Type of recommendation (e.g., locator)"
        },
        "source":{
            "type":"string",
            "description":"The HTML or DOM source to analyze"
        },
        "originalValue":{
            "type":"string",
            "description":"The original XPath or locator to improve"
        },
        "context":{
            "type":"string",
            "description":"Optional developer-provided note or context"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Fetch Instance Recommendation

Headers

• etag:
  For optimistic concurrency control. See `if-match`.
• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : InstanceRecommendationResponse

Type: object

Show Source

• category(required): string
• originalValue(required): string
• recommendations(required): array recommendations

{
    "type":"object",
    "required":[
        "category",
        "originalValue",
        "recommendations"
    ],
    "properties":{
        "category":{
            "type":"string"
        },
        "originalValue":{
            "type":"string"
        },
        "recommendations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InstanceRecommendationOption"
            }
        }
    }
}

Nested Schema : recommendations

Type: array

Show Source

• Array of: object InstanceRecommendationOption

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

Nested Schema : InstanceRecommendationOption

Type: object

Show Source

• confidence: number (float)
  Confidence score (0 to 1)
• reason: string
  Justification or rationale for the recommendation
• recommendedValue(required): string
  The improved or recommended locator value

{
    "type":"object",
    "required":[
        "recommendedValue"
    ],
    "properties":{
        "recommendedValue":{
            "type":"string",
            "description":"The improved or recommended locator value"
        },
        "confidence":{
            "type":"number",
            "format":"float",
            "description":"Confidence score (0 to 1)"
        },
        "reason":{
            "type":"string",
            "description":"Justification or rationale for the recommendation"
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

412 Response

Precondition failed

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Back to Top