Jump to

• Request
• Response

Replace an operation

put

https://{your_site_interface}/opa-hub/api/12.2.35/operations/{operation-name}

This operation will replace an operation.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• invokeUrl(required): string
  The URL to be called when the operation is invoked.
• name(required): string
  The name of the operation.
• queryParams(required): array queryParams
  The query parameter names expected by the operation endpoint
• statusUrl(required): string
  The URL to be called to check the status of the operation.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the operation."
        },
        "invokeUrl":{
            "type":"string",
            "description":"The URL to be called when the operation is invoked."
        },
        "statusUrl":{
            "type":"string",
            "description":"The URL to be called to check the status of the operation."
        },
        "queryParams":{
            "type":"array",
            "description":"The query parameter names expected by the operation endpoint",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false,
    "required":[
        "queryParams",
        "statusUrl",
        "name",
        "invokeUrl"
    ]
}

Nested Schema : queryParams

Type: array

The query parameter names expected by the operation endpoint

Show Source

• Array of: string

{
    "type":"array",
    "description":"The query parameter names expected by the operation endpoint",
    "items":{
        "type":"string"
    }
}

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

Type: object

Show Source

• interfaces: object interfaces
• invokeUrl(required): string
  The URL to be called when the operation is invoked.
• name(required): string
  The name of the operation.
• queryParams(required): array queryParams
  The query parameter names expected by the operation endpoint
• state: string
  Read Only: true

  The state of the operation.
• statusUrl(required): string
  The URL to be called to check the status of the operation.
• type: string
  Read Only: true

  The type of the operation.
• version: number (double)
  Read Only: true

  The version of the operation.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the operation."
        },
        "type":{
            "type":"string",
            "description":"The type of the operation.",
            "readOnly":true
        },
        "state":{
            "type":"string",
            "description":"The state of the operation.",
            "readOnly":true
        },
        "version":{
            "type":"number",
            "format":"double",
            "description":"The version of the operation.",
            "readOnly":true
        },
        "invokeUrl":{
            "type":"string",
            "description":"The URL to be called when the operation is invoked."
        },
        "statusUrl":{
            "type":"string",
            "description":"The URL to be called to check the status of the operation."
        },
        "queryParams":{
            "type":"array",
            "description":"The query parameter names expected by the operation endpoint",
            "items":{
                "type":"string"
            }
        },
        "interfaces":{
            "readOnly":true,
            "$ref":"#/components/schemas/interfaces"
        }
    },
    "additionalProperties":false,
    "required":[
        "queryParams",
        "statusUrl",
        "name",
        "invokeUrl"
    ]
}

Nested Schema : interfaces

Type: object

Show Source

• items: array items

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

Nested Schema : queryParams

Type: array

The query parameter names expected by the operation endpoint

Show Source

• Array of: string

{
    "type":"array",
    "description":"The query parameter names expected by the operation endpoint",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object interface

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/interface"
    }
}

Nested Schema : interface

Type: object

Show Source

• name: string
  Read Only: true

  The name of the interface
• properties: object interfaceProperties
  Additional Properties Allowed: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the interface",
            "readOnly":true
        },
        "properties":{
            "description":"The properties of the object.",
            "readOnly":true,
            "$ref":"#/components/schemas/interfaceProperties"
        }
    },
    "additionalProperties":false
}

Nested Schema : interfaceProperties

Type: object

Additional Properties Allowed: true

400 Response

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

403 Response

The user does not have authorization for this resource.

404 Response

The requested resource does not exist.

409 Response

The request could not be completed due to a conflict with the current state of the resource.

Back to Top