ITimeDataExportService1

Operations

NameSignatureDescription
CancelTimeDataExportvoid CancelTimeDataExport(TimeDataExportTargetParameter1 target)Mark a draft time data export as cancelled and release its time data items
CreateTimeDataDownloadBatchUri CreateTimeDataDownloadBatch(Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression, Uri fileFormatScriptUri)Create a batch to generate a time data download file
CreateTimeDataExportTimeDataExportReference1 CreateTimeDataExport(FilterExpression1 filterExpression, Uri[] columnUris, String unitOfWorkId)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreateTimeDataExportBatch. Generate a time data export and add all of the time data items that matches the filters
CreateTimeDataExportBatchUri CreateTimeDataExportBatch(Uri[] columnUris, FilterExpression1 filterExpression)Create a batch to create a time data export based on the filters and columns selected, use BatchManagement services to start and monitor the batch
CreateTimeDataExportStatusBatchUri CreateTimeDataExportStatusBatch(TimeDataExportTargetParameter1 target, Uri statusUri)Creates batch for updating status of time data export
CreateTimeDataItemDataBatchUri CreateTimeDataItemDataBatch(Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression)Create a batch to return all rows of data for the selected columns, sort and filter expression same as for GetData, use BatchManagement services to start and monitor the batch
CreateTimeDataItemRowCountsBatchUri CreateTimeDataItemRowCountsBatch(FilterExpression1[] filterExpressions, Uri[] columnUris)Create a batch that calculates the number of rows that are expected to be available, for a given set of filter expressions and the columns. 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.
CreateTimeDataItemTotalsBatchUri CreateTimeDataItemTotalsBatch(FilterExpression1 filterExpression, Uri[] columnUris)Creates a batch that 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.
DeleteTimeDataExportvoid DeleteTimeDataExport(TimeDataExportTargetParameter1 target)Delete a time data export
DisableTimeDataExportMetadataColumnvoid DisableTimeDataExportMetadataColumn(TimeDataExportMetadataColumnTargetParameter1 target)Disable a metadata column so to make it unavailable for list service
EnableTimeDataExportMetadataColumnvoid EnableTimeDataExportMetadataColumn(TimeDataExportMetadataColumnTargetParameter1 target)Enable a metadata column so to make it available for list service
GetActiveTimeDataExportMetadataColumnsTimeDataExportMetadataColumnReference1[] GetActiveTimeDataExportMetadataColumns()Get all enabled metadata columns for list service
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.
GetAllTimeDataExportMetadataColumnsTimeDataExportMetadataColumnReference1[] GetAllTimeDataExportMetadataColumns()Get all metadata columns for list service
GetCreateTimeDataExportBatchResultsCreateTimeDataExportBatchResult GetCreateTimeDataExportBatchResults(Uri timeDataExportBatchUri)Get the results of the specified CreateTimeDataExportBatch batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetDataListData1 GetData(Int32 page, Int32 pagesize, Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreateTimeDataItemDataBatch. 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.
GetRowCountsInt32[] GetRowCounts(FilterExpression1[] filterExpressions, Uri[] columnUris)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreateTimeDataItemRowCountsBatch. Calculates the number of rows that are expected to be available, for a given set of filter expressions and the columns. 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.
GetTimeDataDownloadBatchResultsTimeDataDownloadBatchResult1 GetTimeDataDownloadBatchResults(Uri timeDataDownloadBatchUri)Get the results of the specified TimeDataDownload batch. Will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetTimeDataExportDetailsTimeDataExportDetails1 GetTimeDataExportDetails(TimeDataExportTargetParameter1 target)Get the details of a given time data export
GetTimeDataExportMetadataColumnDetailsTimeDataExportMetadataColumnDetails1 GetTimeDataExportMetadataColumnDetails(TimeDataExportMetadataColumnTargetParameter1 target)Get a single metadata column detail for list service
GetTimeDataExportStatusBatchResultsTimeDataExportStatusBatchResult1 GetTimeDataExportStatusBatchResults(Uri timeDataExportStatusBatchUri)Get the results of the specified TimeDataExportStatusBatch batch. Will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetTimeDataItemDataBatchResultsTimeDataItemDataBatchResult GetTimeDataItemDataBatchResults(Uri timeDataItemDataBatchUri)Get the results of the specified TimeDataItemExportData batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetTimeDataItemRowCountsBatchResultsTimeDataItemRowCountsBatchResults1 GetTimeDataItemRowCountsBatchResults(Uri timeDataItemRowCountsBatchUri)Get the results of the specified TimeDataItemRowCounts batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetTimeDataItemTotalsBatchResultsTimeDataItemTotalsBatchResults1 GetTimeDataItemTotalsBatchResults(Uri timeDataItemRowCountsBatchUri)Get the results of the specified TimeDataItemTotals batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetTotalsListDataRow1 GetTotals(FilterExpression1 filterExpression, Uri[] columnUris)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreateTimeDataItemTotalsBatch. 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.
MarkTimeDataExportAsCompletevoid MarkTimeDataExportAsComplete(TimeDataExportTargetParameter1 target)Mark a draft time data export as complete
MarkTimeDataExportAsDraftvoid MarkTimeDataExportAsDraft(TimeDataExportTargetParameter1 target)Mark a complete time data export as draft
PutTimeDataExportMetadataColumnTimeDataExportMetadataColumnReference1 PutTimeDataExportMetadataColumn(TimeDataExportMetadataColumnParameter1 metadataColumn)Define a metadata column for list service
SetNextTimeDataExportNumbervoid SetNextTimeDataExportNumber(Int32 startingTimeDataExportNumber)Update the intitial time data export's starting number on new exports to be an autogenerated number incremented by 1 for each new payrun, starting with the specified number
UpdateTimeDataExportDescriptionvoid UpdateTimeDataExportDescription(TimeDataExportTargetParameter1 target, String description)Update the time data export's description
UpdateTimeDataExportMetadataColumnNamevoid UpdateTimeDataExportMetadataColumnName(TimeDataExportMetadataColumnTargetParameter1 target, String name)Change the display name of metadata column
UpdateTimeDataExportNamevoid UpdateTimeDataExportName(TimeDataExportTargetParameter1 target, String name)Update the time data export's name