Skip to main content
Loading...

API docs by

Search permissible assets

Request

The POST assets API returns all assets for a specific asset from search form. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

Query
sortsArray of strings

Sort fields

Items Enum:"SERIAL_NUMBER""ORDER_NUMBER""PRODUCT_TYPE""PRODUCT_NAME""CAGE""IBX""PRODUCT_DESCRIPTION""ACCOUNT_NUMBER""INSTALLED_DATE""ASSET_NUMBER"
sourceArray of strings

"q" parameter will be searched in these fields, by default search will performed on all fields

Items Enum:"LEGACY_CAGE""LEGACY_CABINET""LEGACY_PATCH_PANEL""LEGACY_SALES_ORDER""BILLING_AGREEMENT""CAGE""CABINET""PATCH_PANEL""ASSET_NUMBER""CUSTOMER_INTERNAL_REFERENCE"
qstring

To support add a keyword, free text search on source fields. Min 3 character for efficient search results.

exactMatchboolean

flag determines the q should be Exact match or partial match, By default flag is false

offsetinteger, >= 0

The start index from which the list is created.

limitinteger, [ 1 .. 100 ]

Number of entries in response.

Headers
Authorizationstringrequired

Specify the Access token with prefix 'Bearer '.

Bodyapplication/json
filterobject

assets search filter.

Payload
{
  "filter": {
    "ibxs": [ … ],
    "cages": [ … ],
    "productTypes": [ … ],
    "dateRange": { … }
  }
}

Responses

Assets search response

Bodyapplication/json
dataArray of objects(AssetsSummary)
pageobject(PageInfo)
Response
{
  "data": [
    { … },
    { … }
  ],
  "page": {
    "total": 20,
    "limit": 2,
    "offset": 0,
    "sorts": [ … ]
  },
  "_links": {
    "self": { … },
    "next": { … },
    "previous": { … }
  }
}
Was this page helpful?