Usage / Attribute

What can you do with UsageAttribute?


Properties

Property Details
id
"id": 227
Type: Number
This is the unique numeric identifier for the UsageAttribute
dataTypeId
"dataTypeId": 490
Type: Number
Unique identifier for the associated DataType object.
ownerId
"ownerId": 51
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
label
"label": "Hello World"
Type: String
help
"help": "Hello World"
Type: String
sqlColumnName
"sqlColumnName": "Hello World"
Type: String
sqlDataType
"sqlDataType": "Hello World"
Type: String
sqlMaxLength
"sqlMaxLength": 584
Type: Number
sqlDefaultConstraint
"sqlDefaultConstraint": "Hello World"
Type: String
sqlIsNullable
"sqlIsNullable": true
Type: Boolean
sortOrder
"sortOrder": 894
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:

  • dataTypeId
  • name
  • label
  • help
  • sqlColumnName
  • sqlDataType
  • sqlMaxLength
  • sqlDefaultConstraint
  • sqlIsNullable
  • sortOrder
  • visible

DataFlow PATCH objects:


End Points

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