Dell DX6004S DX Content Router Setup and Configuration Guide - Page 39

C.2.1. Enumerator Start Query Arguments, C.2.2. Enumerator Start Response

Get Dell DX6004S PDF manuals and user guides View all Dell DX6004S manuals
Add to My Manuals
Save this manual to your list of manuals

Page 39 highlights

POST /?type=&start=&end= HTTP/1.1 Host: Here channel is the "subscription name" as specified when configuring a DX Content Router replicator service. It corresponds to one of the sets of filter rules identified by a select tag in the publisher rules.xml file. The start and end parameters delimit the create dates of objects to be enumerated for metadata and UUID enumerator types. Event type enumerators do not support start and end dates. Both dates are ISO 8601 date-time values; RFC 1123 formatted date-time values are not yet supported. The time-of-day specification may be omitted, in which case the time 00:00:00 is assumed. The start date-time is inclusive, the end date-time non-inclusive. C.2.1. Enumerator Start Query Arguments The following query arguments are supported for the Start command. The Publisher saves all provided query arguments so arguments need not be supplied with every call after the initial one unless a change is desired. Argument Name type start end Description The case-insensitive value for enumerator type: Metadata, UUID or Event. An ISO 8601 formatted date-time string that corresponds to the start of the time range that should be enumerated. All time stamp comparisons are based on file creation timestamps. An ISO 8601 formatted date-time string that corresponds to the end of the time range that should be enumerated. All time stamp comparisons are based on file creation timestamps. C.2.2. Enumerator Start Response The normal response to an Enumerator Start command is: HTTP/1.1 201 Date: ... Server: Content Router Publisher Content-UUID: 41a140b5271dc8d22ff8d027176a0821 Content-Sync-Token: Content-Type: text/plain Content-Length: Object Enumerator created - channel: '', type: ''[,start: ''][, end: ''] The Content-UUID header contains a generated UUID identifying the enumerator instance created. The Content-Sync-Token is used by the Next command to indicate the previous request was successfully received. The (optional) start/end date-times in the response body are displayed as unix epoch time seconds. If for any reason the request is not successful, a 404 response code will be returned with a descriptive message in the response body as to the encountered problem. Copyright © 2010 Caringo, Inc. All rights reserved 35 Version 2.2 December 2010

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
Copyright © 2010 Caringo, Inc.
All rights reserved
35
Version 2.2
December 2010
POST /<channel>?type=<enumerator type>&start=<date-time1>&end=<date-time2>
HTTP/1.1
Host: <publisherhost>
Here channel is the "subscription name" as specified when configuring a DX Content Router
replicator service. It corresponds to one of the sets of filter rules identified by a select tag in the
publisher rules.xml file. The start and end parameters delimit the create dates of objects to be
enumerated for metadata and UUID enumerator types. Event type enumerators do not support
start and end dates. Both dates are ISO 8601 date-time values; RFC 1123 formatted date-time
values are not yet supported. The time-of-day specification may be omitted, in which case the time
00:00:00 is assumed. The start date-time is inclusive, the end date-time non-inclusive.
C.2.1. Enumerator Start Query Arguments
The following query arguments are supported for the Start command. The Publisher saves all
provided query arguments so arguments need not be supplied with every call after the initial one
unless a change is desired.
Argument Name
Description
type
The case-insensitive value for enumerator type:
Metadata, UUID or Event.
start
An ISO 8601 formatted date-time string that
corresponds to the start of the time range
that should be enumerated. All time stamp
comparisons are based on file creation
timestamps.
end
An ISO 8601 formatted date-time string that
corresponds to the end of the time range
that should be enumerated. All time stamp
comparisons are based on file creation
timestamps.
C.2.2. Enumerator Start Response
The normal response to an Enumerator Start command is:
HTTP/1.1 201
Date: ...
Server: Content Router Publisher
Content-UUID: 41a140b5271dc8d22ff8d027176a0821
Content-Sync-Token: <token value>
Content-Type: text/plain
Content-Length: <bytes in response body>
Object Enumerator created - channel: '<channel name>', type:
'<enumerator type>'[,start: '<date-time1>'][, end: '<date-time2>']
The Content-UUID header contains a generated UUID identifying the enumerator instance created.
The Content-Sync-Token is used by the Next command to indicate the previous request was
successfully received. The (optional) start/end date-times in the response body are displayed as
unix epoch time seconds. If for any reason the request is not successful, a 404 response code will
be returned with a descriptive message in the response body as to the encountered problem.