Delinea WorkflowInstances API

openapi: 3.2.0
info:
  title: Secret Server Rest Activations Workflow Instances API
  description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
  termsOfService: https://delinea.com/eula
  contact:
    name: Support
    url: https://delinea.com
  version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: WorkflowInstances
  description: View and maintain Workflow Instances
paths:
  /v1/workflows/instances/template/{id}:
    get:
      tags:
      - WorkflowInstances
      summary: Get Workflow Instances By Workflow Template Id.
      description: Get active workflow instances that use the given workflow template
      operationId: WorkflowInstancesService_GetByTemplateId
      parameters:
      - name: id
        in: path
        description: Workflow Template ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The active workflow instances that use the Workflow Template
          content:
            application/json:
              schema:
                description: The active workflow instances that use the Workflow Template
                items:
                  $ref: '#/components/schemas/WorkflowInstanceDto'
                type: array
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
components:
  schemas:
    WorkflowInstanceDto:
      description: WorkflowInstanceDto[]
      properties:
        configurationJson:
          description: ConfigurationJson
          type: string
        currentState:
          description: CurrentState
          type: string
        currentStateInfoJson:
          description: CurrentStateInfoJson
          type: string
        currentStepId:
          description: CurrentStepId
          type:
          - integer
          - 'null'
          format: int32
        currentStepState:
          $ref: '#/components/schemas/AccessRequestState'
        endTime:
          description: EndTime
          type:
          - string
          - 'null'
          format: date-time
        entityWorkflowMapId:
          description: EntityWorkflowMapId
          type: integer
          format: int32
        expirationTime:
          description: ExpirationTime
          type:
          - string
          - 'null'
          format: date-time
        id:
          description: Id
          type: integer
          format: int32
        pendingTransaction:
          description: PendingTransaction
          type: boolean
        startTime:
          description: StartTime
          type: string
          format: date-time
        status:
          description: Status
          type: string
        workflowTemplateId:
          description: WorkflowTemplateId
          type: integer
          format: int32
      type: object
    AccessRequestState:
      description: The Status of the request
      properties: {}
      type: string
      enum:
      - WaitingForRequest
      - Pending
      - Approved
      - Denied
      - Canceled
      - Expired
    BadRequestResponse:
      description: Response object for invalid requests
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
        messageDetail:
          description: Error message detail
          type: string
        errorCode:
          description: Error message code
          type: string
        modelState:
          description: An object describing validation errors
          type: object
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header