Provides methods to manage resources and resource notes, delegate work between resources, and get working dates/times for a resource. More...
Public Member Functions | |
ResourceIdentity | AddCaseParticipant (string sessionId, WorkerResource resource) |
This function is deprecated. Please use AddCaseParticipant3 instead Adds a new resource based on the resource supplied. More... | |
ResourceIdentity | AddCaseParticipant2 (string sessionId, CaseParticipant caseParticipant) |
This function is deprecated. Please use AddCaseParticipant4 instead Adds a new resource based on the given participant's details More... | |
void | AddCaseParticipant3 (string sessionId, CaseParticipant2 resource) |
This function is deprecated. Please use AddCaseParticipant4 instead Adds a new resource based on the given participant's details More... | |
ResourceIdentity | AddCaseParticipant4 (string sessionId, CaseParticipant2 resource) |
Adds a new resource based on the given participant's details More... | |
void | AddExternalWorkerGroupResource (string sessionId, WorkerGroupResource groupResource) |
This method is deprecated. Please use AddCaseParticipant3 instead More... | |
string | AddNote (string sessionId, ResourceIdentity ownerId, string subject, string noteText) |
Adds a note to the specified resource. More... | |
ResourceIdentity | AddWorkerGroupResource (string sessionId, WorkerGroupResource resource) |
Adds a new group resource based on the information provided. More... | |
void | AddWorkerGroupResourceMember (string sessionId, ResourceIdentity groupResource, ResourceIdentity memberResource) |
Adds an existing resource to the specified group More... | |
ResourceIdentity | AddWorkerResource (string sessionId, WorkerResource resource) |
This function is deprecated. Please use AddWorkerResource2 instead. Adds a resource with the specified details. More... | |
void | AddWorkerResource2 (string sessionId, WorkerResource2 resource) |
Please note that this function is deprecated. Please use AddWorkerResource3 instead. Adds a resource using the specified details. More... | |
ResourceIdentity | AddWorkerResource3 (string sessionId, WorkerResource2 resource) |
Adds a resource using the specified details. More... | |
ResourceIdentity | AddWorkerResource4 (string sessionId, WorkerResource2 resource, ResourceIdentityCollection addToGroups) |
Adds a resource using the specified details. Also can specify groups that the resource should be added to using the addToGroups parameter More... | |
DateTime | ApplySkillLevelToResourceAndProcess (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processId, SkillLevel skillLevel, string comments, bool overwrite) |
Assigns a skill level for a specified process to a specified resource More... | |
void | AssignWorkAllocationRuleToGroup (string sessionId, ResourceIdentity groupIdentity, WorkAllocationRuleIdentity ruleIdentity) |
Associates a work allocation rule to a group. More... | |
void | DelegateFromTo (string sessionId, ResourceIdentity delegator, ResourceIdentity delegatee, DelegationOptions options) |
Allows work to be delegated from one resource to another until a given date or indefinitely. More... | |
void | DeleteResource (string sessionId, ResourceIdentity resourceIdentity, bool checkMaps, bool overrideSupervisorCheck) |
Deletes the specified resource. More... | |
bool | DoesResourceExist (string sessionId, ResourceIdentity resourceIdentity) |
Determines whether the specified resource exists. More... | |
bool | DoesResourceHaveADelegatee (string sessionId, ResourceIdentity delegator) |
Checks whether the specified resource is delegating thier activities to another resource. More... | |
bool | DoesResourceHaveDelegators (string sessionId, ResourceIdentity delegatee) |
Checks whether the specified resource is assigned as a delagtee for any other resources. More... | |
void | ExcludeFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity) |
Set ths resource as unavailable when doing Manual Work Allocation from the TotalAgility Workspace. More... | |
ResourceSummaryCollection | GetAssociatedGroups (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the groups associated with the specified resource. More... | |
ProcessIdentityCollection | GetAssociatedProcesses (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the associated processes for the specified resource More... | |
AvailableResources | GetAvailableResourcesWithSkillLevelForActivities (string sessionId, ProcessActivityIdentityCollection activities, DateTime startDate, DateTime endDate) |
This method is deprecated. Please use GetAvailableResourcesWithSkillLevelForActivities2 instead. Retrieves the available resources with a sufficient skill level to perform the specified activities. More... | |
AvailableResources | GetAvailableResourcesWithSkillLevelForActivities2 (string sessionId, JobActivityIdentityCollection activities, DateTime startDate, DateTime endDate) |
Retrieves the available resources with a sufficient skill level to perform the specified activities More... | |
ResourceAvailabilityCollection | GetAvailableResourcesWithSkillLevelForProcess (string sessionId, ResourceIdentity onLoanGroupResourceIdentity, ProcessIdentity processIdentity, short skillLevel, DateTime startDate, DateTime endDate) |
Retrieves a list of resources with the minimum skill level required for a specified process. More... | |
CaseParticipant2 | GetCaseParticipant (string sessionId, ResourceIdentity resource) |
Gets a resource associated with a case based on the given participant's details. More... | |
CategoryIdentity | GetCategoryForResource (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the Id and Name of the category assigned to a specified resource More... | |
Model.Resources.Delegate | GetDelegation (string sessionId, ResourceIdentity delegatorResource) |
Retrieves the delegation for a specified resource. More... | |
DelegateInfoCollection | GetDelegations (string sessionId) |
Retrieves a list of all delegations. More... | |
LdapResourceCollection | GetFailedToSynchLdapResourcesFromXml (string sessionId, string errorsXml) |
Gets a list of the LDAP resources that failed to synchronize from the error output in XML. More... | |
DateTime | GetFutureDateUsingWorkingDaysForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days) |
Get a date in the future using a specified number of working days from a date. More... | |
DateTime | GetFutureDateUsingWorkingHoursForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int hours) |
Get a date in the future using a specified number of working hours from a date. More... | |
DateTime | GetFutureDateUsingWorkingMinutesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int minutes) |
Get a date in the future using a specified number of working minutes from a date. More... | |
DateTime | GetFutureDateUsingWorkingSecondsForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int seconds) |
Get a date in the future using a specified number of working seconds from a date. More... | |
DateTime | GetFutureDateUsingWorkingTimeForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days, int hours, int minutes, int seconds) |
Get a date in the future by adding a specified working time to a date. More... | |
ResourceSummaryCollection | GetGroupResourceMembers (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the groups and workers associated with the specified resource. More... | |
int | GetLoanedSecondsForResourceBetweenDates (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroupIdentity) |
Gets the number of seconds a resource has been on loan to a group. More... | |
TimePeriod | GetLoanedTimeForResourceBetweenDates (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroupIdentity) |
Calculates the amount of time the specified resource is allocated as on loan to the specified group between the dates given. More... | |
NetTimeForResource | GetLoanedTimeForResourcesBetweenDates (string sessionId, ResourceIdentity resourceIdentity, int workloadInSeconds, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroup) |
Works out a resource's total and net remaining working days on loan to a specified resource, taking into account a specifiable existing workload. More... | |
ResourceSummaryCollection | GetMembersOfGroup (string sessionId, ResourceIdentity groupResourceId, bool useManualWorkAllocationExclusion) |
Retrieves the resources that are members of the specified group. More... | |
NetTimeForResource | GetNetTimeBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, int workloadInSeconds, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroupIdentity) |
Works out the amount of time a resource will be available between the dates specified, taking into account a specifiable existing work load. More... | |
NoteCollection | GetNotes (string sessionId, ResourceIdentity ownerId, NoteFilter noteFilter) |
Retrieves the notes for the specified resource using specified note filter. More... | |
long | GetNumberOfActivitiesAssignedToResource (string sessionId, ResourceActivityFilter resourceActivityFilter) |
Gets the number of activities assigned to the specified resource. More... | |
DateTime | GetPastDateUsingWorkingDaysForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days) |
Get a date in the past using a specified number of working days from a date. More... | |
DateTime | GetPastDateUsingWorkingHoursForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int hours) |
Get a date in the past using a specified number of working hours from a date. More... | |
DateTime | GetPastDateUsingWorkingMinutesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int minutes) |
Get a date in the past using a specified number of working minutes from a date. More... | |
DateTime | GetPastDateUsingWorkingSecondsForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int seconds) |
Get a date in the past using a specified number of working seconds from a date. More... | |
DateTime | GetPastDateUsingWorkingTimeForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, int days, int hours, int minutes, int seconds) |
Get a date in the past subtracting a specified working time from a date. More... | |
ResourceProcessSkillLevelCollection | GetProcessSkillLevelsForResource (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves all process skill levels assigned to a specified resource. More... | |
TeamProductivityInfo | GetProductivityForTeamResources (string sessionId, ResourceIdentity team) |
This API is deprecated and will not work on a clean install, since PI no longer is part of the KTA installation. This will only work on an installation which has been upgraded from 5.5 Retrieves the team productivity for a specified resource More... | |
string | GetResourceEmailAddress (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the email address of the specified resource More... | |
ResourceIdentity | GetResourceIdFromResourceIdentity (string sessionId, ResourceIdentity resourceIdentity) |
This function is deprecated. Please use GetResourceIdFromResourceIdentity2 instead. Retrieves the resource id from the specified resource's name More... | |
ResourceIdentity | GetResourceIdFromResourceIdentity2 (string sessionId, ResourceIdentity2 resourceIdentity) |
Retrieves the resource id from resource information More... | |
string | GetResourceName (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves a resource's name from its Id. More... | |
int | GetResourceNoteCount (string sessionId, ResourceIdentity ownerId, short status) |
Retrieves the number of notes assignd to the specified resource. More... | |
ResourceSummaryCollection | GetResources (string sessionId, ResourceFilter resourceFilter, ResourceIconSettings resourceIconSettings) |
This function is deprecated. Please use GetResources2 instead. Retrieves all resources based on a specified filter criteria More... | |
ResourceSummaryCollection | GetResources2 (string sessionId, ResourceFilter2 resourceFilter, ResourceIconSettings resourceIconSettings) |
Retrieves all resources based on a specified filter criteria. More... | |
ResourceIdentity2Collection | GetResourcesEmailAddresses (string sessionId, ResourceIdentityCollection resources) |
Retrieves the email address for each specified resource. More... | |
ResourceProcessSkillLevelCollection | GetResourceSkillLevelsForProcess (string sessionId, ProcessIdentity processIdentity) |
Retrieves all Resource Process Skill Levels set up for a specified process. More... | |
ResourceOnLoanCollection | GetResourcesOnLoanBetweenDates (string sessionId, DateTime fromDate, DateTime toDate, ResourceIdentity onLoanGroup) |
Retrieves details of all resources on loan to a specified group between the given dates. More... | |
ResourceSummary | GetResourceSummary (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves summary details of the specified resource. More... | |
ResourceIdentity | GetResourceSupervisor (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the supervisor of the specified resource. More... | |
ResourceSummaryCollection | GetResourcesUsingSearchCriteria (string sessionId, ResourceSearchFilter resourceSearchFilter) |
Method to return a list of Resource details depending on the parameters passed into the method These parameters will be used as criteria for the returned list to be based upon. More... | |
ResourceIdentity | GetResourceWorkingGroup (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the working group assigned to the specified resource. More... | |
ResourceIdentityCollection | GetRoleMembers (string sessionId, ResourceIdentity roleIdentity) |
Retrieves a list of the resources that are members of a specified role. More... | |
SkillLevelHistoryCollection | GetSkillLevelHistory (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processIdentity) |
Retrieves the history of the skill level of a specified resource. More... | |
SkillLevel | GetSkillLevelOfResourceForProcess (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processIdentity) |
Retrieves the skill level for a speciified resource within a specified process. More... | |
SubordinateCollection | GetSubordinateGroups (string sessionId, ResourceIdentity groupResource, bool recursiveGroups) |
Retrieves a list of groups for which the specified resource is the supervisor. Subordinates of those groups can also be returned. More... | |
SubordinateCollection | GetSubordinates (string sessionId, ResourceIdentity resource, SubordinateFilter subordinateFilter) |
This function is deprecated. Please use GetSubordinates2 instead. Retrieves all direct worker subordinates of the specified resource More... | |
SubordinateCollection | GetSubordinates2 (string sessionId, ResourceIdentity resource, SubordinateFilter2 subordinateFilter) |
Retrieves all direct worker subordinates of the specified resource More... | |
SubordinateCollection | GetSupervisors (string sessionId, SupervisorFilter supervisorFilter) |
Retrieves all the supervisors based on the specified search filter criteria More... | |
SupervisorCollection | GetSupervisors2 (string sessionId, SupervisorFilter supervisorFilter) |
Retrieves all the supervisors based on the specified search filter criteria More... | |
WorkAllocationRule | GetWorkAllocationRuleForGroup (string sessionId, ResourceIdentity groupIdentity) |
Retrieves the work allocation rule details assigned to the specified resource. More... | |
WorkerGroupResource | GetWorkerGroupResource (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the full details of the specified resource. More... | |
WorkerGroupResource3 | GetWorkerGroupResource2 (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves details of the specified worker group resource. More... | |
WorkerResource | GetWorkerResource (string sessionId, ResourceIdentity resourceIdentity) |
This function is deprecated. Please use GetWorkerResource2 instead. Retrieves the full details of a worker resource. More... | |
WorkerResource2 | GetWorkerResource2 (string sessionId, ResourceIdentity resource) |
Gets the full details of the specified resource. More... | |
CategoryIdentity | GetWorkingCategory (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the working category details of the specified resource. More... | |
int | GetWorkingDaysBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity) |
Retrieves the number of working days between two specified dates for a specified resource. More... | |
int | GetWorkingHoursBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity) |
Retrieves the number of working hours between two specified dates for a specified resource. More... | |
TimePeriod | GetWorkingHoursBreakdownForResource (string sessionId, ResourceIdentity resourceIdentity, int hours) |
Converts the specified number of hours into a resource's working time. More... | |
int | GetWorkingMinutesBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity) |
Retrieves the number of working minutes between two specified dates for a specified resource. More... | |
TimePeriod | GetWorkingMinutesBreakdownForResource (string sessionId, ResourceIdentity resourceIdentity, int minutes) |
Converts the specified number of minutes into a resource's working time. More... | |
int | GetWorkingSecondsBetweenDatesForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime fromDate, DateTime toDate, bool useOnLoanGroupResourceId, ResourceIdentity onLoanGroupResourceIdentity) |
Retrieves the number of working seconds between two specified dates for a specified resource. More... | |
TimePeriod | GetWorkingSecondsBreakdownForResource (string sessionId, ResourceIdentity resourceIdentity, int seconds) |
Converts the specified number of seconds into a resource's working time. More... | |
TimePeriod | GetWorkingTimeBetweenDatesForResource (string sessionId, ResourceTimeFilter resourceTimeFilter) |
Retrieves the working time between two specified dates for a specified resource. More... | |
bool | IsExcludedFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity) |
Determines whether the resource has been excluded from muanl work allocation using ExcludeFromManualWorkAllocation method. More... | |
bool | IsResourceInGroup (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity groupIdentity) |
Determines whether the specified resource is in the specified group More... | |
bool | IsWorkingDateTimeForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime dateToCheck) |
Determines whether the specified datetime is a working day for a specified resource. More... | |
bool | IsWorkingDayForResource (string sessionId, ResourceIdentity resourceIdentity, DateTime dateToCheck) |
Determines whether the specified date is a working day for the resource. More... | |
LdapSynchonizationErrors | ProcessLdapSynchronizationErrors (string sessionId, LdapSynchronizationData synchronizationData) |
Processes the specified LDAP synchronization errors. More... | |
void | RemoveExclusionFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity) |
Allow resource to be available for manual work allocation. More... | |
void | RemoveResourceFromGroup (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity groupIdentity) |
Removes the specified resource from the specified group. More... | |
bool | RemoveSkillLevelForResourceAndProcess (string sessionId, ResourceIdentity resourceIdentity, ProcessIdentity processIdentity, string comments) |
Removes the existing skill level for a specified resource for a specified process More... | |
void | RemoveSubordinatesExclusionFromManualWorkAllocation (string sessionId, ResourceIdentity resourceIdentity) |
Removes exclusion from manual work allocation for each resource that is a subordinate of the specified resource. More... | |
void | RemoveWorkAllocationRuleFromGroup (string sessionId, ResourceIdentity groupIdentity, WorkAllocationRuleIdentity ruleIdentity) |
Removes the specified work allocation rule from the specified group. More... | |
LdapSynchronizationResult | SynchronizeWithLdap (string sessionId, LdapSynchronizationSettings settings) |
Synchronizes the with an LDAP Server in order to retrieve a list of users which will be added to the resources available within TotalAgility. More... | |
void | UnDelegate (string sessionId, ResourceIdentity delegator) |
Removes any delegation from the specified resource. More... | |
void | UpdateCaseParticipant (string sessionId, WorkerResource resource) |
Please note that this function is deprecated. Please use UpdateCaseParticipant2 instead. Updates the details for for specified case participant. More... | |
void | UpdateCaseParticipant2 (string sessionId, UpdatedCaseParticipant resource, bool overwrite) |
Updates the case participants for a specified resource. More... | |
void | UpdateDelegation (string sessionId, DelegateInfo delegateInfo, bool overwrite) |
Updates the specified delegation and optionally overwrites it More... | |
void | UpdateExternalWorkerGroupResource (string sessionId, WorkerGroupResource resource, bool overwrite) |
This method is deprecated. Please use UpdateCaseParticipant2 instead More... | |
void | UpdateNotesStatus (string sessionId, NoteIdentityCollection noteIdCollection, short status) |
Updates the status of all the specified notes to either read or unread. More... | |
void | UpdateResourceSupervisor (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity supervisorIdentity) |
Assigns a supervisor to the specified resource, replacing any existing supervisor. More... | |
void | UpdateResourceWorkingGroup (string sessionId, ResourceIdentity resourceIdentity, ResourceIdentity workingGroup) |
Assigns the specified working group to the specified respurce, replacing any existing working group. More... | |
void | UpdateWorkerGroupResource (string sessionId, WorkerGroupResource resource, bool overwrite) |
Please note that this function is deprecated. Please use UpdateWorkerGroupResource2 instead. Updates the worker group resource information, optionally replacing any existing information. More... | |
void | UpdateWorkerGroupResource2 (string sessionId, WorkerGroupResource2 resource, bool overwrite) |
Updates the worker group resource information, optionally replacing any existing information. More... | |
void | UpdateWorkerGroupResource3 (string sessionId, WorkerGroupResource2 resource, ResourceIdentityCollection addMembers, ResourceIdentityCollection removeMembers, bool overwrite) |
Updates the worker group resource information using the addMember and removeMembers parameters. More... | |
void | UpdateWorkerResource (string sessionId, WorkerResource resource, bool overwrite) |
This function is deprecated. Please use UpdateWorkerResource2 instead. Updates the worker resource information with the specified information. More... | |
void | UpdateWorkerResource2 (string sessionId, WorkerResource2 resource, bool overwrite) |
Updates a resource based on the specified details. More... | |
void | UpdateWorkerResource3 (string sessionId, WorkerResource2 resource, ResourceIdentityCollection addToGroups, ResourceIdentityCollection removeFromGroups, bool overwrite) |
Updates a resource based on the specified details. More... | |
Provides methods to manage resources and resource notes, delegate work between resources, and get working dates/times for a resource.
ResourceIdentity AddCaseParticipant | ( | string | sessionId, |
WorkerResource | resource | ||
) |
This function is deprecated. Please use AddCaseParticipant3 instead
Adds a new resource based on the resource supplied.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource object containing the details of the case particpant to add.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Name of the resource |
Resource Type | Int16 | The resource type of the user. Defaults to ExternalWorker (32) |
ResourceIdentity AddCaseParticipant2 | ( | string | sessionId, |
CaseParticipant | caseParticipant | ||
) |
This function is deprecated. Please use AddCaseParticipant4 instead
Adds a new resource based on the given participant's details
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||
caseParticipant | A CaseParticipant object containing the details of the case particpant to add.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Name of the resource |
Resource Type | Int16 | The resource type of the user. Defaults to ExternalWorker (32) |
void AddCaseParticipant3 | ( | string | sessionId, |
CaseParticipant2 | resource | ||
) |
This function is deprecated. Please use AddCaseParticipant4 instead
Adds a new resource based on the given participant's details
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||
resource | A CaseParticipant2 object containing the details of the case particpant to add.
|
ResourceIdentity AddCaseParticipant4 | ( | string | sessionId, |
CaseParticipant2 | resource | ||
) |
Adds a new resource based on the given participant's details
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||
resource | A CaseParticipant2 object containing the details of the case particpant to add.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource. |
Name | String | Name of the resource. |
Resource Type | Int16 | The resource type of the user. |
void AddExternalWorkerGroupResource | ( | string | sessionId, |
WorkerGroupResource | groupResource | ||
) |
This method is deprecated. Please use AddCaseParticipant3 instead
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
groupResource | A WorkerGroupResource that identifies the group to be added. |
string AddNote | ( | string | sessionId, |
ResourceIdentity | ownerId, | ||
string | subject, | ||
string | noteText | ||
) |
Adds a note to the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
ownerId | A ResourceIdentity object to add the note to.
| ||||||||||||||||
subject | The title of the note. This must be specified. | ||||||||||||||||
noteText | The body of the note. This must be specified. |
ResourceIdentity AddWorkerGroupResource | ( | string | sessionId, |
WorkerGroupResource | resource | ||
) |
Adds a new group resource based on the information provided.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerGroupResource object containing the details of the case particpant to add.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Name of the resource |
Resource Type | Int16 | Always returns 0 |
void AddWorkerGroupResourceMember | ( | string | sessionId, |
ResourceIdentity | groupResource, | ||
ResourceIdentity | memberResource | ||
) |
Adds an existing resource to the specified group
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
groupResource | A ResourceIdentity the group to add the resource to.
| ||||||||||||||||
memberResource | A ResourceIdentity the resource to be added.
|
ResourceIdentity AddWorkerResource | ( | string | sessionId, |
WorkerResource | resource | ||
) |
This function is deprecated. Please use AddWorkerResource2 instead.
Adds a resource with the specified details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource object containing the details of the resource to add
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource. |
Name | String | Name of the resource. |
Resource Type | Int16 | The resource type of the user. |
void AddWorkerResource2 | ( | string | sessionId, |
WorkerResource2 | resource | ||
) |
Please note that this function is deprecated. Please use AddWorkerResource3 instead.
Adds a resource using the specified details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource2 object containing the details of the resource particpant to add.
|
ResourceIdentity AddWorkerResource3 | ( | string | sessionId, |
WorkerResource2 | resource | ||
) |
Adds a resource using the specified details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource2 object containing the details of the resource particpant to add.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource. |
Name | String | Name of the resource. |
Resource Type | Int16 | The resource type of the user. |
ResourceIdentity AddWorkerResource4 | ( | string | sessionId, |
WorkerResource2 | resource, | ||
ResourceIdentityCollection | addToGroups | ||
) |
Adds a resource using the specified details. Also can specify groups that the resource should be added to using the addToGroups parameter
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource2 object containing the details of the resource particpant to add.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
addToGroups | A collection that indicates groups the resource is to be added to |
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource. |
Name | String | Name of the resource. |
Resource Type | Int16 | The resource type of the user. |
DateTime ApplySkillLevelToResourceAndProcess | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ProcessIdentity | processId, | ||
SkillLevel | skillLevel, | ||
string | comments, | ||
bool | overwrite | ||
) |
Assigns a skill level for a specified process to a specified resource
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id to identify the resource
| ||||||||||||||||
processId | A processID object containing the process id to identify the process
| ||||||||||||||||
skillLevel | A SkillLevel object containing the Skill Level information.
| ||||||||||||||||
comments | Comments are not used | ||||||||||||||||
overwrite | If set to true then any existing skill level will be overwritten. |
void AssignWorkAllocationRuleToGroup | ( | string | sessionId, |
ResourceIdentity | groupIdentity, | ||
WorkAllocationRuleIdentity | ruleIdentity | ||
) |
Associates a work allocation rule to a group.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
groupIdentity | A ResourceIdentity object containing the resource id information of the group resource.
| ||||||||||||||||
ruleIdentity | A WorkAllocationRuleIdentity object containing the work allocation rule id information.
|
void DelegateFromTo | ( | string | sessionId, |
ResourceIdentity | delegator, | ||
ResourceIdentity | delegatee, | ||
DelegationOptions | options | ||
) |
Allows work to be delegated from one resource to another until a given date or indefinitely.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
delegator | A ResourceIdentity object containing the resource information of the delegator.
| ||||||||||||||||
delegatee | A ResourceIdentity object containing the resource information of the delegatee.
| ||||||||||||||||
options | A DelegationOptions object that is used to specify the optional end date of the delegation, and an option to overwrite any existing delegation between the delegator and delegatee.
|
void DeleteResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
bool | checkMaps, | ||
bool | overrideSupervisorCheck | ||
) |
Deletes the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource that needs to be deleted.
| ||||||||||||||||
checkMaps | If set to true it checks the business process if the resource is being used and also its live activities. | ||||||||||||||||
overrideSupervisorCheck | Indicator that the resource should be deleted even if it is being used as a supervisor. |
false
if not specified bool DoesResourceExist | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Determines whether the specified resource exists.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information to check whether it exists or not.
|
True
if resource exists; false, otherwise.bool DoesResourceHaveADelegatee | ( | string | sessionId, |
ResourceIdentity | delegator | ||
) |
Checks whether the specified resource is delegating thier activities to another resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
delegator | A ResourceIdentity object to be checked for a delegatee
|
True
if the resource has a delegatee; false otherwise.bool DoesResourceHaveDelegators | ( | string | sessionId, |
ResourceIdentity | delegatee | ||
) |
Checks whether the specified resource is assigned as a delagtee for any other resources.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
delegatee | A ResourceIdentity object to be checked for delegators.
|
True
if the resource has any delegators; false otherwise.void ExcludeFromManualWorkAllocation | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Set ths resource as unavailable when doing Manual Work Allocation from the TotalAgility Workspace.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity specifying the resource that needs to be excluded from manual work allocation.
|
ResourceSummaryCollection GetAssociatedGroups | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the groups associated with the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity specifying the resource to check.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Object containing the Id, Name and ResourceType of the resource |
Category | Identity | Object containing the Id and Name of the category the resource belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
UserId | String | The NTName of the resource |
ResourceImageUrl | String | Path to the image associated with the resource |
ImageUrl | String | Always the same as ResourceImageUrl |
EmailAddress | String | Email address of the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
ProcessIdentityCollection GetAssociatedProcesses | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the associated processes for the specified resource
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object to check for associated processes.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the process |
Version | Double | Version number of the process |
Name | String | Name of the process |
AvailableResources GetAvailableResourcesWithSkillLevelForActivities | ( | string | sessionId, |
ProcessActivityIdentityCollection | activities, | ||
DateTime | startDate, | ||
DateTime | endDate | ||
) |
This method is deprecated. Please use GetAvailableResourcesWithSkillLevelForActivities2 instead.
Retrieves the available resources with a sufficient skill level to perform the specified activities.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
activities | A collection of type ProcessActivityIdentity specifying the activitiesthat should be checked. At least one must be specified.
| ||||||||||||||||
startDate | Only activities whose ActivityDueDate is after this will be eligible. This must be specified. | ||||||||||||||||
endDate | Only activities whose ActivityDueDate is before this will be eligible. This must be specified. |
Name | Type | Comment |
---|---|---|
OnLoanResources | A collection of OnLoanResourceAvailability | Contains details of any loaned resources that are elegible. |
AvailableTeamResources | A collection of ResourceAvailability | Contains details of any loaned resources that are elegible. |
AvailableResources GetAvailableResourcesWithSkillLevelForActivities2 | ( | string | sessionId, |
JobActivityIdentityCollection | activities, | ||
DateTime | startDate, | ||
DateTime | endDate | ||
) |
Retrieves the available resources with a sufficient skill level to perform the specified activities
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
activities | A collection of type JobActivityIdentity that will be checked for matching resources. At lewast one must be specified.
| ||||||||||||||||
startDate | Only activities whose ActivityDueDate is after this will be eligible. This must be specified. | ||||||||||||||||
endDate | Only activities whose ActivityDueDate is before this will be eligible. This must be specified. |
Name | Type | Comment |
---|---|---|
OnLoanResources | A collection of OnLoanResourceAvailability | Contains details of any loaned resources that are elegible. |
AvailableTeamResources | A collection of ResourceAvailability | Contains details of any loaned resources that are elegible. |
ResourceAvailabilityCollection GetAvailableResourcesWithSkillLevelForProcess | ( | string | sessionId, |
ResourceIdentity | onLoanGroupResourceIdentity, | ||
ProcessIdentity | processIdentity, | ||
short | skillLevel, | ||
DateTime | startDate, | ||
DateTime | endDate | ||
) |
Retrieves a list of resources with the minimum skill level required for a specified process.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
onLoanGroupResourceIdentity | A ResourceIdentity object for any resources that are on loan and should also be checked
| ||||||||||||||||
processIdentity | A ProcessIdentity object specifying the process that needs the resource
| ||||||||||||||||
skillLevel | The minimum skill level of the resource. | ||||||||||||||||
startDate | Specify this to get the resources that are assigned to the activities whose ActivityDueDate is after the StartDate. | ||||||||||||||||
endDate | Specify this to get the resources that are assigned to the activities whose ActivityDueDate is before the EndDate. |
Name | Type | Comment |
---|---|---|
OnLoanResources | A collection of OnLoanResourceAvailability | Contains details of any loaned resources that are elegible. |
AvailableTeamResources | A collection of ResourceAvailability | Contains details of any loaned resources that are elegible. |
CaseParticipant2 GetCaseParticipant | ( | string | sessionId, |
ResourceIdentity | resource | ||
) |
Gets a resource associated with a case based on the given participant's details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resource | A ResourceIdentity object containing the details of the case participant to retrieve
|
Name | Type | Comment |
---|---|---|
PersonaIdentity | Identity | Details of the resource's persona |
LastModifiedDate | DateTime | Date the resource is valid from |
Name | String | Name of participant |
Category | Identity | The category to be assigned to the resource |
EmailAddress | String | Email address of participant |
Password | String | Returns a password mask if specified for the resource |
StartDate | DateTime? | Date the resource is valid from |
EndDate | DateTime? | Date the resource is valid to |
CategoryIdentity GetCategoryForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the Id and Name of the category assigned to a specified resource
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | The ResourceIdentity that specifies the resource to retrieve the ctaegory information from.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the category |
Name | String | Name of the category |
Model.Resources.Delegate GetDelegation | ( | string | sessionId, |
ResourceIdentity | delegatorResource | ||
) |
Retrieves the delegation for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
delegatorResource | A ResourceIdentity object to retrieve the delegation information from.
|
Name | Type | Comment |
---|---|---|
Delegator | ResourceIdentity | Id of the delegating resource. |
Delegatee | ResourceIdentity | Id of the delegatee resource. |
CreationDate | DateTime? | Date the delegation was created. |
LastModifiedDate | DateTime? | Date the delegation was last modified. |
EndDate | DateTime? | Date the delegation ends. |
CreatedBy | ResourceIdentity | Id of the resource that created the delegation. |
LastModifiedBy | ResourceIdentity | Id of the resource that last modified the delegation. |
DelegateInfoCollection GetDelegations | ( | string | sessionId | ) |
Retrieves a list of all delegations.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
Name | Type | Comment |
---|---|---|
Delegator | ResourceIdentity | Id of the delegating resource. |
Delegatee | ResourceIdentity | Id of the delegatee resource. |
CreationDate | DateTime? | Date the delegation was created. |
LastModifiedDate | DateTime? | Date the delegation was last modified. |
EndDate | DateTime? | Date the delegation ends. |
CreatedBy | ResourceIdentity | Id of the resource that created the delegation. |
LastModifiedBy | ResourceIdentity | Id of the resource that last modified the delegation. |
OverWrite | Boolean | Will always return false . |
LdapResourceCollection GetFailedToSynchLdapResourcesFromXml | ( | string | sessionId, |
string | errorsXml | ||
) |
Gets a list of the LDAP resources that failed to synchronize from the error output in XML.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
errorsXml | The XML error output of the LDAP synchronisation. This must be specified. |
Name | Type | Comment |
---|---|---|
LdapName | String | Name of the Ldap resource. |
ResourceId | String | Id of the resource. |
ErrorText | String | Error message |
String | Email address of the Ldap resource. | |
LdapFullPath | String | Fully qualified path of the Ldap resource. |
LdapResourceType | String | The type of the Ldap resource. |
Deleted | String | The deleted. |
DateTime GetFutureDateUsingWorkingDaysForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | days | ||
) |
Get a date in the future using a specified number of working days from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working days will be taken into account when calculating the future date.
| ||||||||||||||||
fromDate | Date onto which the working days are added. This must be specified. | ||||||||||||||||
days | Number of working days to add to the specified date. |
DateTime GetFutureDateUsingWorkingHoursForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | hours | ||
) |
Get a date in the future using a specified number of working hours from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working days will be taken into account when calculating the future date.
| ||||||||||||||||
fromDate | Date onto which the working hours are added. This must be specified | ||||||||||||||||
hours | Number of working hours to add to the specified date. |
DateTime GetFutureDateUsingWorkingMinutesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | minutes | ||
) |
Get a date in the future using a specified number of working minutes from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working days will be taken into account when calculating the future date.
| ||||||||||||||||
fromDate | Date onto which the working minutes are added. This must be specified. | ||||||||||||||||
minutes | Number of working minutes to add to the specified date. |
DateTime GetFutureDateUsingWorkingSecondsForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | seconds | ||
) |
Get a date in the future using a specified number of working seconds from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working days will be taken into account when calculating the future date.
| ||||||||||||||||
fromDate | Date onto which the working seconds are added. This must be specified. | ||||||||||||||||
seconds | Number of working seconds to add to the specified date. |
DateTime GetFutureDateUsingWorkingTimeForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | days, | ||
int | hours, | ||
int | minutes, | ||
int | seconds | ||
) |
Get a date in the future by adding a specified working time to a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | The resource identity.
| ||||||||||||||||
fromDate | Date onto which the working time is added. This must be specified. | ||||||||||||||||
days | Number of working days to add to the specified date. | ||||||||||||||||
hours | Number of working hours to add to the specified date. | ||||||||||||||||
minutes | Number of working minutes to add to the specified date. | ||||||||||||||||
seconds | Number of working seconds to add to the specified date. |
ResourceSummaryCollection GetGroupResourceMembers | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the groups and workers associated with the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity specifying the resource to check.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Object containing the Id, Name and ResourceType of the resource |
Category | Identity | Object containing the Id and Name of the category the resource belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
UserId | String | The NTName of the resource |
ResourceImageUrl | String | Path to the image associated with the resource |
ImageUrl | String | Always the same as ResourceImageUrl |
EmailAddress | String | Email address of the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
int GetLoanedSecondsForResourceBetweenDates | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
ResourceIdentity | onLoanGroupIdentity | ||
) |
Gets the number of seconds a resource has been on loan to a group.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resourceid information of the resource whose count of loaned seconds need to be retrieved.
| ||||||||||||||||
fromDate | Start date for the loan details retrieval. This must be specified. | ||||||||||||||||
toDate | End date for the loan details retrieval. This must be specified. | ||||||||||||||||
onLoanGroupIdentity | Identity of group that resources are on loan to.
|
TimePeriod GetLoanedTimeForResourceBetweenDates | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
ResourceIdentity | onLoanGroupIdentity | ||
) |
Calculates the amount of time the specified resource is allocated as on loan to the specified group between the dates given.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to retrive the data for.
| ||||||||||||||||
fromDate | Start date for the loan details retrieval. This must be specified. | ||||||||||||||||
toDate | End date for the loan details retrieval. This must be specified. | ||||||||||||||||
onLoanGroupIdentity | Identity of group that resources are on loan to.
|
Name | Type | Comment |
---|---|---|
Days | In16 | The number of days the resource was on loan for. |
Hours | In16 | The number of hours the resource was on loan for. |
Minutes | In16 | The number of minutes the resource was on loan for. |
Seconds | In16 | The number of seconds the resource was on loan for. |
FormattedAsString | String | The TimePeriod in string format. |
TotalSeconds | In16 | Always 0 |
TotalMinutes | In16 | Always 0 |
NetTimeForResource GetLoanedTimeForResourcesBetweenDates | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
int | workloadInSeconds, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
ResourceIdentity | onLoanGroup | ||
) |
Works out a resource's total and net remaining working days on loan to a specified resource, taking into account a specifiable existing workload.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resourceid information of the resource whose loaned time need to be retrieved.
| ||||||||||||||||
workloadInSeconds | The current workload of the resource, in seconds | ||||||||||||||||
fromDate | From date. Must be specified. | ||||||||||||||||
toDate | To date. Must be specified. | ||||||||||||||||
onLoanGroup | A ResourceIdentity object that specifies the group the resource is on loan to.
|
Name | Type | Comment |
---|---|---|
TimeAvailableForWork | Model.TimePeriod | The amount of working time left in total between the dates. |
TimeFreeForWorkAllocation | Model.TimePeriod | The amount of working time left in total after taking workloadInSeconds into account. |
ResourceSummaryCollection GetMembersOfGroup | ( | string | sessionId, |
ResourceIdentity | groupResourceId, | ||
bool | useManualWorkAllocationExclusion | ||
) |
Retrieves the resources that are members of the specified group.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
groupResourceId | A ResourceIdentity object whose members will be retrieved.
| ||||||||||||||||
useManualWorkAllocationExclusion | if set to true whether to use the manual work allocation exclusions or not |
Name | Type | Comment |
---|---|---|
Identity | Identity | Object containing the Id, Name and ResourceType of the resource |
Category | Identity | Object containing the Id and Name of the category the resource belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
UserId | String | The NTName of the resource |
ResourceImageUrl | String | Path to the image assocaited with the resource |
ImageUrl | String | Always the same as ResourceImageUrl |
EmailAddress | String | Email address of the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise |
true
then any members found that have been marked as excluded, using ExcludeFromManualWorkAllocation, will not be shown. NetTimeForResource GetNetTimeBetweenDatesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
int | workloadInSeconds, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
ResourceIdentity | onLoanGroupIdentity | ||
) |
Works out the amount of time a resource will be available between the dates specified, taking into account a specifiable existing work load.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to retrive the data for.
| ||||||||||||||||
workloadInSeconds | The current workload of the resource, in seconds. | ||||||||||||||||
fromDate | Start date for calculation. Must be specified. | ||||||||||||||||
toDate | End date for the calculation. Must be specified. | ||||||||||||||||
onLoanGroupIdentity | A ResourceIdentity object that specifies the group the resource is on loan to.
|
Name | Type | Comment |
---|---|---|
TimeAvailableForWork | Model.TimePeriod | The amount of working time left in total between the dates. |
TimeFreeForWorkAllocation | Model.TimePeriod | The amount of working time left in total after taking workloadInSeconds into account. |
NoteCollection GetNotes | ( | string | sessionId, |
ResourceIdentity | ownerId, | ||
NoteFilter | noteFilter | ||
) |
Retrieves the notes for the specified resource using specified note filter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
ownerId | A ResourceIdentity object containing the resource id information of the resource whose notes need to be retrieved.
| ||||||||||||||||
noteFilter | A NoteFilter object containing the filter criteria to retrieve the notes.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the note |
OwnerId | String | Id of the resource the note is attached to |
CreatorId | String | The Id of the resource that created the note |
NoteTypeDescription | String | Text description of type of note |
OwnerName | String | Name of the resource the note is attached to |
Text | String | The text of the note |
Subject | String | The subject of the note |
Status | Int16 | 1 for unread, 2 for read |
CreatorName | String | The name of the resource that created the note |
StatusDisplayText | String | Unread or read |
StatusImageUrl | String | Path to image for status of the note |
CreationDate | DateTime | The date the note was created |
LastModifiedDate | DateTime | The date the note was last amended |
long GetNumberOfActivitiesAssignedToResource | ( | string | sessionId, |
ResourceActivityFilter | resourceActivityFilter | ||
) |
Gets the number of activities assigned to the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
resourceActivityFilter | A ResourceActivityFilter object containing the filter criteria to retrieve the activities. |
Name | Type | Comment | Required |
---|---|---|---|
ResourceIdentity | Identity | The resource to retrieve the data for. | Yes - Id or Name is required |
useActivityName | Boolean | Indicates whether the name of the activitiy should be used. | No |
ActivityName | String | The name of the activity. | No |
useProcessId | Boolean | Indicates whether the process's Id should be used. | No |
ProcessIdentity | Identity | The details of the process. | No |
ResourcesIncluded | Int16 | Indicator of the types of resources to be included in the count. | No |
DateTime GetPastDateUsingWorkingDaysForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | days | ||
) |
Get a date in the past using a specified number of working days from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working days will be taken into account when calculating the past date.
| ||||||||||||||||
fromDate | Date onto which the working days are subtracted. This must be specified. | ||||||||||||||||
days | Number of working days to subtract from the specified date. |
DateTime GetPastDateUsingWorkingHoursForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | hours | ||
) |
Get a date in the past using a specified number of working hours from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working hours will be taken into account when calculating the past date.
| ||||||||||||||||
fromDate | Date onto which the working hours are subtracted. This must be specified. | ||||||||||||||||
hours | Number of working hours to subtract from the specified date. |
DateTime GetPastDateUsingWorkingMinutesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | minutes | ||
) |
Get a date in the past using a specified number of working minutes from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working minutes will be taken into account when calculating the past date.
| ||||||||||||||||
fromDate | Date onto which the working minutes are subtracted. | ||||||||||||||||
minutes | Number of working minutes to subtract from the specified date. |
DateTime GetPastDateUsingWorkingSecondsForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | seconds | ||
) |
Get a date in the past using a specified number of working seconds from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object whose working seconds will be taken into account when calculating the past date.
| ||||||||||||||||
fromDate | Date onto which the working seconds are subtracted. This must be specified. | ||||||||||||||||
seconds | Number of working seconds to subtract from the specified date. |
DateTime GetPastDateUsingWorkingTimeForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
int | days, | ||
int | hours, | ||
int | minutes, | ||
int | seconds | ||
) |
Get a date in the past subtracting a specified working time from a date.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | The resource identity.
| ||||||||||||||||
fromDate | Date onto which the working time is subtracted. This must be specified. | ||||||||||||||||
days | Number of working days to subtract from the specified date. | ||||||||||||||||
hours | Number of working hours to subtract from the specified date. | ||||||||||||||||
minutes | Number of working minutes to subtract from the specified date. | ||||||||||||||||
seconds | Number of working seconds to subtract from the specified date. |
ResourceProcessSkillLevelCollection GetProcessSkillLevelsForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves all process skill levels assigned to a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object that specifies the resource to retrieve the skill levels for.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | The Id, Name and ResourceType the skill is applied to |
Process | Identity | The Id and Name of the process the skill is applied to |
SkillLevel | Int32 | The level of the skill |
SkillLevelName | String | Text version of the skill level |
Comment | String | Comment for the skilll level |
LastModifiedDate | DateTime | The date the skill level was last amended |
TeamProductivityInfo GetProductivityForTeamResources | ( | string | sessionId, |
ResourceIdentity | team | ||
) |
This API is deprecated and will not work on a clean install, since PI no longer is part of the KTA installation.
This will only work on an installation which has been upgraded from 5.5 Retrieves the team productivity for a specified resource
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
team | A ResourceIdentity object containing the resource id information of the team whose productivity for team resources needs to be retrieved.
|
string GetResourceEmailAddress | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the email address of the specified resource
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information of the resource whose email address needs to be retrieved.
|
ResourceIdentity GetResourceIdFromResourceIdentity | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
This function is deprecated. Please use GetResourceIdFromResourceIdentity2 instead.
Retrieves the resource id from the specified resource's name
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource name information of the resource to retrieve the resource id.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Not populated |
Resource Type | Int16 | Not populated |
ResourceIdentity GetResourceIdFromResourceIdentity2 | ( | string | sessionId, |
ResourceIdentity2 | resourceIdentity | ||
) |
Retrieves the resource id from resource information
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
resourceIdentity | A ResourceIdentity2 object containing the resource name information of the resource to retrieve the resource id.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Name of the resource |
Resource Type | Int16 | The type of the resource |
string GetResourceName | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves a resource's name from its Id.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information of the resource to retrieve the name.
|
int GetResourceNoteCount | ( | string | sessionId, |
ResourceIdentity | ownerId, | ||
short | status | ||
) |
Retrieves the number of notes assignd to the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
ownerId | A ResourceIdentity object containing the resource id information of the resource to retrieve the note count.
| ||||||||||||||||
status | The type of notes to count. |
ResourceSummaryCollection GetResources | ( | string | sessionId, |
ResourceFilter | resourceFilter, | ||
ResourceIconSettings | resourceIconSettings | ||
) |
This function is deprecated. Please use GetResources2 instead.
Retrieves all resources based on a specified filter criteria
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||
resourceFilter | A ResourceFilter object containing the filter criteria to retrieve the resources.
| ||||||||||||||||||||||||||||||||
resourceIconSettings | A ResourceIconSettings object containing the resource icon settings to retrieve the icon URL. This is NOT used. |
Name | Type | Comment |
---|---|---|
Identity | Identity | Object containing the Id, Name and ResourceType of the resource |
Category | Identity | Object containing the Id and Name of the category the resource belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
UserId | String | The NTName of the resource |
ResourceImageUrl | String | Path to the image assocaited with the resource |
ImageUrl | String | Always the same as ResourceImageUrl |
EmailAddress | String | Email address of the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
true
then the list will be ordered by resource type and then by name. ResourceSummaryCollection GetResources2 | ( | string | sessionId, |
ResourceFilter2 | resourceFilter, | ||
ResourceIconSettings | resourceIconSettings | ||
) |
Retrieves all resources based on a specified filter criteria.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceFilter | A ResourceFilter2 object containing the filter criteria to retrieve the resources.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceIconSettings | A ResourceIconSettings object containing the resource icon settings to retrieve the icon URL. This is NOT used. |
Name | Type | Comment |
---|---|---|
Identity | Identity | Object containing the Id, Name and ResourceType of the resource |
Category | Identity | Object containing the Id and Name of the category the resource belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
UserId | String | The NTName of the resource |
ResourceImageUrl | String | Path to the image assocaited with the resource |
ImageUrl | String | Always the same as ResourceImageUrl |
EmailAddress | String | Email address of the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
true
then the list will be ordered by resource type and then by name. SearchText will only find resources that contain the specified text ResourceIdentity2Collection GetResourcesEmailAddresses | ( | string | sessionId, |
ResourceIdentityCollection | resources | ||
) |
Retrieves the email address for each specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resources | A collection of type ResourceIdentity from which to retrieve the email addresses. At least one must be specified.
|
ResourceProcessSkillLevelCollection GetResourceSkillLevelsForProcess | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Retrieves all Resource Process Skill Levels set up for a specified process.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
processIdentity | A ProcessIdentity object containing the process id information of the process whose resource skill levels need to be retrieved.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | The Id, Name and ResourceType off the resource the skill is applied to |
Process | Identity | The Id and Name of the process the skill is applied to |
SkillLevel | Int32 | The level of the skill |
SkillLevelName | String | Text version of the skill level |
Comment | String | Comment for the skilll level |
LastModifiedDate | DateTime | The date the skill level was last amended |
ResourceOnLoanCollection GetResourcesOnLoanBetweenDates | ( | string | sessionId, |
DateTime | fromDate, | ||
DateTime | toDate, | ||
ResourceIdentity | onLoanGroup | ||
) |
Retrieves details of all resources on loan to a specified group between the given dates.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
fromDate | Start date for the loan details retrieval. Must be specified. | ||||||||||||||||
toDate | End date for the loan details retrieval. Must be specified. | ||||||||||||||||
onLoanGroup | A ResourceIdentity object specifying the group to retrieve details from.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | The Id, Name and ResourceType of the resource on loan |
Server | Identity | The Id and Name of the server |
OnLoanToGroup | Identity | The Id, Name and ResourceType of the group the resource is on loan to |
OnLoanDate | DateTime? | The date the resource is on loan. |
EmailAddress | String | Email address of the resource that is on loan |
TotalDurationInMinutes | Int64 | The number of minutes the resource is on loan on OnLoanDate |
DurationHours | Int16 | Not populated |
DurationMins | Int16 | Not populated |
DayOfWeek | Int16 | Not populated |
ResourceSummary GetResourceSummary | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves summary details of the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information of the resource whose resource summary information needs to be retrieved.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Object containing the Id, Name and ResourceType of the resource |
Category | Identity | Object containing the Id and Name of the category the resource belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
UserId | String | The NTName of the resource |
ResourceImageUrl | String | Path to the image assocaited with the resource |
ImageUrl | String | Always the same as ResourceImageUrl |
EmailAddress | String | Email address of the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
ResourceIdentity GetResourceSupervisor | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the supervisor of the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information of the resource whose supervisor information needs to be retrieved.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Name of the resource |
Resource Type | Int16 | Not populated |
ResourceSummaryCollection GetResourcesUsingSearchCriteria | ( | string | sessionId, |
ResourceSearchFilter | resourceSearchFilter | ||
) |
Method to return a list of Resource details depending on the parameters passed into the method These parameters will be used as criteria for the returned list to be based upon.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||
resourceSearchFilter | A ResourceSearchFilter object containing the filter criteria to retrieve the resources.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Object containing the Id, Name and ResourceType of the resource |
Category | Identity | Object containing the Id and Name of the category the resource belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
UserId | String | The NTName of the resource |
ResourceImageUrl | String | Path to the image assocaited with the resource |
ImageUrl | String | Always the same as ResourceImageUrl |
EmailAddress | String | Email address of the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
ResourceIdentity GetResourceWorkingGroup | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the working group assigned to the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource information to retrieve the working group.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Name of the resource |
Resource Type | Int16 | Not populated |
ResourceIdentityCollection GetRoleMembers | ( | string | sessionId, |
ResourceIdentity | roleIdentity | ||
) |
Retrieves a list of the resources that are members of a specified role.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
roleIdentity | A ResourceIdentity object containing the resource information to retrieve the roles.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the resource |
Name | String | Name of the resource |
Resource Type | Int16 | Not populated |
SkillLevelHistoryCollection GetSkillLevelHistory | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ProcessIdentity | processIdentity | ||
) |
Retrieves the history of the skill level of a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource information to retrieve the skill level history.
| ||||||||||||||||
processIdentity | A ProcessIdentity object containing the process information to retrieve the skill level history.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id, Name and ResourceType that the skill level is attached to |
LastModifiedBy | Identity | The resource that last modified the skill level |
Category | Identity | Id and Name of the process the skill level is attached to |
DateModified | DateTime | Date the skill level was last modified |
Comment | String | Comment attached to the skill level |
SkillLevel GetSkillLevelOfResourceForProcess | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ProcessIdentity | processIdentity | ||
) |
Retrieves the skill level for a speciified resource within a specified process.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity specifying the resource to retrieve the skill level for.
| ||||||||||||||||
processIdentity | A ProcessIdentity specifying the process to retrieve the skill level for.
|
Name | Type | Comment |
---|---|---|
Level | Int16 | The skill level of the resource |
Name | String | Name attached to the skill level |
LastModifiedDate | DateTime | The date the skill level was last modified |
LastModifiedResource | Identity | Id, Name and ResourceType of the resource that last modifed the skill level |
SubordinateCollection GetSubordinateGroups | ( | string | sessionId, |
ResourceIdentity | groupResource, | ||
bool | recursiveGroups | ||
) |
Retrieves a list of groups for which the specified resource is the supervisor. Subordinates of those groups can also be returned.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
groupResource | A ResourceIdentity object containing the resource id for which to retrieve the subordinate groups. worker resource should only be specified and not the group resource.
| ||||||||||||||||
recursiveGroups | If set to true then each group found will also be checked for subordinates. Defaults to false. |
Name | Type | Comment |
---|---|---|
Identity | ResourceIdentity | Id, Name and ResourceType that the skill level is attached to |
Server | ServerIdentity | Id and Name of the server |
DateModified | DateTime | Date the skill level was last modified |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
EmailAddress | String | Email address of the subordinate group |
recursiveGroups | Resources returned |
---|---|
FALSE | Groups that have the specified resource as a supervisor. |
TRUE | As above but groups that are members of those groups will also be returned and so on. |
SubordinateCollection GetSubordinates | ( | string | sessionId, |
ResourceIdentity | resource, | ||
SubordinateFilter | subordinateFilter | ||
) |
This function is deprecated. Please use GetSubordinates2 instead.
Retrieves all direct worker subordinates of the specified resource
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
resource | A ResourceIdentity object containing the resource id to retrieve the subordinates.
| ||||||||||||||||||||
subordinateFilter | A SubordinateFilter object containing the filter criteria to retrieve the subordinates.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id, Name and ResourceType that the skill level is attached to |
Server | Identity | Id and Name of the server |
DateModified | DateTime | Date the skill level was last modified |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
EmailAddress | String | Email address of the subordinate group |
SubordinateCollection GetSubordinates2 | ( | string | sessionId, |
ResourceIdentity | resource, | ||
SubordinateFilter2 | subordinateFilter | ||
) |
Retrieves all direct worker subordinates of the specified resource
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||
resource | A ResourceIdentity object containing the resource id to retrieve the subordinates.
| ||||||||||||||||||||||||||||||||||||
subordinateFilter | A SubordinateFilter2 object containing the filter criteria to retrieve the subordinates.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id, Name and ResourceType that the skill level is attached to |
Server | Identity | Id and Name of the server |
DateModified | DateTime | Date the skill level was last modified |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
EmailAddress | String | Email address of the subordinate group |
SubordinateCollection GetSupervisors | ( | string | sessionId, |
SupervisorFilter | supervisorFilter | ||
) |
Retrieves all the supervisors based on the specified search filter criteria
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
supervisorFilter | A SupervisorFilter object containing the filter criteria to retrieve the supervisors.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id, Name and ResourceType that the skill level is attached to |
Server | Identity | Id and Name of the server |
DateModified | DateTime | Date the skill level was last modified |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
EmailAddress | String | Email address of the subordinate group |
SupervisorCollection GetSupervisors2 | ( | string | sessionId, |
SupervisorFilter | supervisorFilter | ||
) |
Retrieves all the supervisors based on the specified search filter criteria
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
supervisorFilter | A SupervisorFilter object containing the filter criteria to retrieve the supervisors.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id, Name and ResourceType |
Server | Identity | Id and Name of the server |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 otherwise. |
EmailAddress | String | Email address of the Supervisor |
WorkAllocationRule GetWorkAllocationRuleForGroup | ( | string | sessionId, |
ResourceIdentity | groupIdentity | ||
) |
Retrieves the work allocation rule details assigned to the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
groupIdentity | A ResourceIdentity object containing the resource group id information to retrieve the work allocation rule.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id and Name of the Work Allocation Rule |
Id | String | Id of the Work Allocation Rule |
Name | String | The name of the rule |
Description | String | The description of the rule |
Category | Identity | Id and Name of the category that the rule belongs to |
RuleData | Object | Details of the rule itself |
LastModifiedResource | Identity | Id, Name and ResourceType that the skill level is attached to |
LastModifiedDate | DateTime | Date the skill level was last modified |
WorkerGroupResource GetWorkerGroupResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the full details of the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id to retrieve the worker group resource.
|
Name | Type | Comment |
---|---|---|
AssociatedResources | Collection | Collection of associated resources |
WorkAllocationRule | Identity | Id and Name of the Work Allocation Rule associated with the resource |
Identity | Identity | The Id, Name and ResourceType of the resource |
Category | Identity | The category the group belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the group |
SkillLevelMin | Int32 | Minimum skill level of the group |
EmailAddress | String | Email address of the resource |
Supervisor | Identity | Id, NAme and ResourceType of the resource's supervisor |
LastModifiedUser | Identity | Id, NAme and ResourceType of the resource that last modifeid the specified resource |
LastModifiedDate | DateTime | Date the resource was last modified |
NTName | String | The resource's user name |
resourceType | Int16 | The type of the resource |
GroupId | Identity | The Id, Name and ResourceType of the resource |
ExtensionFields | Collection | Collection of fields that hold extra information |
WorkerGroupResource3 GetWorkerGroupResource2 | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves details of the specified worker group resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id to retrieve the worker group resource.
|
Name | Type | Comment |
---|---|---|
AssociatedResources | Collection | Collection of associated resources |
Identity | Identity | The Id, Name and ResourceType of the resource |
Category | Identity | The category the group belongs to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the group |
SkillLevelMin | Int32 | Minimum skill level of the group |
EmailAddress | String | Email address of the resource |
Supervisor | Identity | Id, NAme and ResourceType of the resource's supervisor |
LastModifiedUser | Identity | Id, NAme and ResourceType of the resource that last modifeid the specified resource |
LastModifiedDate | DateTime | Date the resource was last modified |
NTName | String | The resource's user name |
resourceType | Int16 | The type of the resource |
GroupId | Identity | The Id, Name and ResourceType of the resource |
ExtensionFields | Collection | Collection of fields that hold extra information |
WorkerResource GetWorkerResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
This function is deprecated. Please use GetWorkerResource2 instead.
Retrieves the full details of a worker resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id to retrieve the worker resource.
|
Name | Type | Comment |
---|---|---|
FixedCostRate | Double | Fixed cost of the resource |
VariableCostRate | Double | Variable cost of the resource |
VariableCostPeriod | Double | Unit of time for variable costs |
WorkingCategory | Identity | Category that the resource will be working in |
Password | String | Returns a password mask if specified for the resource |
ManagerialLevel | Int16 | Managerial level of the resource |
WorkingGroup | Identity | Group the resource will be working in |
StartDate | DateTime | Date the resource is valid from |
EndDate | DateTime | Date the resource is valid to |
PasswordChanged | Boolean | Indicates that the password has changed |
Identity | Identity | Object containing the name of the resource to be added |
Category | Identity | Category the resource should assigned to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
EmailAddress | String | Email address of participant |
Supervisor | Identity | Resource's supervisor id |
LastModifiedUser | Identity | The last user to modify the resource |
LastModifiedDate | DateTime | Date the resource was last modified |
NTName | String | Resource's name in the Windows environment |
GroupId | Identity | The group the resource is to be attached to |
Supervisor | Identity | Resource's supervisor id |
ExtensionFields | Collection | Collection of ExtensionFields for any additional information |
WorkerResource2 GetWorkerResource2 | ( | string | sessionId, |
ResourceIdentity | resource | ||
) |
Gets the full details of the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resource | The resource.
|
Name | Type | Comment |
---|---|---|
PersonaIdentity | Identity | Details of the resource's persona |
PersonaIdentity | Identity | The Id and Name of the associated Persona |
FixedCostRate | Double | Fixed cost of the resource |
VariableCostRate | Double | Variable cost of the resource |
VariableCostPeriod | Double | Unit of time for variable costs |
WorkingCategory | Identity | Category that the resource will be working in |
Password | String | Returns a password mask if specified for the resource |
ManagerialLevel | Int16 | 1-10 if resource is a manager, 99 othwerwise |
WorkingGroup | Identity | Group the resource will be working in |
StartDate | DateTime? | Date the resource is valid from |
EndDate | DateTime? | Date the resource is valid to |
PasswordChanged | Boolean | Indicates that the password has changed |
Identity | Identity | Object containing the name of the resource to be added |
Category | Identity | Category the resource should assigned to |
SecurityLevel | Int32 | Security level of the resource |
SkillLevelMax | Int32 | Maximum skill level of the resource |
SkillLevelMin | Int32 | Minimum skill level of the resource |
EmailAddress | String | Email address of participant |
Supervisor | Identity | Resource's supervisor id |
LastModifiedUser | Identity | The last user to modify the resource |
LastModifiedDate | DateTime | Date the resource was last modified |
NTName | String | Resource's name in the Windows environment |
GroupId | Identity | The group the resource is to be attached to |
Supervisor | Identity | Resource's supervisor id |
ExtensionFields | Collection | Collection of ExtensionFields for any additional information |
CategoryIdentity GetWorkingCategory | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the working category details of the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to retrieve the category for.
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the category |
Name | String | Name of the category |
int GetWorkingDaysBetweenDatesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
bool | useOnLoanGroupResourceId, | ||
ResourceIdentity | onLoanGroupResourceIdentity | ||
) |
Retrieves the number of working days between two specified dates for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to retrieve the working days for. While creating this resource make sure that Working Group has been assigned.
| ||||||||||||||||
fromDate | From Date. This must be specified. | ||||||||||||||||
toDate | To Date. This must be specified. | ||||||||||||||||
useOnLoanGroupResourceId | If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit | ||||||||||||||||
onLoanGroupResourceIdentity | object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true . |
true
then the resource's calendar will be checked on a day by day basis.int GetWorkingHoursBetweenDatesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
bool | useOnLoanGroupResourceId, | ||
ResourceIdentity | onLoanGroupResourceIdentity | ||
) |
Retrieves the number of working hours between two specified dates for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to retrieve the working hours for.
| ||||||||||||||||
fromDate | From Date. This must be specified. | ||||||||||||||||
toDate | To Date. This must be specified. | ||||||||||||||||
useOnLoanGroupResourceId | If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit | ||||||||||||||||
onLoanGroupResourceIdentity | object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true . |
true
then the resource's calendar will be checked on a day by day basis.TimePeriod GetWorkingHoursBreakdownForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
int | hours | ||
) |
Converts the specified number of hours into a resource's working time.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id to retrieve the working hours breakdown.
| ||||||||||||||||
hours | Number of working hours to breakdown. |
Name | Type | Comment |
---|---|---|
Days | In16 | The number of days the resource was on loan for. |
Hours | In16 | The number of hours the resource was on loan for. |
Minutes | In16 | The number of minutes the resource was on loan for. |
Seconds | In16 | The number of seconds the resource was on loan for. |
FormattedAsString | String | The TimePeriod in string format. |
TotalSeconds | In16 | Always 0 |
TotalMinutes | In16 | Always 0 |
int GetWorkingMinutesBetweenDatesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
bool | useOnLoanGroupResourceId, | ||
ResourceIdentity | onLoanGroupResourceIdentity | ||
) |
Retrieves the number of working minutes between two specified dates for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to retrieve the working hours for.
| ||||||||||||||||
fromDate | From Date. This must be specified. | ||||||||||||||||
toDate | To Date. This must be specified. | ||||||||||||||||
useOnLoanGroupResourceId | If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit | ||||||||||||||||
onLoanGroupResourceIdentity | object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true . |
true
then the resource's calendar will be checked on a day by day basis.TimePeriod GetWorkingMinutesBreakdownForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
int | minutes | ||
) |
Converts the specified number of minutes into a resource's working time.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id to retrieve the working minutes breakdown.
| ||||||||||||||||
minutes | Number of working minutes to breakdown. |
Name | Type | Comment |
---|---|---|
Days | In16 | The number of days the resource was on loan for. |
Hours | In16 | The number of hours the resource was on loan for. |
Minutes | In16 | The number of minutes the resource was on loan for. |
Seconds | In16 | The number of seconds the resource was on loan for. |
FormattedAsString | String | The TimePeriod in string format. |
TotalSeconds | In16 | Always 0 |
TotalMinutes | In16 | Always 0 |
int GetWorkingSecondsBetweenDatesForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
bool | useOnLoanGroupResourceId, | ||
ResourceIdentity | onLoanGroupResourceIdentity | ||
) |
Retrieves the number of working seconds between two specified dates for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to retrieve the working hours for.
| ||||||||||||||||
fromDate | From Date. This must be specified. | ||||||||||||||||
toDate | To Date. This must be specified. | ||||||||||||||||
useOnLoanGroupResourceId | If set to true then the specified group by onLoanGroupResourceIdentity will be used as a credit | ||||||||||||||||
onLoanGroupResourceIdentity | object specifying the group to consider. Must be specified if useOnLoanGroupResourceId is set to true . |
true
then the resource's calendar will be checked on a day by day basis.TimePeriod GetWorkingSecondsBreakdownForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
int | seconds | ||
) |
Converts the specified number of seconds into a resource's working time.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id to retrieve the working seconds breakdown.
| ||||||||||||||||
seconds | Number of working seconds to breakdown. |
Name | Type | Comment |
---|---|---|
Days | In16 | The number of days the resource was on loan for. |
Hours | In16 | The number of hours the resource was on loan for. |
Minutes | In16 | The number of minutes the resource was on loan for. |
Seconds | In16 | The number of seconds the resource was on loan for. |
FormattedAsString | String | The TimePeriod in string format. |
TotalSeconds | In16 | Always 0 |
TotalMinutes | In16 | Always 0 |
TimePeriod GetWorkingTimeBetweenDatesForResource | ( | string | sessionId, |
ResourceTimeFilter | resourceTimeFilter | ||
) |
Retrieves the working time between two specified dates for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
resourceTimeFilter | A ResourceTimeFilter that specifies the resource and date details.
|
Name | Type | Comment |
---|---|---|
Days | In16 | The number of days the resource was on loan for. |
Hours | In16 | The number of hours the resource was on loan for. |
Minutes | In16 | The number of minutes the resource was on loan for. |
Seconds | In16 | The number of seconds the resource was on loan for. |
FormattedAsString | String | The TimePeriod in string format. |
TotalSeconds | In16 | Always 0 |
TotalMinutes | In16 | Always 0 |
true
then the resource's calendar will be checked on a day by day basis.bool IsExcludedFromManualWorkAllocation | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Determines whether the resource has been excluded from muanl work allocation using ExcludeFromManualWorkAllocation method.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity resource for which the check should be carried out.
|
true
if the resource is exculded, falsde
otherwise.bool IsResourceInGroup | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ResourceIdentity | groupIdentity | ||
) |
Determines whether the specified resource is in the specified group
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information of the resource to check whether the resource exists in the group or not.
| ||||||||||||||||
groupIdentity | A ResourceIdentity object containing the resource id information of the group resource to check whether the resource exists in group or not.
|
true
, if the specified resource is a member of specified group, false
otherwise. bool IsWorkingDateTimeForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | dateToCheck | ||
) |
Determines whether the specified datetime is a working day for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource whose working day is to be checked.
| ||||||||||||||||
dateToCheck | Date to check. Must be specified. |
true
if dateToCheck falls within the resources working time, false
otherwise.false
. bool IsWorkingDayForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
DateTime | dateToCheck | ||
) |
Determines whether the specified date is a working day for the resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information of the resource to retrieve the working day.
| ||||||||||||||||
dateToCheck | Date to be checked. Please note that any time part will be ignored. Must be specified. |
true
if the resource is working at any point on the given day, false
otherwise.true
. LdapSynchonizationErrors ProcessLdapSynchronizationErrors | ( | string | sessionId, |
LdapSynchronizationData | synchronizationData | ||
) |
Processes the specified LDAP synchronization errors.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||
synchronizationData | A LdapSynchronizationData object containing the LDAP synchronization data.
|
Name | Type | Comment |
---|---|---|
Successful | Boolean | Indicates whether the method worked correctly |
CriticalError | Boolean | Indicates that any failure is critical |
ErrorXml | Boolean | The error text returned by the LDAP server |
void RemoveExclusionFromManualWorkAllocation | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Allow resource to be available for manual work allocation.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object for the resource to be used.
|
void RemoveResourceFromGroup | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ResourceIdentity | groupIdentity | ||
) |
Removes the specified resource from the specified group.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to be removed.
| ||||||||||||||||
groupIdentity | A ResourceIdentity object specifying the group the resource is to be removed from.
|
bool RemoveSkillLevelForResourceAndProcess | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ProcessIdentity | processIdentity, | ||
string | comments | ||
) |
Removes the existing skill level for a specified resource for a specified process
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object containing the resource id information of the resource to remove the skill level.
| ||||||||||||||||
processIdentity | A ProcessIdentity object containing the process id information to remove the skill level.
| ||||||||||||||||
comments | A string for comments that will be added to the audit log, if it is enabled |
void RemoveSubordinatesExclusionFromManualWorkAllocation | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Removes exclusion from manual work allocation for each resource that is a subordinate of the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object that specifies the resource to check for subordinates.
|
void RemoveWorkAllocationRuleFromGroup | ( | string | sessionId, |
ResourceIdentity | groupIdentity, | ||
WorkAllocationRuleIdentity | ruleIdentity | ||
) |
Removes the specified work allocation rule from the specified group.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
groupIdentity | A ResourceIdentity object containing the details of the group resource to remove the work allocation rule from.
| ||||||||||||||||
ruleIdentity | A WorkAllocationRuleIdentity object containing the rule id information of the work allocation rule that needs to be removed.
|
LdapSynchronizationResult SynchronizeWithLdap | ( | string | sessionId, |
LdapSynchronizationSettings | settings | ||
) |
Synchronizes the with an LDAP Server in order to retrieve a list of users which will be added to the resources available within TotalAgility.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||
settings | A LdapSynchronizationSettings object containing the LDAP synchronization settings.
|
Name | Type | Comment |
---|---|---|
LastSequenceChangeNumber | String | Used to keep track of changes in the LDAP server. |
Successful | Boolean | Indicates whether the method worked correctly |
ErrorXml | String | The error text returned by the LDAP server |
CriticalError | Boolean | Indicates that any failure is critical |
CriticalErrorText | String | Critical error message |
void UnDelegate | ( | string | sessionId, |
ResourceIdentity | delegator | ||
) |
Removes any delegation from the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
delegator | A ResourceIdentity object specifying resource that is delgating tasks to another resource.
|
void UpdateCaseParticipant | ( | string | sessionId, |
WorkerResource | resource | ||
) |
Please note that this function is deprecated. Please use UpdateCaseParticipant2 instead.
Updates the details for for specified case participant.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource object containing the resource information of the worker resource to update the information.
|
void UpdateCaseParticipant2 | ( | string | sessionId, |
UpdatedCaseParticipant | resource, | ||
bool | overwrite | ||
) |
Updates the case participants for a specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||
resource | A UpdatedCaseParticipant object deriving from the CaseParticipant2 class containing the resource information of the worker resource to update the information.
| ||||||||||||||||||||||||||||||||||||||||||||
overwrite | if set to true [overwrite]. |
void UpdateDelegation | ( | string | sessionId, |
DelegateInfo | delegateInfo, | ||
bool | overwrite | ||
) |
Updates the specified delegation and optionally overwrites it
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||
delegateInfo | A DelegateInfo object containing the delegate information to update the delegation details.
| ||||||||||||||||||||||||||||||||||||
overwrite | Set to true to replace a delegation. |
false
means that the method will always fail.void UpdateExternalWorkerGroupResource | ( | string | sessionId, |
WorkerGroupResource | resource, | ||
bool | overwrite | ||
) |
This method is deprecated. Please use UpdateCaseParticipant2 instead
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
resource | A Model.Resources.WorkerGroupResource object specifying the worker group and the details to update. |
overwrite | True, to overwrite; false, otherwise. |
void UpdateNotesStatus | ( | string | sessionId, |
NoteIdentityCollection | noteIdCollection, | ||
short | status | ||
) |
Updates the status of all the specified notes to either read or unread.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
noteIdCollection | A Collection of type NoteIdentity. At least one must be specified..
| ||||||||
status | The status that the specified notes will be set to. Valid values are:
|
void UpdateResourceSupervisor | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ResourceIdentity | supervisorIdentity | ||
) |
Assigns a supervisor to the specified resource, replacing any existing supervisor.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to update.
| ||||||||||||||||
supervisorIdentity | A ResourceIdentity object containing the details of the supervisor.
|
void UpdateResourceWorkingGroup | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
ResourceIdentity | workingGroup | ||
) |
Assigns the specified working group to the specified respurce, replacing any existing working group.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity object specifying the resource to update.
| ||||||||||||||||
workingGroup | A ResourceIdentity object specifying the working group to be assigned to the resource.
|
void UpdateWorkerGroupResource | ( | string | sessionId, |
WorkerGroupResource | resource, | ||
bool | overwrite | ||
) |
Please note that this function is deprecated. Please use UpdateWorkerGroupResource2 instead.
Updates the worker group resource information, optionally replacing any existing information.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerGroupResource object containing the worker group resource information that needs to be updated.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
overwrite | Indicates whether the group should be updated regardless od any other changes that may happened. Defaults to false |
false
then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database. void UpdateWorkerGroupResource2 | ( | string | sessionId, |
WorkerGroupResource2 | resource, | ||
bool | overwrite | ||
) |
Updates the worker group resource information, optionally replacing any existing information.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerGroupResource2 object containing the worker group resource information that needs to be updated.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
overwrite | Indicates whether the group should be updated regardless of any other changes that may happened. Defaults to false |
false
then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database. void UpdateWorkerGroupResource3 | ( | string | sessionId, |
WorkerGroupResource2 | resource, | ||
ResourceIdentityCollection | addMembers, | ||
ResourceIdentityCollection | removeMembers, | ||
bool | overwrite | ||
) |
Updates the worker group resource information using the addMember and removeMembers parameters.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerGroupResource2 object containing the worker group resource information that needs to be updated.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
addMembers | A collection of type ResourceIdentity that indicate what members are to be added to the group resource
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removeMembers | A collection of type ResourceIdentity that indicate what members sre to be removed from the group resource
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
overwrite | Indicates whether the group should be updated regardless of any other changes that may happened. Defaults to false |
false
then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database. void UpdateWorkerResource | ( | string | sessionId, |
WorkerResource | resource, | ||
bool | overwrite | ||
) |
This function is deprecated. Please use UpdateWorkerResource2 instead.
Updates the worker resource information with the specified information.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource object containing the worker resource information that needs to be updated.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
overwrite | True to overwrite; false otherwise. |
void UpdateWorkerResource2 | ( | string | sessionId, |
WorkerResource2 | resource, | ||
bool | overwrite | ||
) |
Updates a resource based on the specified details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource2 object containing the details of the resource particpant to add.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
overwrite | Indicates whether the resource should be updated regardless of any other changes that may happened. Defaults to false |
false
then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database. void UpdateWorkerResource3 | ( | string | sessionId, |
WorkerResource2 | resource, | ||
ResourceIdentityCollection | addToGroups, | ||
ResourceIdentityCollection | removeFromGroups, | ||
bool | overwrite | ||
) |
Updates a resource based on the specified details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource | A WorkerResource2 object containing the details of the resource particpant to add.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
addToGroups | A collection that indicates groups the resource is to be added to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removeFromGroups | A collection that indicates groups the resource is to be removed from | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
overwrite | Indicates whether the resource should be updated regardless of any other changes that may happened. Defaults to false |
false
then LastModifiedDate must be specified and has to match the LastModifedDate stored on the database.