PlanRadar Gantt V2 API

swagger: '2.0'
info:
  title: PlanRadar's API Documentation Approval Requests V2 Gantt 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: Gantt V2
paths:
  /api/v2/{customer_id}/projects/{project_id}/gantt_tasks:
    get:
      summary: Retrieves All Phases for a specific projects
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: list all the filters
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: last_sync_date
        in: query
        type: string
      - name: pagesize
        in: query
        type: string
      - name: page
        in: query
        type: string
      - name: sort
        in: query
        type: string
      - name: search
        in: query
        type: string
      - name: component_id
        in: query
        type: string
      - name: hide_closed_tickets
        in: query
        type: boolean
      - name: ids
        in: query
        type: array
        items:
          type: string
        description: ID's for the need gantt tasks
      responses:
        '404':
          description: Phases/Tasks not found
    post:
      summary: Create New Phase/Task
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Create new phase / task
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: task
        in: body
        schema:
          type: object
          properties:
            data:
              type: object
              properties:
                attributes:
                  type: object
                  properties:
                    title:
                      type: string
                    duration:
                      type: integer
                    auto:
                      type: boolean
                    start_date:
                      type: string
                    end_date:
                      type: string
                    parent_id:
                      type: string
                    progress:
                      type: integer
                    has_custom_progress:
                      type: boolean
        description: 'parent_id: Phase id to set the new phase as a sub phase'
      responses:
        '404':
          description: Task/Phase Errors
  /api/v2/{customer_id}/projects/{project_id}/gantt_tasks/{id}:
    put:
      summary: Update Phase/Task
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Update phase / task
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: id
        in: path
        type: string
        required: true
      - name: task
        in: body
        schema:
          type: object
          properties:
            data:
              type: object
              properties:
                attributes:
                  type: object
                  properties:
                    title:
                      type: string
                    start_date:
                      type: string
                    end_date:
                      type: string
                    parent_id:
                      type: string
                    duration:
                      type: integer
                    auto:
                      type: boolean
                    task_order:
                      type: integer
                    progress:
                      type: integer
                    has_custom_progress:
                      type: boolean
        description: 'parent_id: Phase id to set the phase as a sub phase, task_order: Order of the task/phase in the same level of the tree'
      responses:
        '404':
          description: Task/Phase Errors
    delete:
      summary: Delete Phase/Task
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Delete phase / task
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: Task/Phase Errors
    get:
      summary: Retrieve Phase/Task
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Retrieve phase / task
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: Task/Phase Errors
  /api/v2/{customer_id}/projects/{project_id}/gantt_tasks/{id}/clone:
    post:
      summary: Clone Phase/Task
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Clone phase / task
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: Task/Phase Errors
  /api/v2/{customer_id}/projects/{project_id}/gantt_tasks/attach_ticket:
    post:
      summary: Attach Ticket to Phase/Task
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Add ticket to phase / task
      x-websocket-response:
        channel: user_{customerId}_{userId}
        message_type: cable-events
        payload:
          type: object
          properties:
            assign-ticket-to-gantt-finished:
              type: boolean
              description: Always true, signals completion
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: pagesize
        in: query
        type: integer
        description: Maximum is 500, default is 100
      - name: last_sync_date
        in: query
        type: string
      - name: sort
        in: query
        type: string
      - name: filter
        in: query
        type: string
      - name: apply_filter
        in: query
        type: string
        description: filterid, based on which the tickets should be filtered
      - name: search
        in: query
        type: string
        description: keyword, based on which the tickets should be filtered
      - name: task
        in: body
        schema:
          type: object
          properties:
            data:
              type: object
              properties:
                attributes:
                  type: object
                  properties:
                    start_date:
                      type: string
                    end_date:
                      type: string
                    parent_id:
                      type: string
                    uuids:
                      type: array
                      items:
                        type: string
        description: 'uuids: array of tickets uuids will be attached to a phase, parent_id: the phase which the tickets will be attached to'
      responses:
        '404':
          description: Task/Phase Errors
  /api/v2/{customer_id}/projects/{project_id}/gantt_tasks/import:
    post:
      summary: Import Gantt Tasks
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Import Gantt Tasks
      x-websocket-response:
        channel: user_{customerId}_{userId}
        message_type: gantt_tasks_import
        payload:
          type: object
          properties:
            progress:
              type: integer
              description: Import progress percentage (0-100)
            status:
              type: string
              description: Import status
              enum:
              - progress
              - failed
              - done
            errors:
              type: object
              description: Import errors (present when status is failed)
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: data[attributes][file]
        in: formData
        type: file
      responses:
        '404':
          description: Task/Phase Errors
  /api/v2/{customer_id}/projects/{project_id}/gantt_tasks/sync_scheduler:
    post:
      summary: Import Gantt Tasks
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: 'Get the status of scheduler if mpp or any other supported format was imported '
      x-websocket-response:
        channel: user_{customerId}_{userId}
        message_type: gantt_tasks_sync
        payload:
          type: object
          properties:
            new_tasks:
              type: array
              description: Newly added tasks
              items:
                type: object
                properties:
                  id:
                    type: integer
                  subject:
                    type: string
            matched_tasks:
              type: array
              description: Tasks matched to existing ones
              items:
                type: object
                properties:
                  id:
                    type: integer
                  subject:
                    type: string
            deleted_tasks:
              type: array
              description: Tasks deleted during sync
              items:
                type: object
                properties:
                  id:
                    type: integer
                  subject:
                    type: string
            removed_linked_tasks:
              type: array
              description: Linked tasks removed
              items:
                type: object
                properties:
                  id:
                    type: integer
                  subject:
                    type: string
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      - name: data[][attributes][file]
        in: formData
        type: file
      responses:
        '404':
          description: Task/Phase Errors
  /api/v2/{customer_id}/projects/{project_id}/gantt_tasks/export:
    get:
      summary: Export Gantt Tasks
      tags:
      - Gantt V2
      security:
      - apiKey: []
      description: Export the Gantt chart for a project (e.g. PDF/XML).
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: project_id
        in: path
        type: string
        required: true
      responses:
        '404':
          description: Task/Phase Errors
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/