Data Profile / Variable / Key

What can you do with DataProfileVariableKey?


Properties

Property Details
id
"id": 285
Type: Number
This is the unique numeric identifier for the DataProfileVariableKey
key
"key": "Hello World"
Type: String
dataProfileVariableId
"dataProfileVariableId": 848
Type: Number
Unique identifier for the associated DataProfileVariable object.
dataProfileVariableKeyLocatorId
"dataProfileVariableKeyLocatorId": 910
Type: Number
Unique identifier for the associated DataProfileVariableKeyLocator object.


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:

  • key
  • dataProfileVariableId
  • dataProfileVariableKeyLocatorId

DataFlow PATCH objects:


End Points

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