Data Profile/ Variable

What can you do with DataProfileVariable?


Properties

Property Details
id
"id": 581
Type: Number
This is the unique numeric identifier for the DataProfileVariable
ownerId
"ownerId": 675
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
linkGuid
"linkGuid": "Hello World"
Type: String
start
"start": 671
Type: Number
end
"end": 116
Type: Number
dataProfileDataTypeId
"dataProfileDataTypeId": 120
Type: Number
Unique identifier for the associated DataProfileDataType object.
dataProfileLayoutId
"dataProfileLayoutId": 622
Type: Number
Unique identifier for the associated DataProfileLayout 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:

  • name
  • linkGuid
  • start
  • end
  • dataProfileDataTypeId
  • dataProfileLayoutId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the DataProfileVariable object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/DataProfile/Variable/{id:int}
Delete an instance of the DataProfileVariable object.
GETapi/v1/DataProfile/Variable
Retrieve all of the DataProfileVariable objects.
GETapi/v1/DataProfile/Variable/Metadata
Retrieve all of the meta data details of the DataProfileVariable object.
GETapi/v1/DataProfile/Variable/Metadata/{option}
Retrieve all the meta data details of the DataProfileVariable object based on provided options.
{option}Metadata options for the DataProfileVariable object.
GETapi/v1/DataProfile/Variable/Paged
Retreive all of the DataProfileVariable objects in a paged fashion.
GETapi/v1/DataProfile/Variable/Paged/Detail
Retreive all of the DataProfileVariable objects in a paged fashion with all object details.
GETapi/v1/DataProfile/Variable/{id:int}
Retrieve an instance of the DataProfileVariable object by it's ID.
{id:int}Unique identifier for the DataProfileVariable object.
GETapi/v1/DataProfile/Variable/{id:int}/Detail
Retreive all of the Detail objects for the specified DataProfileVariable.
{id:int}Unique identifier for the DataProfileVariable object.
PATCHapi/v1/DataProfile/Variable/{id:int}
Update the DataProfileVariable object and optionally make changes to any child objects.
POSTapi/v1/DataProfile/Variable
Create a new instance of the DataProfileVariable object.
PUTapi/v1/DataProfile/Variable/{id:int}
Update an existing instance of the DataProfileVariable object.