EventDataSyncPolicyMetaData - EventDataSyncPolicyMetaData Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy/{PolicyId}

Supported Methods

GET
PUT
DELETE
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

None.

Success Codes

Fault Codes

Response Data

Object type: datasync_policy
Needs description.
FieldDescription
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
EventDataSyncPolicyNeeds description. Definition
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
moddateThe date and time when the object was last modified.
modifierThe URL of the Sentinel User object that represents the last modifier of the object.
PolicyIdNeeds description.
ReportDataDefinitionIdNeeds description.
ReportDataDefinitionNameNeeds description.
ReportDataDefinitionNamespaceNeeds description.
Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type
Object type: EventDataSyncPolicy
Needs description.
FieldDescription
AlwaysScheduledNeeds description.
BackoffPeriodNeeds description.
CountColumnNeeds description.
DestDatabaseConnectionNeeds description. Definition
DestTableNeeds description. Definition
DoSummariesNeeds description.
EventFieldsToSyncNeeds description. Definition
FilterNeeds description.
IsEnabledNeeds description.
IsForReportingNeeds description.
MaximumBatchSizeNeeds description.
MaximumEPSNeeds description.
NameNeeds description.
PartitionTableNeeds description.
PolicyIdNeeds description.
ResyncDateTimeNeeds description.
ResyncIdNeeds description.
RetentionPeriodNeeds description.
ScheduleItemsNeeds description. Definition
SummaryKeyColumnNeeds description.
SummaryPeriodNeeds description.
SyncStartDateTimeNeeds description.
TimeColumnNeeds description.
ViewNameNeeds description.

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy/79600390-9B73-102E-A3E2-001676E4A757
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"datasync_policy",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy/79600390-9B73-102E-A3E2-001676E4A757"
   },
   "moddate":"2012-04-25T13:33:44.473Z",
   "PolicyId":"79600390-9B73-102E-A3E2-001676E4A757",
   "ReportDataDefinitionNamespace":"Wildebeest",
   "createdate":"2012-04-25T13:33:44.473Z",
   "ReportDataDefinitionName":"Wildebeest",
   "ReportDataDefinitionId":"79600390-9B73-102E-A3E2-001676E4A757",
   "EventDataSyncPolicy":{
      "CountColumn":"Wildebeest",
      "IsForReporting":true,
      "DoSummaries":true,
      "BackoffPeriod":42,
      "DestTable":{
         "TableName":"Wildebeest",
         "SchemaName":"Wildebeest"
      },
      "SummaryKeyColumn":"Wildebeest",
      "ResyncDateTime":"2012-04-25T13:33:44.473Z",
      "Name":"Wildebeest",
      "RetentionPeriod":42,
      "Filter":"Wildebeest",
      "MaximumEPS":42,
      "ResyncId":"79600390-9B73-102E-A3E2-001676E4A757",
      "PolicyId":"79600390-9B73-102E-A3E2-001676E4A757",
      "MaximumBatchSize":42,
      "SyncStartDateTime":"2012-04-25T13:33:44.473Z",
      "AlwaysScheduled":true,
      "TimeColumn":"Wildebeest",
      "DestDatabaseConnection":{
         "DbPlatform":"Wildebeest",
         "Database":"Wildebeest",
         "Password":"Wildebeest",
         "PortNum":42,
         "UserName":"Wildebeest",
         "HostName":"Wildebeest"
      },
      "PartitionTable":true,
      "SummaryPeriod":42,
      "IsEnabled":true,
      "ViewName":"Wildebeest",
      "ScheduleItems":[
         {
            "StartHour":42,
            "StartMinute":42,
            "Duration":42,
            "DayOfWeek":42
         }
      ],
      "EventFieldsToSync":[
         {
            "DBColumn":{
               "ColumnSize":42,
               "IsIndexed":true,
               "DataType":42,
               "TypeName":"Wildebeest",
               "ColumnName":"Wildebeest",
               "Nullable":42
            },
            "EventFieldName":"Wildebeest"
         }
      ]
   }
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: datasync_policy
Needs description.
FieldRequiredDescription
EventDataSyncPolicyfalseNeeds description. Definition
PolicyIdtrueNeeds description.
ReportDataDefinitionIdfalseNeeds description.
ReportDataDefinitionNamefalseNeeds description.
ReportDataDefinitionNamespacefalseNeeds description.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Object type: EventDataSyncPolicy
Needs description.
FieldRequiredDescription
AlwaysScheduledfalseNeeds description.
BackoffPeriodfalseNeeds description.
CountColumnfalseNeeds description.
DestDatabaseConnectionfalseNeeds description. Definition
DestTablefalseNeeds description. Definition
DoSummariesfalseNeeds description.
EventFieldsToSyncfalseNeeds description. Definition
FilterfalseNeeds description.
IsEnabledfalseNeeds description.
IsForReportingfalseNeeds description.
MaximumBatchSizefalseNeeds description.
MaximumEPSfalseNeeds description.
NametrueNeeds description.
PartitionTablefalseNeeds description.
PolicyIdtrueNeeds description.
ResyncDateTimefalseNeeds description.
ResyncIdfalseNeeds description.
RetentionPeriodfalseNeeds description.
ScheduleItemsfalseNeeds description. Definition
SummaryKeyColumnfalseNeeds description.
SummaryPeriodfalseNeeds description.
SyncStartDateTimefalseNeeds description.
TimeColumnfalseNeeds description.
ViewNamefalseNeeds description.

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy/79600390-9B73-102E-A3E2-001676E4A757
{
   "PolicyId":"79600390-9B73-102E-A3E2-001676E4A757",
   "ReportDataDefinitionNamespace":"Wildebeest",
   "ReportDataDefinitionName":"Wildebeest",
   "ReportDataDefinitionId":"79600390-9B73-102E-A3E2-001676E4A757",
   "EventDataSyncPolicy":{
      "CountColumn":"Wildebeest",
      "IsForReporting":true,
      "DoSummaries":true,
      "BackoffPeriod":42,
      "DestTable":{
         "TableName":"Wildebeest",
         "SchemaName":"Wildebeest"
      },
      "SummaryKeyColumn":"Wildebeest",
      "ResyncDateTime":"2012-04-25T13:33:44.477Z",
      "Name":"Wildebeest",
      "RetentionPeriod":42,
      "Filter":"Wildebeest",
      "MaximumEPS":42,
      "ResyncId":"79600390-9B73-102E-A3E2-001676E4A757",
      "PolicyId":"79600390-9B73-102E-A3E2-001676E4A757",
      "MaximumBatchSize":42,
      "SyncStartDateTime":"2012-04-25T13:33:44.477Z",
      "AlwaysScheduled":true,
      "TimeColumn":"Wildebeest",
      "DestDatabaseConnection":{
         "DbPlatform":"Wildebeest",
         "Database":"Wildebeest",
         "Password":"Wildebeest",
         "PortNum":42,
         "UserName":"Wildebeest",
         "HostName":"Wildebeest"
      },
      "PartitionTable":true,
      "SummaryPeriod":42,
      "IsEnabled":true,
      "ViewName":"Wildebeest",
      "ScheduleItems":[
         {
            "StartHour":42,
            "StartMinute":42,
            "Duration":42,
            "DayOfWeek":42
         }
      ],
      "EventFieldsToSync":[
         {
            "DBColumn":{
               "ColumnSize":42,
               "IsIndexed":true,
               "DataType":42,
               "TypeName":"Wildebeest",
               "ColumnName":"Wildebeest",
               "Nullable":42
            },
            "EventFieldName":"Wildebeest"
         }
      ]
   }
}
Sample Response for application/json
Status: 200

DELETE

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy/79600390-9B73-102E-A3E2-001676E4A757