---
title: "Set status of computation"
method: POST
path: "/computations/{computationId}/status"
tags: ["Computations"]
---

# Set status of computation

`POST /computations/{computationId}/status`

Set status of computation given the computation ID.

## Path parameters

- `computationId` string, required

## Headers

- `slb-data-partition-id` string, required

## Request body

- SetComputationStatus — The details of the computation status to be set.
  - `status` 'CompletedSuccessfully' | 'CompletedWithErrors' | 'Stopped' | 'ProgressEvent' | 'ComputationLogEvent' — The computation status.
  - `computationErrors` ComputationError[] — The computation errors. There should not be any computation errors if the status of the computation is being set to 'CompletedSuccessfully'.
    - `addresses` SpecAddress[] — A list of workflow spec addresses to describe the parts of a workflow which have resulted in the error.
      - `type` 'Invalid' | 'Computation' | 'DataTypeInput' | 'DataTypeOutput', required — Whether the address refers to a data-type input, a data-type output or a computation specification.
      - `computationIndex` integer — The zero based index of the Computation Spec.
      - `dataTypeIndex` integer — The zero based index of a data-type with respect to a computation specification. Inputs and outputs are treated as separate ordered lists.
    - `message` string — A message which describes the error(s).
  - `progressEvent` ComputationProgressEventMessage — A message to provide a progress report on the status of an ongoing computation. Messages are logged as events.
    - `timeStamp` string, date-time, required — The time that the event occurred given in format RFC3339, see. <a href="https://www.rfc-editor.org/rfc/rfc3339">https://www.rfc-editor.org/rfc/rfc3339</a>.
    - `progressStatus` string, required — The progress status of the computation e.g. Queued.
    - `source` string, required — The environment/infrastructure the computation is executing.
    - `body` string — Free-form text as per individual requirements.
  - `computationLogEvent` ComputationLogEvent — The computationLogEvent. The log event should contain a list of logs associated with the computation.
    - `logs` ComputationLog[] — The computation logs.
      - `text` string — Text to describe the computation log file.
      - `filePath` string — File path for the log file.

## Response `201`

Computation status updated successfully.

- Computation — A computation is an instance of a computation specification which keeps track of a computation state as well as its input and output containers.
  - `id` string, required — The computation ID.
  - `status` 'Running' | 'CompletedSuccessfully' | 'CompletedWithErrors' | 'Stopping' | 'Stopped' — The computation status.
  - `computationSpec` VersionId — A specification reference which allows the API users to specify the version of a specification when creating or updating a parent specification.
    - `id` string, required — The specification ID.
    - `version` integer, required — The version of the specification of the given ID.
  - `inputContainers` Container[] — A list of containers for the computation inputs.
    - `id` string — The ID of the container.
    - `dataType` WorkflowDataType — A specification reference which allows the API users to specify the version of a specification when creating or updating a parent specification.
      - `id` string, required — The specification ID.
      - `version` integer, required — The version of the specification of the given ID.
      - `address` SpecAddress — An address used to describe the location of a Spec within a WorkflowSpec. Used to enrich the spec model with additional attributes such as specifying the location of a data container or providing annotations.
        - `type` 'Invalid' | 'Computation' | 'DataTypeInput' | 'DataTypeOutput', required — Whether the address refers to a data-type input, a data-type output or a computation specification.
        - `computationIndex` integer — The zero based index of the Computation Spec.
        - `dataTypeIndex` integer — The zero based index of a data-type with respect to a computation specification. Inputs and outputs are treated as separate ordered lists.
    - `store` string — The data store where the data within the container is located.
    - `fileNames` string[] — The file names which are part of the container. (marked for deprecation in favour of files).
    - `files` File[] — The files which are part of the container.
      - `name` string, required — The name of the file.
      - `content` string — Encoded content of the file in the Data URI format. It will be empty if the file size is larger than 15kb.
    - `labels` ContainerLabels — The labels of a container.
    - `caseContainers` CaseContainer[] — The containers for each case (only if the current container is a composite container)
      - `name` string, required — The name of the case.
      - `uri` string, required — The uri of the container.
      - `dataType` string, required — The data-type the container contains.
      - `version` integer, required — The version of the data-type to which the data container is associated.
  - `outputContainers` Container[] — A list of containers for the computation outputs.
    - `id` string — The ID of the container.
    - `dataType` WorkflowDataType — A specification reference which allows the API users to specify the version of a specification when creating or updating a parent specification.
      - `id` string, required — The specification ID.
      - `version` integer, required — The version of the specification of the given ID.
      - `address` SpecAddress — An address used to describe the location of a Spec within a WorkflowSpec. Used to enrich the spec model with additional attributes such as specifying the location of a data container or providing annotations.
        - `type` 'Invalid' | 'Computation' | 'DataTypeInput' | 'DataTypeOutput', required — Whether the address refers to a data-type input, a data-type output or a computation specification.
        - `computationIndex` integer — The zero based index of the Computation Spec.
        - `dataTypeIndex` integer — The zero based index of a data-type with respect to a computation specification. Inputs and outputs are treated as separate ordered lists.
    - `store` string — The data store where the data within the container is located.
    - `fileNames` string[] — The file names which are part of the container. (marked for deprecation in favour of files).
    - `files` File[] — The files which are part of the container.
      - `name` string, required — The name of the file.
      - `content` string — Encoded content of the file in the Data URI format. It will be empty if the file size is larger than 15kb.
    - `labels` ContainerLabels — The labels of a container.
    - `caseContainers` CaseContainer[] — The containers for each case (only if the current container is a composite container)
      - `name` string, required — The name of the case.
      - `uri` string, required — The uri of the container.
      - `dataType` string, required — The data-type the container contains.
      - `version` integer, required — The version of the data-type to which the data container is associated.
  - `logsContainer` Container — A container is an instance of a data-type which is used to obtain the location of files which are part of the container, along with input and output errors.
    - `id` string — The ID of the container.
    - `dataType` WorkflowDataType — A specification reference which allows the API users to specify the version of a specification when creating or updating a parent specification.
      - `id` string, required — The specification ID.
      - `version` integer, required — The version of the specification of the given ID.
      - `address` SpecAddress — An address used to describe the location of a Spec within a WorkflowSpec. Used to enrich the spec model with additional attributes such as specifying the location of a data container or providing annotations.
        - `type` 'Invalid' | 'Computation' | 'DataTypeInput' | 'DataTypeOutput', required — Whether the address refers to a data-type input, a data-type output or a computation specification.
        - `computationIndex` integer — The zero based index of the Computation Spec.
        - `dataTypeIndex` integer — The zero based index of a data-type with respect to a computation specification. Inputs and outputs are treated as separate ordered lists.
    - `store` string — The data store where the data within the container is located.
    - `fileNames` string[] — The file names which are part of the container. (marked for deprecation in favour of files).
    - `files` File[] — The files which are part of the container.
      - `name` string, required — The name of the file.
      - `content` string — Encoded content of the file in the Data URI format. It will be empty if the file size is larger than 15kb.
    - `labels` ContainerLabels — The labels of a container.
    - `caseContainers` CaseContainer[] — The containers for each case (only if the current container is a composite container)
      - `name` string, required — The name of the case.
      - `uri` string, required — The uri of the container.
      - `dataType` string, required — The data-type the container contains.
      - `version` integer, required — The version of the data-type to which the data container is associated.
  - `computationErrors` ComputationError[] — The error associated with the computation.
    - `addresses` SpecAddress[] — A list of workflow spec addresses to describe the parts of a workflow which have resulted in the error.
      - `type` 'Invalid' | 'Computation' | 'DataTypeInput' | 'DataTypeOutput', required — Whether the address refers to a data-type input, a data-type output or a computation specification.
      - `computationIndex` integer — The zero based index of the Computation Spec.
      - `dataTypeIndex` integer — The zero based index of a data-type with respect to a computation specification. Inputs and outputs are treated as separate ordered lists.
    - `message` string — A message which describes the error(s).
  - `computationConfiguration` object — A computation configuration describes the configuration properties of the computation.
    - `schemaRef` SchemaRef — A schema reference.
      - `id` string, required — The unique idenitifer for the schema.
      - `type` 'JSON', required — The type of schema, for instance JSON schema.

## Other responses

- `401` — Unauthorized.
- `404` — The computation was not found.
- `default` — Unexpected error.

---

[API](https://skmtc.net/slb/apis/evaluation.md) · [All operations](https://skmtc.net/slb/apis/evaluation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/slb/evaluation/revisions/b563a2fae7de/schema)