SERTICA

SERTICA Components API

The Components API from SERTICA — 40 operation(s) for components.

GitHub OpenAPI

Operations 46

GET /Components Gets a list of Components #
POST /Components Creates a new component record #
GET /Components/{componentNo} Gets a specific Component #
PUT /Components/{componentNo} Updates an existing Component #
DELETE /Components/{componentNo} Deletes a component record #
GET /Components/{componentNo}/history Gets history for a specific Component #
POST /Components/search Search for Components Takes a SearchDefinition input, which can include filters… #
POST /Components/searchCount Returns number of hits in a search for Components Takes a SearchDefinition… #
POST /Components/searchIndex/{componentGuid} Get index of a record in a search for Components Takes a SearchDefinition… #
GET /Components/searchInfo Returns structured information about what and how you can search for #
GET /Components/{componentNo}/Items Returns a list of Items used to perform the Component #
DELETE /Components/{componentNo}/force Force deletes a component record Force deleting records may cause existing… #
GET /Components/{componentNo}/documents Returns a list of Documents used on the Component #
GET /Components/{componentNo}/documents/{documentNo} Returns a specific component document #
GET /Components/{componentNo}/Suppliers Returns a list of Suppliers used for the Component #
GET /Components/{componentNo}/Suppliers/{supplierNo} Returns a specific Component Supplier #
GET /Components/{componentNo}/counterhistories Returns a list of Counter Histories used on the Component #
POST /Components/{componentNo}/resetcounter Resets the counter on the Component to a specific value/date #
POST /Components/{componentNo}/copyCounterHistory Overwrites the counter history on a component with the history from the counter #
GET /Components/{componentNo}/copy Copies an existing Component to a new object #
POST /Components/labels/{labelTemplateDocumentNo} Gets the labels to print #
GET /Components/labels/{labelTemplateDocumentNo}/{settingsKey} Get the labels to print using ´settings key #
POST /Components/{componentNo}/disable Disable the component #
POST /Components/{componentNo}/enable Enable the component #
GET /Components/propertyDefinitions Get a list of PropertyDefinitions #
POST /Components/propertyDefinitions Creates a new PropertyDefinition record #
GET /Components/propertyDefinitions/{propertyDefinitionGuid} Gets a specific PropertyDefinition #
PUT /Components/propertyDefinitions/{propertyDefinitionGuid} Updates an existing PropertyDefinition #
DELETE /Components/propertyDefinitions/{propertyDefinitionGuid} Deletes a PropertyDefinition record #
GET /Components/propertyDefinitions/{propertyDefinitionGuid}/listValues Returns a list of values for a PropertyDefinition #
DELETE /Components/propertyDefinitions/{propertyDefinitionGuid}/force Force Deletes a PropertyDefinition record #
GET /Components/propertyDefinitions/{propertyName}/available Lookup if PropertyName of a PropertyDefinition is not already in use and… #
GET /Components/{componentNo}/shipdex Exports the chosen component and its data as Shipdex data #
GET /Components/shipdex Checks if the current Shipdex setup is valid #
POST /Components/screenLayout Bulk updates screenlayout and a list of Property Definitions. #
POST /Components/appSubmit Receive component #
GET /Components/{componentNo}/responses Gets a list of component responses #
GET /Components/{componentNo}/responses/count Returns number of ComponentResponses for ComponentNo #
POST /Components/{componentNo}/addResponse Add response #
POST /Components/{componentNo}/webhooklogs/search Searches the Webhooks associated with the Component #
POST /Components/{componentNo}/webhooklogs/searchCount Returns number of hits in a search for the Component's Webhook Logs. #
POST /Components/{componentNo}/webhooklogs/{webhookLogGuid}/retransmit Retransmits a specific Webhook based on the selected Webhook Log #
POST /Components/{componentNo}/webhooklogs/{webhookLogGuid}/resolve Resolves a specific Webhook Log with a Response Log entry #
POST /Components/{componentNo}/rotate Rotates two components #
POST /Components/BatchEdit Component batch edit #
POST /Components/BatchEdit/ApplyTransformations/{componentNo} Component batch edit apply transformations #

Documentation

📖
Documentation
https://support.sertica.com/hc/en-us/articles/28558470734109-SERTICA-Application-Programming-Interface
📖
APIReference
https://docs.sertica.com/api/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/authentication/sertica-authentication.yml

Specifications

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

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/errors/sertica-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/conventions/sertica-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/data-model/sertica-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/asyncapi/sertica-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sertica-components-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sertica-components-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Components API
  description: 'Online API browser for SERTICA Web API.


    Be aware that some endpoints are restricted by license or user rights and may not be available in your environment.


    Each endpoint includes a description of the required license and user rights.'
  version: v1
servers:
- url: /api
tags:
- name: Components
paths:
  /Components:
    get:
      tags:
      - Components
      summary: Gets a list of Components
      operationId: GetComponents
      parameters:
      - name: page
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    post:
      tags:
      - Components
      summary: Creates a new component record
      operationId: CreateComponent
      requestBody:
        description: The Component Object, including reference lists
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component_Update</td><td style='border-bottom:none'>Update</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/{componentNo}:
    get:
      tags:
      - Components
      summary: Gets a specific Component
      operationId: GetComponent
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo to get
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the requested component
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If a component with the supplied Component No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr><tr><td style='border-bottom:none;padding-right:5px'>JobApp</td><td style='border-bottom:none'>Function</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    put:
      tags:
      - Components
      summary: Updates an existing Component
      operationId: UpdateComponent
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo of the component to update
        required: true
        schema:
          type: string
      requestBody:
        description: The Component DTO object with the fields to update
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
      responses:
        '200':
          description: Returns the updated Component object
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
        '400':
          description: Returns a ValidationResult with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component_Update</td><td style='border-bottom:none'>Update</td></tr><tr><td style='border-bottom:none;padding-right:5px'>JobApp</td><td style='border-bottom:none'>Function</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    delete:
      tags:
      - Components
      summary: Deletes a component record
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo of the Component to delete
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component_Delete</td><td style='border-bottom:none'>Delete</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
      operationId: deleteComponentsByComponentNo
      x-operation-id-source: derived
  /Components/{componentNo}/history:
    get:
      tags:
      - Components
      summary: Gets history for a specific Component
      operationId: GetComponentHistory
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo to get
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 5
      responses:
        '200':
          description: Returns the requested component
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If an component with the supplied Component No cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component_HistoryMode</td><td style='border-bottom:none'>HistoryMode</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/search:
    post:
      tags:
      - Components
      summary: Search for Components Takes a SearchDefinition input, which can include filters…
      operationId: SearchComponents
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Pagesize
        schema:
          type: integer
          format: int32
          default: 25
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr><tr><td style='border-bottom:none;padding-right:5px'>JobApp</td><td style='border-bottom:none'>Function</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/searchCount:
    post:
      tags:
      - Components
      summary: Returns number of hits in a search for Components Takes a SearchDefinition…
      operationId: SearchCountComponents
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/searchIndex/{componentGuid}:
    post:
      tags:
      - Components
      summary: Get index of a record in a search for Components Takes a SearchDefinition…
      operationId: SearchIndexComponents
      parameters:
      - name: componentGuid
        in: path
        description: The component to get index for
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/searchInfo:
    get:
      tags:
      - Components
      summary: Returns structured information about what and how you can search for
      operationId: SearchInfoComponents
      responses:
        '200':
          description: Returns a list of valid search fields
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
            application/json:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
            text/json:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
  /Components/{componentNo}/Items:
    get:
      tags:
      - Components
      summary: Returns a list of Items used to perform the Component
      operationId: GetComponentItems
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo to fetch items for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the spare parts for the component
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentItem'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentItem'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentItem'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/{componentNo}/force:
    delete:
      tags:
      - Components
      summary: Force deletes a component record Force deleting records may cause existing…
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo of the Component to delete
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component_ForceDelete</td><td style='border-bottom:none'>ForceDelete</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
      operationId: deleteComponentsByComponentNoForce
      x-operation-id-source: derived
  /Components/{componentNo}/documents:
    get:
      tags:
      - Components
      summary: Returns a list of Documents used on the Component
      operationId: GetComponentDocuments
      parameters:
      - name: componentNo
        in: path
        description: The Componentno to fetch triggers for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the triggers for the component
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/{componentNo}/documents/{documentNo}:
    get:
      tags:
      - Components
      summary: Returns a specific component document
      operationId: GetComponentDocument
      parameters:
      - name: componentNo
        in: path
        description: The Componentno
        required: true
        schema:
          type: string
      - name: documentNo
        in: path
        description: The no of the document to fetch
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the document for the component
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument'
        '404':
          description: If a component document with the supplied document no cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/{componentNo}/Suppliers:
    get:
      tags:
      - Components
      summary: Returns a list of Suppliers used for the Component
      operationId: GetComponentSuppliers
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo to fetch suppliers for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the suppliers for the component
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/{componentNo}/Suppliers/{supplierNo}:
    get:
      tags:
      - Components
      summary: Returns a specific Component Supplier
      operationId: GetComponentSupplier
      parameters:
      - name: componentNo
        in: path
        description: The ComponentNo
        required: true
        schema:
          type: string
      - name: supplierNo
        in: path
        description: The supplierNo to fetch
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the spare parts for the component
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier'
        '404':
          description: If a component supplier with the supplied ComponentNo cannot be found
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/{componentNo}/counterhistories:
    get:
      tags:
      - Components
      summary: Returns a list of Counter Histories used on the Component
      operationId: GetCounterHistories
      parameters:
      - name: componentNo
        in: path
        description: The Component No to fetch counter histories for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the counter histories for the component
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>Component</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Components/{componentNo}/resetcounter:
    post:
      tags:
      - Components
      summary: Resets the counter on the Component to a specific value/date
      operationId: ResetComponentCounter
      parameters:
      - name: componentNo
        in: path
        description: The Component No to fetch counter histories for
        required: true
        schema:
          type: string
      requestBody:
        description: The reading to reset to
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory'
      responses:
        '200':
          description: Returns the counter histories for the component
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Component.Component'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationRe

# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/openapi/sertica-components-api-openapi.yml