Define your own structure data types in addition to standard data types.
Create type
Create a new structure data type.
The page API REST Tip does not exist.
1. Request
POST /<api-version>/types.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
2. Request Body
New structure type information:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| name | x | string | - | Type name. |
| package | string | null | Type package. | |
| public | boolean | false | True if type is visible to other users. | |
| description | string | - | Type description. | |
| properties | x | array | - | Array of type properties. |
| →name | x | string | - | Property name. |
| →type | x | string | - | Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>. |
| →required | boolean | false | True if null value is not allowed. | |
| →description | string | null | Property description. |
The page Spacer does not exist.
3. Response Status
The page API HTTP Response - Update does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
| type | x | object | - | Type details to create. |
| →name | x | string | - | Type name. |
| →package | x | string | null | Type package. |
| →public | boolean | false | True if type is visible to other users. | |
| →description | string | - | Type description. | |
| →properties | x | array | - | Array of type properties. |
| →→name | x | string | - | Property name. |
| →→type | x | string | - | Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>. |
| →→required | boolean | false | True if null value is not allowed. | |
| →→description | string | null |
Property description. |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request. |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get type details
Get type information by name.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/types/<fullTypeName>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
fullTypeName |
x | string | - |
Fully qualified type name: <domain>:<type_package>.<type_name>. If type has no package then just <type name>. If type belongs to the current user then just <type_package>.<type_name>. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
Type information:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| name | x | string | - | Type name. |
| package | string | null | Type package. | |
| public | x | boolean | - | True if type is visible to other users. |
| description | string | null | Type description. | |
| properties | x | array | - | Array of type properties. |
| →name | x | string | - | Property name. |
| →type | x | string | - | Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>. |
| →required | x | boolean | - | True if null value is not allowed. |
| →description | string | null |
Property description. |
The page Spacer does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
type |
x | string | - |
Fully qualified type name: <type package>.<type name>. If type has no package then just <type name>. |
2. Response
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
| result | object | null | Type information. | |
| →name | x | string | - | Type name. |
| →package | string | null | Type package. | |
| →public | x | boolean | - | True if type is visible to other users. |
| →description | string | - | Type description. | |
| →properties | x | array | - | Array of type properties. |
| →→name | x | string | - | Property name. |
| →→type | x | string | - | Property data type: string, int, long, float, double, date, boolean, uuid, <type>[], <user_type>. |
| →→required | x | boolean | - | True if null value is not allowed. |
| →→description | string | null |
Property description. |
3. Example
The page API Mosquitto does not exist.
Request
Response
Delete type
Delete type.
The page API REST Tip does not exist.
1. Request
DELETE /<api-version>/types/<fullTypeName>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
fullTypeName |
x | string | - |
Fully qualified type name: <domain>:<type_package>.<type_name>. If type has no package then just <type name>. If type belongs to the current user then just <type_package>.<type_name>. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Update does not exist.
3. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
type |
x | string | - |
Fully qualified type name: <type package>.<type name>. If type has no package then just <type name>. |
2. Response
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client |
3. Example
The page API Mosquitto does not exist.
Request
Response