PlanRadar Approval Workflows V2 API

swagger: '2.0'
info:
  title: PlanRadar's API Documentation Approval Requests V2 Approval Workflows V2 API
  version: '2.0'
  description: "Welcome to PlanRadar's API documentation, here you can find all the details about our APIs as well as test them online.<br />\n        <h5>Rate Limits</h5>30 requests per minute per account, aggregated across all tokens.<br />\n        If the threshold is exceeded, a 5-minute cooldown is applied to the account, aggregated across all tokens.<br />\n        During the cooldown period, further requests may be rejected until the cooldown ends.<br />\n        In rare cases, an endpoint may have a different rate limit than the default. When that happens, the differing limit will be explicitly stated in the API documentation for that endpoint.<br />\n        <h5>Access Key</h5>In order to be able to access any API you have to create an access token.Therefore you have to follow these steps:-\n        <ul>\n          <li>Go to your profile page and click on Personal Access Tokens on the left side bar</li><li>Click on the 'Create Access Token' top right button in order to create a new access token.</li><li>Copy the created token and paste it into the field that pops up when you click on the 'Authorize' button </li><li>Note: you can copy the token only once.</li><li>Now you can easily access any API</li>\n        </ul>\n        <h5>V2 APIs</h5>We are currently working on upgrading all our APIs to v2, and we recommend that you use v2 APIs if it is available.\n        <p>V2 APIs are faster, robust and more flexible than v1 APIs</p>"
basePath: /
schemes:
- https
- http
consumes:
- application/json
produces:
- application/json
tags:
- name: Approval Workflows V2
  description: Create and manage reusable approval workflow templates
paths:
  /api/v2/{customer_id}/approval_workflows:
    post:
      summary: create new approval workflow
      tags:
      - Approval Workflows V2
      produces:
      - application/json
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        type: string
        default: '100000'
        required: true
      - name: request
        in: body
        schema:
          type: object
          properties:
            data:
              type: object
              properties:
                attributes:
                  type: object
                  properties:
                    subject:
                      type: string
                    message:
                      type: string
                    description:
                      type: string
                    name:
                      type: string
                    steps:
                      type: array
                      items:
                        type: object
                        properties:
                          duration:
                            type: number
                            default: 1
                          approvers:
                            type: array
                            items:
                              type: string
                            default:
                            - oll
                          name:
                            type: string
                            default: step_name
      responses:
        '422':
          description: Requests Not Created
    get:
      summary: list approval workflows
      tags:
      - Approval Workflows V2
      produces:
      - application/json
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        type: string
        default: '100000'
        required: true
      - name: search
        in: query
        type: string
        required: false
        description: Filter workflows by name (case-insensitive, minimum 3 characters)
      responses:
        '404':
          description: Requests Not Found
  /api/v2/{customer_id}/approval_workflows/{id}:
    get:
      summary: load one approval workflow
      tags:
      - Approval Workflows V2
      produces:
      - application/json
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        type: string
        default: '100000'
        required: true
      - name: id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: workflow Not Found
    put:
      summary: edit one approval workflow
      tags:
      - Approval Workflows V2
      produces:
      - application/json
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        type: string
        default: '100000'
        required: true
      - name: id
        in: path
        type: string
        required: true
      - name: request
        in: body
        schema:
          type: object
          properties:
            data:
              type: object
              properties:
                attributes:
                  type: object
                  properties:
                    subject:
                      type: string
                    message:
                      type: string
                    description:
                      type: string
                    name:
                      type: string
                    steps:
                      type: array
                      items:
                        type: object
                        properties:
                          order:
                            type: number
                          duration:
                            type: number
                            default: 1
                          approvers:
                            type: array
                            items:
                              type: string
                            default:
                            - oll
                    steps_to_remove:
                      type: array
                      items:
                        type: string
      responses:
        '404':
          description: workflow Not Found
    delete:
      summary: remove one approval workflow
      tags:
      - Approval Workflows V2
      produces:
      - application/json
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        type: string
        default: '100000'
        required: true
      - name: id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: workflow Not Found
  /api/v2/{customer_id}/approval_workflows/reviewers:
    get:
      summary: list potential reviewers for a customer as long as they are inhouse|subcontractors
      tags:
      - Approval Workflows V2
      produces:
      - application/json
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        type: string
        default: '100000'
        required: true
      - name: search
        in: query
        type: string
        description: user name
      - name: page
        in: query
        type: string
      - name: pagesize
        in: query
        type: string
      responses:
        '404':
          description: Requests Not Found
securityDefinitions:
  apiKey:
    type: apiKey
    name: X-PlanRadar-API-Key
    in: header
externalDocs:
  description: Find out more about our development portal
  url: https://www.planradar.com/knowledge-base-overview/