Skip to main content

Get function transfers with pagination

GET 
/api/v1/devices/{deviceId}/inputs/data-objects/transfer-functions

Retrieve a paginated list of function transfers for a specific device.

Query Parameters

  • keyword (string, optional): Fuzzy search keyword for filtering results. Searches across outputDataObjectName field. Supports multiple keywords separated by comma (e.g., temp,voltage). The search is case-sensitive and performs partial matching (contains operation).
  • skipCount (integer, optional): Number of items to skip for pagination. Used for calculating which page to retrieve. Default: 0. Example: For page 2 with 10 items per page, set skipCount=10.
  • maxResultCount (integer, optional): Maximum number of items to return per page. Controls page size. Default: 10. Maximum allowed: 100.
  • sorting (string, optional): Sorting criteria using format FieldName [ASC|DESC]. Supports multiple fields separated by comma for multi-level sorting.
    • Available fields: OutputDataObjectName, Type, CreationTime, LastModificationTime
    • Default: CreationTime ASC
    • Examples:
      • CreationTime DESC - Sort by creation time, newest first
      • OutputDataObjectName ASC, CreationTime DESC - Sort by output name ascending, then by creation time descending

Responses

  • 200 OK: Returns a paginated result containing:
    • totalCount: Total number of function transfers matching the filter criteria
    • items: Array of function transfer objects for the current page

Security

  • This API requires authentication.

Request​

Responses​

OK