- Type
- entityFeedQuery
- Description
- Returns the social feed of an object
- Properties
-
Name Type Description entityId* entityId (string) fields string[] List of Fields the query should return feedItemOptions string[] List of feed item options Available options:
paging paging Paging setting for the query - Type
- groupsQuery
- Description
- Returns the list of groups the current user is a member of
- Properties
-
Name Type Description fields string[] paging paging Paging setting for the query - Type
- newsFeedQuery
- Description
- Returns the current user news feed
- Properties
-
Name Type Description mode newsFeedMode Mode of the news feed query: Following or All fields string[] List of Fields the query should return feedItemOptions string[] List of feed item options Available options:
paging paging Paging setting for the query - Type
- repliesQuery
- Description
- Retrieves the reply feed of a discussion
- Properties
-
Name Type Description postId* entityId (string) Id of the discussion post fields string[] List of Fields the query should return feedItemOptions string[] List of feed item options Available options:
paging paging Paging setting for the query - Type
- aggregateQuery
- Description
- Performs a query and aggreagtes (and optionally groups) the results using one of the grouping functions (e.g. Count, Sum, etc.)
- Properties
-
Name Type Description typeName* string The main entity type to query (e.g. WorkItem,Useretc.)groupBy string[] A list of field names to group results by orders orderBy[] Optionaly order the result where condition The query criteria aggregations* fieldAggregation[] List of aggregations to perform paging paging Paging setting for the query - Type
- cZQLQuery
- Description
- Executes a CZQL query.
- Properties
-
Name Type Description q string The CZQL Query to perform parameters parameters Values for bind parameters paging paging Paging setting for the query - Type
- entityQuery
- Description
- Retrieve entities from AdaptiveWork according to a certain criteria
- Properties
-
Name Type Description typeName* string The main entity type to query (e.g. WorkItem, User etc.) fields string[] A list of field names to retrieve orders orderBy[] Optionaly order the result where condition The query criteria relations relation[] The query relations deleted boolean If set to true, the query is performed on Deleted entities originalExternalID boolean paging paging Paging setting for the query - Type
- relationQuery
- Description
- Retrieve the related entities of an object from a specific Relation
- Properties
-
Name Type Description entityId* entityId (string) The main entity relationName* string Relation name to retrieve fields string[] A list of field names to retrieve orders orderBy[] Optionaly order the result where condition The query criteria relations relation[] The query relations fromLink boolean The query result of link objects paging paging Paging setting for the query - Type
- expenseQuery
- Description
- Retrieves expenses for a specific Project or Customer
- Properties
-
Name Type Description projectId entityId (string) customerId entityId (string) typeName* string The main entity type to query (e.g. WorkItem, User etc.) fields string[] A list of field names to retrieve orders orderBy[] Optionaly order the result where condition The query criteria relations relation[] The query relations deleted boolean If set to true, the query is performed on Deleted entities originalExternalID boolean paging paging Paging setting for the query - Type
- timesheetQuery
- Description
- Retrieves timesheet according to different criterias
- Properties
-
Name Type Description projectId entityId (string) customerId entityId (string) iAmTheApprover boolean workItems entityId[] timesheetState timesheetState typeName* string The main entity type to query (e.g. WorkItem, User etc.) fields string[] A list of field names to retrieve orders orderBy[] Optionaly order the result where condition The query criteria relations relation[] The query relations deleted boolean If set to true, the query is performed on Deleted entities originalExternalID boolean paging paging Paging setting for the query - Type
- findUserQuery
- Description
- Finds a user based on several criterias
- Properties
-
Name Type Description firstName string lastName string eMail string fuzzySearchUserName boolean includeSuspendedUsers boolean fields string[] orders orderBy[] paging paging Paging setting for the query
