Data Profile

What can you do with DataProfile?


Properties

Property Details
id
"id": 386
Type: Number
This is the unique numeric identifier for the DataProfile
ownerId
"ownerId": 463
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
dataFileTypeId
"dataFileTypeId": 558
Type: Number
Unique identifier for the associated DataFileType object.
resourceName
"resourceName": "Hello World"
Type: String
includeChildren
"includeChildren": true
Type: Boolean
isFirstRowHeader
"isFirstRowHeader": true
Type: Boolean
lockSettings
"lockSettings": true
Type: Boolean
stopOnError
"stopOnError": true
Type: Boolean
patchesPerEnvelope
"patchesPerEnvelope": 83
Type: Number
envelopesPerRequest
"envelopesPerRequest": 404
Type: Number
ignoreRecordFilter
"ignoreRecordFilter": "Hello World"
Type: String
delimiter
"delimiter": "Hello World"
Type: String


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
  • dataFileTypeId
  • resourceName
  • includeChildren
  • isFirstRowHeader
  • lockSettings
  • stopOnError
  • patchesPerEnvelope
  • envelopesPerRequest
  • ignoreRecordFilter
  • delimiter

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 DataProfile object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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