Jump to

• Request
• Response

Get example request and response assessor payloads

get

https://{your_site_interface}/determinations-server/batch/12.2.26/policy-models/{policy-model-name}/assessor/example

This operation will provide examples of the request and response payloads for requests made to the assessor resource for the specified policy model

Request

Path Parameters

• policy-model-name(required): string
  Name of the policy model

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/{API_version}/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/{API_version}/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : example

Type: object

Show Source

• request: object exampleRequest
• response: object exampleResponse

{
    "type":"object",
    "properties":{
        "request":{
            "description":"Example request payload",
            "$ref":"#/components/schemas/exampleRequest"
        },
        "response":{
            "description":"Example response payload",
            "$ref":"#/components/schemas/exampleResponse"
        }
    },
    "additionalProperties":false
}

Nested Schema : exampleRequest

Type: object

Show Source

• cases: array cases
  List of cases submitted for assessment
• outcomes: array outcomes
  List of outcomes to be assessed for each case submitted.

{
    "type":"object",
    "properties":{
        "outcomes":{
            "type":"array",
            "description":"List of outcomes to be assessed for each case submitted.",
            "items":{
                "type":"string"
            }
        },
        "cases":{
            "type":"array",
            "description":"List of cases submitted for assessment",
            "items":{
                "description":"An individual case submitted for assessment",
                "$ref":"#/components/schemas/exampleCase"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : exampleResponse

Type: object

Show Source

• cases: array cases
  List of cases submitted for assessment
• summary: object exampleSummary

{
    "type":"object",
    "properties":{
        "cases":{
            "type":"array",
            "description":"List of cases submitted for assessment",
            "items":{
                "description":"An individual case submitted for assessment",
                "$ref":"#/components/schemas/exampleCase"
            }
        },
        "summary":{
            "description":"Summary of the work performed by the assessor",
            "$ref":"#/components/schemas/exampleSummary"
        }
    },
    "additionalProperties":false
}

Nested Schema : cases

Type: array

List of cases submitted for assessment

Show Source

• Array of: object exampleCase
  Additional Properties Allowed: true

{
    "type":"array",
    "description":"List of cases submitted for assessment",
    "items":{
        "description":"An individual case submitted for assessment",
        "$ref":"#/components/schemas/exampleCase"
    }
}

Nested Schema : outcomes

Type: array

List of outcomes to be assessed for each case submitted.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of outcomes to be assessed for each case submitted.",
    "items":{
        "type":"string"
    }
}

Nested Schema : exampleCase

Type: object

Additional Properties Allowed: true

Nested Schema : cases

Type: array

List of cases submitted for assessment

Show Source

• Array of: object exampleCase
  Additional Properties Allowed: true

{
    "type":"array",
    "description":"List of cases submitted for assessment",
    "items":{
        "description":"An individual case submitted for assessment",
        "$ref":"#/components/schemas/exampleCase"
    }
}

Nested Schema : exampleSummary

Type: object

Show Source

• casesIgnored: number (double)
  The number of submitted cases ignored due to errors
• casesProcessed: number (double)
  The number of submitted cases successfully processed
• casesRead: number (double)
  The total number of cases submitted in the request payload
• processorCasesPerSec: number (double)
  The average number of cases assessed per second
• processorDurationSec: number (double)
  The request processing duration in seconds
• processorQueuedSec: number (double)
  The time the request was queued in seconds

{
    "type":"object",
    "properties":{
        "casesRead":{
            "type":"number",
            "format":"double",
            "description":"The total number of cases submitted in the request payload"
        },
        "casesProcessed":{
            "type":"number",
            "format":"double",
            "description":"The number of submitted cases successfully processed"
        },
        "casesIgnored":{
            "type":"number",
            "format":"double",
            "description":"The number of submitted cases ignored due to errors"
        },
        "processorDurationSec":{
            "type":"number",
            "format":"double",
            "description":"The request processing duration in seconds"
        },
        "processorCasesPerSec":{
            "type":"number",
            "format":"double",
            "description":"The average number of cases assessed per second"
        },
        "processorQueuedSec":{
            "type":"number",
            "format":"double",
            "description":"The time the request was queued in seconds"
        }
    },
    "additionalProperties":false
}

Back to Top