IProgramService1

Operations

NameSignatureDescription
Activatevoid Activate(Uri programUri)Makes the specified program active, making it available for use by projects.
BulkAssignProjectsvoid BulkAssignProjects(Uri programUri, Uri[] projectUris)Assign multiple projects to a program. If project is already assigned to another program, it will be reassigned to this one.
BulkDeleteProgramBulkDeleteResults1 BulkDelete(Uri[] programUris, Uri programBulkDeleteOptionUri)Delete many programs
CreateEditDraftUri CreateEditDraft(Uri programUri)Create a draft of an existing program
CreateNewDraftUri CreateNewDraft()Create a draft of a new program
Deletevoid Delete(Uri programUri)Delete a program.
GetAllProgramManagersAssignedToProgramsProgramManagerReference1[] GetAllProgramManagersAssignedToPrograms(ProgramManagerSearchParameter1 search)Retrieves the list of program managers that are associated with one or more programs
GetAllProgramsProgramReference1[] GetAllPrograms()Retrieve all programs.
GetBillableAmountSeriesProgramBillableAmountSeries1 GetBillableAmountSeries(Uri programUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri programSeriesDataFilterOptionUri)Retrieve historical billing and cost data for a program.
GetBillableAmountSummaryProgramBillableAmountSummary1 GetBillableAmountSummary(Uri programUri)Retrieve actual and estimated billable amounts for a program.
GetBudgetSummaryProgramBudgetAmountSummary1 GetBudgetSummary(Uri programUri)Retrieve the amount of budget already allocated for a program.
GetCostAmountSeriesProgramCostAmountSeries1 GetCostAmountSeries(Uri programUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri programSeriesDataFilterOptionUri)Retrieve historical billing and cost data for a program.
GetCostAmountSummaryProgramCostAmountSummary1 GetCostAmountSummary(Uri programUri)Retrieve actual and estimated cost amount for a program.
GetEligibleProgramManagersProgramManagerReference1[] GetEligibleProgramManagers(Uri programUri)Get all possible program managers for the given program
GetEnabledProgramsProgramReference1[] GetEnabledPrograms()Retrieve currently enabled programs.
GetExplicitSharingAssignmentsProgramSharingAssignmentDetails1[] GetExplicitSharingAssignments(Uri programUri)Retrieves the list of who the program is shared with
GetNumberOfResourcesLoggingTimeSeriesNumberOfResourcesLoggingTimeSeries1 GetNumberOfResourcesLoggingTimeSeries(Uri programUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri programSeriesDataFilterOptionUri)Retrieve historical numbers of resources who have entered time on this program.
GetProgramDetailsProgramDetails1 GetProgramDetails(Uri programUri)Retrieve details on a single program object by URI.
GetProgramReferenceFromSlugProgramReference1 GetProgramReferenceFromSlug(String programSlug)Retrieve a program reference from a program slug.
GetResourceAssignmentSummaryResourceAssignmentSummary1 GetResourceAssignmentSummary(Uri programUri)Retrieve the number of resource assignments for a program.
GetTimeEnteredSeriesProgramTimeEnteredSeries1 GetTimeEnteredSeries(Uri programUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri programSeriesDataFilterOptionUri)Retrieve historical hours data for a program.
GetTimeEnteredSummaryProgramTimeEnteredSummary1 GetTimeEnteredSummary(Uri programUri)Retrieve actual and estimated hours for a program.
GetUriFromSlugUri GetUriFromSlug(String programSlug)Retrieve a program URI from a program slug.
Inactivatevoid Inactivate(Uri programUri)Makes the specified program inactive, and it will be unavailable for use by projects.
PublishDraftProgramDetails1 PublishDraft(Uri draftUri)Publish a program draft
PutExplicitSharingAssignmentsvoid PutExplicitSharingAssignments(Uri programUri, Uri[] sharedUris)Put the entire list of who the program is shared with
PutProgramProgramReference1 PutProgram(ProgramParameter1 program)Put the entire program details. If ProgramParameter1.target.name is specified and not found, it will create that program
UpdateDateRangevoid UpdateDateRange(Uri programUri, DateRangeParameter1 dateRange)Modify the date range for a program; startDate and/or endDate can be null to indicate the past or future.
UpdateNamevoid UpdateName(Uri programUri, String name)Update the name on a single program object by URI.
UpdateProgramManagervoid UpdateProgramManager(Uri programUri, Uri programManagerUri)Update the program manager on a single program object by URI.
ValidateValidationResultsSummary1 Validate(Uri programUri)Validate a program