How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SERTICA Documents API

The Documents API from SERTICA — 28 operation(s) for documents.

SERTICA Documents API is one of 254 APIs that SERTICA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 35 operations across 28 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /api.

35 operations 28 paths 36 schemas 4 DELETE18 GET10 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://{sitename}.sertica.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

SERTICA Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer).

  • Bearer — JWT Authorization header using the Bearer scheme

Paths & Operations 35

Across 28 paths, the API surfaces 35 operations — 4 DELETE, 18 GET, 10 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 35
GET
/Documents
Gets a list of Documents
GetDocuments 2 params → 200401403500
POST
/Documents
Creates a new document record
CreateDocument 1 param body → 201400401403500
GET
/Documents/{documentNo}
Gets a specific Document
GetDocument 1 param → 200400404401403500
PUT
/Documents/{documentNo}
Updates an existing Document
UpdateDocument 1 param body → 200400401403500
DELETE
/Documents/{documentNo}
Deletes a document record
deleteDocumentsByDocumentNo 1 param → 204400401403500
POST
/Documents/searchIndex/{documentGuid}
Get index of a record in a search for document Takes a SearchDefinition input…
SearchIndexDocuments 1 param body → 200401403500
GET
/Documents/{documentNo}/history
Gets history for a specific Document
GetDocumentHistory 3 params → 200400404401403500
DELETE
/Documents/{documentNo}/force
Force deletes a document record Force deleting records may cause existing…
deleteDocumentsByDocumentNoForce 1 param → 204400401403500
POST
/Documents/search
Search for Documents Takes a SearchDefinition input, which can include filters…
SearchDocuments 2 params body → 200401403500
POST
/Documents/searchCount
Returns number of hits in a search for Documents Takes a SearchDefinition…
SearchCountDocuments body → 200401403500
GET
/Documents/searchInfo
Returns structured information about what and how you can search for
SearchInfoDocuments → 200500
GET
/Documents/{documentNo}/pdf
Get document pdf
GetDocumentPdf 1 param → 400200404401403500
GET
/Documents/{documentNo}/file
Get document file
GetDocumentFile 2 params → 400200404401403500
POST
/Documents/{documentNo}/file
Add document file
AddDocumentFile 3 params body → 400401403500
GET
/Documents/{documentNo}/thumbnail
Get image thumbnail
GetImageThumbnail 3 params → 400200404401403500
GET
/Documents/{documentNo}/history/{documentGuid}/pdf
Get document pdf from guid
GetDocumentPdfGuid 2 params → 400200404401403500
GET
/Documents/{documentNo}/history/{documentGuid}/file
Get document file from guid
GetDocumentFileGuid 3 params → 400200404401403500
PUT
/Documents/{documentNo}/checkout
Checks out the document to the current user.
CheckoutDocumentFile 1 param → 400200404401403500
POST
/Documents/{documentNo}/checkin
Checkin document file
CheckinDocumentFile 6 params body → 400200404401403500
GET
/Documents/{documentNo}/copy
Copies an existing Document to a new object
CopyDocument 1 param → 200400401403500
GET
/Documents/{documentNo}/usage
Gets usages for a specific Document
GetDocumentUsages 1 param → 200400404401403500
GET
/Documents/{documentNo}/documentclasses
Get document document classes
GetDocumentDocumentClasses 1 param → 200400404401403500
GET
/Documents/{documentNo}/notifications
Get document notifications
GetDocumentNotifications 1 param → 200400404401403500
POST
/Documents/zipArchive
Zip document archive
ZipDocumentArchive 1 param body → 400200404401403500
GET
/Documents/propertyDefinitions
Get a list of PropertyDefinitions
GetDocumentPropertyDefinitions → 200401500
POST
/Documents/propertyDefinitions
Creates a new PropertyDefinition record
CreateDocumentPropertyDefinition body → 201400401403500
GET
/Documents/propertyDefinitions/{propertyDefinitionGuid}
Gets a specific PropertyDefinition
GetDocumentPropertyDefinition 1 param → 200400404401500
PUT
/Documents/propertyDefinitions/{propertyDefinitionGuid}
Updates an existing PropertyDefinition
UpdateDocumentPropertyDefinition 1 param body → 200400401403500
DELETE
/Documents/propertyDefinitions/{propertyDefinitionGuid}
Deletes a PropertyDefinition record
DeleteDocumentPropertyDefinition 1 param → 200401403500
GET
/Documents/propertyDefinitions/{propertyDefinitionGuid}/listValues
Returns a list of values for a PropertyDefinition
GetDocumentPropertyDefinitionListValues 2 params → 200401500
DELETE
/Documents/propertyDefinitions/{propertyDefinitionGuid}/force
Force Deletes a PropertyDefinition record
ForceDeleteDocumentPropertyDefinition 1 param → 200401403500
GET
/Documents/propertyDefinitions/{propertyName}/available
Lookup if PropertyName of a PropertyDefinition is not already in use and…
DocumentPropertyNameAvailable 1 param → 200401500
POST
/Documents/screenLayout
Bulk updates screenlayout and a list of Property Definitions.
BulkUpdateDocumentScreenLayout body → 201400401403500
GET
/Documents/{documentNo}/documentweblinks
Get document document web links
GetDocumentDocumentWebLinks 1 param → 200400404401403500
POST
/Documents/{documentNo}/share
Share document weblink
ShareDocumentWeblink 1 param body → 201400404401403500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are SerticaWebApi.Models.Document.Document (43 properties), SerticaWebApi.Models.CustomProperties.PropertyDefinition (31 properties), SerticaWebApi.Models.DocumentMail.DocumentNotification (13 properties), SerticaWebApi.Models.CustomProperties.PropertyDefinitionFieldDependency (13 properties). Each schema is shown below with its type and property counts.

SerticaWebApi.Models.DocumentMail.DocumentNotification
object
13 properties
SerticaWebApi.Models.BrokenRuleType
string
Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.DocumentUsageObjectType
string
SerticaWebApi.Models.Document.FileType
string
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType
string
SerticaWebApi.Models.Document.DocumentWeblink
object
10 properties
SerticaWebApi.Models.ValidationResult
object
4 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinition
object
31 properties
SerticaWebApi.Models.Document.Document
object
43 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionUnitDependency
object
11 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField
object
5 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionFieldDependency
object
13 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest
object
4 properties
SerticaWebApi.Models.ErrorReason
object
2 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue
object
9 properties
SerticaWebApi.Models.Document.DocumentShareLinkType
string
SerticaWebApi.Models.Link
object
2 properties
SerticaWebApi.Models.Document.FileContentDisposition
string
SerticaWebApi.Models.Document.DocumentShare
object
3 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching
string
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat
string
Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView
object
5 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.DocumentNotificationDaysDirection
string
SerticaWebApi.Models.CustomLayout.ScreenLayout
object
8 properties
SerticaWebApi.Models.BrokenRule
object
7 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator
string
Logihold.BusinessObjects.LogiholdObjModel.SystemData_ImageDimension
string
SerticaWebApi.Models.Document.DocumentDocumentClass
object
10 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition
object
8 properties
Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection
string
SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.CustomProperties.PropertyDataType
string
Logimatic.BaseClasses30.DataOwner
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sertica-documents-api-openapi.yml Raw ↑

Other APIs SERTICA publishes across the network.

SERTICA Accounting Dimensions API
SERTICA Accounting Dimensions Cache API
SERTICA Accounts API
SERTICA Activity Groups API
SERTICA Address Categories API
SERTICA Address Classifications API
SERTICA Addresses API
SERTICA AI Client API
SERTICA Analytics API
SERTICA Analytics Custom Menus API
SERTICA Analytics Custom Templates API
SERTICA Analytics Excel Templates API
Where this information came from

This is an independent, third-party profile of SERTICA Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.