Jump to

• Request
• Response

Get an about

get

https://{your_site_interface}/opa-hub/api/12.2.40/about

This operation will get basic About information for the Intelligent Advisor Hub.

Request

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 : about

Type: object

Show Source

• otherPolicyModelingInstallerLinks: array otherPolicyModelingInstallerLinks
  Read Only: true

  Contains an array of links to other Policy Modeling installers available for this Hub.
• policyModelingInstallerLink: string
  The Policy Modeling installer url for the of this release.
• product: string
  The descriptive product name.
• siteType: string
  Allowed Values: [ "studio", "production", "test", "development" ]

  The site type
• version: string
  The fully-qualified version identifier, as a decimal separated numeric id.
• versionName: string
  The name of this release.

{
    "type":"object",
    "properties":{
        "product":{
            "type":"string",
            "description":"The descriptive product name."
        },
        "version":{
            "type":"string",
            "description":"The fully-qualified version identifier, as a decimal separated numeric id."
        },
        "versionName":{
            "type":"string",
            "description":"The name of this release."
        },
        "siteType":{
            "type":"string",
            "description":"The site type",
            "enum":[
                "studio",
                "production",
                "test",
                "development"
            ]
        },
        "policyModelingInstallerLink":{
            "type":"string",
            "description":"The Policy Modeling installer url for the  of this release."
        },
        "otherPolicyModelingInstallerLinks":{
            "type":"array",
            "description":"Contains an array of links to other Policy Modeling installers available for this Hub.",
            "readOnly":true,
            "items":{
                "description":"A link to a Policy Modeling installer",
                "$ref":"#/components/schemas/aboutOpmInstallerLink"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : otherPolicyModelingInstallerLinks

Type: array

Read Only: true

Contains an array of links to other Policy Modeling installers available for this Hub.

Show Source

• Array of: object aboutOpmInstallerLink

{
    "type":"array",
    "description":"Contains an array of links to other Policy Modeling installers available for this Hub.",
    "readOnly":true,
    "items":{
        "description":"A link to a Policy Modeling installer",
        "$ref":"#/components/schemas/aboutOpmInstallerLink"
    }
}

Nested Schema : aboutOpmInstallerLink

Type: object

Show Source

• url: string
  Read Only: true

  The url to the Policy Modeling installer
• versionName: string
  Read Only: true

  The version of the Policy Modeling installer

{
    "type":"object",
    "properties":{
        "versionName":{
            "type":"string",
            "description":"The version of the Policy Modeling installer",
            "readOnly":true
        },
        "url":{
            "type":"string",
            "description":"The url to the Policy Modeling installer",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Back to Top