Jump to

• Request
• Response

Create a referencesTo

post

https://{your_site_interface}/opa-hub/api/12.2.34/deployments/{deployment-name}/referencesTo

This operation will create a referencesTo.

Request

Path Parameters

• deployment-name(required): string
  The name of the deployment.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• scope(required): string
  Allowed Values: [ "active", "latest", "all" ]

  The scope of the references to be reported.
• targets(required): string
  Allowed Values: [ "deployments", "projects", "all" ]

  The requested targets for this report.

{
    "type":"object",
    "properties":{
        "targets":{
            "type":"string",
            "description":"The requested targets for this report.",
            "writeOnly":true,
            "enum":[
                "deployments",
                "projects",
                "all"
            ]
        },
        "scope":{
            "type":"string",
            "description":"The scope of the references to be reported.",
            "writeOnly":true,
            "enum":[
                "active",
                "latest",
                "all"
            ]
        }
    },
    "additionalProperties":false,
    "required":[
        "scope",
        "targets"
    ]
}

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

201 Response

The request has been fulfilled and resulted in a new resource being created.

Body ()

Root Schema : referencesTo

Type: object

Show Source

• deployments: object referencesToDeployments
• projects: object referencesToProjects

{
    "type":"object",
    "properties":{
        "deployments":{
            "description":"The object containing deployment reference information.",
            "readOnly":true,
            "$ref":"#/components/schemas/referencesToDeployments"
        },
        "projects":{
            "description":"The object containing project reference information.",
            "readOnly":true,
            "$ref":"#/components/schemas/referencesToProjects"
        }
    },
    "additionalProperties":false
}

Nested Schema : referencesToDeployments

Type: object

Show Source

• entries: array entries
  Read Only: true

  An array of deployment references,
• hiddenEntries: integer (int64)
  Read Only: true

  The number of hidden references to this deployment, due to permissions.
• totalEntries: integer (int64)
  Read Only: true

  The total number of references to this deployment.

{
    "type":"object",
    "properties":{
        "totalEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of references to this deployment.",
            "readOnly":true
        },
        "hiddenEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The number of hidden references to this deployment, due to permissions.",
            "readOnly":true
        },
        "entries":{
            "type":"array",
            "description":"An array of deployment references,",
            "readOnly":true,
            "items":{
                "description":"Describes a single deployment version that refers to this deployment.",
                "$ref":"#/components/schemas/referencesToDeploymentItem"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : referencesToProjects

Type: object

Show Source

• entries: array entries
  Read Only: true

  An array of project references,
• hiddenEntries: integer (int64)
  Read Only: true

  The number of hidden references to this project, due to permissions.
• totalEntries: integer (int64)
  Read Only: true

  The total number of references to this project.

{
    "type":"object",
    "properties":{
        "totalEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of references to this project.",
            "readOnly":true
        },
        "hiddenEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The number of hidden references to this project, due to permissions.",
            "readOnly":true
        },
        "entries":{
            "type":"array",
            "description":"An array of project references,",
            "readOnly":true,
            "items":{
                "description":"Describes a single deployment version that refers to this deployment.",
                "$ref":"#/components/schemas/referencesToProjectItem"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : entries

Type: array

Read Only: true

An array of deployment references,

Show Source

• Array of: object referencesToDeploymentItem

{
    "type":"array",
    "description":"An array of deployment references,",
    "readOnly":true,
    "items":{
        "description":"Describes a single deployment version that refers to this deployment.",
        "$ref":"#/components/schemas/referencesToDeploymentItem"
    }
}

Nested Schema : referencesToDeploymentItem

Type: object

Show Source

• activeFlag: boolean
  Read Only: true

  Whether this deployment version is the active version.
• environment: string
  Read Only: true

  The environment for this deployment version. Only populated when environments are active.
• fingerprint: string
  Read Only: true

  The fingerprint of this deployment version.
• kind: string
  Read Only: true

  Allowed Values: [ "opm", "flow", "decision" ]

  The kind of the deployment version.
• name: string
  Read Only: true

  The name of the deployment.
• versionNo: integer (int64)
  Read Only: true

  The deployment version.
• workspace: string
  The workspace which the deployment is a member.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the deployment.",
            "readOnly":true
        },
        "versionNo":{
            "type":"integer",
            "format":"int64",
            "description":"The deployment version.",
            "readOnly":true
        },
        "fingerprint":{
            "type":"string",
            "description":"The fingerprint of this deployment version.",
            "readOnly":true
        },
        "kind":{
            "type":"string",
            "description":"The kind of the deployment version.",
            "readOnly":true,
            "enum":[
                "opm",
                "flow",
                "decision"
            ]
        },
        "activeFlag":{
            "type":"boolean",
            "description":"Whether this deployment version is the active version.",
            "readOnly":true
        },
        "environment":{
            "type":"string",
            "description":"The environment for this deployment version. Only populated when environments are active.",
            "readOnly":true
        },
        "workspace":{
            "type":"string",
            "description":"The workspace which the deployment is a member."
        }
    },
    "additionalProperties":false
}

Nested Schema : entries

Type: array

Read Only: true

An array of project references,

Show Source

• Array of: object referencesToProjectItem

{
    "type":"array",
    "description":"An array of project references,",
    "readOnly":true,
    "items":{
        "description":"Describes a single deployment version that refers to this deployment.",
        "$ref":"#/components/schemas/referencesToProjectItem"
    }
}

Nested Schema : referencesToProjectItem

Type: object

Show Source

• environment: string
  Read Only: true

  The environment for this project version. Only populated when environments are active.
• fingerprint: string
  Read Only: true

  The fingerprint of this project version.
• kind: string
  Read Only: true

  Allowed Values: [ "opm", "flow", "decision" ]

  The kind of the project version.
• name: string
  Read Only: true

  The name of the project.
• versionNo: integer (int64)
  Read Only: true

  The project version.
• workspace: string
  The workspace which the project is a member.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the project.",
            "readOnly":true
        },
        "versionNo":{
            "type":"integer",
            "format":"int64",
            "description":"The project version.",
            "readOnly":true
        },
        "fingerprint":{
            "type":"string",
            "description":"The fingerprint of this project version.",
            "readOnly":true
        },
        "kind":{
            "type":"string",
            "description":"The kind of the project version.",
            "readOnly":true,
            "enum":[
                "opm",
                "flow",
                "decision"
            ]
        },
        "environment":{
            "type":"string",
            "description":"The environment for this project version. Only populated when environments are active.",
            "readOnly":true
        },
        "workspace":{
            "type":"string",
            "description":"The workspace which the project is a member."
        }
    },
    "additionalProperties":false
}

400 Response

The request could not be processed because it contains missing or invalid information.

Back to Top