First page created
This event occurs when the first page of the transaction cache is available.
Type: object
Domain: transaction
Event: cache
Version: 1
key required
Title: Cache key
Description: Auto-generated cache key
Type: string
Example:
bb3b8d8c7860bd645273861e009efcb7ce226cb3
396ac2a33748bb784077f4112335faa073861e00
account_id required
Title: Account ID
Description: ID of the account on which caching operation is being performed
Type: integer
Example:
1
2
page_size required
Title: Page size
Description: Maximum number of transactions per page
Type: integer
Example:
1000
2000
endpoint required
Title: Endpoint
Description: Endpoint referenced by the initial request
Type: string
Example:
/some/path
status required
Title: Status
Description: Current status of the cache operation
Type: string
Must be one of the following:
AVAILABLE
FINISHED
FAILED
Example:
AVAILABLE
FINISHED
FAILED
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "First page created",
"description": "This event occurs when the first page of the transaction cache is available.",
"required": [
"key",
"account_id",
"page_size",
"endpoint",
"status"
],
"properties": {
"key": {
"type": "string",
"title": "Cache key",
"description": "Auto-generated cache key",
"examples": [
"bb3b8d8c7860bd645273861e009efcb7ce226cb3",
"396ac2a33748bb784077f4112335faa073861e00"
]
},
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "ID of the account on which caching operation is being performed",
"examples": [
1,
2
]
},
"page_size": {
"type": "integer",
"title": "Page size",
"description": "Maximum number of transactions per page",
"examples": [
1000,
2000
]
},
"endpoint": {
"type": "string",
"title": "Endpoint",
"description": "Endpoint referenced by the initial request",
"examples": [
"/some/path"
]
},
"status": {
"type": "string",
"title": "Status",
"description": "Current status of the cache operation",
"enum": [
"AVAILABLE",
"FINISHED",
"FAILED"
],
"examples": [
"AVAILABLE",
"FINISHED",
"FAILED"
]
}
}
}
{
"key": "bb3b8d8c7860bd645273861e009efcb7ce226cb3",
"account_id": 1,
"page_size": 1000,
"endpoint": "/some/path",
"status": "AVAILABLE"
}
Updated 6 days ago