AlgoSeek

AlgoSeek TTLPeriodType API

The TTLPeriodType API from AlgoSeek — 5 operation(s) for ttlperiodtype.

GitHub OpenAPI

Documentation

📖
Documentation
https://metadata-services.algoseek.com/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/algoseek/refs/heads/main/openapi/algoseek-ttlperiodtype-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/algoseek/refs/heads/main/overlays/algoseek-ttlperiodtype-api-overlay.yaml

OpenAPI Specification

algoseek-ttlperiodtype-api-openapi.yml Raw ↑ 
openapi: 3.0.2
info:
  title: metadata-api AWSAccount TTLPeriodType API
  version: '1.2'
tags:
- name: TTLPeriodType
paths:
  /api/v1/internal/ttl_period_type/:
    get:
      tags:
      - TTLPeriodType
      summary: List TTL Period Types
      description: Get a list of all ttl period types
      operationId: get_ttl_period_types_internal_api_v1_internal_ttl_period_type__get
      parameters:
      - required: false
        schema:
          title: Is Active
          type: boolean
        name: is_active
        in: query
      - required: false
        schema:
          title: Is Public
          type: boolean
        name: is_public
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Get Ttl Period Types Internal Api V1 Internal Ttl Period Type  Get
                type: array
                items:
                  $ref: '#/components/schemas/EnumOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    post:
      tags:
      - TTLPeriodType
      summary: Add TTL Period Type
      description: Add a new ttl period type
      operationId: create_ttl_period_type_api_v1_internal_ttl_period_type__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnumCreate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnumOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/internal/ttl_period_type/{ttl_period_type_id}/:
    get:
      tags:
      - TTLPeriodType
      summary: Get TTL Period Type
      description: Get ttl period type details by id
      operationId: get_ttl_period_type_internal_api_v1_internal_ttl_period_type__ttl_period_type_id___get
      parameters:
      - required: true
        schema:
          title: Ttl Period Type Id
          type: integer
        name: ttl_period_type_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnumOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    put:
      tags:
      - TTLPeriodType
      summary: Update TTL Period Type
      description: Update ttl period type details by id
      operationId: update_ttl_period_type_api_v1_internal_ttl_period_type__ttl_period_type_id___put
      parameters:
      - required: true
        schema:
          title: Ttl Period Type Id
          type: integer
        name: ttl_period_type_id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnumUpdate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnumOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    delete:
      tags:
      - TTLPeriodType
      summary: Delete TTL Period Type
      description: Delete a ttl period type record
      operationId: delete_ttl_period_type_api_v1_internal_ttl_period_type__ttl_period_type_id___delete
      parameters:
      - required: true
        schema:
          title: Ttl Period Type Id
          type: integer
        name: ttl_period_type_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnumOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/internal/ttl_period_type/text_id/{text_id}/:
    get:
      tags:
      - TTLPeriodType
      summary: Get TTL Period Type by text id
      description: Get ttl period type details by text_id
      operationId: get_ttl_period_type_by_text_id_internal_api_v1_internal_ttl_period_type_text_id__text_id___get
      parameters:
      - required: true
        schema:
          title: Text Id
          type: string
        name: text_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnumOutAdmin'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/public/ttl_period_type/{ttl_period_type_id}/:
    get:
      tags:
      - TTLPeriodType
      summary: Get TTL Period Type
      description: Get ttl period type details by id
      operationId: get_ttl_period_type_public_api_v1_public_ttl_period_type__ttl_period_type_id___get
      parameters:
      - required: true
        schema:
          title: Ttl Period Type Id
          type: integer
        name: ttl_period_type_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnumOutPublic'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/public/ttl_period_type/:
    get:
      tags:
      - TTLPeriodType
      summary: List TTL Period Types
      description: Get a list of all ttl period types
      operationId: get_ttl_period_types_public_api_v1_public_ttl_period_type__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Get Ttl Period Types Public Api V1 Public Ttl Period Type  Get
                type: array
                items:
                  $ref: '#/components/schemas/EnumOutPublic'
      security:
      - HTTPBearer: []
components:
  schemas:
    EnumOutAdmin:
      title: EnumOutAdmin
      required:
      - text_id
      - internal_name
      - is_active
      - is_public
      - id
      - created
      - modified
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
        id:
          title: Id
          type: integer
        created:
          title: Created
          type: string
          format: date-time
        modified:
          title: Modified
          type: string
          format: date-time
    EnumCreate:
      title: EnumCreate
      required:
      - text_id
      - internal_name
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    EnumOutPublic:
      title: EnumOutPublic
      required:
      - text_id
      - id
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        id:
          title: Id
          type: integer
    EnumUpdate:
      title: EnumUpdate
      type: object
      properties:
        text_id:
          title: Text Id
          type: string
        display_name:
          title: Display Name
          type: string
        full_name:
          title: Full Name
          type: string
        description:
          title: Description
          type: string
        internal_name:
          title: Internal Name
          type: string
        is_active:
          title: Is Active
          type: boolean
        is_public:
          title: Is Public
          type: boolean
        notes:
          title: Notes
          type: string
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer