Data Profile / Layout

What can you do with DataProfileLayout?


Properties

Property Details
id
"id": 661
Type: Number
This is the unique numeric identifier for the DataProfileLayout
ownerId
"ownerId": 195
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
dataProfileId
"dataProfileId": 799
Type: Number
Unique identifier for the associated DataProfile object.
dataProfileLayoutTypeId
"dataProfileLayoutTypeId": 452
Type: Number
Unique identifier for the associated DataProfileLayoutType object.
recordIdentifier
"recordIdentifier": "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
  • dataProfileId
  • dataProfileLayoutTypeId
  • recordIdentifier

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

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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