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

X-SAML

Sentinel Permissions Needed

_adminRole_

Supported Formats

Response

application/json

URL Parameters

None.

Success Codes

200 OK
204 No Content

Fault Codes

400 Bad Request
403 Forbidden
404 Not Found
500 Internal Server Error
503 Service Unavailable

Response Data

Object type: datasync_policy
Needs description.
Field	Description
createdate	The date and time when the object was created.
creator	The URL of the Sentinel User object that represents the creator of the object.
EventDataSyncPolicy	Needs description. Definition
meta	The metadata for an object, including the object type name and the URL reference to the object. Definition
moddate	The date and time when the object was last modified.
modifier	The URL of the Sentinel User object that represents the last modifier of the object.
PolicyId	Needs description.
ReportDataDefinitionId	Needs description.
ReportDataDefinitionName	Needs description.
ReportDataDefinitionNamespace	Needs description.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
Field	Description
@href	The URL reference to the object.
type	The name of the object type

Object type: EventDataSyncPolicy
Needs description.
Field	Description
AlwaysScheduled	Needs description.
BackoffPeriod	Needs description.
CountColumn	Needs description.
DestDatabaseConnection	Needs description. Definition
DestTable	Needs description. Definition
DoSummaries	Needs description.
EventFieldsToSync	Needs description. Definition
Filter	Needs description.
IsEnabled	Needs description.
IsForReporting	Needs description.
MaximumBatchSize	Needs description.
MaximumEPS	Needs description.
Name	Needs description.
PartitionTable	Needs description.
PolicyId	Needs description.
ResyncDateTime	Needs description.
ResyncId	Needs description.
RetentionPeriod	Needs description.
ScheduleItems	Needs description. Definition
SummaryKeyColumn	Needs description.
SummaryPeriod	Needs description.
SyncStartDateTime	Needs description.
TimeColumn	Needs description.
ViewName	Needs 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

X-SAML

Sentinel Permissions Needed

_adminRole_

Supported Formats

Request

application/json

URL Parameters

None.

Success Codes

204 No Content

Fault Codes

400 Bad Request
403 Forbidden
404 Not Found
500 Internal Server Error
503 Service Unavailable

Request Data

Object type: datasync_policy
Needs description.
Field	Required	Description
EventDataSyncPolicy	false	Needs description. Definition
PolicyId	true	Needs description.
ReportDataDefinitionId	false	Needs description.
ReportDataDefinitionName	false	Needs description.
ReportDataDefinitionNamespace	false	Needs description.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
Field	Required	Description
@href	false	The URL reference to the object.
type	false	The name of the object type

Object type: EventDataSyncPolicy
Needs description.
Field	Required	Description
AlwaysScheduled	false	Needs description.
BackoffPeriod	false	Needs description.
CountColumn	false	Needs description.
DestDatabaseConnection	false	Needs description. Definition
DestTable	false	Needs description. Definition
DoSummaries	false	Needs description.
EventFieldsToSync	false	Needs description. Definition
Filter	false	Needs description.
IsEnabled	false	Needs description.
IsForReporting	false	Needs description.
MaximumBatchSize	false	Needs description.
MaximumEPS	false	Needs description.
Name	true	Needs description.
PartitionTable	false	Needs description.
PolicyId	true	Needs description.
ResyncDateTime	false	Needs description.
ResyncId	false	Needs description.
RetentionPeriod	false	Needs description.
ScheduleItems	false	Needs description. Definition
SummaryKeyColumn	false	Needs description.
SummaryPeriod	false	Needs description.
SyncStartDateTime	false	Needs description.
TimeColumn	false	Needs description.
ViewName	false	Needs 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

X-SAML

Sentinel Permissions Needed

_adminRole_

URL Parameters

None.

Success Codes

204 No Content

Fault Codes

400 Bad Request
403 Forbidden
404 Not Found
500 Internal Server Error
503 Service Unavailable

Sample Request

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

Back to main API page