{
"opencollection": "1.0.0",
"info": {
"name": "PlanRadar's API Documentation Approval Requests V2 Tickets API",
"version": "2.0"
},
"items": [
{
"info": {
"name": "Tickets",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieves All tickets",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/load",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path",
"description": "Set project_id to `0` if you want to load tickets from all projects"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "pagesize",
"value": "",
"type": "query",
"description": "Maximum is 500, default is 100"
},
{
"name": "last_sync_date",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "apply_filter",
"value": "",
"type": "query"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search keyword to filter tickets based on it"
}
]
},
"docs": "Load all tickets from a specific project
\n Without any extra parameters it will return the first 100 tickets ordered by ID ascending. Extra parameters can be added to filter and sort the results.
\n Ticket Sorting:\n Field name to sort the results based on it, sort is always ascending unless the field name is prefixed with a minus (U+002D HYPHEN-MINUS, “-“) i.e. `-id` or `id`\n
Example: `tickets/load?sort=-component_id`
\n Ticket Filtr"
},
{
"info": {
"name": "Multi Update Tickets based on the provided filteration, no filter will update all data for the project id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/multi_update",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Used to filter tickets based on any conditions of the related model, filter[author_id]=1 will list all tickets related to this author id, similar to filter[author.id]=1, the second one will use the condition based on the user table such a filter is available filter[author.email]=test@email.com, for multiple values for the same filter use filter[id][]=PN&filter[id][]=nE,,,, available models are: customer, ticket_type, project, component, status, ticket, author, assigned_to, updated_by, due_by, overdue_by, creation_period"
},
{
"name": "apply_filter",
"value": "",
"type": "query",
"description": "ID of the custom filter to be applied before returning the data"
}
]
},
"docs": "Multi update tickets, for typed values it has to be grouped by the ticket type, all any other fields should be added in the attributes, the key is the field name, the value is the new value, filter data is OPTIONAL and can be used in either the query string or in the body of the request or both"
},
{
"info": {
"name": "Show one ticket based on its UUID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/:uuid",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
},
{
"name": "uuid",
"value": "",
"type": "path"
}
]
},
"docs": "Show one ticket based on its UUID"
},
{
"info": {
"name": "Update one ticket",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/:uuid",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
},
{
"name": "uuid",
"value": "",
"type": "path",
"description": "UUID of the ticket to load"
},
{
"name": "clean_up_assets",
"value": "",
"type": "query",
"description": "If set to true, it will remove any assets that dont belong to the ticket"
}
]
},
"docs": "Update one ticket"
},
{
"info": {
"name": "Delete one ticket",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/:uuid",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
},
{
"name": "uuid",
"value": "",
"type": "path",
"description": "UUID of the ticket to delete"
}
]
},
"docs": "Delete one ticket"
},
{
"info": {
"name": "Retrieves All tickets",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path",
"description": "Set project_id to `0` if you want to load tickets from all projects"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "pagesize",
"value": "",
"type": "query",
"description": "Maximum is 500, default is 100"
},
{
"name": "last_sync_date",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "apply_filter",
"value": "",
"type": "query"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search keyword to filter tickets based on it"
}
]
},
"docs": "This API is similar to `tickets/load` API the only difference that it retrieves all children ticket in the same page.\n Requesting this API with pagesize = 10 will return the first matched 10 tickets plus all their children tickets.
\n Without any extra parameters it will return the first 100 tickets ordered by ID ascending. Extra parameters can be added to filter and sort the results.
\n Ticket Sorting:\n Field name to sort the results based on it, sort is alway"
},
{
"info": {
"name": "Create one ticket",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
}
]
},
"docs": "Create one ticket"
},
{
"info": {
"name": "Add a comment to a Ticket",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/:uuid/comment",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
},
{
"name": "uuid",
"value": "",
"type": "path",
"description": "UUID of the ticket to add a comment to it"
}
]
},
"docs": "Add a comment to a specific ticket."
},
{
"info": {
"name": "Export single ticket as PDF",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/:uuid/export",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
},
{
"name": "uuid",
"value": "",
"type": "path",
"description": "UUID of the ticket to export"
},
{
"name": "template_id",
"value": "",
"type": "query",
"description": "ID of the template to be used for the export OPTIONAL, leave blank and the default template will be used"
},
{
"name": "timezone_offset",
"value": "",
"type": "query"
}
]
},
"docs": "Export single ticket as a PDF documnet\n If images included in the ticket more than 10, the ticket will be exported in a job.\n
\n timezone_offset
\n Is used to convert all dates included in the PDF document to the correct timezone. the value should be the difference in minutes between UTC and your location."
},
{
"info": {
"name": "Clone a ticket",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/api/v1/:customer_id/projects/:project_id/tickets/:uuid/clone",
"params": [
{
"name": "customer_id",
"value": "",
"type": "path"
},
{
"name": "project_id",
"value": "",
"type": "path"
},
{
"name": "uuid",
"value": "",
"type": "path",
"description": "UUID of the ticket to be cloned"
}
]
},
"docs": "Copy all the content of a ticket in a new one."
}
]
}
],
"bundled": true
}