Base Operations Source Categories API

openapi: 3.0.0
info:
  title: Customer API - Base Operations Analytics Source 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: Source Categories
paths:
  /v1/public/source-categories:
    get:
      operationId: PublicSourceCategoriesController_findAll_v1
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SourceCategoryEntity'
      security:
      - bearer: []
      tags:
      - Source Categories
  /v1/public/source-categories/{id}:
    get:
      operationId: PublicSourceCategoriesController_findOne_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceCategoryEntity'
      security:
      - bearer: []
      tags:
      - Source Categories
components:
  schemas:
    SourceCategoryEntity:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        weight:
          type: number
        isActive:
          type: boolean
        parentId:
          type: number
          nullable: true
        organizationId:
          type: string
          nullable: true
      required:
      - id
      - name
      - isActive
      - parentId
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-KEY