ProcessMaker Environment Variables API

openapi: 3.0.0
info:
  title: ProcessMaker Platform RESTful Environment Variables API
  description: 'The ProcessMaker Platform RESTful API provides programmatic access to all platform functionality including process design, case management, task handling, user management, and enterprise integrations. The API is BPMN 2.0 compliant and follows the OpenAPI specification with interactive Swagger UI documentation auto-generated by Swagger/L5-Swagger.

    '
  version: 1.0.0
  contact:
    email: info@processmaker.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{organization}.processmaker.net/api/1.0
  description: ProcessMaker Cloud instance
  variables:
    organization:
      default: myorg
      description: Your ProcessMaker organization subdomain
security:
- bearerAuth: []
tags:
- name: Environment Variables
  description: Environment variable management
paths:
  /environment-variables:
    get:
      tags:
      - Environment Variables
      summary: Returns all environment variables
      operationId: getEnvironmentVariables
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order_by'
      - $ref: '#/components/parameters/order_direction'
      - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: List of environment variables
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EnvironmentVariable'
                  meta:
                    $ref: '#/components/schemas/Metadata'
    post:
      tags:
      - Environment Variables
      summary: Save a new environment variable
      operationId: createEnvironmentVariable
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentVariableEditable'
      responses:
        '201':
          description: Created environment variable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariable'
  /environment-variables/{environment_variable_id}:
    get:
      tags:
      - Environment Variables
      summary: Get a single environment variable
      operationId: getEnvironmentVariableById
      parameters:
      - name: environment_variable_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Single environment variable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariable'
        '404':
          $ref: '#/components/responses/404'
    put:
      tags:
      - Environment Variables
      summary: Update an environment variable
      operationId: updateEnvironmentVariable
      parameters:
      - name: environment_variable_id
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentVariableEditable'
      responses:
        '204':
          description: No content
    delete:
      tags:
      - Environment Variables
      summary: Delete an environment variable
      operationId: deleteEnvironmentVariable
      parameters:
      - name: environment_variable_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: No content
components:
  schemas:
    EnvironmentVariable:
      allOf:
      - $ref: '#/components/schemas/EnvironmentVariableEditable'
      - type: object
        properties:
          id:
            type: integer
          created_at:
            type: string
            format: date-time
          updated_at:
            type: string
            format: date-time
    EnvironmentVariableEditable:
      type: object
      required:
      - name
      - description
      - value
      properties:
        name:
          type: string
        description:
          type: string
        value:
          type: string
    Metadata:
      type: object
      properties:
        total:
          type: integer
        count:
          type: integer
        per_page:
          type: integer
        current_page:
          type: integer
        total_pages:
          type: integer
        sort_by:
          type: string
        sort_order:
          type: string
        search:
          type: string
  parameters:
    per_page:
      name: per_page
      in: query
      schema:
        type: integer
        default: 10
    filter:
      name: filter
      in: query
      description: 'Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

        '
      schema:
        type: string
    order_by:
      name: order_by
      in: query
      description: Field to order results by
      schema:
        type: string
    order_direction:
      name: order_direction
      in: query
      schema:
        type: string
        enum:
        - asc
        - desc
        default: asc
  responses:
    '404':
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT