Jump to

• Request
• Response

Get details about a single deployed policy model

get

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

This operation will provide details 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/12.2.17/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/12.2.17/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 : policyModel

Type: object

Show Source

• assessor: object assessor
• data-model: object dataModel
• name: string
  Name of the policy model

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the policy model"
        },
        "data-model":{
            "$ref":"#/components/schemas/dataModel"
        },
        "assessor":{
            "$ref":"#/components/schemas/assessor"
        }
    },
    "additionalProperties":false
}

Nested Schema : assessor

Type: object

Show Source

• example: object example

{
    "type":"object",
    "properties":{
        "example":{
            "$ref":"#/components/schemas/example"
        }
    },
    "additionalProperties":false
}

Nested Schema : dataModel

Type: object

Show Source

• properties: object dataModelProperties
  Additional Properties Allowed: true

{
    "type":"object",
    "properties":{
        "properties":{
            "description":"Properties of the object",
            "$ref":"#/components/schemas/dataModelProperties"
        }
    },
    "additionalProperties":false
}

Nested 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":{
                "oneOf":[
                    {
                        "type":"string",
                        "description":"The name of the attribute or relationship that the outcome applies to."
                    },
                    {
                        "type":"object",
                        "properties":{
                            "id":{
                                "type":"string",
                                "description":"The name of the attribute or relationship that the outcome applies to."
                            },
                            "knownOutcomeStyle":{
                                "type":"string",
                                "description":"Indicates the outcome style of the outcome for known values. Defaults to 'value-only'",
                                "enum":[
                                    "value-only",
                                    "decision-report",
                                    "base-attributes"
                                ]
                            },
                            "unknownOutcomeStyle":{
                                "type":"string",
                                "description":"Indicates the outcome style of the outcome for unknown values. Defaults to 'value-only'",
                                "enum":[
                                    "value-only",
                                    "decision-report",
                                    "base-attributes"
                                ]
                            },
                            "showSlient":{
                                "type":"boolean",
                                "description":"Indicates whether to force show silent fields in decision reports. Defaults to false."
                            },
                            "showInvisible":{
                                "type":"boolean",
                                "description":"Indicates whether to force show invisible fields in decision reports. Defaults to false."
                            },
                            "resolveIndecisionRelationships":{
                                "type":"boolean",
                                "description":"Indicates whether to expand relationships for indecision reports. Defaults to false."
                            }
                        },
                        "required":[
                            "id"
                        ],
                        "additionalProperties":false
                    }
                ]
            }
        },
        "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: items

{
    "type":"array",
    "description":"List of outcomes to be assessed for each case submitted.",
    "items":{
        "oneOf":[
            {
                "type":"string",
                "description":"The name of the attribute or relationship that the outcome applies to."
            },
            {
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"The name of the attribute or relationship that the outcome applies to."
                    },
                    "knownOutcomeStyle":{
                        "type":"string",
                        "description":"Indicates the outcome style of the outcome for known values. Defaults to 'value-only'",
                        "enum":[
                            "value-only",
                            "decision-report",
                            "base-attributes"
                        ]
                    },
                    "unknownOutcomeStyle":{
                        "type":"string",
                        "description":"Indicates the outcome style of the outcome for unknown values. Defaults to 'value-only'",
                        "enum":[
                            "value-only",
                            "decision-report",
                            "base-attributes"
                        ]
                    },
                    "showSlient":{
                        "type":"boolean",
                        "description":"Indicates whether to force show silent fields in decision reports. Defaults to false."
                    },
                    "showInvisible":{
                        "type":"boolean",
                        "description":"Indicates whether to force show invisible fields in decision reports. Defaults to false."
                    },
                    "resolveIndecisionRelationships":{
                        "type":"boolean",
                        "description":"Indicates whether to expand relationships for indecision reports. Defaults to false."
                    }
                },
                "required":[
                    "id"
                ],
                "additionalProperties":false
            }
        ]
    }
}

Nested Schema : exampleCase

Type: object

Additional Properties Allowed: true

Nested Schema : items

Match One Schema

Show Source

• string
  The name of the attribute or relationship that the outcome applies to.
• object items-oneOf[1]

{
    "oneOf":[
        {
            "type":"string",
            "description":"The name of the attribute or relationship that the outcome applies to."
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The name of the attribute or relationship that the outcome applies to."
                },
                "knownOutcomeStyle":{
                    "type":"string",
                    "description":"Indicates the outcome style of the outcome for known values. Defaults to 'value-only'",
                    "enum":[
                        "value-only",
                        "decision-report",
                        "base-attributes"
                    ]
                },
                "unknownOutcomeStyle":{
                    "type":"string",
                    "description":"Indicates the outcome style of the outcome for unknown values. Defaults to 'value-only'",
                    "enum":[
                        "value-only",
                        "decision-report",
                        "base-attributes"
                    ]
                },
                "showSlient":{
                    "type":"boolean",
                    "description":"Indicates whether to force show silent fields in decision reports. Defaults to false."
                },
                "showInvisible":{
                    "type":"boolean",
                    "description":"Indicates whether to force show invisible fields in decision reports. Defaults to false."
                },
                "resolveIndecisionRelationships":{
                    "type":"boolean",
                    "description":"Indicates whether to expand relationships for indecision reports. Defaults to false."
                }
            },
            "required":[
                "id"
            ],
            "additionalProperties":false
        }
    ]
}

Nested Schema : items-oneOf[1]

Type: object

Show Source

• id(required): string
  The name of the attribute or relationship that the outcome applies to.
• knownOutcomeStyle: string
  Allowed Values: [ "value-only", "decision-report", "base-attributes" ]

  Indicates the outcome style of the outcome for known values. Defaults to 'value-only'
• resolveIndecisionRelationships: boolean
  Indicates whether to expand relationships for indecision reports. Defaults to false.
• showInvisible: boolean
  Indicates whether to force show invisible fields in decision reports. Defaults to false.
• showSlient: boolean
  Indicates whether to force show silent fields in decision reports. Defaults to false.
• unknownOutcomeStyle: string
  Allowed Values: [ "value-only", "decision-report", "base-attributes" ]

  Indicates the outcome style of the outcome for unknown values. Defaults to 'value-only'

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The name of the attribute or relationship that the outcome applies to."
        },
        "knownOutcomeStyle":{
            "type":"string",
            "description":"Indicates the outcome style of the outcome for known values. Defaults to 'value-only'",
            "enum":[
                "value-only",
                "decision-report",
                "base-attributes"
            ]
        },
        "unknownOutcomeStyle":{
            "type":"string",
            "description":"Indicates the outcome style of the outcome for unknown values. Defaults to 'value-only'",
            "enum":[
                "value-only",
                "decision-report",
                "base-attributes"
            ]
        },
        "showSlient":{
            "type":"boolean",
            "description":"Indicates whether to force show silent fields in decision reports. Defaults to false."
        },
        "showInvisible":{
            "type":"boolean",
            "description":"Indicates whether to force show invisible fields in decision reports. Defaults to false."
        },
        "resolveIndecisionRelationships":{
            "type":"boolean",
            "description":"Indicates whether to expand relationships for indecision reports. Defaults to false."
        }
    },
    "required":[
        "id"
    ],
    "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 : 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
}

Nested Schema : dataModelProperties

Type: object

Additional Properties Allowed: true

404 Response

The requested resource does not exist.

Back to Top