ITaskListservice1

Operations

NameSignatureDescription
CreateCSVExportBatchUri CreateCSVExportBatch(Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression, String fileName)Begins a CSV export batch. This will create a CSV file with all of the pages of data. The parameters are the same as passed to IListService.GetData
CreateCSVExportBatch2Uri CreateCSVExportBatch2(CSVExportBatchOptionsParameter1 options)Begins a CSV export batch. This will create a CSV file with all of the pages of data. The parameters are the same as passed to IListService.GetData
CreateHierarchyCSVExportBatchUri CreateHierarchyCSVExportBatch(Uri[] columnUris, FilterExpression1 filterExpression, Uri[] hierarchyListDataOptionUris, String fileName, ColumnNameOverrideParameter1[] columnNameOverrides)Begins a hierarchy CSV export batch. This will create a CSV file with all of the pages of data. The parameters are the same as passed to IHierarchyListService1.GetHierarchyData
CreateObjectSetUri CreateObjectSet(Uri columnUri, FilterExpression1 filterExpression)Create an 'object set' matching given filter expression. This can then be used in batch and bulk operations. The 'columnUri' specified must be a 'urn:replicon:list-type:object' data type
GetAllColumnsListColumnGroup1[] GetAllColumns()Retrieves all the supported columns for the list service; this includes their display name and a URI to refer to the column.
GetAllFilterDefinitionsFilterDefinitionDetails1[] GetAllFilterDefinitions()Retrieves all the different filter definitions which can be used in filter expressions on this list service.
GetAllGroupDefinitionsListGroupDefinition1[] GetAllGroupDefinitions()Retrieve available grouping options.
GetChildHierarchyDataHierarchyListData1 GetChildHierarchyData(Int32 page, Int32 pagesize, Uri[] columnUris, Uri parentUri)Retrieves a page of rows with specifiable hierarchy data options, including only the data that is a child of the specified parent. "page" is a one-based page count; "pagesize" is the number of records on each page; "parentUri" is the URI of the object that we're getting child data for, or null to specify top-level records; "filterExpression" is used to exclude some data rows, and can be null; columnUris is an array of column Uri that are included in the output.
GetCSVExportBatchResultsCSVExportBatchResult1 GetCSVExportBatchResults(Uri csvExportBatchUri)Get the results of the csv export batch. The result will contain either a download URL or an error.
GetDataListData1 GetData(Int32 page, Int32 pagesize, Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression)Retrieves a page of data. "page" is a one-based page count; "pagesize" is the number of records on each page; "sort" is an array of sort clauses to apply to the data, and can be null; "filterExpression" is used to exclude some data rows, and can be null; columnUris is an array of column Uri that are included in the output.
GetDataByGroupListDataByGroup1 GetDataByGroup(Int32 page, Int32 pagesize, Uri groupUri, Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression)Retrieves a page of data, where the data rows are grouped by a specified grouping configuration. All parameters are the same as "GetData", except that "groupUri" is added and must be specified. The grouping URI is provided by GetAllGroupDefinitions
GetHierarchyCSVExportBatchResultsCSVExportBatchResult1 GetHierarchyCSVExportBatchResults(Uri hierarchyCsvExportBatchUri)Get the results of the csv export batch. The result will contain either a download URL or an error.
GetHierarchyDataHierarchyListData1 GetHierarchyData(Int32 page, Int32 pagesize, Uri[] columnUris, FilterExpression1 filterExpression, Uri[] hierarchyListDataOptionUris)Retrieves a page of rows with specifiable hierarchy data options. "page" is a one-based page count; "pagesize" is the number of records on each page; "filterExpression" is used to exclude some data rows, and can be null; columnUris is an array of column Uri that are included in the output.
GetHierarchyDataForProjectHierarchyListData1 GetHierarchyDataForProject(Int32 page, Int32 pagesize, ProjectTargetParameter1 project, Uri[] columnUris, FilterExpression1 filterExpression, Uri[] hierarchyListDataOptionUris)It's similar to GetHierarchyData but a project must be mentioned.
GetHierarchyDataRowCountsInt32[] GetHierarchyDataRowCounts(FilterExpression1[] filterExpressions, Uri[] hierarchyListDataOptionUris)Calculates the number of rows that are expected to be available, for a given set of filter expressions. A filter expression can be 'null' to represent a complete row count without filtering. The result is not guaranteed to be accurate; approximations may be used when large numbers of records are available.
GetHierarchyDataRowCountsForProjectInt32[] GetHierarchyDataRowCountsForProject(ProjectTargetParameter1 project, FilterExpression1[] filterExpressions, Uri[] hierarchyListDataOptionUris)It's similar to GetHierarchyDataRowCounts but a project must be mentioned.
GetRowCountByGroupListRowCountByGroup1 GetRowCountByGroup(Uri groupUri, FilterExpression1 filterExpression)Retrieves a page of data, where the data rows are grouped by a specified grouping configuration. All parameters are the same as "GetData", except that "groupUri" is added and must be specified. The grouping URI is provided by GetAllGroupDefinitions
GetRowCountsInt32[] GetRowCounts(FilterExpression1[] filterExpressions)Calculates the number of rows that are expected to be available, for a given set of filter expressions. A filter expression can be 'null' to represent a complete row count without filtering. The result is not guaranteed to be accurate; approximations may be used when large numbers of records are available.
GetTotalsListDataRow1 GetTotals(FilterExpression1 filterExpression, Uri[] columnUris)Calculates per-column totals over the range of data. "filterExpression" is used to exclude some data rows from the calculation, and can be null; "columnUris" is an array of column Uri to total. A data row is returned; for columns that cannot be aggregated (eg. text columns like "Name"), a data cell of null type is expected.