List node subscriptions

v1.0.0

🚀 Since v4.20.0

Description:

Retrieve a list of subscribed nodes for current user.

Precondition:

Authenticated user.

Postcondition:

List of subscribed nodes is returned.

Further Information:

None.

Filtering:

All filter fields are connected via logical conjunction (AND)
Filter string syntax: FIELD_NAME:OPERATOR:VALUE[:VALUE...]

Example

authParentId:eq:#
Get nodes where authParentId equals #.

Filtering options:

Expand

`FIELD_NAME`	Filter Description	`OPERATOR`	Operator Description	`VALUE`
`nodeId`	Node ID filter	`eq`	Node ID equals value.	`long value`
`authParentId`	Auth parent ID filter	`eq`	Auth parent ID equals value.	`long value`

Sorting:

Sort string syntax: FIELD_NAME:ORDER
ORDER can be asc or desc.
Multiple sort criteria are possible.
Fields are connected via logical conjunction AND.

Example

nodeId:desc|authParentId:asc
Sort by nodeId descending AND authParentId ascending.

Sorting options:

Expand

`FIELD_NAME`	Description
`nodeId`	Node ID
`authParentId`	Auth parent ID

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    },
    "filter": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "sort": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List of subscribed nodes",
  "required": [
    "items",
    "range"
  ],
  "properties": {
    "items": {
      "type": "array",
      "description": "List of subscribed nodes",
      "items": {
        "type": "object",
        "description": "Subscribed node information",
        "required": [
          "id"
        ],
        "properties": {
          "authParentId": {
            "type": "integer",
            "format": "int64",
            "description": "Auth parent room ID"
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "Node ID"
          },
          "type": {
            "type": "string",
            "description": "Node type",
            "enum": [
              "room",
              "folder",
              "file"
            ]
          }
        }
      }
    },
    "range": {
      "type": "object",
      "description": "Range information",
      "required": [
        "limit",
        "offset",
        "total"
      ],
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "description": "Range limit. Maximum 500."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "description": "Range offset"
        },
        "total": {
          "type": "integer",
          "format": "int64",
          "description": "Total items available"
        }
      }
    }
  }
}