Bonitasoft Archived Process Instance Document API

openapi: 3.2.0
info:
  title: Bonitasoft Com Archived Process Instance Document 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 ArchivedProcessInstanceDocument 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: ArchivedProcessInstanceDocument
  name: ArchivedProcessInstanceDocument
  x-displayName: ArchivedProcessInstanceDocument
paths:
  /API/bpm/archivedCaseDocument:
    get:
      description: 'Finds ArchivedProcessInstanceDocuments with pagination params and filters


        You can filter on :


        * `sourceObjectId="id"`: search for documents by specifying the original document id.

        This is useful if you know the id of a ProcessInstanceDocument and you wish to retrieve all its previous versions..

        * `caseId="id"`: search for documents with the specified open process instance id.

        * `archivedCaseId="id"`: search for documents with the specified archived process instance id.

        * `submittedBy="id"`: search for documents that were submitted by the user with the specified identifier.

        * `name="string"`: search for documents with names that contain _string_.

        Depending on the setting for word-based search, the search returns documents with _string_ at the start of the name or the start of a word in the name.

        * `description="string"`: search for documents with descriptions that contain _string_.

        Depending on the setting for word-based search, the search returns documents with _string_ at the start of the description or the start of a word in the description.'
      operationId: searchArchivedProcessInstanceDocuments
      parameters:
      - description: index of the page to display
        example: '0'
        explode: true
        in: query
        name: p
        required: true
        schema:
          default: 0
          format: int32
          minimum: 0
          type: integer
        style: form
      - description: maximum number of elements to retrieve
        example: '10'
        explode: true
        in: query
        name: c
        required: true
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
        style: form
      - description: can filter on attributes with the format f={filter\_name}={filter\_value} with the name/value pair as url encoded string.
        example: abc%3d123
        explode: true
        in: query
        name: f
        required: false
        schema:
          items:
            maxLength: 250
            pattern: ^[A-Za-z0-9%]{0,250}$
            type: string
          type: array
        style: form
      - description: can order on attributes
        example: myProp%20ASC
        explode: true
        in: query
        name: o
        required: false
        schema:
          maxLength: 250
          pattern: ^[A-Za-z0-9%]{0,250}$
          type: string
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ArchivedProcessInstanceDocument'
                type: array
          description: 'Success '
          headers:
            Content-Range:
              description: The total number of matching items
              explode: false
              schema:
                format: int64
                type: integer
              style: simple
        '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.
        5XX:
          content:
            application/json:
              example:
                message: An unexpected error occured.
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error.
      summary: Finds ArchivedProcessInstanceDocuments
      tags:
      - ArchivedProcessInstanceDocument
      x-accepts:
      - application/json
    servers:
    - description: Sample url for a local development server.
      url: http://localhost:8080/bonita
  /API/bpm/archivedCaseDocument/{id}:
    delete:
      description: Delete the single ArchivedProcessInstanceDocument for the given ID
      operationId: deleteArchivedProcessInstanceDocumentById
      parameters:
      - description: ID of the ArchivedProcessInstanceDocument to delete
        explode: false
        in: path
        name: id
        required: true
        schema:
          maxLength: 250
          pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
          type: string
        style: simple
      responses:
        '200':
          description: OK
        '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: Delete the ArchivedProcessInstanceDocument by ID
      tags:
      - ArchivedProcessInstanceDocument
      x-accepts:
      - application/json
    servers:
    - description: Sample url for a local development server.
      url: http://localhost:8080/bonita
components:
  schemas:
    ProcessInstanceDocument:
      description: A document in an active case
      example:
        id: '3'
        creationDate: 2014-10-09 16:45:36.658000
        author: '1'
        index: '-1'
        contentMimetype: application/octet-stream
        caseId: '1'
        contentStorageId: '4'
        isInternal: 'true'
        description: draft
        name: Doc 1
        fileName: document_1.jpg
        submittedBy: '1'
        url: documentDownload?fileName=document_1.jpg&contentStorageId=4
        version: '1'
      properties:
        id:
          description: documentId
          type: string
        creationDate:
          description: date and time
          type: string
        author:
          deprecated: true
          description: submittorUserId
          type: string
        index:
          description: index in a list of documents, or -1 for a single document
          type: string
        contentMimetype:
          description: MIME type
          type: string
        caseId:
          description: caseId
          type: string
        contentStorageId:
          description: storageId
          type: string
        isInternal:
          description: '`true` if  the the document object contains the content directly. `false` if the document is specified by URL so the document object contains a reference to the content, not the content itself.'
          type: boolean
        description:
          description: description
          type: string
        name:
          description: name
          type: string
        fileName:
          description: filename
          type: string
        submittedBy:
          description: submittorUserId
          type: string
        url:
          description: urlForDownload
          type: string
        version:
          description: version
          type: string
      type: object
    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
    ArchivedProcessInstanceDocument:
      allOf:
      - $ref: '#/components/schemas/ProcessInstanceDocument'
      - description: A document in an active case
        example:
          id: '1'
          creationDate: 2014-10-09 16:39:52.472000
          author: '1'
          index: '0'
          contentMimetype: text/plain
          caseId: '1'
          contentStorageId: '1'
          isInternal: 'true'
          description: ''
          name: myDoc
          fileName: test1.txt
          submittedBy: '1'
          url: documentDownload?fileName=test1.txt&contentStorageId=1
          version: '1'
          sourceObjectId: '1'
          archivedDate: 2014-10-09 17:39:52.473000
        properties:
          sourceObjectId:
            description: original document id
            type: string
          archivedDate:
            description: the date ('yyyy-MM-dd HH:mm:ss.SSS') when the current task was assigned for example '2014-10-17 16:05:42.626'
            pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) (2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]$
            type: string
        type: object
      example:
        submittedBy: submittedBy
        archivedDate: archivedDate
        fileName: fileName
        author: author
        contentStorageId: contentStorageId
        index: index
        description: description
        sourceObjectId: sourceObjectId
        creationDate: creationDate
        contentMimetype: contentMimetype
        version: version
        url: url
        isInternal: true
        caseId: caseId
        name: name
        id: id
  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