Bonitasoft Archived Activity Variable API

openapi: 3.2.0
info:
  title: Bonitasoft Com Archived Activity Variable API
  version: 1.0.9
  license:
    name: GPL-v2.0
    url: http://www.gnu.org/licenses/gpl-2.0.txt
  x-logo:
    url: images/ofelia-logo.svg
    backgroundColor: '#19465f'
    altText: Bonita API
    href: /
  description: 'Operations tagged ArchivedActivityVariable across 2 of this provider''s published API definitions: bonita-java-client-openapi.yaml, bonita-java-client.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: Sample url for a local development server.
  url: http://localhost:8080/bonita
security:
- bonita_auth: []
  bonita_token: []
- bearer_auth: []
tags:
- description: ArchivedActivityVariable
  name: ArchivedActivityVariable
  x-displayName: ArchivedActivityVariable
paths:
  /API/bpm/archivedActivityVariable/{id}/{variableName}:
    get:
      description: 'Since 2022.1


        Returns the single ArchivedActivityVariable for the given activity ID and variable name'
      operationId: getArchivedActivityInstanceVariable
      parameters:
      - description: The identifier of the activity from which to retrieve the variable
        explode: false
        in: path
        name: id
        required: true
        schema:
          maxLength: 250
          pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
          type: string
        style: simple
      - description: The name of the variable to retrieve
        explode: false
        in: path
        name: variableName
        required: true
        schema:
          maxLength: 250
          pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArchivedActivityVariable'
          description: 'Success '
        '400':
          content:
            application/json:
              example:
                message: Bad request
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request.
        '401':
          content:
            application/json:
              example:
                message: Unauthorized
              schema:
                $ref: '#/components/schemas/Error'
          description: Authorization information is missing or invalid.
        '403':
          content:
            application/json:
              example:
                message: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
        '404':
          content:
            application/json:
              example:
                message: Resource not found.
              schema:
                $ref: '#/components/schemas/Error'
          description: The resource for the specified ID was not found.
        5XX:
          content:
            application/json:
              example:
                message: An unexpected error occured.
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error.
      summary: Finds the ArchivedActivityVariable by case ID and name
      tags:
      - ArchivedActivityVariable
      x-accepts:
      - application/json
    servers:
    - description: Sample url for a local development server.
      url: http://localhost:8080/bonita
components:
  schemas:
    Error:
      additionalProperties: true
      example:
        exception: exception
        explanations:
        - explanations
        - explanations
        message: message
      properties:
        message:
          description: The error message
          type: string
        exception:
          description: The exception type
          type: string
        explanations:
          description: Further details on the error
          items:
            type: string
          type: array
      type: object
    ArchivedActivityVariable:
      description: This resource enables you to retrieve the value of a specific archived variable name for a specific case (or process instance). Only persistent variables are concerned by this resource, not transient variables.
      example:
        name: RequestValidationData
        description: null
        type: java.lang.String
        containerId: 20004
        containerType: ACTIVITY_INSTANCE
        value: Confirmed
        archivedDate: 2021-12-27 23:10:59.342000
        sourceObjectId: 42
      properties:
        name:
          description: The name of the archived  activity variable
          type: string
        description:
          description: The description of the variable if any
          type: string
        type:
          description: The fully qualified class name of the variable type
          type: string
        containerId:
          description: The ID of the activity containing this variable (same as the one passed as parameter)
          type: string
        containerType:
          description: ACTIVITY_INSTANCE
          type: string
        value:
          description: the value of this variable. The format of the value depends on the type of the variable
          type: string
        archivedDate:
          description: The date when this variable was archived. The date format is yyyy-MM-dd HH:mm:ss.SSS
          type: string
        sourcedObjectId:
          description: The id of the activity variable before it was archived
          type: string
      type: object
  securitySchemes:
    bonita_auth:
      description: 'To call the REST API, you must first log on with a user registered in the Engine database. Please refer to the __[Login API](#operation/login)__ operations section.

        '
      in: cookie
      name: JSESSIONID
      type: apiKey
    bonita_token:
      description: 'To call the REST API, you must first log on with a user registered in the Engine database. Please refer to the __[Login API](#operation/login)__ operations section.

        '
      in: header
      name: X-Bonita-API-Token
      type: apiKey
    bearer_auth:
      description: '![edition](https://img.shields.io/badge/edition-entreprise-blue)


        When Bonita runtime is configured for SSO with openID Connect it is possible To call the REST API directly with a Bearer Authorization header containing the access token.

        '
      scheme: bearer
      type: http
x-refined-from:
- bonita-java-client-openapi.yaml
- bonita-java-client.yaml
x-tagGroups:
- name: Authentication
  tags:
  - Authentication
  - PlatformAuthentication
- name: Application
  tags:
  - Application
  - ApplicationMenu
  - ApplicationPage
  - FormMapping
- name: BDM
  tags:
  - BDM
  - BusinessDataQuery
  - Business Data Operations
  - BDMAccessControl
  - DataRetention
- name: BPM
  tags:
  - Activity
  - ArchivedActivity
  - HumanTask
  - ManualTask
  - Task
  - UserTask
  - ArchivedHumanTask
  - ArchivedManualTask
  - ArchivedTask
  - ArchivedUserTask
  - ActivityVariable
  - ArchivedActivityVariable
  - ProcessInstanceVariable
  - ArchivedProcessInstanceVariable
  - ProcessInstanceDocument
  - ArchivedProcessInstanceDocument
  - Actor
  - ActorMember
  - ProcessInstance
  - ArchivedProcessInstance
  - ProcessInstanceInfo
  - ProcessInstanceComment
  - ArchivedProcessInstanceComment
  - Process
  - Diagram
  - ProcessInfo
  - ProcessParameter
  - ProcessResolutionProblem
  - ProcessSupervisor
  - ProcessConnectorDependency
  - ConnectorFailure
  - ConnectorInstance
  - ArchivedConnectorInstance
  - FlowNode
  - ArchivedFlowNode
  - Failure
  - ArchivedFailure
  - TimerEventTrigger
  - Message
  - Signal
  - Delegation
- name: Custom user info
  tags:
  - CustomUserDefinition
  - CustomUserValue
  - CustomUser
- name: Identity
  tags:
  - ProfessionalContactData
  - Group
  - Membership
  - Role
  - User
  - Authentication
- name: Platform
  tags:
  - PlatformAuthentication
  - Platform
  - License
  - Information
- name: Portal
  tags:
  - Page
  - Profile
  - ProfileEntry
  - ProfileMember
  - Theme
  - Upload
- name: System
  tags:
  - I18nlocale
  - I18ntranslation
  - Log
  - Session
  - Maintenance
- name: Other
  tags:
  - RestAPIextensions
- name: Upload
  tags:
  - FormFileUpload