Read a persisted request. See API authentication for more information about persisted requests.
The user must be authenticated and be the creator of the persisted request.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
id |
String |
No |
Identifier for the persisted request. |
If no parameters are specified, all persisted requests user has created are retrieved.
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
Identifier for the updated persisted request. |
|
path |
String |
Path to the method to execute when executing the persisted request. |
|
request |
Object or Array of Object |
Request object or array of objects sent as parameter when executing the persisted request. |
|
mutable |
Object |
Object with boolean parameters. Fields that have the boolean value |
|
description |
String |
Textual description of the persisted request. |
Examples
$ python cx.py /persisted '{"id":"58e5154490191e5ca6b941ee56f6e7349b9d2fe1"}'
{
"persisted": [
{
"id": "58e5154490191e5ca6b941ee56f6e7349b9d2fe1"
"user": "user@example.com",
"path": "/site",
"request": {
"siteId": "9222300742735526873"
},
"mutable": {
"siteId": true
},
"description": "Example persisted",
}
]
}