Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Asset Information Management

Steps to retrieve cookie

  • Last UpdatedOct 21, 2026
  • 2 minute read

Follow the steps to retrieve a cookie:

  1. Call GET API and pass a bearer token for authorization to get a XSRF cookie.

    GET {dashboardUrl}/api/domain/authorization/issessionvalid

    Example: {dashboardUrl}/api/domain/authorization/issessionvalid

  2. Retrieve the cookie from the above request and add it into the header of the POST API call (see Figures 1 and 2)

    POST {dashboardUrl}/api/v1/domain/searches/run

    Example: {dashboardUrl}/api/v1/domain/searches/run

    1. For full loads, pass in a request body based on the example in section Search API Request Inputs - Initial Load below.

    2. For delta loads, pass in a request body based on the example in section Search API Request Inputs - Delta Loads below.

    3. Always call issessionvalid API before getting subsequent pages.

    4. The field ‘totalNumberOfResults’ in the response gives the total number of records and is to be used to calculate the page count.

  3. Call the GET API to retrieve object attributes and relationships by passing an object handle, for each object in the response from the previous POST API.

    GET {dashboardUrl}/api/v1/domain/dataGroup/{objecthandle}?dataGroupNames=Main Attributes&dataGroupNames=Related Items 1&dataGroupNames=Related Items 2

    Example: {dashboardUrl}/api/v1/domain/dataGroup/975441?dataGroupNames=Main Attributes&dataGroupNames=Related Items 1&dataGroupNames=Related Items 2

    Note: It is recommended to continue calling the above API for fetching the tag-document relationships even though the results are capped at 3000. When the tag-document relationships returned reaches 3000, then additionally call the below API to fetch all tag-document relations.

  4. Call the POST API to retrieve the tag-document relationships by using a request based on the example in section Search API Request Inputs – Tag-Document relationships, and passing in the fullId as highlighted for each object in response from the POST API from point 2.

    POST {dashboardUrl}/api/v1/domain/searches/run

    Example: {dashboardUrl}/api/v1/domain/searches/run

    Figure 1: Retrieving the x-xsrf cookie from the issessionvalid GET API

    Figure 2: Using the retrieved cookie in the Search API