openapi: 3.0.1
info:
  title: called-service-async-Called_Service_Process_asyncRest-rest
  version: 25.3.1
servers:
- url: https://acme.saas.pas-cloud.com/pas-doc/gateway/xuml/called-service-async-Called_Service_Process_asyncRest-rest/25.3.1
  description: ""
security:
- KeycloakOIDC: []
tags:
- name: Instances
  description: Retreive active process instances
- name: Start Events
  description: Start the BPMN process
paths:
  /:
    get:
      tags:
      - Instances
      parameters:
      - name: roles
        in: query
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: page
        in: query
        schema:
          type: integer
      - name: instancesPerPage
        in: query
        schema:
          type: integer
      - name: currentTask
        in: query
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sortByCreation
        in: query
        schema:
          type: string
      - name: sortByUpdate
        in: query
        schema:
          type: string
      - name: externals
        in: query
        schema:
          type: boolean
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_asyncInstances'
            text/xml:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_asyncInstances'
        default:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestError'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestError'
        "401":
          description: Unauthorized
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "403":
          description: Forbidden
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "4XX":
          description: Policy Failures
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
    post:
      tags:
      - Instances
      parameters:
      - name: externals
        in: query
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceListRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/InstanceListRequest'
        required: true
      responses:
        "201":
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_asyncInstances'
            text/xml:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_asyncInstances'
        default:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestError'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestError'
        "401":
          description: Unauthorized
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "403":
          description: Forbidden
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "4XX":
          description: Policy Failures
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
      x-codegen-request-body-name: options
  /Message_Start_Event:
    post:
      tags:
      - Start Events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Message'
          text/xml:
            schema:
              $ref: '#/components/schemas/Message'
        required: true
      responses:
        "201":
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_async'
            text/xml:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_async'
        default:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestError'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestError'
        "401":
          description: Unauthorized
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "403":
          description: Forbidden
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "4XX":
          description: Policy Failures
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
      x-codegen-request-body-name: body
  /{id}:
    get:
      tags:
      - Instances
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_async'
            text/xml:
              schema:
                $ref: '#/components/schemas/Called_Service_Process_async'
        default:
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestError'
            text/xml:
              schema:
                $ref: '#/components/schemas/RestError'
        "401":
          description: Unauthorized
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "403":
          description: Forbidden
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: The error type
                  failureCode:
                    type: integer
                    description: The failure code
                    format: int32
                  responseCode:
                    type: integer
                    description: The response code
                    format: int32
                  message:
                    type: string
                    description: The error message
                  headers:
                    type: object
                    description: Optional headers
        "4XX":
          description: Policy Failures
          headers:
            X-Policy-Failure-Type:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Message:
              style: simple
              explode: false
              schema:
                type: string
            X-Policy-Failure-Code:
              style: simple
              explode: false
              schema:
                type: integer
                format: int32
components:
  schemas:
    InstanceListRequest:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingInstruction'
        sort:
          type: array
          items:
            $ref: '#/components/schemas/SortInstruction'
        filter:
          $ref: '#/components/schemas/Condition'
        roles:
          type: array
          items:
            type: string
    PagingInstruction:
      type: object
      properties:
        limit:
          type: integer
        skip:
          type: integer
    Condition:
      type: object
      properties:
        attribute:
          type: string
        operator:
          type: string
    SortInstruction:
      type: object
      properties:
        attribute:
          type: string
        direction:
          type: string
    Message:
      type: object
      properties:
        length:
          type: integer
        message:
          type: string
    Called_Service_Process_asyncInstances:
      type: object
      properties:
        instances:
          type: array
          items:
            $ref: '#/components/schemas/Called_Service_Process_async'
        totalCount:
          type: integer
        filteredCount:
          type: integer
        stateCounters:
          type: array
          items:
            $ref: '#/components/schemas/StateCount'
        roleCounters:
          type: array
          items:
            $ref: '#/components/schemas/RoleCount'
    RoleCount:
      type: object
      properties:
        id:
          type: string
        listCount:
          type: integer
        readCount:
          type: integer
        writeCount:
          type: integer
    StateCount:
      type: object
      properties:
        name:
          type: string
        count:
          type: integer
    Called_Service_Process_async:
      type: object
      properties:
        id:
          type: string
        currentTasks:
          type: string
        message:
          $ref: '#/components/schemas/Message'
        _meta:
          $ref: '#/components/schemas/InstanceMeta'
    InstanceMeta:
      type: object
      properties:
        currentTasks:
          type: array
          items:
            type: string
        creation:
          type: string
          format: date-time
        lastUpdate:
          type: string
          format: date-time
        stateId:
          type: string
    RestError:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
  securitySchemes:
    KeycloakOIDC:
      type: openIdConnect
      openIdConnectUrl: http://scheer-keycloak:8080/pas-doc/keycloak/realms/PAS/.well-known/openid-configuration
x-original-swagger-version: "2.0"
