Parameter | Type | Default Value | Description |
---|---|---|---|
query |
string | [no filter] | The TinyQ language filter that specifies a subset of all available records. |
field |
string | not present | The name or names of fields whose values are to be returned. The field item may appear zero or more times in the URI query parameters. A single value of "[none]" indicates return only metadata. The absence of any field parameter indicates return all field values, |
page |
integer | 1 | The 1-based offset into the total records based on page size. Actual offset is (page - 1) * pagesize. |
pagesize |
integer | [unlimited] | The maximum number of object records to return as a result of the request. |
Object type: page | |
---|---|
A container for one or more objects in the result listing. There may be multiple pages in a listing if a page size is specified that is less than the total number of objects in the listing. | |
Field | Description |
next | A URL addressing the subsequent page of objects in the total set of available objects. |
objects | The list of objects returned in the page of results. |
prev | A URL addressing the previous page of objects in the total set of available objects. |
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. |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy?page=2&pagesize=1
{ "objects":[ { "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.469Z", "PolicyId":"79600390-9B73-102E-A3E2-001676E4A757", "ReportDataDefinitionNamespace":"Wildebeest", "createdate":"2012-04-25T13:33:44.469Z", "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.469Z", "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.469Z", "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" } ] } } ], "prev":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy?pagesize=1&page=1" }, "next":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy?pagesize=1&page=3" } }
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. |
Object type: | |
---|---|
The metadata representation of the newly-created datasync_policy object, including the URL reference to the new object. | |
Field | Description |
meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
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. |
POST https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy
{ "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.472Z", "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.472Z", "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" } ] } }
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy/79600390-9B73-102E-A3E2-001676E4A757
{ "meta":{ "type":"datasync_policy", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/datasync_policy/79600390-9B73-102E-A3E2-001676E4A757" } }