Data Archive Configuration

What can you do with DataArchiveConfiguration?


Properties

Property Details
id
"id": 592
Type: Number
This is the unique numeric identifier for the DataArchiveConfiguration
name
"name": "Hello World"
Type: String
dataSource
"dataSource": "Hello World"
Type: String
dataArchiveExportTypeId
"dataArchiveExportTypeId": 826
Type: Number
Unique identifier for the associated DataArchiveExportType object.
dataArchiveActionTypeId
"dataArchiveActionTypeId": 227
Type: Number
Unique identifier for the associated DataArchiveActionType object.
joinCriteria
"joinCriteria": "Hello World"
Type: String
dateField
"dateField": "Hello World"
Type: String
retentionMonths
"retentionMonths": 517
Type: Number
exportPath
"exportPath": "Hello World"
Type: String
purgeAction
"purgeAction": "Hello World"
Type: String
purgeBatchSize
"purgeBatchSize": 399
Type: Number
purgeBatchDelaySeconds
"purgeBatchDelaySeconds": 474
Type: Number
dataArchiveGroupId
"dataArchiveGroupId": 504
Type: Number
Unique identifier for the associated DataArchiveGroup object.
archiveGroupOrder
"archiveGroupOrder": 496
Type: Number
isActive
"isActive": true
Type: Boolean
lastExportedDate
"lastExportedDate": "2005-04-11T14:56:24"
Type: Date
lastPurgedDate
"lastPurgedDate": "2005-04-11T14:56:24"
Type: Date


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
  • dataSource
  • dataArchiveExportTypeId
  • dataArchiveActionTypeId
  • joinCriteria
  • dateField
  • retentionMonths
  • exportPath
  • purgeAction
  • purgeBatchSize
  • purgeBatchDelaySeconds
  • dataArchiveGroupId
  • archiveGroupOrder
  • isActive
  • lastExportedDate
  • lastPurgedDate

DataFlow PATCH objects:


End Points

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