SERTICA

SERTICA Document Weblinks API

The DocumentWeblinks API from SERTICA — 3 operation(s) for documentweblinks.

GitHub OpenAPI

Operations 3

GET /DocumentWeblinks/{documentWeblinksGuid}/preview Get document weblink preview #
GET /DocumentWeblinks/{documentWeblinksGuid}/file Get document weblink file #
GET /DocumentWeblinks/{documentWeblinksGuid}/pdf Get document weblink pdf #

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-documentweblinks-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-documentweblinks-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-documentweblinks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Document Weblinks 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: DocumentWeblinks
paths:
  /DocumentWeblinks/{documentWeblinksGuid}/preview:
    get:
      tags:
      - DocumentWeblinks
      operationId: GetDocumentWeblinkPreview
      parameters:
      - name: documentWeblinksGuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.DocumentSharePreview'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.DocumentSharePreview'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Document.DocumentSharePreview'
        '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'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      summary: Get document weblink preview
      x-summary-source: derived
  /DocumentWeblinks/{documentWeblinksGuid}/file:
    get:
      tags:
      - DocumentWeblinks
      operationId: GetDocumentWeblinkFile
      parameters:
      - name: documentWeblinksGuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
            text/json:
              schema:
                type: string
                format: binary
        '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'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      summary: Get document weblink file
      x-summary-source: derived
  /DocumentWeblinks/{documentWeblinksGuid}/pdf:
    get:
      tags:
      - DocumentWeblinks
      operationId: GetDocumentWeblinkPdf
      parameters:
      - name: documentWeblinksGuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
            text/json:
              schema:
                type: string
                format: binary
        '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'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound'
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      summary: Get document weblink pdf
      x-summary-source: derived
components:
  schemas:
    SerticaWebApi.Models.Document.DocumentSharePreview:
      type: object
      properties:
        filename:
          type:
          - string
          - 'null'
        previewFormat:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat'
        fileUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
    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
    Microsoft.AspNetCore.Http.HttpResults.NotFound:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
          readOnly: true
      additionalProperties: false
    SerticaWebApi.Models.ErrorReason:
      type: object
      properties:
        text:
          type:
          - string
          - 'null'
        fieldName:
          type:
          - string
          - 'null'
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat:
      enum:
      - Unknown
      - Image
      - PDF
      - WordDocument
      - Link
      - AutoCad
      - Excel
      - PowerPoint
      - Email
      - Visio
      - Projects
      - Website
      - FormFields
      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
    SerticaWebApi.Models.BrokenRuleType:
      enum:
      - Default
      - ShouldBeFilled
      - Information
      - Warning
      - Error
      - Delete
      type: string
  securitySchemes:
    Bearer:
      type: http
      description: JWT Authorization header using the Bearer scheme
      scheme: bearer