SERTICA

SERTICA Job History Data Entry Documents API

The JobHistoryDataEntryDocuments API from SERTICA — 5 operation(s) for jobhistorydataentrydocuments.

GitHub OpenAPI

Operations 6

GET /JobHistoryDataEntryDocuments/{documentNo} Gets a specific Document #
POST /JobHistoryDataEntryDocuments Creates a new document record #
POST /JobHistoryDataEntryDocuments/search Search for Documents Takes a SearchDefinition input, which can include filters… #
GET /JobHistoryDataEntryDocuments/{documentNo}/pdf Job history data entry get document pdf #
GET /JobHistoryDataEntryDocuments/{documentNo}/file Job history data entry get document file #
POST /JobHistoryDataEntryDocuments/{documentNo}/file Job history data entry add document file #

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-jobhistorydataentrydocuments-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-jobhistorydataentrydocuments-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-jobhistorydataentrydocuments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Job History Data Entry 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: JobHistoryDataEntryDocuments
paths:
  /JobHistoryDataEntryDocuments/{documentNo}:
    get:
      tags:
      - JobHistoryDataEntryDocuments
      summary: Gets a specific Document
      operationId: JobHistoryDataEntryGetDocument
      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
        '403':
          description: Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>JobHistoryDataEntryWeb</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
  /JobHistoryDataEntryDocuments:
    post:
      tags:
      - JobHistoryDataEntryDocuments
      summary: Creates a new document record
      operationId: JobHistoryDataEntryCreateDocument
      parameters:
      - name: forceAutogenerateDocumentNo
        in: query
        description: Forces API to set an autogenerated DocumentNo
        schema:
          type: boolean
          default: false
      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'
        '403':
          description: Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>JobHistoryDataEntryWeb</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
  /JobHistoryDataEntryDocuments/search:
    post:
      tags:
      - JobHistoryDataEntryDocuments
      summary: Search for Documents Takes a SearchDefinition input, which can include filters…
      operationId: JobHistoryDataEntrySearchDocuments
      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'
        '403':
          description: Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>JobHistoryDataEntryWeb</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
  /JobHistoryDataEntryDocuments/{documentNo}/pdf:
    get:
      tags:
      - JobHistoryDataEntryDocuments
      summary: Job history data entry get document pdf
      operationId: JobHistoryDataEntryGetDocumentPdf
      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
        '403':
          description: Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>JobHistoryDataEntryWeb</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      x-summary-source: derived
  /JobHistoryDataEntryDocuments/{documentNo}/file:
    get:
      tags:
      - JobHistoryDataEntryDocuments
      summary: Job history data entry get document file
      operationId: JobHistoryDataEntryGetDocumentFile
      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
        '403':
          description: Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>JobHistoryDataEntryWeb</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      x-summary-source: derived
    post:
      tags:
      - JobHistoryDataEntryDocuments
      operationId: JobHistoryDataEntryAddDocumentFile
      parameters:
      - name: documentNo
        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'
        '403':
          description: Customer must have one of these License values set<table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>JobHistoryDataEntryWeb</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      summary: Job history data entry add document file
      x-summary-source: derived
components:
  schemas:
    Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection:
      enum:
      - Asc
      - Desc
      type: string
    SerticaWebApi.Models.DocumentMail.DocumentNotification:
      type: object
      properties:
        days:
          type: integer
          format: int32
        daysDirection:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentNotificationDaysDirection'
        documentMailTemplateNo:
          type:
          - string
          - 'null'
        recipients:
          type:
          - string
          - 'null'
        dateSent:
          type:
          - string
          - 'null'
          format: date-time
        documentNo:
          type:
          - string
          - 'null'
        documentDescription:
          type:
          - string
          - 'null'
        guid:
          type:
          - string
          - 'null'
          format: uuid
        liveObjectGuid:
          type:
          - string
          - 'null'
          format: uuid
        unitGuid:
          type:
          - string
          - 'null'
          format: uuid
        deleted:
          type: boolean
        latestHistoryGuid:
          type:
          - string
          - 'null'
          format: uuid
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Link'
          readOnly: true
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.DocumentNotificationDaysDirection:
      enum:
      - Before
      - After
      type: string
    SerticaWebApi.Models.BrokenRule:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/SerticaWebApi.Models.BrokenRuleType'
        index:
          type:
          - integer
          - 'null'
          format: int32
        objectGuid:
          type:
          - string
          - 'null'
          format: uuid
        field:
          type:
          - string
          - 'null'
        field2:
          type:
          - string
          - 'null'
        field3:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator:
      enum:
      - Equals
      - LessThan
      - GreaterThan
      - Like
      - Range
      - In
      - Dynamic
      - StartsWith
      - EndsWith
      - IsNull
      - NotLike
      - Or
      - NotEquals
      - NotIn
      type: string
    SerticaWebApi.Models.ErrorReason:
      type: object
      properties:
        text:
          type:
          - string
          - 'null'
        fieldName:
          type:
          - string
          - 'null'
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        direction:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection'
      additionalProperties: false
    SerticaWebApi.Models.Document.Document:
      type: object
      properties:
        dataOwner:
          $ref: '#/components/schemas/Logimatic.BaseClasses30.DataOwner'
        documentNo:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        fileName:
          type:
          - string
          - 'null'
        revisionRemark:
          type:
          - string
          - 'null'
        documentRef:
          type:
          - string
          - 'null'
        remark:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
        fileSize:
          type:
          - integer
          - 'null'
          format: int64
        type:
          $ref: '#/components/schemas/SerticaWebApi.Models.Document.FileType'
        expireDate:
          type:
          - string
          - 'null'
          format: date-time
        issueDate:
          type:
          - string
          - 'null'
          format: date-time
        checkOutDate:
          type:
          - string
          - 'null'
          format: date-time
        checkOutUserNo:
          type:
          - string
          - 'null'
        checkOutUserName:
          type:
          - string
          - 'null'
        version:
          type:
          - integer
          - 'null'
          format: int32
        documentTypeNo:
          type:
          - string
          - 'null'
        documentTypeName:
          type:
          - string
          - 'null'
        documentGroupNo:
          type:
          - string
          - 'null'
        documentGroupName:
          type:
          - string
          - 'null'
        documentTypeUnitNo:
          type:
          - string
          - 'null'
        documentGroupUnitNo:
          type:
          - string
          - 'null'
        customProperties: {}
        fileModified:
          type:
          - string
          - 'null'
          format: date-time
        ignoreDocumentGroupMandatoryRule:
          type:
          - boolean
          - 'null'
        previewFormat:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat'
        documentClasses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass'
        notifications:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentNotification'
        documentWeblinks:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Document.DocumentWeblink'
        unitNo:
          type:
          - string
          - 'null'
        unitName:
          type:
          - string
          - 'null'
        updateUserNo:
          type:
          - string
          - 'null'
        updateUserName:
          type:
          - string
          - 'null'
        updateDate:
          type:
          - string
          - 'null'
          format: date-time
        createUserNo:
          type:
          - string
          - 'null'
        createUserName:
          type:
          - string
          - 'null'
        createDate:
          type:
          - string
          - 'null'
          format: date-time
        guid:
          type:
          - string
          - 'null'
          format: uuid
        liveObjectGuid:
          type:
          - string
          - 'null'
          format: uuid
        unitGuid:
          type:
          - string
          - 'null'
          format: uuid
        deleted:
          type: boolean
        latestHistoryGuid:
          type:
          - string
          - 'null'
          format: uuid
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Link'
          readOnly: true
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest:
      type: object
      properties:
        deviceGuid:
          type:
          - string
          - 'null'
          format: uuid
        requestIdGuid:
          type:
          - string
          - 'null'
          format: uuid
        fullSynchronization:
          type: boolean
        appType:
          type: integer
          format: int32
      additionalProperties: false
    SerticaWebApi.Models.Link:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition:
      type: object
      properties:
        distinct:
          type: boolean
        subObjectsToInclude:
          type:
          - array
          - 'null'
          items:
            type: string
        contains:
          type:
          - array
          - 'null'
          items:
            type: string
        criteria:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria'
        sorting:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy'
        columns:
          type:
          - array
          - 'null'
          items:
            type: string
        forDeviceRequest:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest'
        unitFilter:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    SerticaWebApi.Models.Document.DocumentDocumentClass:
      type: object
      properties:
        documentNo:
          type:
          - string
          - 'null'
        documentClassNo:
          type:
          - string
          - 'null'
        documentClassName:
          type:
          - string
          - 'null'
        guidForReferencedObject:
          type:
          - string
          - 'null'
          format: uuid
        guid:
          type:
          - string
          - 'null'
          format: uuid
        liveObjectGuid:
          type:
          - string
          - 'null'
          format: uuid
        unitGuid:
          type:
          - string
          - 'null'
          format: uuid
        deleted:
          type: boolean
        latestHistoryGuid:
          type:
          - string
          - 'null'
          format: uuid
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Link'
          readOnly: true
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat:
      enum:
      - Unknown
      - Image
      - PDF
      - WordDocument
      - Link
      - AutoCad
      - Excel
      - PowerPoint
      - Email
      - Visio
      - Projects
      - Website
      - FormFields
      type: string
    Logimatic.BaseClasses30.DataOwner:
      enum:
      - Unit
      - MasterUnit
      type: string
    SerticaWebApi.Models.Document.FileType:
      enum:
      - None
      - File
      - Link
      - Folder
      type: string
    SerticaWebApi.Models.Document.DocumentWeblink:
      type: object
      properties:
        document2Guid:
          type: string
          format: uuid
        description:
          type:
          - string
          - 'null'
        expireDate:
          type:
          - string
          - 'null'
          format: date-time
        link:
          type:
          - string
          - 'null'
        guid:
          type:
          - string
          - 'null'
          format: uuid
        liveObjectGuid:
          type:
          - string
          - 'null'
          format: uuid
        unitGuid:
          type:
          - string
          - 'null'
          format: uuid
        deleted:
          type: boolean
        latestHistoryGuid:
          type:
          - string
          - 'null'
          format: uuid
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Link'
          readOnly: true
      additionalProperties: false
    SerticaWebApi.Models.Document.FileContentDisposition:
      enum:
      - Inline
      type: string
    SerticaWebApi.Models.ValidationResult:
      type: object
      properties:
        isValid:
          type: boolean
          readOnly: true
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.ErrorReason'
          readOnly: true
        brokenRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.BrokenRule'
          readOnly: true
        subResults:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
          readOnly: true
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching:
      enum:
      - All
      - One
      type: string
    SerticaWebApi.Models.BrokenRuleType:
      enum:
      - Default
      - ShouldBeFilled
      - Information
      - Warning
      - Error
      - Delete
      type: string
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        operator:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator'
        values:
          type:
          - array
          - 'null'
          items: {}
        valuesMatching:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: JWT Authorization header using the Bearer scheme
      scheme: bearer