Skip to main content

Get a list of assets

GET 
/Assets

Gets list of all assets to which logged-in user has access to from graph. Gets asset details of asset from graph. Authorization is checked for asset, if user has access to asset then only asset details along with the assetModel details and security group details of asset is returned else unauthorized error is thrown.

Request​

Query Parameters

    filter stringrequired

    We can provide filter parameter like alertPriority,maintenanceStatus,lastCommunicatedFilter if nothing is provided we will fetch the assets that logged-in user has access to from graph. Note: Encoding Objects for Query String Parameters When passing an object as part of the query string parameters in a URL, you must encode the object to ensure it is correctly interpreted by the server. To encode the object:

    1. Use the encodeURIComponent() method in the browser, which converts the object into a valid URL-encoded string. 2.Pass the encoded string as the query string parameter. example: encodeURIComponent('{}')
    pagination stringrequired

    Pagination details if have any. Note: Encoding Objects for Query String Parameters When passing an object as part of the query string parameters in a URL, you must encode the object to ensure it is correctly interpreted by the server. To encode the object:

    1. Use the encodeURIComponent() method in the browser, which converts the object into a valid URL-encoded string. 2.Pass the encoded string as the query string parameter. example: encodeURIComponent(' { "page": 1, "perPage": 5, "serverSidePaginationEnabled": false, "totalCount": 0, }')
    type stringrequired

    Type of method example: GET_LIST, GET_ONE

Responses​

200 response

Response Headers

  • Access-Control-Expose-Headers

    string

    manages CORS exposed headers

  • Access-Control-Allow-Origin

    string

    manages CORS

  • Content-Range

    string

    data range of result

  • X-Total-Count

    string

    length of output

  • Access-Control-Allow-Headers

    string

    manages header for CORS

  • Content-Type

    string

    data type of content

Schema

    assetList

    object[]

  • Array [

    • template string
    updateDate string
    modelTranslateUrl string
    description string
    telematicsSerialNumber numberrequired
    type string
    distributorName string
    model string
    id stringrequired
    make string
    forgeid string
    createDate stringrequired
    owner string
    address string
    serialNumber stringrequired
    customerIndustry string
    lastCommunicated number
    dealerId string

    subscribers

    object

    email string
    label stringrequired
    tags string
    urn string
    availableStatus string
    assetImage string
    customProperties string
    name stringrequired
    productVideo string

    location

    object

    lat number
    long number
    translateType string
    activationDate string
    status stringrequired

  • ]

Loading...