read_collection
Retrieve paged inner collections (Tasks, Comments, etc.) for any entity by resource, ID, and collection name. Use filters, sorting, and field selection to target the needed data.
Instructions
GET an inner collection of an entity, e.g. UserStories/{id}/Tasks or Bugs/{id}/Comments (layer 1), fully paged. See read_meta for collection names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| limit | No | Maximum items to return (default 500, max 5000). A capped result says truncated: true. | |
| where | No | v1 filter, e.g. (EntityState.Name eq 'Open') and (Project.Id eq 2). Operators: eq, ne, gt, gte, lt, lte, contains, in; no 'or'. | |
| append | No | Calculated values, e.g. [Tasks-Count,Bugs-Count] | |
| exclude | No | Fields to omit | |
| include | No | Fields to return, e.g. [Id,Name,Project[Name],Tasks[Id,Name]] | |
| orderBy | No | Sort field; "Field desc" is accepted | |
| resource | Yes | Resource name (UserStory) or plural path (UserStories); see read_meta | |
| collection | Yes | Collection name, e.g. Tasks, Comments, Assignments | |
| orderByDesc | No | Sort field, descending |