{
  "opencollection": "1.0.0",
  "info": {
    "name": "PlanRadar's API Documentation Approval Requests V2 Filters V2 API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Filters V2",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns all filters of a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "last_sync_date",
                "value": "",
                "type": "query",
                "description": "is a Unix Timestamp. If it is set, only filters that were created after that timestamp will be returned"
              },
              {
                "name": "pagesize",
                "value": "",
                "type": "query",
                "description": "sets the number of filters that should be returned per page <br> Maximum is 500, default is 100"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "sets the number of pages for the returned filters"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "keyword, based on which the roles will be filtered"
              },
              {
                "name": "load_all",
                "value": "",
                "type": "query",
                "description": "sets whether or not all filters should be loaded"
              }
            ]
          },
          "docs": "This API returns all filters of the logged in costumer."
        },
        {
          "info": {
            "name": "Creates new filter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for creating a new filter. <br />The filters object contains all the filter data. Each filter is an array that consists of the attributes \"predicate\" and \"value\". The default field-keys of the filters object are \"sequential-id\", \"subject\", \"status-id\", \"priority-id\", \"assigned-to-id\", \"author-id\", \"created-at\", \"updated-at\", \"updated-by-id\", \"due-date\", \"progress\", \"component-id\", \"company\". If a filter is a custom created one its field key will be generated and look similar to "
        },
        {
          "info": {
            "name": "Checks for filter name duplication",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters/check_name_duplication",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for checking if the name of a filter already exists."
        },
        {
          "info": {
            "name": "Returns specific filter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters/:id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API returns a specific filter based on its id."
        },
        {
          "info": {
            "name": "Updates specific filter",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters/:id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id of the filter that should be updated"
              }
            ]
          },
          "docs": "This API is used for updating a specific filter based on its id. <br />The filters object contains all the filter data. Each filter is an array that consists of the attributes \"predicate\" and \"value\". The default field-keys of the filters object are \"sequential-id\", \"subject\", \"status-id\", \"priority-id\", \"assigned-to-id\", \"author-id\", \"created-at\", \"updated-at\", \"updated-by-id\", \"due-date\", \"progress\", \"component-id\", \"company\". If a filter is a custom created one its field key will be generated"
        },
        {
          "info": {
            "name": "Deletes specific filter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters/:id",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API is used for deleting a specific filter based on its id."
        },
        {
          "info": {
            "name": "List available filterable fields for a given type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters/filterable_fields",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path",
                "description": "ID of the customer"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of entity to get filterable fields for"
              }
            ]
          },
          "docs": "Returns all available filter fields for a given entity type (e.g., tickets, dms, approval-requests). Each field includes its ID, name, type, predicates, and display options."
        },
        {
          "info": {
            "name": "List available options for a specific field",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/:customer_id/projects/:project_id/filters/list_options",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "path",
                "description": "ID of the customer"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "ID of the project"
              },
              {
                "name": "field_id",
                "value": "",
                "type": "query",
                "description": "Field ID for which options are listed (e.g., \"ticket.status-id\", \"ticket.approval-status\")"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of filter (e.g., tickets, dms, approval-requests)"
              },
              {
                "name": "selected_ids",
                "value": "",
                "type": "query",
                "description": "Array of selected option IDs"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search term to filter options"
              }
            ]
          },
          "docs": "This API returns all options for a specific field based on its id."
        }
      ]
    }
  ],
  "bundled": true
}