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 Components API

The Components API from SERTICA — 40 operation(s) for components.

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

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

This API exposes 46 operations across 40 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

46 operations 40 paths 47 schemas 4 DELETE20 GET20 POST2 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 Components API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer).

  • Bearer — JWT Authorization header using the Bearer scheme

Paths & Operations 46

Across 40 paths, the API surfaces 46 operations — 4 DELETE, 20 GET, 20 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Components 46
GET
/Components
Gets a list of Components
GetComponents 2 params → 200401403500
POST
/Components
Creates a new component record
CreateComponent body → 201400401403500
GET
/Components/{componentNo}
Gets a specific Component
GetComponent 1 param → 200400404401403500
PUT
/Components/{componentNo}
Updates an existing Component
UpdateComponent 1 param body → 200400401403500
DELETE
/Components/{componentNo}
Deletes a component record
deleteComponentsByComponentNo 1 param → 204400401403500
GET
/Components/{componentNo}/history
Gets history for a specific Component
GetComponentHistory 3 params → 200400404401403500
POST
/Components/search
Search for Components Takes a SearchDefinition input, which can include filters…
SearchComponents 2 params body → 200401403500
POST
/Components/searchCount
Returns number of hits in a search for Components Takes a SearchDefinition…
SearchCountComponents body → 200401403500
POST
/Components/searchIndex/{componentGuid}
Get index of a record in a search for Components Takes a SearchDefinition…
SearchIndexComponents 1 param body → 200401403500
GET
/Components/searchInfo
Returns structured information about what and how you can search for
SearchInfoComponents → 200500
GET
/Components/{componentNo}/Items
Returns a list of Items used to perform the Component
GetComponentItems 1 param → 200401403500
DELETE
/Components/{componentNo}/force
Force deletes a component record Force deleting records may cause existing…
deleteComponentsByComponentNoForce 1 param → 204400401403500
GET
/Components/{componentNo}/documents
Returns a list of Documents used on the Component
GetComponentDocuments 1 param → 200401403500
GET
/Components/{componentNo}/documents/{documentNo}
Returns a specific component document
GetComponentDocument 2 params → 200404401403500
GET
/Components/{componentNo}/Suppliers
Returns a list of Suppliers used for the Component
GetComponentSuppliers 1 param → 200401403500
GET
/Components/{componentNo}/Suppliers/{supplierNo}
Returns a specific Component Supplier
GetComponentSupplier 2 params → 200404401403500
GET
/Components/{componentNo}/counterhistories
Returns a list of Counter Histories used on the Component
GetCounterHistories 1 param → 200401403500
POST
/Components/{componentNo}/resetcounter
Resets the counter on the Component to a specific value/date
ResetComponentCounter 1 param body → 200400401403500
POST
/Components/{componentNo}/copyCounterHistory
Overwrites the counter history on a component with the history from the counter
CopyCounterHistory 1 param → 200404400401403500
GET
/Components/{componentNo}/copy
Copies an existing Component to a new object
CopyComponent 1 param → 200400401403500
POST
/Components/labels/{labelTemplateDocumentNo}
Gets the labels to print
PrintComponentLabels 1 param body → 400200404401403500
GET
/Components/labels/{labelTemplateDocumentNo}/{settingsKey}
Get the labels to print using ´settings key
GetLabelPdf 2 params → 400200404401403500
POST
/Components/{componentNo}/disable
Disable the component
DisableComponent 1 param → 400200404401403500
POST
/Components/{componentNo}/enable
Enable the component
EnableComponent 1 param → 400200404401403500
GET
/Components/propertyDefinitions
Get a list of PropertyDefinitions
GetPropertyDefinitions → 200401500
POST
/Components/propertyDefinitions
Creates a new PropertyDefinition record
CreatePropertyDefinition body → 201400401403500
GET
/Components/propertyDefinitions/{propertyDefinitionGuid}
Gets a specific PropertyDefinition
GetPropertyDefinition 1 param → 200400404401500
PUT
/Components/propertyDefinitions/{propertyDefinitionGuid}
Updates an existing PropertyDefinition
UpdatePropertyDefinition 1 param body → 200400401403500
DELETE
/Components/propertyDefinitions/{propertyDefinitionGuid}
Deletes a PropertyDefinition record
DeletePropertyDefinition 1 param → 200401403500
GET
/Components/propertyDefinitions/{propertyDefinitionGuid}/listValues
Returns a list of values for a PropertyDefinition
GetComponentPropertyDefinitionListValues 2 params → 200401500
DELETE
/Components/propertyDefinitions/{propertyDefinitionGuid}/force
Force Deletes a PropertyDefinition record
ForceDeletePropertyDefinition 1 param → 200401403500
GET
/Components/propertyDefinitions/{propertyName}/available
Lookup if PropertyName of a PropertyDefinition is not already in use and…
ComponentPropertyNameAvailable 1 param → 200401500
GET
/Components/{componentNo}/shipdex
Exports the chosen component and its data as Shipdex data
GetShipdexFile 1 param → 404400200401403500
GET
/Components/shipdex
Checks if the current Shipdex setup is valid
ValidateShipdexSetup → 200400401403500
POST
/Components/screenLayout
Bulk updates screenlayout and a list of Property Definitions.
BulkUpdateScreenLayout body → 201400401403500
POST
/Components/appSubmit
Receive component
ReceiveComponent body → 200400401403500
GET
/Components/{componentNo}/responses
Gets a list of component responses
GetComponentResponses 1 param → 200401403500
GET
/Components/{componentNo}/responses/count
Returns number of ComponentResponses for ComponentNo
CountComponentResponses 1 param → 200401403500
POST
/Components/{componentNo}/addResponse
Add response
AddComponentResponse 1 param body → 400200401403500
POST
/Components/{componentNo}/webhooklogs/search
Searches the Webhooks associated with the Component
SearchComponentWebhookLogs 3 params body → 200401403500
POST
/Components/{componentNo}/webhooklogs/searchCount
Returns number of hits in a search for the Component's Webhook Logs.
SearchComponentWebhookLogsCount 1 param body → 200401403500
POST
/Components/{componentNo}/webhooklogs/{webhookLogGuid}/retransmit
Retransmits a specific Webhook based on the selected Webhook Log
RetransmitComponentWebhookLog 2 params → 200401403500
POST
/Components/{componentNo}/webhooklogs/{webhookLogGuid}/resolve
Resolves a specific Webhook Log with a Response Log entry
ResolveComponentWebhookLog 2 params body → 200401403500
POST
/Components/{componentNo}/rotate
Rotates two components
RotateComponent 1 param body → 200400401403500
POST
/Components/BatchEdit
Component batch edit
ComponentBatchEdit body → 200400401403500
POST
/Components/BatchEdit/ApplyTransformations/{componentNo}
Component batch edit apply transformations
ComponentBatchEditApplyTransformations 1 param body → 200400401403500

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are SerticaWebApi.Models.Component.Component (81 properties), SerticaWebApi.Models.CustomProperties.PropertyDefinition (31 properties), SerticaWebApi.Models.Component.ComponentDocument (25 properties), SerticaWebApi.Models.Component.ComponentItem (23 properties). Each schema is shown below with its type and property counts.

SerticaWebApi.Models.BrokenRuleType
string
Logihold.BusinessObjects.Apps.Models.ComponentAppObject
object
9 properties
SerticaWebApi.Models.Component.ComponentResponse
object
13 properties
SerticaWebApi.Models.BatchEdit.BatchEditOperation
string
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType
string
SerticaWebApi.Models.BatchEdit.BatchEditResultState
string
SerticaWebApi.Models.BatchEdit.BatchEditResult
object
1 property
SerticaWebApi.Models.Component.ComponentSupplier
object
14 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateResult
object
3 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateIssue
object
2 properties
SerticaWebApi.Models.ValidationResult
object
4 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinition
object
31 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionUnitDependency
object
11 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField
object
5 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionFieldDependency
object
13 properties
SerticaWebApi.Models.Component.Component
object
81 properties
SerticaWebApi.Models.Component.ComponentItem
object
23 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.Component.ComponentCounterHistory
object
13 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue
object
9 properties
SerticaWebApi.Models.Link
object
2 properties
SerticaWebApi.Models.BatchEdit.BatchEditRecordResult
object
3 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_WebhookLogStatus
string
Logihold.BusinessObjects.LogiholdObjModel.SystemData_DataObject
string
Microsoft.AspNetCore.Mvc.NotFoundResult
object
1 property
Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching
string
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat
string
SerticaWebApi.Models.Component.ComponentDocument
object
25 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateIssueReason
string
SerticaWebApi.Models.Framework.Amount
object
3 properties
SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy
object
2 properties
SerticaWebApi.Models.BatchEdit.BatchEditTransformation
object
8 properties
SerticaWebApi.Models.CustomLayout.ScreenLayout
object
8 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator
string
SerticaWebApi.Models.BrokenRule
object
7 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition
object
8 properties
Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection
string
SerticaWebApi.Models.Webhooks.WebhookLog
object
20 properties
SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.CustomProperties.PropertyDataType
string
Logimatic.BaseClasses30.DataOwner
string
SerticaWebApi.Models.Component.ComponentRotateArguments
object
3 properties
SerticaWebApi.Models.BatchEdit.BatchEdit
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sertica-components-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 Components 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.