journal_get_next_for_consumer_after_cursor
The following is a list of properties for the function journal_get_next_for_consumer_after_cursor
:
Property | Value |
---|---|
brief | Get next journal entry for consumer after cursor |
category | journal |
description | Get the next journal entry for a consumer referenced by the consumer_id after the one specified by the entry_cursor parameter. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning. This option will set response properties "entry" and "cursor" if an applicable entry is retrieved. The properties of the _AdaptiveProvisioningPeer_ object associated with the consumer_id are used in the following way: The consumerFilter expression is used to determine if an entry is applicable. Unlike option get_next_for_consumer, no other properties are referenced or modified. |
functionId | journal_get_next_for_consumer_after_cursor |
functionLabel | journal_get_next_for_consumer_after_cursor |
parameters | [ { "dataType": "string", "description": "Id of adaptor.", "name": "adaptorId" }, { "dataType": "string", "description": "The consumerId property value of the associated _AdaptiveProvisioningPeer_ object.", "name": "consumerId" }, { "dataType": "string", "description": "Journal entry cursor.", "name": "cursor" }, { "dataType": "integer", "description": "The maximum number of entries that will be scanned for an entry where the consumerFilter expression in the associated _AdaptiveProvisioningPeer_ object evaluates to true.", "name": "limit", "optional": true } ] |
returns | { "dataType": "object", "description": "Response object." } |