Products

CrUD service for equipment products

Get All Equipment Products

get

Retrieve all equipment products that match the specified search criteria.

Query parameters

isSoftwarebooleanOptional

Indicates whether to filter products that are software-based or hardware-based.

pagestringOptional

The page number of results to return in a paginated response.

sizestringOptional

The number of records to return per page.

sortstringOptional

The sorting criteria for the results. Possible values: by name or model.

termstringOptional

A search term to filter products by keyword.

Responses

200

Success

application/json

401

Unauthorized

403

Forbidden

404

No Products found with search parameters

get

/api/equipment/products

HTTPcURLJavaScriptPython

GET /api/equipment/products HTTP/1.1
Host: /
Accept: */*

{
  "frontends": [
    "text"
  ],
  "manufacturer": "text",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  },
  "modelId": 1,
  "productName": "text",
  "productType": "Terminal"
}

Get a Specific Equipment Product

get

Retrieve a specific equipment product based on the manufacturer and device type.

Path parameters

deviceTypestringRequired

The type or model of the device.

manufacturerstringRequired

The manufacturer of the product.

Responses

200

Success

application/json

401

Unauthorized

403

Forbidden

404

Requested product does not exist

get

/api/equipment/products/{manufacturer}/{deviceType}

HTTPcURLJavaScriptPython

GET /api/equipment/products/{manufacturer}/{deviceType} HTTP/1.1
Host: /
Accept: */*

{
  "frontends": [
    "text"
  ],
  "manufacturer": "text",
  "metadata": {
    "exchangeId": "text",
    "timestamp": "text"
  },
  "modelId": 1,
  "productName": "text",
  "productType": "Terminal"
}