Jump to

• Request
• Response

Get a projectDefinition

get

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

This operation will get the definition as JSON for a Decision Service or Flow deployment.

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/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 : projectDefinition

Type: object

Show Source

• definition: object definition
  Read Only: true

  Additional Properties Allowed: true

  The Decision service or Flow project
• scheme: object scheme
  Read Only: true

  Additional Properties Allowed: true

  The Flow Scheme. Only supplied for Flow deployments.

{
    "type":"object",
    "properties":{
        "definition":{
            "type":"object",
            "description":"The Decision service or Flow project",
            "additionalProperties":true,
            "readOnly":true
        },
        "scheme":{
            "type":"object",
            "description":"The Flow Scheme. Only supplied for Flow deployments.",
            "additionalProperties":true,
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : definition

Type: object

Read Only: true

Additional Properties Allowed: true

The Decision service or Flow project

Nested Schema : scheme

Type: object

Read Only: true

Additional Properties Allowed: true

The Flow Scheme. Only supplied for Flow deployments.

304 Response

The resource wasn't modified according to the ETag that was provided.

404 Response

The requested resource does not exist.

410 Response

The requested resource is no longer available.

412 Response

The resource state on the server side doesn't match the provided ETag.

Back to Top