swagger: '2.0'
info:
title: PlanRadar's API Documentation Approval Requests V2 Ticket Imports 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: Ticket Imports
paths:
/api/v1/{customer_id}/projects/{project_id}/ticket_imports:
post:
summary: Upload file with read content
tags:
- Ticket Imports
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
- name: data[][attributes][options]
in: formData
type: object
description: '{"first_line_is_headers":true,"validate_tickets":true,"seperated_by":"comma"}'
- name: data[][attributes][ticket_type_id]
in: formData
type: string
- name: data[][attributes][uuid]
in: formData
type: string
description: UUID of the ticket import record if you want to update existing record
- name: data[][attributes][file_name]
in: formData
type: string
description: Name of the file being uploaded
responses:
'404':
description: Plan 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/