Summary
Get a list of views.
Description
Get a list of views in IAP.
Route
GET /authorization/views
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"multiContains": {
"path": "/",
"provenance": "WorkFlowEngine"
},
"multiEquals": {
"path": "/",
"provenance": "WorkFlowEngine"
},
"multiStartsWith": {
"path": "/",
"provenance": "WorkFlowEngine"
},
"skip": 0,
"limit": 10,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"multiContains": {
"$ref": "system-common#/definitions/views-query"
},
"multiEquals": {
"$ref": "system-common#/definitions/views-query"
},
"multiStartsWith": {
"$ref": "system-common#/definitions/views-query"
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
List of views in IAP. |
Copied to Clipboard
{
"results": [
{
"path": "/",
"provenance": "WorkFlowEngine"
},
{
"path": "/",
"provenance": "WorkFlowEngine"
},
{
"path": "/",
"provenance": "WorkFlowEngine"
}
],
"total": 5
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"examples": [
"/"
]
},
"provenance": {
"type": "string",
"examples": [
"WorkFlowEngine"
]
}
}
}
},
"total": {
"$ref": "common-schema#/definitions/total"
}
}
}
