The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.
Apiera REST API (1.1.0)
| Items Enum Value | Description |
|---|---|
| draft | The initial state of the input type. |
| active | The input type is active and available for use. |
| inactive | The input type is temporarily disabled. |
| removed | The input type has been soft-deleted. |
| Items Enum Value | Description |
|---|---|
| text | Single-line plain text. |
| textArea | Multi-line plain text. |
| richText | Formatted text with markup support. |
| integer | Whole number value. |
| decimal | Decimal number value. |
| boolean | True or false value. |
| date | Date without time component. |
| dateTime | Date with time component. |
| url | A URL value. |
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types
- Productionhttps://api.apiera.io/v1/type-groups/{typeGroupUuid}/input-types
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&codes%5Beq%5D=string&code%5Bcontains%5D=string&code%5Bstarts%5D=string&code%5Bends%5D=string&code%5Border%5D=string&displayNames%5Beq%5D=string&displayName%5Bcontains%5D=string&displayName%5Bstarts%5D=string&displayName%5Bends%5D=string&displayName%5Border%5D=string&statuses%5Beq%5D=draft&status%5Border%5D=string&dataTypes%5Beq%5D=text&dataType%5Border%5D=string&isLocalizable%5Beq%5D=true&isUnique%5Beq%5D=true&createdAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Border%5D=string&updatedAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Border%5D=string&isRemoved%5Beq%5D=true&page=0&size=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'A paginated list of input types.
Timestamp when this input type was created.
Timestamp when this input type was last modified.
Timestamp when this input type was removed. Null if not removed.
Lifecycle status of an input type.
| Enum Value | Description |
|---|---|
| draft | The initial state of the input type. |
| active | The input type is active and available for use. |
| inactive | The input type is temporarily disabled. |
| removed | The input type has been soft-deleted. |
Data type that defines the kind of value an input type accepts.
| Enum Value | Description |
|---|---|
| text | Single-line plain text. |
| textArea | Multi-line plain text. |
| richText | Formatted text with markup support. |
| integer | Whole number value. |
| decimal | Decimal number value. |
| boolean | True or false value. |
| date | Date without time component. |
| dateTime | Date with time component. |
| url | A URL value. |
{ "items": [ { … } ], "pagination": { "page": 0, "size": 0, "totalItems": 0, "totalPages": 0 } }
Data type that defines the kind of value an input type accepts.
| Enum Value | Description |
|---|---|
| text | Single-line plain text. |
| textArea | Multi-line plain text. |
| richText | Formatted text with markup support. |
| integer | Whole number value. |
| decimal | Decimal number value. |
| boolean | True or false value. |
| date | Date without time component. |
| dateTime | Date with time component. |
| url | A URL value. |
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types
- Productionhttps://api.apiera.io/v1/type-groups/{typeGroupUuid}/input-types
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"code": "string",
"displayName": "string",
"description": "string",
"dataType": "text",
"isLocalizable": true,
"isUnique": true,
"minLength": 0,
"maxLength": 0,
"minValue": 0.1,
"maxValue": 0.1,
"precision": 0,
"pattern": "string"
}'The created input type.
Timestamp when this input type was created.
Timestamp when this input type was last modified.
Timestamp when this input type was removed. Null if not removed.
Lifecycle status of an input type.
| Enum Value | Description |
|---|---|
| draft | The initial state of the input type. |
| active | The input type is active and available for use. |
| inactive | The input type is temporarily disabled. |
| removed | The input type has been soft-deleted. |
Data type that defines the kind of value an input type accepts.
| Enum Value | Description |
|---|---|
| text | Single-line plain text. |
| textArea | Multi-line plain text. |
| richText | Formatted text with markup support. |
| integer | Whole number value. |
| decimal | Decimal number value. |
| boolean | True or false value. |
| date | Date without time component. |
| dateTime | Date with time component. |
| url | A URL value. |
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "typeGroupUuid": "a1b2c3d4-5678-9012-3456-789012345678", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "draft", "code": "product-description", "displayName": "Product Description", "description": "Rich text description for product listings.", "dataType": "richText", "isLocalizable": true, "isUnique": false, "maxLength": 5000 }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}
- Productionhttps://api.apiera.io/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The requested input type.
Timestamp when this input type was created.
Timestamp when this input type was last modified.
Timestamp when this input type was removed. Null if not removed.
Lifecycle status of an input type.
| Enum Value | Description |
|---|---|
| draft | The initial state of the input type. |
| active | The input type is active and available for use. |
| inactive | The input type is temporarily disabled. |
| removed | The input type has been soft-deleted. |
Data type that defines the kind of value an input type accepts.
| Enum Value | Description |
|---|---|
| text | Single-line plain text. |
| textArea | Multi-line plain text. |
| richText | Formatted text with markup support. |
| integer | Whole number value. |
| decimal | Decimal number value. |
| boolean | True or false value. |
| date | Date without time component. |
| dateTime | Date with time component. |
| url | A URL value. |
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "typeGroupUuid": "a1b2c3d4-5678-9012-3456-789012345678", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "draft", "code": "product-description", "displayName": "Product Description", "description": "Rich text description for product listings.", "dataType": "richText", "isLocalizable": true, "isUnique": false, "maxLength": 5000 }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}
- Productionhttps://api.apiera.io/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"code": "string",
"displayName": "string",
"description": "string",
"minLength": 0,
"maxLength": 0,
"minValue": 0.1,
"maxValue": 0.1,
"precision": 0,
"pattern": "string"
}'The updated input type.
Timestamp when this input type was created.
Timestamp when this input type was last modified.
Timestamp when this input type was removed. Null if not removed.
Lifecycle status of an input type.
| Enum Value | Description |
|---|---|
| draft | The initial state of the input type. |
| active | The input type is active and available for use. |
| inactive | The input type is temporarily disabled. |
| removed | The input type has been soft-deleted. |
Data type that defines the kind of value an input type accepts.
| Enum Value | Description |
|---|---|
| text | Single-line plain text. |
| textArea | Multi-line plain text. |
| richText | Formatted text with markup support. |
| integer | Whole number value. |
| decimal | Decimal number value. |
| boolean | True or false value. |
| date | Date without time component. |
| dateTime | Date with time component. |
| url | A URL value. |
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "typeGroupUuid": "a1b2c3d4-5678-9012-3456-789012345678", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "draft", "code": "product-description", "displayName": "Product Description", "description": "Rich text description for product listings.", "dataType": "richText", "isLocalizable": true, "isUnique": false, "maxLength": 5000 }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}
- Productionhttps://api.apiera.io/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Request
Transitions an input type to a different lifecycle state. Valid transitions depend on the current status.
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}/actions/lifecycle
- Productionhttps://api.apiera.io/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}/actions/lifecycle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.apiera.io/_mock/openapi/v1/type-groups/{typeGroupUuid}/input-types/{inputTypeUuid}/actions/lifecycle' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"transition": "activate"
}'The input type after the lifecycle transition.
Timestamp when this input type was created.
Timestamp when this input type was last modified.
Timestamp when this input type was removed. Null if not removed.
Lifecycle status of an input type.
| Enum Value | Description |
|---|---|
| draft | The initial state of the input type. |
| active | The input type is active and available for use. |
| inactive | The input type is temporarily disabled. |
| removed | The input type has been soft-deleted. |
Data type that defines the kind of value an input type accepts.
| Enum Value | Description |
|---|---|
| text | Single-line plain text. |
| textArea | Multi-line plain text. |
| richText | Formatted text with markup support. |
| integer | Whole number value. |
| decimal | Decimal number value. |
| boolean | True or false value. |
| date | Date without time component. |
| dateTime | Date with time component. |
| url | A URL value. |
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "typeGroupUuid": "a1b2c3d4-5678-9012-3456-789012345678", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "active", "code": "product-description", "displayName": "Product Description", "description": "Rich text description for product listings.", "dataType": "richText", "isLocalizable": true, "isUnique": false, "maxLength": 5000 }