pub.flow:iterator

$internal	IData A document that specifies the information required to batch output.
	Key	Description
	batchContext	String Optional. Unique handle for this specific batch request. For the first call, this parameter must be null or empty. On subsequent calls, it will contain a universally unique identifier (UUID) that Integration Server uses as the key to retrieve the current state of the batching request.
	batchSize	Integer Optional. Number of records (IData) to return in the result set array. The value must be greater than 0. The default is 100.
	timeToLive	Integer Length of time in seconds that the request remains in the cache. The value must be greater than 0. The default is 60.
	resultSetKey	String Pipeline key name of the IData array that should be batched. If not specified, the service creates batches from the first IData array in the pipeline. If no IData array exists in the service signature, the service will not batch results, and Integration Server returns all records at once.
	serviceName	String Fully qualified service name from which pub.flow:iterator receives the IData array. This parameter is required for the first invocation, and is optional for subsequent calls.

$internal	IData A document that specifies the results of the batch request.
	Key	Description
	batchContext	String Conditional. Unique handle for this specific request. Returned only if hasMore is true.
	hasMore	Boolean Indicates whether there are still records to process in the result set (true), or if there are no more to process (false).
	resultSetKey	String Indicates the pipeline key name of the IData array that was batched. If resultSetKey is specified in the input, Integration Server returns that value. If resultSetKey is not specified in the input, this parameter contains the key of the first IData array that was processed.

Note:

In addition to the output parameters listed above, pub.flow:iterator returns any parameters returned in the output signature of the service specified in the serviceName input parameter.

The output service signature of the service specified by the serviceName input parameter must contain at least one IData array. If there are multiple IData arrays in the output signature and the resultSetKey input parameter is not specified, pub.flow:iterator batches the first IData array in the pipeline. If there are no IData arrays in the pipeline, pub.flow:iterator returns the output all at once instead of in batches.