Get Collection Details

API to get Collection details based on the query.

Before you begin

Before attempting to use collection operations, you must ensure that the following permissions are available:

Workflow > Collection > Action > View
Workflow > Collection > User Preference > Show Collection.

You can check this in the Platform module under IDENTITY > Role > Authorized functions.

Request Structure


Endpoint:	`/collection-get-details`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/collection-get-details?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Input Parameters
Name	Description
sessionID `Header`	(Mandatory) Use session ID retrieved from login API is required if username and password are not provided. Example: "sessionId": "ce7f1a14-2bf9-4e4a-89a8-bc780a255813"
username `Header`	(Mandatory) AppViewX login username is required if sessionId is not provided. Example: "admin"
password `Header`	(Mandatory) AppViewX login password is required if sessionId is not provided.. Example: "AppViewX@123"
Content-Type `Header`	(Mandatory) The parameter should be set to `application/json` to specify the nature of the data in the payload. Example: "application/json"
gwsource `Query`	(Mandatory) Source from which the request is triggered. The values can be: web external
Payload `String`	Input data for request body in application/json format. For payload details, see Payload section.

Payload


Name	Description
startIndex `Payload`	(Optional) Start index of the data. Default value is 0. Type: Nmber
maxSize `Payload`	(Optional) Maximum number of data can be fetched. Default value is 100. Type: Nmber
queryParam.collectionName `Payload`	(Mandatory) Collection name to get the details. Type: String
filterValue `Payload`	(Optional) Filter based on keywords. Type: String

Response Structure

Status Code: 200 OK
Message: Collection details fetched successfully
Headers:
- Content-Type: application/json

Table 2. Response Parameters
Name	Description
response `Key value pair`	Contains the response object along with the hierarchy of the object mapped in field children.
message `String`	Success message or failure description in case of error.
appStatusCode `String`	Application specific status code for the response. Will be non-null for failure response.
tags `NA`	More info in case of failure response.

Status Codes


HTTP Code	appStatusCode	Message and Remediation
200 OK	NA	Collection details fetched successfully.
400 Bad Request	NA	If the payload is not proper.(Invalid input).
404 Not Found	NA	If the collection does not exist.

Sample Request/Response

Use Case:

To get Collection details based on the query.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/collection-get-details?gwsource=external

Request Payload

{
  "payload": {
	"startIndex": 0,
	"maxSize": 5,
	"queryParam": {
  	"collectionName": "ExcludeIP"
	},
	"filterValue": "172.168.23.25"
  }
}

Sample Response

{
  "response": {
	"data": [{
  	"ip": "172.168.23.25",
  	"uniqueKey": "ip",
  	"orderBy": "ip",
  	"_keywords": "[172.168.23.25, ip, ip, [172.168.23.25, ip, ip, Alaska, datacenter, General, ExcludeIP], Alaska, datacenter, General, ExcludeIP]",
  	"datacenter": "Alaska",
  	"_id": "5ec2c367d027f42e05c6e750",
  	"groupBy": "datacenter",
  	"type": "General",
  	"collectionName": "ExcludeIP"
	}],
	"uniqueKey": "ip",
	"count": 1
  },
  "message": null,
  "appStatusCode": null,
  "tags": null,
  "headers": null
}

Reference

Understanding the sample URL

IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
- IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication
  The IP address will be included in the endpoint URL for an on-prem deployment.
- HostName: A human-readable label assigned to a device (host) on a network
  The hostname will be included in the endpoint URL for an on-prem deployment.
- TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify
  The tenant name will be included in the endpoint URL for a SaaS deployment.
GWPORT: AppViewX gateway port
A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: execute-hook
gwsource: Source or origin of a gateway, for example: external.