Acronis Activities API

openapi: 3.2.0
info:
  title: Acronis Activities API
  x-refined-note:
  - x-generated-from differs across the merged source definitions and was not carried
  - x-last-validated differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Activities across 2 of this provider''s published API definitions: acronis-tasks-v2-openapi.json, acronis-task-manager-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dev-cloud.acronis.com/api/task_manager/v2
  variables: {}
- url: https://{datacenter}.acronis.com/api/task_manager/v2
  description: Acronis Task Manager API
  variables:
    datacenter:
      default: eu2-cloud
      description: Acronis datacenter region
tags:
- name: Activities
paths:
  /activities:
    get:
      operationId: Fetch a list of activities
      description: 'Fetches a list of activities.


        # Sustainable behavior (informative):

        Sustainable activities move to `enqueued` when their task is requeued and must be restarted with `PUT /activities/{id}/started`.

        If not restarted by task completion, they will be marked `abandoned`.'
      x-AllowedTo:
      - task_manager::admin
      - task_manager::viewer
      parameters:
      - name: lod
        in: query
        schema:
          $ref: '#/components/schemas/levelOfDetail'
      - name: limit
        description: A number of activities to return in one page. This parameter restricts usage of the query string parameters to `after`.
        in: query
        schema:
          description: A number of activities to return in one page. This parameter restricts usage of the query string parameters to `after`.
          type: integer
      - name: after
        description: The page token with the next page of the results. Can be used only with the `limit` query string parameter.
        in: query
        schema:
          description: The page token with the next page of the results. Can be used only with the `limit` query string parameter.
          type: string
      - name: order
        description: 'An ordering filter (position-dependent).


          Available ordering operators are:

          - `asc(field)` - ascending order

          - `desc(field)` - descending order


          Where "field" is one of the following values:  `id`, `uuid`, `type`, `startedByUser`,

          `state`, `createdAt`, `startedAt`, `updatedAt`, `completedAt`.

          '
        in: query
        schema:
          description: 'An ordering filter (position-dependent).


            Available ordering operators are:

            - `asc(field)` - ascending order

            - `desc(field)` - descending order


            Where "field" is one of the following values:  `id`, `uuid`, `type`, `startedByUser`,

            `state`, `createdAt`, `startedAt`, `updatedAt`, `completedAt`.

            '
          type: string
      - name: id
        description: An ID filter. Multiple entries are accepted.
        in: query
        schema:
          description: An ID filter. Multiple entries are accepted.
          type: integer
      - name: uuid
        description: A UUID filter. Multiple entries are accepted.
        in: query
        schema:
          description: A UUID filter. Multiple entries are accepted.
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      - name: type
        description: A type filter. Multiple entries are accepted.
        in: query
        schema:
          description: A type filter. Multiple entries are accepted.
          type: string
      - name: startedBy
        description: 'A filter by a user who started the activity. Multiple entries are accepted.


          The ''like'' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where "value" is a sequence of characters.

          '
        in: query
        schema:
          description: 'A filter by a user who started the activity. Multiple entries are accepted.


            The ''like'' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where "value" is a sequence of characters.

            '
          type: string
      - name: policyId
        description: A policy ID filter. Multiple entries are accepted.
        in: query
        schema:
          description: A policy ID filter. Multiple entries are accepted.
          type: string
      - name: policyName
        description: 'A policy name filter. Multiple entries are accepted.


          The ''like'' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where "value" is a sequence of characters.

          '
        in: query
        schema:
          description: 'A policy name filter. Multiple entries are accepted.


            The ''like'' operator can be used to find a policy name by a sequence of characters. Usage: `like(value)` where "value" is a sequence of characters.

            '
          type: string
      - name: policyType
        description: A policy type filter. Multiple entries are accepted.
        in: query
        schema:
          description: A policy type filter. Multiple entries are accepted.
          type: string
      - name: resourceId
        description: A resource ID filter. Multiple entries are accepted.
        in: query
        schema:
          description: A resource ID filter. Multiple entries are accepted.
          type: string
      - name: resourceName
        description: 'A resource name filter. Multiple entries are accepted.


          The ''like'' operator can be used to find a resource name by a sequence of characters. Usage: `like(value)` where "value" is a sequence of characters.

          '
        in: query
        schema:
          description: 'A resource name filter. Multiple entries are accepted.


            The ''like'' operator can be used to find a resource name by a sequence of characters. Usage: `like(value)` where "value" is a sequence of characters.

            '
          type: string
      - name: resourceType
        description: A resource type filter. Multiple entries are accepted.
        in: query
        schema:
          description: A resource type filter. Multiple entries are accepted.
          type: string
      - name: taskId
        description: A task ID filter. Multiple entries are accepted.
        in: query
        schema:
          description: A task ID filter. Multiple entries are accepted.
          type: integer
      - name: workflowId
        description: A workflow ID filter. Multiple entries are accepted.
        in: query
        schema:
          description: A workflow ID filter. Multiple entries are accepted.
          type: integer
      - name: parentActivityId
        description: A parent activity ID filter. Multiple entries are accepted.
        in: query
        schema:
          description: A parent activity ID filter. Multiple entries are accepted.
          type: integer
      - name: state
        description: A state filter. Multiple entries are accepted.
        in: query
        schema:
          description: A state filter. Multiple entries are accepted.
          enum:
          - enqueued
          - assigned
          - started
          - paused
          - completed
          type: string
      - name: resultCode
        description: A code filter. Multiple entries are accepted.
        in: query
        schema:
          description: A code filter. Multiple entries are accepted.
          enum:
          - ok
          - error
          - warning
          - cancelled
          - abandoned
          - timedout
          type: string
      - name: createdAt
        description: A time filter. Single entry is accepted.
        in: query
        schema:
          description: A time filter. Single entry is accepted.
          type: string
      - name: startedAt
        description: A time filter. Single entry is accepted.
        in: query
        schema:
          description: A time filter. Single entry is accepted.
          type: string
      - name: updatedAt
        description: A time filter. Single entry is accepted.
        in: query
        schema:
          description: A time filter. Single entry is accepted.
          type: string
      - name: completedAt
        description: A time filter. Single entry is accepted.
        in: query
        schema:
          description: A time filter. Single entry is accepted.
          type: string
      - name: tag
        description: A tag filter. Multiple entries are accepted.
        in: query
        schema:
          description: A tag filter. Multiple entries are accepted.
          type: string
      - name: sustainable
        description: Filter by sustainable activities.
        in: query
        schema:
          description: Filter by sustainable activities.
          type: boolean
      - name: allow_deleted
        description: If true, allows to work with deleted entities.
        required: false
        in: query
        schema:
          description: If true, allows to work with deleted entities.
          example: true
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: A collection of activities.
                type: object
                required:
                - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/activity'
                  cursors:
                    type: object
                    properties:
                      after:
                        description: The page token that points to the next page
                        type: string
                      before:
                        description: The page token that points to the previous page.
                        type: string
        '400':
          description: Bad user input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domainError'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domainError'
      security:
      - oauth2:
        - urn:acronis.com::task_manager::admin
        - urn:acronis.com::task_manager::viewer
      tags:
      - Activities
      summary: Fetch a list of activities
      x-summary-source: derived
    servers:
    - url: https://dev-cloud.acronis.com/api/task_manager/v2
      variables: {}
  /activities/{activity-id}:
    get:
      operationId: Fetch an activity
      description: Fetches an activity by provided activity ID.
      x-AllowedTo:
      - task_manager::admin
      - task_manager::viewer
      parameters:
      - name: lod
        in: query
        schema:
          $ref: '#/components/schemas/levelOfDetailSingleEntity'
      - name: allow_deleted
        description: If true, allows to work with deleted entities.
        required: false
        in: query
        schema:
          description: If true, allows to work with deleted entities.
          example: true
          type: boolean
      - name: activity-id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/activity_2'
        '400':
          description: Bad user input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domainError'
        '404':
          description: The activity does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domainError'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domainError'
      security:
      - oauth2:
        - urn:acronis.com::task_manager::admin
        - urn:acronis.com::task_manager::viewer
      tags:
      - Activities
      summary: Fetch an activity
      x-summary-source: derived
    servers:
    - url: https://dev-cloud.acronis.com/api/task_manager/v2
      variables: {}
  /activities/{activity_id}:
    get:
      operationId: getActivity
      summary: Acronis Get Activity
      description: Retrieve details about a specific task activity by ID.
      tags:
      - Activities
      parameters:
      - name: activity_id
        in: path
        required: true
        schema:
          type: string
        description: Activity unique identifier
      responses:
        '200':
          description: Activity details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activity'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    servers:
    - url: https://{datacenter}.acronis.com/api/task_manager/v2
      description: Acronis Task Manager API
      variables:
        datacenter:
          default: eu2-cloud
          description: Acronis datacenter region
components:
  schemas:
    tenant:
      description: A tenant identity.
      type: object
      required:
      - id
      - uuid
      properties:
        id:
          $ref: '#/components/schemas/string64'
        uuid:
          $ref: '#/components/schemas/uuid'
        name:
          type: string
        locator:
          description: A hierarchical tenant identifier in the following format - `/root-id/unit-id/sub-unit-id/tenant-id/`.
          type: string
    kbLinkInfo:
      description: Components for kblink
      type: object
      required:
      - lineTag
      - serCode
      - version
      - build
      - product
      - os
      properties:
        lineTag:
          type: string
        serCode:
          type: string
        version:
          type: string
        build:
          type: integer
        product:
          type: string
        os:
          type: string
    string64:
      description: A string that may contain up to 64 characters.
      type: string
    executionBottleneck:
      description: An execution bottleneck. The sum of all field values must equal 100.
      type: object
      properties:
        source:
          description: Bottleneck score when reading data.
          type: integer
          minimum: 0
          maximum: 100
        destination:
          description: Bottleneck score when writing data.
          type: integer
          minimum: 0
          maximum: 100
        processing:
          description: Bottleneck score during data processing on executor side.
          type: integer
          minimum: 0
          maximum: 100
    actor:
      description: An actor identity.
      type: object
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/string64'
        clusterId:
          $ref: '#/components/schemas/string64'
    blob:
      description: Arbitrary data.
    resultCode:
      enum:
      - ok
      - error
      - warning
      - cancelled
      - abandoned
      - timedout
      type: string
    levelOfDetailSingleEntity:
      enum:
      - tiny
      - short
      - long
      - full
      - debug
      type: string
    activity_2:
      description: The activity object.
      type: object
      required:
      - state
      - taskId
      - tenant
      - id
      - createdAt
      - updatedAt
      - executor
      - type
      properties:
        parentActivityId:
          description: The ID of the parent activity.
          type: integer
        state:
          $ref: '#/components/schemas/executionState'
        taskId:
          description: The ID of the task that is related to the activity.
          type: integer
        context:
          description: Activity context.
        result:
          $ref: '#/components/schemas/executionResult'
        tenant:
          $ref: '#/components/schemas/tenant'
        startedAt:
          $ref: '#/components/schemas/time'
        id:
          description: Unique numeric identifier for the activity object (server-generated).
          type: integer
        createdAt:
          $ref: '#/components/schemas/time'
        startedByUser:
          description: The name of the user who created the activity.
          type: string
        completedAt:
          $ref: '#/components/schemas/time'
        resource:
          description: The link to the resource which is related to the activity.
          type: object
          required:
          - id
          properties:
            name:
              $ref: '#/components/schemas/string256'
            id:
              $ref: '#/components/schemas/string64'
            type:
              $ref: '#/components/schemas/string64'
        uuid:
          description: Universally unique identifier for the activity object. If not set, it will be automatically generated by the server.
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        progress:
          $ref: '#/components/schemas/progress'
        tags:
          description: A list of user-defined tags.
          type: array
          items:
            $ref: '#/components/schemas/string64'
        updatedAt:
          $ref: '#/components/schemas/time'
        executor:
          $ref: '#/components/schemas/actor'
        policy:
          description: The link to the policy which execution requires to create the activity.
          type: object
          required:
          - id
          properties:
            name:
              $ref: '#/components/schemas/string256'
            id:
              $ref: '#/components/schemas/string64'
            type:
              $ref: '#/components/schemas/string64'
        workflowId:
          description: The ID of the workflow that is related to the activity.
          type: integer
        type:
          description: The type of the activity that is defined by the user.
          type: string
    executionState:
      description: An execution state.
      enum:
      - enqueued
      - assigned
      - started
      - paused
      - completed
      type: string
    time:
      description: Time in RFC3339 format.
      type: string
    progress:
      description: A progress value.
      type: object
      required:
      - total
      properties:
        current:
          type: integer
        bytesProcessed:
          type: integer
        processingSpeed:
          type: number
        leftTime:
          $ref: '#/components/schemas/duration'
        bytesSaved:
          type: integer
        bottleneck:
          $ref: '#/components/schemas/executionBottleneck'
        total:
          type: integer
    domainError:
      description: Base error object
      type: object
      required:
      - domain
      - code
      properties:
        domain:
          description: Error type or category. Can be ['Licensing','Access'] or name of service (for example 'PolicyManager' or 'VaultManager')
          type: string
        code:
          description: Error id or code, unique in the domain. Same as in 'reason' field
          type: string
        reason:
          description: Obsolete. Error id or code, unique in the domain. Same as in 'code' field
          type: string
        context:
          description: Error context dictionary
          type: object
        kbLink:
          $ref: '#/components/schemas/kbLinkInfo'
        debug:
          $ref: '#/components/schemas/debugInfo'
    levelOfDetail:
      enum:
      - tiny
      - short
      - long
      - full
      - debug
      - count
      type: string
    executionResult:
      description: An execution result.
      type: object
      required:
      - code
      properties:
        code:
          $ref: '#/components/schemas/resultCode'
        error:
          $ref: '#/components/schemas/domainError'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/domainError'
        payload:
          $ref: '#/components/schemas/blob'
    activity:
      description: The activity object.
      type: object
      required:
      - state
      - taskId
      - tenant
      - id
      - createdAt
      - updatedAt
      - executor
      - type
      properties:
        parentActivityId:
          description: The ID of the parent activity.
          type: integer
        state:
          $ref: '#/components/schemas/executionState'
        taskId:
          description: The ID of the task that is related to the activity.
          type: integer
        context:
          description: Activity context.
        result:
          $ref: '#/components/schemas/executionResult'
        tenant:
          $ref: '#/components/schemas/tenant'
        startedAt:
          $ref: '#/components/schemas/time'
        id:
          description: Unique numeric identifier for the activity object (server-generated).
          type: integer
        createdAt:
          $ref: '#/components/schemas/time'
        startedByUser:
          description: The name of the user who created the activity.
          type: string
        completedAt:
          $ref: '#/components/schemas/time'
        resource:
          description: The link to the resource which is related to the activity.
          type: object
          required:
          - id
          properties:
            name:
              $ref: '#/components/schemas/string256'
            id:
              $ref: '#/components/schemas/string64'
            type:
              $ref: '#/components/schemas/string64'
        tags:
          description: A list of user-defined tags.
          type: array
          items:
            $ref: '#/components/schemas/string64'
        progress:
          $ref: '#/components/schemas/progress'
        uuid:
          description: Universally unique identifier for the activity object. If not set, it will be automatically generated by the server.
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        updatedAt:
          $ref: '#/components/schemas/time'
        executor:
          $ref: '#/components/schemas/actor'
        policy:
          description: The link to the policy which execution requires to create the activity.
          type: object
          required:
          - id
          properties:
            name:
              $ref: '#/components/schemas/string256'
            id:
              $ref: '#/components/schemas/string64'
            type:
              $ref: '#/components/schemas/string64'
        workflowId:
          description: The ID of the workflow that is related to the activity.
          type: integer
        type:
          description: The type of the activity that is defined by the user.
          type: string
    duration:
      description: Duration in the human-readable format like "1m", "10s", "1h25m43s" where "m" = "minutes", "s" = "seconds", "h" = "hours".
      type: string
    uuid:
      type: string
      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    string256:
      description: A string that may contain up to 256 characters.
      type: string
    debugInfo:
      description: Error debug information (map type)
      type: object
    ActivityList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Activity'
        paging:
          type: object
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
    Activity:
      type: object
      description: A subordinate activity within a task
      properties:
        id:
          type: string
          description: Activity unique identifier
        type:
          type: string
          description: Activity type
        state:
          type: string
          enum:
          - enqueued
          - assigned
          - started
          - paused
          - completed
        result_code:
          type: string
          enum:
          - ok
          - error
          - warning
          - cancelled
          - abandoned
          - timedout
        parent_activity_id:
          type: string
          description: Parent activity UUID if nested
        task_id:
          type: string
          description: Parent task identifier
        sustainable:
          type: boolean
          description: Whether activity can be requeued on failure
        createdAt:
          type: string
          format: date-time
        startedAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
  responses:
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            urn:acronis.com::task_manager::viewer: ''
            urn:acronis.com::task_manager::issuer: ''
            urn:acronis.com::task_manager::consumer: ''
            urn:acronis.com::task_manager::admin: ''
          tokenUrl: https://dev-cloud.acronis.com/api/2/idp/token
        password:
          scopes:
            urn:acronis.com::task_manager::viewer: ''
            urn:acronis.com::task_manager::issuer: ''
            urn:acronis.com::task_manager::consumer: ''
            urn:acronis.com::task_manager::admin: ''
          tokenUrl: https://dev-cloud.acronis.com/api/2/idp/token
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- acronis-tasks-v2-openapi.json
- acronis-task-manager-openapi.yaml
x-roles:
- name: public
  id: '1'
  description: public role
  x-tags:
  - public
- name: private
  id: '2'
  description: private role
  x-tags:
  - private