Scan Asset Search Results

Provides the ability to scan a search result set of assets using a cursor to fetch the next set of results pages on the limit (page size) passed.

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body must be a JSON object

limit
integer

Number of results that will be returned for each page

searchTerm
Array of strings

List of search terms

includeDeleted
boolean

Flag to denote whether or not to include Deleted assets in the result

includeVersions
boolean

Flag to denote whether or not to include prior versions of the asset in the result

Array of objects (Search_sortBy)
operation
string

Operation between search terms

Enum: "AND" "OR"
keywordSearchField
string

Specified Search Terms

cursor
string

Optional parameter on the first call. On subsequent calls requires the cursor value returned in the API response.

assetType
string

Optional parameter that restricts search results to the asset type specified.

Responses
200

The Response Body will be a JSON object

400

Bad Request

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Failed operation

post/asset/scan
Request samples
application/json
{
  • "limit": 100,
  • "searchTerm": [
    ],
  • "includeDeleted": true,
  • "includeVersions": true,
  • "sortBy": [
    ],
  • "operation": "AND",
  • "keywordSearchField": "string",
  • "cursor": "WzE2ODI5NTczMDM2NDgsMTY4Mjk1NzI2MzU5NSwxNjgyOTU3MjYzNTk1LCI3ZDkwZTkzMi01MmU4LTQ2NTEtYmQ3Ny03M2Y1OWFjMmY3YTMiLDEyMDI1OTA4NTEzMF0=",
  • "assetType": "Base Product"
}
Response samples
application/json
{
  • "hitCount": 1,
  • "cursor": "WzE2ODI5NTczMDM2NDgsMTY4Mjk1NzI2MzU5NSwxNjgyOTU3MjYzNTk1LCI3ZDkwZTkzMi01MmU4LTQ2NTEtYmQ3Ny03M2Y1OWFjMmY3YTMiLDEyMDI1OTA4NTEzMF0=",
  • "result": [
    ],
  • "facets": [
    ]
}