Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Cancel workflow execution

POST /automation/execution/workflows/{wid}/cancel

Cancels scheduled, ongoing or suspended workflow execution.

This operation requires space_schedule_atm_workflow_executions when invoked by scheduling user, or space_manage_atm_workflow_executions otherwise.

Example cURL requests

Cancel workflow execution

curl -H "X-Auth-Token: $TOKEN" \
-X POST "https://$PROVIDER_HOST/api/v3/oneprovider/automation/execution/workflows/$ATM_WORKFLOW_EXECUTION_ID/cancel"

Path parameters

Parameter	Type & Description
wid required	string Workflow execution Id.

Request Examples

Shell

oneprovider-rest-cli cancelWorkflowExecution wid=$ATM_WORKFLOW_SCHEMA_ID

Responses

application/json

204

The workflow execution cancel has been initiated.

400

Invalid request.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

403

Forbidden request.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

404

Workflow execution with provided Id was not found.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

500

Internal server error.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required integer Timestamp in milliseconds.
serviceReleaseVersion required string Release version of a product, for example "25.0".
serviceId required string Identifier of a service instance — either Oneprovider Id or "onezone".
serviceDomain required string Domain of the service.
serviceBuildVersion required string Build version of the service.
service required string Short name of service. Enum: ozwopwozpopp
onedataErrorsRevision required string Revision of onedata-errors repo, where the error is defined.
module required string Module where the error occurred.
line required integer Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}