Summary
Get a list of pinned items.
Description
Fetches a list of pinned items based on the input parameters. This api supports pagination.
Route
POST /configuration_manager/pins/fetch
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| options |
object |
yes |
Contains items which will be passed in the db search query. |
Copied to Clipboard
{
"options": {
"start": -90322035.37788539,
"limit": -5966478.38521944
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"properties": {
"filters": {
"type": "object",
"example": "{ sourceItem: 'cm_gc' }"
},
"start": {
"type": "number",
"example": "0"
},
"limit": {
"type": "number",
"example": "10"
},
"projection": {
"type": "object",
"example": "{ users: 0 }"
}
}
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| pins |
object |
Returns the list of pins and the total count. |
Copied to Clipboard
{
"pins": [],
"count": 26062881.653763264
}
Copied to Clipboard
{
"title": "pins",
"type": "object",
"properties": {
"pins": {
"type": "array"
},
"count": {
"type": "number",
"example": "10"
}
}
}
