Data Profile / Field

What can you do with DataProfileField?


Properties

Property Details
id
"id": 75
Type: Number
This is the unique numeric identifier for the DataProfileField
ownerId
"ownerId": 548
Type: Number
Unique identifier for the associated Owner object.
linkGuid
"linkGuid": "Hello World"
Type: String
name
"name": "Hello World"
Type: String
start
"start": 677
Type: Number
end
"end": 656
Type: Number
dataProfileFieldTypeId
"dataProfileFieldTypeId": 842
Type: Number
Unique identifier for the associated DataProfileFieldType object.
dataProfileLayoutId
"dataProfileLayoutId": 584
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:

  • linkGuid
  • name
  • start
  • end
  • dataProfileFieldTypeId
  • 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 DataProfileField object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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