Jump to

• Request
• Response

Get URL parameters

get

https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/versions/{deployment-version-versionNo}/urlParameters

This operation will get a deployment version's seed data URL parameters as a JSON data model.

Request

Path Parameters

• deployment-name(required): string
  The name of the deployment.
• deployment-version-versionNo(required): integer(int64)
  The version number for the deployment version.

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

Type: object

Show Source

• properties: object urlParametersProperties
  Additional Properties Allowed: true
• type(required): string
  Allowed Values: [ "global", "containmentRelationship", "boolean", "text", "number", "currency", "date", "datetime", "time of day" ]

  The object type. The root object will always be of type 'global'.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The object type. The root object will always be of type 'global'.",
            "enum":[
                "global",
                "containmentRelationship",
                "boolean",
                "text",
                "number",
                "currency",
                "date",
                "datetime",
                "time of day"
            ]
        },
        "properties":{
            "description":"If the type is 'global' or 'containmentRelationship', the attributes and relationships contained by this entity.",
            "$ref":"#/components/schemas/urlParametersProperties"
        }
    },
    "additionalProperties":false,
    "required":[
        "type"
    ]
}

Nested Schema : urlParametersProperties

Type: object

Additional Properties Allowed: true

Back to Top