Base Operations Threat Categories API

openapi: 3.0.0
info:
  title: Customer API - Base Operations Analytics Threat Categories API
  description: 'Welcome to the Base Operations Customer API! This API allows you to interact with our data and perform detailed analysis. In this documentation, we''ll explain how to use the API, including the available endpoints and the expected request bodies or query parameters.


    ### Authentication


    To use this API, you''ll need to authenticate using an API key. Please reach out to Base Operations to have an API key provisioned for your user. Once you have your API key, you can use it to authorize the Swagger docs.


    To authenticate on the Swagger docs, follow these steps:


    1.  Click on the "Authorize" button on the top right corner of the Swagger docs.

    2.  In the "Value" field, enter your API key.

    3.  Click "Authorize" to authenticate.


    ### Helpful Hints


    When using the API, you may see the following query parameters:


    - `savedLocationId`: This is an internal identifier for a saved location. You can acquire this identifier by using the `GET /v1/public/saved-locations` endpoint.


    - `categoryId`: This is an internal identifier for a threat category. You can acquire this identifier by using the `GET /v1/public/threat-categories` endpoint.<br><br>


    That''s it! You''re now authenticated and can start using the API. If you have any questions or issues, please contact Base Operations support.

    '
  version: '1.0'
  contact: {}
servers:
- url: https://api.baseoperationsenterprise.com/
tags:
- name: Threat Categories
paths:
  /v1/public/threat-categories:
    get:
      description: This endpoint returns the `name` an `id` of all threat categories in our system. Use these `id`'s to refine your analysis when interacting with our other endpoints.
      operationId: PublicThreatCategoriesController_getCategories_v1
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ThreatCategoryEntity'
      security:
      - ApiKey: []
      summary: Get All Threat Categories
      tags:
      - Threat Categories
  /v1/public/threat-categories/{id}:
    get:
      description: This endpoint returns the `name` an `id` of a threat category. This endpoint is best used when you are trying to determine details about a specific `categoryId` in your analysis
      operationId: PublicThreatCategoriesController_findOne_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: number
      responses:
        '404':
          description: Threat category not found
      security:
      - ApiKey: []
      summary: Get Threat Category
      tags:
      - Threat Categories
components:
  schemas:
    ThreatCategoryEntity:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        severity:
          type: number
        type:
          enum:
          - crime
          - unrest
          - customer
          - uas_sighting
          type: string
        parentId:
          type: number
          nullable: true
        organizationId:
          type: string
          nullable: true
      required:
      - id
      - name
      - severity
      - type
      - parentId
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-KEY