# SERTICA Components API

**Canonical:** https://apis.io/apis/sertica/sertica-components-api/  
**Provider:** SERTICA — https://apis.io/providers/sertica/  
**Base URL:** https://{sitename}.sertica.com/api  
**Documentation:** https://www.sertica.com/modules/maintenance-api/

SERTICA Components API is one of 254 APIs that [SERTICA](https://apis.io/providers/sertica/) publishes on the [APIs.io](https://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.

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

## Operations (46)

| Method | Path | Summary |
|---|---|---|
| GET | `/Components` | Gets a list of Components |
| POST | `/Components` | Creates a new component record |
| GET | `/Components/{componentNo}` | Gets a specific Component |
| PUT | `/Components/{componentNo}` | Updates an existing Component |
| DELETE | `/Components/{componentNo}` | Deletes a component record |
| GET | `/Components/{componentNo}/history` | Gets history for a specific Component |
| POST | `/Components/search` | Search for Components Takes a SearchDefinition input, which can include filters… |
| POST | `/Components/searchCount` | Returns number of hits in a search for Components Takes a SearchDefinition… |
| POST | `/Components/searchIndex/{componentGuid}` | Get index of a record in a search for Components Takes a SearchDefinition… |
| GET | `/Components/searchInfo` | Returns structured information about what and how you can search for |
| GET | `/Components/{componentNo}/Items` | Returns a list of Items used to perform the Component |
| DELETE | `/Components/{componentNo}/force` | Force deletes a component record Force deleting records may cause existing… |
| GET | `/Components/{componentNo}/documents` | Returns a list of Documents used on the Component |
| GET | `/Components/{componentNo}/documents/{documentNo}` | Returns a specific component document |
| GET | `/Components/{componentNo}/Suppliers` | Returns a list of Suppliers used for the Component |
| GET | `/Components/{componentNo}/Suppliers/{supplierNo}` | Returns a specific Component Supplier |
| GET | `/Components/{componentNo}/counterhistories` | Returns a list of Counter Histories used on the Component |
| POST | `/Components/{componentNo}/resetcounter` | Resets the counter on the Component to a specific value/date |
| POST | `/Components/{componentNo}/copyCounterHistory` | Overwrites the counter history on a component with the history from the counter |
| GET | `/Components/{componentNo}/copy` | Copies an existing Component to a new object |
| POST | `/Components/labels/{labelTemplateDocumentNo}` | Gets the labels to print |
| GET | `/Components/labels/{labelTemplateDocumentNo}/{settingsKey}` | Get the labels to print using ´settings key |
| POST | `/Components/{componentNo}/disable` | Disable the component |
| POST | `/Components/{componentNo}/enable` | Enable the component |
| GET | `/Components/propertyDefinitions` | Get a list of PropertyDefinitions |
| POST | `/Components/propertyDefinitions` | Creates a new PropertyDefinition record |
| GET | `/Components/propertyDefinitions/{propertyDefinitionGuid}` | Gets a specific PropertyDefinition |
| PUT | `/Components/propertyDefinitions/{propertyDefinitionGuid}` | Updates an existing PropertyDefinition |
| DELETE | `/Components/propertyDefinitions/{propertyDefinitionGuid}` | Deletes a PropertyDefinition record |
| GET | `/Components/propertyDefinitions/{propertyDefinitionGuid}/listValues` | Returns a list of values for a PropertyDefinition |
| DELETE | `/Components/propertyDefinitions/{propertyDefinitionGuid}/force` | Force Deletes a PropertyDefinition record |
| GET | `/Components/propertyDefinitions/{propertyName}/available` | Lookup if PropertyName of a PropertyDefinition is not already in use and… |
| GET | `/Components/{componentNo}/shipdex` | Exports the chosen component and its data as Shipdex data |
| GET | `/Components/shipdex` | Checks if the current Shipdex setup is valid |
| POST | `/Components/screenLayout` | Bulk updates screenlayout and a list of Property Definitions. |
| POST | `/Components/appSubmit` | Receive component |
| GET | `/Components/{componentNo}/responses` | Gets a list of component responses |
| GET | `/Components/{componentNo}/responses/count` | Returns number of ComponentResponses for ComponentNo |
| POST | `/Components/{componentNo}/addResponse` | Add response |
| POST | `/Components/{componentNo}/webhooklogs/search` | Searches the Webhooks associated with the Component |
| POST | `/Components/{componentNo}/webhooklogs/searchCount` | Returns number of hits in a search for the Component's Webhook Logs. |
| POST | `/Components/{componentNo}/webhooklogs/{webhookLogGuid}/retransmit` | Retransmits a specific Webhook based on the selected Webhook Log |
| POST | `/Components/{componentNo}/webhooklogs/{webhookLogGuid}/resolve` | Resolves a specific Webhook Log with a Response Log entry |
| POST | `/Components/{componentNo}/rotate` | Rotates two components |
| POST | `/Components/BatchEdit` | Component batch edit |
| POST | `/Components/BatchEdit/ApplyTransformations/{componentNo}` | Component batch edit apply transformations |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/openapi/sertica-components-api-openapi.yml
- **Documentation** — https://support.sertica.com/hc/en-us/articles/28558470734109-SERTICA-Application-Programming-Interface
- **APIReference** — https://docs.sertica.com/api/swagger/index.html
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/errors/sertica-problem-types.yml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/authentication/sertica-authentication.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

## Other SERTICA APIs (12)

- [SERTICA Accounting Dimensions API](https://apis.io/apis/sertica/sertica-accountingdimensions-api/)
- [SERTICA Accounting Dimensions Cache API](https://apis.io/apis/sertica/sertica-accountingdimensionscache-api/)
- [SERTICA Accounts API](https://apis.io/apis/sertica/sertica-accounts-api/)
- [SERTICA Activity Groups API](https://apis.io/apis/sertica/sertica-activitygroups-api/)
- [SERTICA Address Categories API](https://apis.io/apis/sertica/sertica-addresscategories-api/)
- [SERTICA Address Classifications API](https://apis.io/apis/sertica/sertica-addressclassifications-api/)
- [SERTICA Addresses API](https://apis.io/apis/sertica/sertica-addresses-api/)
- [SERTICA AI Client API](https://apis.io/apis/sertica/sertica-aiclient-api/)
- [SERTICA Analytics API](https://apis.io/apis/sertica/sertica-analytics-api/)
- [SERTICA Analytics Custom Menus API](https://apis.io/apis/sertica/sertica-analyticscustommenus-api/)
- [SERTICA Analytics Custom Templates API](https://apis.io/apis/sertica/sertica-analyticscustomtemplates-api/)
- [SERTICA Analytics Excel Templates API](https://apis.io/apis/sertica/sertica-analyticsexceltemplates-api/)

## Tags

Components

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sertica/sertica-components-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sertica/.