SERTICA

SERTICA Forms API

The Forms API from SERTICA — 33 operation(s) for forms.

GitHub OpenAPI

Operations 36

GET /Forms Gets a list of Forms #
POST /Forms Creates a new form record #
GET /Forms/{formNo} Gets a specific Form #
PUT /Forms/{formNo} Updates an existing Form #
DELETE /Forms/{formNo} Deletes a form record #
GET /Forms/fromFormTemplate/{formTemplateNo} Gets a non-created Form made from a Form Template #
GET /Forms/{formNo}/copy Copies an existing Form to a new object #
POST /Forms/{formNo}/formUpdateDocument Form update document #
POST /Forms/search Search for Form Takes a SearchDefinition input, which can include filters and… #
POST /Forms/searchIndex/{formGuid} Get index of a record in a search for form Takes a SearchDefinition input… #
POST /Forms/searchCount Returns number of hits in a search for Form Takes a SearchDefinition input… #
GET /Forms/searchInfo Returns structured information about what and how you can search for #
POST /Forms/search/{formTemplateNo} Search for forms using a specific FormTemplate Takes a Form Template No. #
GET /Forms/searchInfo/{formTemplateNo} Returns structured information about what and how you can search for #
POST /Forms/searchCount/{formTemplateNo} Returns number of hits in a search for Forms using a specific Form Template… #
POST /Forms/searchIndex/{formGuid}/{formTemplateNo} Get index of a record in a search for Forms using a specific Form Template… #
GET /Forms/{formNo}/history Gets history for a specific Form #
GET /Forms/{formNo}/formprint Get form print #
POST /Forms/zipArchive Zip forms archive #
GET /Forms/{formNo}/formresponses Fetches all Responses attached to the form #
GET /Forms/{formNo}/formresponses/count Returns number of FormResponses for formNo #
POST /Forms/{formNo}/addformresponse Add response #
GET /Forms/{formNo}/usage Gets usages for a specific Form #
POST /forms/{formNo}/approve Approve Form #
POST /forms/{formNo}/reject Reject Form #
POST /forms/{formNo}/requestApproval Request Approval of Form #
POST /forms/{formNo}/reopen Reopen Form #
GET /Forms/{formNo}/formActions Returns a bool telling if the User is allowed to approve the Form #
GET /Forms/{formNo}/approvers Returns a list of Approvers on the Form #
GET /Forms/{formNo}/confidentialityUserRoles Fetches all ConfidentialityUserRoles attached to the Form #
POST /Forms/appRequest Get Forms for App #
GET /Forms/appRequest/{guid} Get Form for App by Guid #
POST /Forms/appFormPDFPreview Form app PDF preview #
POST /Forms/appSubmit Submits a Form from App #
GET /Forms/tasklistFormNodes Get forms browser nodes #

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-forms-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-forms-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-forms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Forms 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: Forms
paths:
  /Forms:
    get:
      tags:
      - Forms
      summary: Gets a list of Forms
      operationId: GetForms
      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.Form.Form'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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'>Form</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:
      - Forms
      summary: Creates a new form record
      operationId: CreateForm
      requestBody:
        description: The Form Object, including reference lists
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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'>Form_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: []
  /Forms/{formNo}:
    get:
      tags:
      - Forms
      summary: Gets a specific Form
      operationId: GetForm
      parameters:
      - name: formNo
        in: path
        description: The FormNo to get
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the requested form
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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 form with the supplied Form 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'>Form</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: []
    put:
      tags:
      - Forms
      summary: Updates an existing Form
      operationId: UpdateForm
      parameters:
      - name: formNo
        in: path
        description: The FormNo of the form to update
        required: true
        schema:
          type: string
      requestBody:
        description: The Form DTO object with the fields to update
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
      responses:
        '200':
          description: Returns the updated Form object
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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'>Form_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: []
    delete:
      tags:
      - Forms
      summary: Deletes a form record
      parameters:
      - name: formNo
        in: path
        description: The FormNo of the Form 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'>Form_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: deleteFormsByFormNo
      x-operation-id-source: derived
  /Forms/fromFormTemplate/{formTemplateNo}:
    get:
      tags:
      - Forms
      summary: Gets a non-created Form made from a Form Template
      operationId: GetFormFromFormTemplate
      parameters:
      - name: formTemplateNo
        in: path
        description: The FormTempalte no from where the Form should be created
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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'>Form_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: []
  /Forms/{formNo}/copy:
    get:
      tags:
      - Forms
      summary: Copies an existing Form to a new object
      operationId: CopyForm
      parameters:
      - name: formNo
        in: path
        description: The FormNo of the form to copy
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the new Form object with properties from original
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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'>Form_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: []
  /Forms/{formNo}/formUpdateDocument:
    post:
      tags:
      - Forms
      operationId: FormUpdateDocument
      parameters:
      - name: formNo
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Choose the file to upload
        content:
          multipart/form-data:
            schema:
              required:
              - File
              type: object
              properties:
                File:
                  type: string
                  format: binary
        required: true
      responses:
        '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'>Form_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: []
      summary: Form update document
      x-summary-source: derived
  /Forms/search:
    post:
      tags:
      - Forms
      summary: Search for Form Takes a SearchDefinition input, which can include filters and…
      operationId: SearchForms
      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.Form.Form'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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'>Form</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: []
  /Forms/searchIndex/{formGuid}:
    post:
      tags:
      - Forms
      summary: Get index of a record in a search for form Takes a SearchDefinition input…
      operationId: SearchIndexForms
      parameters:
      - name: formGuid
        in: path
        description: The form 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'>Form</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: []
  /Forms/searchCount:
    post:
      tags:
      - Forms
      summary: Returns number of hits in a search for Form Takes a SearchDefinition input…
      operationId: SearchCountForms
      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'>Form</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: []
  /Forms/searchInfo:
    get:
      tags:
      - Forms
      summary: Returns structured information about what and how you can search for
      operationId: SearchInfoForms
      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
  /Forms/search/{formTemplateNo}:
    post:
      tags:
      - Forms
      summary: Search for forms using a specific FormTemplate Takes a Form Template No.
      operationId: SearchFormTemplateNo
      parameters:
      - name: formTemplateNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      - 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.Form.Form'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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'>Form</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: []
  /Forms/searchInfo/{formTemplateNo}:
    get:
      tags:
      - Forms
      summary: Returns structured information about what and how you can search for
      operationId: SearchInfoFormsByTemplateNo
      parameters:
      - name: formTemplateNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns a list of valid search fields based on the given Form Template
          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'
        '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'>Form</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: []
  /Forms/searchCount/{formTemplateNo}:
    post:
      tags:
      - Forms
      summary: Returns number of hits in a search for Forms using a specific Form Template…
      operationId: SearchCountFormsByTemplateNo
      parameters:
      - name: formTemplateNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      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'>Form</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: []
  /Forms/searchIndex/{formGuid}/{formTemplateNo}:
    post:
      tags:
      - Forms
      summary: Get index of a record in a search for Forms using a specific Form Template…
      operationId: SearchIndexFormsByTemplateNo
      parameters:
      - name: formGuid
        in: path
        description: The form to get index for
        required: true
        schema:
          type: string
          format: uuid
      - name: formTemplateNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      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'>Form</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: []
  /Forms/{formNo}/history:
    get:
      tags:
      - Forms
      summary: Gets history for a specific Form
      operationId: GetFormHistory
      parameters:
      - name: formNo
        in: path
        description: The FormNo 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 form
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Form.Form'
        '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  form with the supplied Form 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'>Form_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: []
  /Forms/{formNo}/formprint:
    get:
      tags:
      - Forms
      operationId: GetFormPrint
      parameters:
      - name: formNo
        in: path
        description: The Form no to print form for
        required: true
        schema:
          type: string
      - name: filename
        in: query
        description: the name for the report
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
         

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