Data Type

What can you do with DataType?


Properties

Property Details
id
"id": 697
Type: Number
This is the unique numeric identifier for the DataType
databaseTypeId
"databaseTypeId": 41
Type: Number
Unique identifier for the associated DatabaseType object.
name
"name": "Hello World"
Type: String
regex
"regex": "Hello World"
Type: String
hint
"hint": "Hello World"
Type: String
lockedType
"lockedType": true
Type: Boolean
sqlColumnName
"sqlColumnName": "Hello World"
Type: String
sqlDataType
"sqlDataType": "Hello World"
Type: String
sqlMaxLength
"sqlMaxLength": 465
Type: Number
sqlDefaultConstraint
"sqlDefaultConstraint": "Hello World"
Type: String
sqlIsNullable
"sqlIsNullable": true
Type: Boolean
sortOrder
"sortOrder": 305
Type: Number
visible
"visible": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • databaseTypeId
  • name
  • regex
  • hint
  • lockedType
  • sqlColumnName
  • sqlDataType
  • sqlMaxLength
  • sqlDefaultConstraint
  • sqlIsNullable
  • sortOrder
  • visible

DataFlow PATCH objects:


End Points

DELETEapi/v1/DataType/{id:int}
Delete an instance of the DataType object.
GETapi/v1/DataType
Retrieve all of the DataType objects.
GETapi/v1/DataType/Metadata
Retrieve all of the meta data details of the DataType object.
GETapi/v1/DataType/Metadata/{option}
Retrieve all the meta data details of the DataType object based on provided options.
{option}Metadata options for the DataType object.
GETapi/v1/DataType/Paged
Retreive all of the DataType objects in a paged fashion.
GETapi/v1/DataType/{id:int}
Retrieve an instance of the DataType object by it's ID.
{id:int}Unique identifier for the DataType object.
POSTapi/v1/DataType
Create a new instance of the DataType object.
PUTapi/v1/DataType/{id:int}
Update an existing instance of the DataType object.