List Topics
The list topics endpoints support OData through query parameters to manipulate the data returned. The following operations are supported.
- Filtering
- Searching
- Sorting
- Limiting
- Skipping
To support OData, query parameters must not be URL encoded. For example, use $filter instead of %24filter.
Filtering
Search based on the value of a property by providing the $filter query parameter. The following properties are supported.
- assigned_to
- bimsync_assigned_to
- bimsync_creation_author
- bimsync_issue_number
- bimsync_points
- bimsync_requester
- bimsync_status_type: Valid values are Open, Closed and Candidate
- creation_author
- creation_date
- due_date
- labels
- modified_author
- modified_date
- stage
- topic_status
- topic_type
Filter by creation author
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$filter=creation_author eq '[email protected]'Filter by status
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$filter=topic_status in ('Open', 'Closed')Filter by status type
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$filter=bimsync_status_type eq 'Open'Filter by creation date
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$filter=creation_date gt 2024-05-1T09:54:00.000ZFilter by multiple properties
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$filter=assigned_to eq '[email protected]' and topic_status in ('Open') and due_date lt 2024-05-1T09:54:00.000ZSearching
Search for a specific value in the title or description of a topic by providing the $search query parameter.
Search for the term "wall" in the title or description of a topic
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$search=wallSorting
Sort the results by providing the $orderby query parameter. The default sort is by bimsync_issue_number in descending order. The following properties are supported.
- bimsync_issue_number
- creation_date
- due_date
- modified_date
Sort by creation date ascending
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$orderby=creation_dateSort by creation date descending
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$orderby=creation_date descLimiting
Specify which fields are included in the response by providing the $select query parameter. The following fields are always returned:
- guid
- server_assigned_id
- bimsync_issue_number
The following properties are supported.
- *: All default fields, useful when wanting to include additional fields to the default set
- assigned_to: Includes assigned_to and bimsync_assigned_to
- bimsync_comments_size
- bimsync_custom_fields
- bimsync_document_references
- bimsync_points
- bimsync_requester
- bimsync_viewpoints
- creation_author: Includes creation_author and bimsync_creation_author
- creation_date: Includes creation_date and bimsync_imported_at
- description
- due_date
- labels
- modified_author
- modified_date
- stage
- title
- topic_priority
- topic_status
- topic_type
Select title and description
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$select=title,descriptionSelect all default fields and the field
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$select=*,bimsync_document_referencesSkipping
Combine the $skip and $top query parameters to paginate the results. The default limit is 100 topics per request.
Retrieve the first 10 topics
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$top=10Skip the first 10 topics and return the next 10
https://api.catenda.com/opencde/bcf/3.0/projects/e18a2d1015954e52a94122d43bf8d7ad/topics?$skip=10&$top=10