Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get workflow execution details

GET /automation/execution/workflows/{wid}

Returns the details of a specific workflow execution.

This operation requires space_view_atm_workflow_executions privilege and the requesting user must belong to the automation inventory containing the corresponding workflow schema definition.

Example cURL requests

Get workflow execution details

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

{
    "atmWorkflowExecutionId": "11a53ed06d175c89bc3ed5be61f8217cch1890",
    "atmWorkflowSchemaSnapshotId": "821711ad53ed06be61f175c89bc3ed5cch1890",
    "name": "test execution",
    "atmInventoryId": "2d180796daafcf15d586d29dd13dae48chd5fc",
    "spaceId": "c17147cc3188408c26f522881282cb83ch9853",
    "userId": "08c26cc228812c3188417147f582cb83ch9853",
    "status": "enqueued",
    "scheduleTime": 1626107063,
    "startTime": 0,
    "suspendTime": 0,
    "finishTime": 0,
    "lambdaSnapshotRegistry": {
        "e412848d415329d81b7edd15c80b7740chf93f": "3946496fb29e3cf3faa96dbbd58d42d9ch9e3c"
    },
    "storeRegistry": {
        "216a5de15ba9f8f3138168682c3da954212abf": "805392e2b84fb7e6ff5b31b4b7e70845ch1995"
    },
    "systemAuditLogStoreId": "1439ca4dee1a251483923f4535bca500e72f2a",
    "lanes": [
        {
            "schemaId": "3a1a829f714a41b043c4ce67402d8c136f125f",
            "runs": [
                {
                    "runNumber": 3,
                    "originRunNumber": 1,
                    "runType": "retry",
                    "status": "pending",
                    "iteratedStoreId": "1b502545a3f9faa7f1e339f4aea793117be91d",
                    "exceptionStoreId": "98c669ec69c0394a38391c0ab0117f67ch260d",
                    "parallelBoxes": [
                        {
                            "taskRegistry": {
                                "d92b861a5edfb08b920e0e80f4670a87f48176": "1697f7c1f46e0e22bb426bead5a3cb47chda3d"
                            },
                            "schemaId": "0068146d662adc878f699bf82af08b9ddbd9ab"
                        }
                    ],
                    "isRetriable": false,
                    "isRerunable": false
                },
                ...
            ]
        }
    ]
}

Path parameters

Parameter	Type & Description
wid required	string Workflow execution Id.

Request Examples

Shell

oneprovider-rest-cli getWorkflowExecutionDetails wid=$ATM_WORKFLOW_EXECUTION_ID

Responses

application/json

200

Workflow execution details.

Property Type & Description

atmWorkflowExecutionId

string

Id of this workflow execution.

atmWorkflowSchemaSnapshotId

string

Id of the snapshot of the workflow schema describing the tasks and stores for this workflow.

name

string

Name of the workflow schema used for this execution.

atmInventoryId

string

Id of automation inventory from which the workflow schema originates.

spaceId

string

Id of the space in context of which the workflow was executed.

userId

string

Id of the scheduling user.

status

string

Overall status of the workflow execution.

Enum:

resumingscheduledactivestoppinginterruptedpausedfinishedcrashedcancelledfailed

scheduleTime

integer

Schedule time in seconds (POSIX epoch timestamp).

startTime

integer

Start time in seconds (POSIX epoch timestamp).

suspendTime

integer

Suspend time in seconds (POSIX epoch timestamp).

finishTime

integer

Finish time in seconds (POSIX epoch timestamp).

lambdaSnapshotRegistry

object

Map with lambda Ids (keys) and corresponding snapshot Ids.

storeRegistry

object

Map with store schema Ids (keys) and corresponding store instance Ids.

systemAuditLogStoreId

string

Id of this execution system audit log store.

lanes

array of objects

Details of lanes in this workflow execution.

schemaId

string

Id of the lane schema used for this execution.

runs

array of objects (AtmWorkflowExecutionLaneRunDetails)

Basic information about lane's runs.

runNumber required

integer

Number of workflow execution run in which this lane run is included. When prepared in advance, this value is null, as the specific number is not yet known.

originRunNumber required

integer

Number of workflow execution lane run on which this lane run is based in case of repeat (either rerun or retry) or null otherwise.

runType required

string

Type of lane run.

Enum:

regularrerunretry

status required

string

Overall status of the lane run.

Enum:

resumingscheduledpreparingenqueuedactivestoppinginterruptedpausedfinishedcrashedcancelledfailed

iteratedStoreId required

string

Id of this lane run iterated store.

exceptionStoreId required

string

Id of this lane run exception store.

parallelBoxes required

array of objects

Details of parallel boxes in this lane run.

schemaId string Id of the parallel box schema used for this execution.
taskRegistry object Map with task schema Ids (keys) and corresponding task execution Ids.

isRetriable required

boolean

Indicates whether this lane execution run can be retried or not.

isRerunable required

boolean

Indicates whether this lane execution run can be rerun or not.

Example

application/json

{
  "atmWorkflowExecutionId": "11a53ed06d175c89bc3ed5be61f8217cch1890",
  "atmWorkflowSchemaSnapshotId": "821711ad53ed06be61f175c89bc3ed5cch1890",
  "name": "test execution",
  "atmInventoryId": "2d180796daafcf15d586d29dd13dae48chd5fc",
  "spaceId": "c17147cc3188408c26f522881282cb83ch9853",
  "userId": "08c26cc228812c3188417147f582cb83ch9853",
  "status": "enqueued",
  "scheduleTime": 1626107063,
  "startTime": 0,
  "suspendTime": 0,
  "finishTime": 0,
  "lambdaSnapshotRegistry": {
    "e412848d415329d81b7edd15c80b7740chf93f": "3946496fb29e3cf3faa96dbbd58d42d9ch9e3c"
  },
  "storeRegistry": {
    "216a5de15ba9f8f3138168682c3da954212abf": "805392e2b84fb7e6ff5b31b4b7e70845ch1995"
  },
  "systemAuditLogStoreId": "1439ca4dee1a251483923f4535bca500e72f2a",
  "lanes": [
    {
      "schemaId": "3a1a829f714a41b043c4ce67402d8c136f125f",
      "runs": [
        {
          "runNumber": 1,
          "originRunNumber": null,
          "runType": "regular",
          "status": "pending",
          "iteratedStoreId": "1b502545a3f9faa7f1e339f4aea793117be91d",
          "exceptionStoreId": "98c669ec69c0394a38391c0ab0117f67ch260d",
          "parallelBoxes": {
            "schemaId": "0068146d662adc878f699bf82af08b9ddbd9ab",
            "taskRegistry": {
              "d92b861a5edfb08b920e0e80f4670a87f48176": "1697f7c1f46e0e22bb426bead5a3cb47chda3d"
            }
          },
          "isRetriable": false,
          "isRerunable": false
        }
      ]
    }
  ]
}

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
    }
  }
}