SERTICA

SERTICA Form Template Help Image Documents API

The FormTemplateHelpImageDocuments API from SERTICA — 15 operation(s) for formtemplatehelpimagedocuments.

GitHub OpenAPI

Operations 19

GET /FormTemplateHelpImageDocuments Gets a list of FormTemplateHelpImageDocuments #
POST /FormTemplateHelpImageDocuments Creates a new document record #
GET /FormTemplateHelpImageDocuments/{documentNo} Gets a specific FormTemplateHelpImageDocument #
PUT /FormTemplateHelpImageDocuments/{documentNo} Updates an existing Document #
DELETE /FormTemplateHelpImageDocuments/{documentNo} Deletes a document record #
POST /FormTemplateHelpImageDocuments/searchIndex/{documentGuid} Get index of a record in a search for FormTemplateHelpImageDocument Takes a… #
GET /FormTemplateHelpImageDocuments/{documentNo}/history Gets history for a specific FormTemplateHelpImageDocument #
POST /FormTemplateHelpImageDocuments/search Search for Documents Takes a SearchDefinition input, which can include filters… #
POST /FormTemplateHelpImageDocuments/searchCount Returns number of hits in a search for Documents Takes a SearchDefinition… #
GET /FormTemplateHelpImageDocuments/searchInfo Returns structured information about what and how you can search for #
GET /FormTemplateHelpImageDocuments/{documentNo}/pdf Get form template help image document pdf #
GET /FormTemplateHelpImageDocuments/{documentNo}/file Get form template help image document file #
POST /FormTemplateHelpImageDocuments/{documentNo}/file Add form template help image document file #
GET /FormTemplateHelpImageDocuments/{documentNo}/history/{documentGuid}/pdf Get document pdf from guid #
GET /FormTemplateHelpImageDocuments/{documentNo}/history/{documentGuid}/file Get document file from guid #
PUT /FormTemplateHelpImageDocuments/{documentNo}/checkout Checks out the document to the current user. #
POST /FormTemplateHelpImageDocuments/{documentNo}/checkin Checkin form template help image document file #
GET /FormTemplateHelpImageDocuments/{documentNo}/copy Copies an existing Document to a new object #
GET /FormTemplateHelpImageDocuments/{documentNo}/usage Gets usages for a specific Document #

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-formtemplatehelpimagedocuments-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-formtemplatehelpimagedocuments-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-formtemplatehelpimagedocuments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Form Template Help Image Documents 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: FormTemplateHelpImageDocuments
paths:
  /FormTemplateHelpImageDocuments:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Gets a list of FormTemplateHelpImageDocuments
      operationId: GetFormTemplateHelpImageDocuments
      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.Document.Document'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
        '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'>FormTemplates</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:
      - FormTemplateHelpImageDocuments
      summary: Creates a new document record
      operationId: CreateFormTemplateHelpImageDocument
      requestBody:
        description: The Document Object, including reference lists
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
        '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'>FormTemplates_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: []
  /FormTemplateHelpImageDocuments/{documentNo}:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Gets a specific FormTemplateHelpImageDocument
      operationId: GetFormTemplateHelpImageDocument
      parameters:
      - name: documentNo
        in: path
        description: The DocumentNo to get
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the requested document
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
        '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 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'>FormTemplates</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:
      - FormTemplateHelpImageDocuments
      summary: Updates an existing Document
      operationId: UpdateFormTemplateHelpImageDocument
      parameters:
      - name: documentNo
        in: path
        description: The DocumentNo of the document to update
        required: true
        schema:
          type: string
      requestBody:
        description: The Document DTO object with the fields to update
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
      responses:
        '200':
          description: Returns the updated Document object
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
        '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'>FormTemplates_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:
      - FormTemplateHelpImageDocuments
      summary: Deletes a document record
      parameters:
      - name: documentNo
        in: path
        description: The DocumentNo of the Document 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'>FormTemplates_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: deleteFormTemplateHelpImageDocumentsByDocumentNo
      x-operation-id-source: derived
  /FormTemplateHelpImageDocuments/searchIndex/{documentGuid}:
    post:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Get index of a record in a search for FormTemplateHelpImageDocument Takes a…
      operationId: SearchIndexFormTemplateHelpImageDocuments
      parameters:
      - name: documentGuid
        in: path
        description: The document 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'>FormTemplates</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: []
  /FormTemplateHelpImageDocuments/{documentNo}/history:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Gets history for a specific FormTemplateHelpImageDocument
      operationId: GetFormTemplateHelpImageDocumentHistory
      parameters:
      - name: documentNo
        in: path
        description: The DocumentNo 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 document
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
        '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 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'>FormTemplates_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: []
  /FormTemplateHelpImageDocuments/search:
    post:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Search for Documents Takes a SearchDefinition input, which can include filters…
      operationId: SearchFormTemplateHelpImageDocuments
      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.Document.Document'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Document.Document'
        '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'>FormTemplates</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: []
  /FormTemplateHelpImageDocuments/searchCount:
    post:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Returns number of hits in a search for Documents Takes a SearchDefinition…
      operationId: SearchCountFormTemplateHelpImageDocuments
      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'>FormTemplates</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: []
  /FormTemplateHelpImageDocuments/searchInfo:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Returns structured information about what and how you can search for
      operationId: SearchInfoFormTemplateHelpImageDocuments
      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
  /FormTemplateHelpImageDocuments/{documentNo}/pdf:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Get form template help image document pdf
      operationId: GetFormTemplateHelpImageDocumentPdf
      parameters:
      - name: documentNo
        in: path
        description: The Document No. to get file for
        required: true
        schema:
          type: string
      responses:
        '400':
          description: If a document cannot be converted to pdf
          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'
        '200':
          description: Returns the requested document report as pdf
        '404':
          description: If a 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'>FormTemplates</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: []
      x-summary-source: derived
  /FormTemplateHelpImageDocuments/{documentNo}/file:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Get form template help image document file
      operationId: GetFormTemplateHelpImageDocumentFile
      parameters:
      - name: documentNo
        in: path
        description: The Document No. to get file for
        required: true
        schema:
          type: string
      - name: contentDisposition
        in: query
        description: Set to 'inline' to view file in browser
        schema:
          $ref: '#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition'
      responses:
        '400':
          description: If a document cannot be converted to pdf
          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'
        '200':
          description: Returns the requested document report as pdf
        '404':
          description: If a 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'>FormTemplates</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: []
      x-summary-source: derived
    post:
      tags:
      - FormTemplateHelpImageDocuments
      operationId: AddFormTemplateHelpImageDocumentFile
      parameters:
      - name: documentNo
        in: path
        required: true
        schema:
          type: string
      - name: imageDimension
        in: query
        schema:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData_ImageDimension'
      - name: imageQuality
        in: query
        schema:
          type: integer
          format: int32
          default: 80
      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'>FormTemplates_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: Add form template help image document file
      x-summary-source: derived
  /FormTemplateHelpImageDocuments/{documentNo}/history/{documentGuid}/pdf:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Get document pdf from guid
      operationId: GetFormTemplateHelpImageDocumentPdfGuid
      parameters:
      - name: documentNo
        in: path
        description: The Document No. to get file for
        required: true
        schema:
          type: string
      - name: documentGuid
        in: path
        description: The document Guid to get the pdf for
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '400':
          description: If a document cannot be converted to pdf
          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'
        '200':
          description: Returns the requested document report as pdf
        '404':
          description: If a 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'>FormTemplates</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: []
  /FormTemplateHelpImageDocuments/{documentNo}/history/{documentGuid}/file:
    get:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Get document file from guid
      operationId: GetFormTemplateHelpImageDocumentFileGuid
      parameters:
      - name: documentNo
        in: path
        description: The Document No. to get file for
        required: true
        schema:
          type: string
      - name: documentGuid
        in: path
        description: The document guid
        required: true
        schema:
          type: string
          format: uuid
      - name: contentDisposition
        in: query
        description: Set to 'inline' to view file in browser
        schema:
          type: string
      responses:
        '400':
          description: If a document cannot be converted to pdf
          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'
        '200':
          description: Returns the requested document report as pdf
        '404':
          description: If a 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'>FormTemplates</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: []
  /FormTemplateHelpImageDocuments/{documentNo}/checkout:
    put:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Checks out the document to the current user.
      operationId: CheckoutFormTemplateHelpImageDocumentFile
      parameters:
      - name: documentNo
        in: path
        description: The Document No. to get file for
        required: true
        schema:
          type: string
      responses:
        '400':
          description: If a document cannot be checked out
          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'
        '200':
          description: Returns the checked out file
        '404':
          description: If a 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'>FormTemplates_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: []
  /FormTemplateHelpImageDocuments/{documentNo}/checkin:
    post:
      tags:
      - FormTemplateHelpImageDocuments
      summary: Checkin form template help image document file
      operationId: CheckinFormTemplateHelpImageDocumentFile
      parameters:
      - name: documentNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: checkinWithoutVersion
        in: query
        description: ''
        schema:
          type: boolean
      - name: version
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      - name: revisionRemark
        in: query
        description: ''
        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: If a document cannot be checked in
          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'
        '200':
          description: Returns the updated document
        '404':
          description: If a 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'>FormTemplates_Update</td><td style='border-bottom:none'>Update</td></tr></tbody></table>
    

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