v1

latestOpenAPI 3.0.42026-08-064075233.0 KB
EdgeNodes

Get labels for a specific node

Returns a list of all labels connected to the specified node with the specified filters.

get/api/edgenodes/{edgeNodeId}/labels

Path parameters

edgeNodeIdstring uuid required

The identifier for the node that we want to find labels that are connected to.

Query parameters

offsetinteger

The offset of the first item to return.

limitinteger

The maximum number of items to return.

propertyNamestring nullable
propertyValuestring nullable
operatorstring nullable

List of conditions of the items to return. Alternative to using offset and limit to define what items to return. Configuration describing from what condition we should start searching for items. Typically the value of a property returned as the last element of a previous search will be used as the condition for the next search when fetching new items. The orderBy property is typically set to the same property. <PropertyName><summary> propertyName: Name of the property to check. </summary><example>(Example: Name)</example></PropertyName><PropertyValue><summary> propertyValue: Value of the property to check. </summary><example>(Example: MyName)</example></PropertyValue><Operator><summary> operator: Operator to use when checking the property value. Available values are GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual. </summary><example>(Example: GreaterThan)</example></Operator>

includeCountboolean

Include total number of items matching the specified filter in the response.

descendingboolean

Use descending sort order when fetching items.

orderBystring

The field to order by.

propertyNamestring nullable
propertyValuestring[] nullable
filtertypestring nullable
ignoreCaseboolean

List of filters of the items to return. Defines what items to return based on the properties of the specific object. <PropertyName><summary> propertyName: Name of the property to check. Note: This is case sensitive and different objects have different properties that can be used in a filter. </summary><example>(Example: Name)</example></PropertyName><PropertyValue><summary> propertyValue: Value of the property to check. Can be defined as a list of several values and the result is then the union of the items that match any of the values. </summary><example>(Example: MyName)</example></PropertyValue><FilterType><summary> filterType: Type of filter to use when checking the property value. Available values are equal, notequal, contains, readableBy, ownedBy, startswith, greaterthan, greaterthanorequal, lessthan, lessthanorequal. Note: These are case sensitive and depending on the property type some filters might not be available. </summary><example>(Example: equal)</example></FilterType>

Response

OK

offsetinteger

The offset of the collection.

limitinteger

The limit of the collection.

countinteger nullable

The total number of items in the collection.

Example response

{
  "limit": 10,
  "count": 100,
  "items": [
    {
      "id": "17c2316e-901c-4c6f-8ee5-18abf4075d60",
      "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
      "name": "My label",
      "createdAt": "2024-09-24T09:33:38.013347Z",
      "createdBy": {
        "type": "User",
        "id": "256f791c-fbc0-4435-9429-d291227f6577",
        "name": "My User"
      },
      "updatedAt": "2024-09-24T09:33:38.013347Z",
      "updatedBy": {
        "type": "User",
        "id": "256f791c-fbc0-4435-9429-d291227f6577",
        "name": "My User"
      }
    }
  ]
}