Skip to main content

Get list of systems

GET 
/Systems

Interface to API endpoint "Systems". Gets a list of systems based on the applied filter from logged-in user's account.

Request​

Query Parameters

    filter string

    You need to pass the filter parameter if you have chosen the method type GET_LIST to fetch the systems from user security group or provided security group, along with the user id. If queryType is set to SYSTEM_IN_USER_SECURITY_GROUP, you must provide the user ID in the id field. OR If queryType is set to SYSTEM_IN_SINGLE_SECURITY_GROUP, you must provide the security group ID using the securityGroupId field. 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('{"id":"US-oem@industrility.com","queryType":"SYSTEM_IN_USER_SECURITY_GROUP","securityGroupId":"SG-OEM"}')
    pagination string

    You need to pass the pagination parameter if you have chosen the method type GET_LIST 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, "lastEvaluatedKey":null,}')
    type stringrequired

    Method type, e.g., "GET_LIST", "GET_ONE". example: GET_LIST, GET_ONE

    id string

    You only need to pass this parameter if you have set the type to "GET_ONE". example: GET_ONE

Responses​

200 response
Response Headers
  • Access-Control-Expose-Headersstring

    manages CORS exposed headers

  • Access-Control-Allow-Originstring

    manages CORS

  • Content-Rangestring

    data range of result

  • X-Total-Countstring

    length of output

  • Access-Control-Allow-Headersstring

    manages header for CORS

  • Content-Typestring

    data type of content

Schema

  • Array [

    • owner string
    systemid stringrequired
    address stringrequired
    modelTranslateUrl string
    description stringrequired
    integrator stringrequired
    label string
    type stringrequired
    tags string
    name string
    location string
    id stringrequired
    translateType string
    createDate string
    status stringrequired

  • ]

Loading...