Provides methods to create case process, case fragment for a case process, update the status of case process and manage properties for case process and case fragment. More...
Public Member Functions | |
void | ActivateCase (string sessionId, CaseIdentity caseIdentity, bool activateAllAssociatedJobs) |
Activates the specified case and associated jobs, if any exist. More... | |
void | AddCaseNote (string sessionId, CaseIdentity caseIdentity, NoteInfo noteInfo) |
Adds a note to a specified case. More... | |
void | AddCaseRoleMember (string sessionId, CaseIdentity caseIdentity, RoleIdentity roleIdentity, ResourceIdentity resourceIdentity) |
Adds a member to a specified role for a specified case. More... | |
void | AddLinkedCase (string sessionId, CaseIdentity sourceCase, CaseIdentity targetCase, string linkDescription) |
Adds a link for a source case process and target case process and also provides a description of the link. More... | |
void | AddRoleMember (string sessionId, CaseIdentity caseIdentity, RoleIdentity roleIdentity, ResourceIdentity resourceIdentity) |
Adds a member to a role for a specified case. More... | |
void | ChangeCaseState (string sessionId, CaseIdentity caseIdentity, string jobState) |
Changes the state of a specified case and performs any actions associated with that state. More... | |
void | CloseCase (string sessionId, CaseIdentity caseIdentity) |
Closes the specified case. More... | |
bool | ConfirmCaseDocument (string sessionId, CaseIdentity caseIdentity, DocumentTypeIdentity documentTypeIdentity) |
Confirms the case document. More... | |
JobIdentity | CreateCase2 (string sessionId, ProcessIdentity processIdentity, string caseReference, CaseInitialization caseInitialization) |
Creates a case on the specified case definition process. More... | |
JobProgressOutput | CreateCaseAndProgress (string sessionId, ProcessIdentity processIdentity, string caseReference, CaseInitialization caseInitialization) |
Creates a job for a specified case and executes all automatic activities and returns the pending manual activity(s) if available, job id, and job status. More... | |
JobIdentity | CreateCaseWithDocuments (string sessionId, ProcessIdentity processIdentity, string caseReference, CaseWithDocumentsInitialization caseWithDocumentsInitialization) |
Creates a new instance (a job) for the specified case definition process map. More... | |
JobWithDocumentsProgressOutput2 | CreateCaseWithDocumentsAndProgress2 (string sessionId, ProcessIdentity processIdentity, string caseReference, CaseWithDocumentsInitialization caseWithDocumentsInitialization, VariableIdentityCollection variablesToReturn) |
Creates a new instance (a job) for the specified case definition process map. In addition, if automatic activities are the first actviites of the job, they will be performed until the job is finished or only manual activities are pending. More... | |
void | DeleteLinkedCase (string sessionId, CaseIdentity sourceCase, CaseIdentity targetCase) |
Deletes the link between the source case and the target case. More... | |
void | DeleteRoleMember (string sessionId, CaseIdentity caseIdentity, RoleIdentity roleIdentity, ResourceIdentity resourceIdentity) |
Deletes the role member from a role for a specified case. More... | |
bool | DoesCaseExist (string sessionId, CaseIdentity caseIdentity) |
Checks if there is already a case with the specified case reference. More... | |
void | ForceValidCaseDocument (string sessionId, CaseIdentity caseIdentity, DocumentTypeIdentity documentTypeIdentity, string comment) |
Forces the valid case document. More... | |
JobEventCollection | GetCaseEvents (string sessionId, CaseIdentity caseIdentity) |
Retrieves the list of events for a specified case. More... | |
JobHistoryCollection | GetCaseHistory (string sessionId, CaseIdentity caseIdentity, bool associatedJobs) |
Retrieves the case history with details such as activities performed and associated jobs if specified. More... | |
JobIdentity | GetCaseId (string sessionId, CaseIdentity caseIdentity) |
Retrieves the case id for a specified case reference. More... | |
CaseIdentity | GetCaseIdentity (string sessionId, CaseIdentity caseIdentity) |
Gets the case identity. More... | |
JobProperties | GetCaseJobProperties (string sessionId, CaseIdentity caseIdentity, JobHistoryFilter filter) |
Retrieves the properties of the specified case. More... | |
JobMilestoneCollection | GetCaseMilestones (string sessionId, CaseIdentity caseIdentity) |
Retrieves the list of milestones for a specified case. More... | |
JobNoteCollection | GetCaseNotes (string sessionId, CaseIdentity caseIdentity, CaseNoteFilter caseNoteFilter) |
Retrieves the case notes for the specified case. More... | |
JobRole2 | GetCaseRole2 (string sessionId, CaseIdentity caseIdentity, RoleIdentity roleIdentity) |
Retrieves the details of a role for the specified case. More... | |
JobRole2Collection | GetCaseRoles2 (string sessionId, CaseIdentity caseIdentity) |
Retrieves the details of all roles for a specified case. More... | |
StateCollection | GetCaseStates (string sessionId, ProcessIdentity processIdentity) |
Retrieves all states for the specified case definition. More... | |
CaseSummary | GetCaseSummary (string sessionId, CaseIdentity caseIdentity) |
Gets the case summary. More... | |
VariableAssociationCollection | GetCaseVariableAssociations (string sessionId, ProcessIdentity processIdentity) |
Retrieves all the variable associations for the specified case process. More... | |
VariableValueCollection | GetCaseVariablesValues (string sessionId, CaseIdentity caseIdentity, VariableIdentityCollection variableIdentityCollection) |
Retrieves the specified variables value for the specified case. More... | |
JobInfoCollection | GetJobsAssociatedWithCase (string sessionId, CaseIdentity caseIdentity) |
Retrieves all the jobs that are associated with the specified case. More... | |
LinkedCaseCollection | GetLinkedCasesForCase (string sessionId, CaseIdentity caseIdentity) |
Retrieves all linked cases for the specified case. More... | |
ProcessIdentityCollection | GetProcessesForCase (string sessionId, CategoryIdentity category, CaseIdentity caseIdentity) |
Gets the processes for specified case. More... | |
void | PutCaseOnHold (string sessionId, CaseIdentity caseIdentity, OnHoldOptions onHoldOptions) |
The specified case is placed on hold based on the on hold options. Note: The expected finish time and the expected duration of a case will be updated by the amount of time the case was on hold when the case is taken off hold. Also escalations will not fire while the job is on hold More... | |
void | RaiseEvent (string sessionId, CaseIdentity caseIdentity, string eventName, string eventSource, InputVariableCollection updatedVariables) |
Raises a case process event for the specified case. More... | |
void | ReceivedCaseDocument (string sessionId, CaseIdentity caseIdentity, DocumentIdentity documentIdentity, bool useSource, string source, bool useStatus, short status) |
Documents Received will be added with the status of Received and if the docuemnt already exists it will be updated with the given status. More... | |
void | ReevaluateCaseDocumentRequiredDates (string sessionId, CaseIdentity caseIdentity) |
Reevaluate the required dates for documents on a document set in a running case More... | |
void | ReplaceRoleMembers (string sessionId, CaseIdentity caseIdentity, RoleIdentity roleIdentity, ResourceIdentityCollection resourceIdentityCollection) |
Replaces the members for the specified role. More... | |
void | SuspendCase (string sessionId, CaseIdentity caseIdentity, bool suspendAllAssociatedJobs) |
Suspends the specified case. More... | |
void | TakeCaseOffHold (string sessionId, CaseIdentity caseIdentity, bool takeOffHoldAllAssociatedJobs) |
Takes the specified case off hold. More... | |
void | UpdateCaseMilestoneActualDate (string sessionId, CaseIdentity caseIdentity, JobMilestone jobMilestone, ResourceIdentity resourceIdentity) |
Updates the actual date of the specified case milestone. More... | |
void | UpdateCaseMilestoneTargetDate (string sessionId, CaseIdentity caseIdentity, JobMilestone jobMilestone) |
Updates the target date of the specified case milestone. More... | |
void | UpdateCaseReference (string sessionId, CaseIdentity caseIdentity, string newCaseReference) |
Updates the existing case reference with the new case reference value. More... | |
void | UpdateCaseSpend (string sessionId, CaseIdentity caseIdentity, double newSpendValue) |
Updates the amount spent for the specified case. More... | |
void | UpdateLinkedCase (string sessionId, CaseIdentity sourceCase, CaseIdentity oldTargetCase, CaseIdentity newTargetCase, string linkDescription) |
Replaces the old target case with a new target case for the specified source case. More... | |
Provides methods to create case process, case fragment for a case process, update the status of case process and manage properties for case process and case fragment.
void ActivateCase | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
bool | activateAllAssociatedJobs | ||
) |
Activates the specified case and associated jobs, if any exist.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs to be activated. Cannot be null
| ||||||||||||
activateAllAssociatedJobs | If true then all associated jobs (fragments and business processes) are activated. |
void AddCaseNote | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
NoteInfo | noteInfo | ||
) |
Adds a note to a specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case to which the note has to be added. Cannot be null
| ||||||||||||
noteInfo | A NoteInfo object that specifies the note text and type. Cannot be null
|
void AddCaseRoleMember | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
RoleIdentity | roleIdentity, | ||
ResourceIdentity | resourceIdentity | ||
) |
Adds a member to a specified role for a specified case.
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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case in which the resource specified in the resourceIdentity parameter needs to added as a floating role member. Cannot be null
| ||||||||||||||||
roleIdentity | A RoleIdentity identity object indicating the id of the role to which we must add a member. Cannot be null
| ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object containing the id of the resource that needs to be added as a member. Cannot be null
|
void AddLinkedCase | ( | string | sessionId, |
CaseIdentity | sourceCase, | ||
CaseIdentity | targetCase, | ||
string | linkDescription | ||
) |
Adds a link for a source case process and target case process and also provides a description of the link.
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. | ||||||||||||
sourceCase | A CaseIdentity identity object indicating the case that needs to be linked to the target case. Cannot be null
| ||||||||||||
targetCase | A CaseIdentity identity object indicating the case that needs to be linked to the source case. Cannot be null
| ||||||||||||
linkDescription | A description of the link between the cases. Can be null |
void AddRoleMember | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
RoleIdentity | roleIdentity, | ||
ResourceIdentity | resourceIdentity | ||
) |
Adds a member to a role for a specified case.
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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case in which the resource specified in the resourceIdentity parameter needs to added as a floating role member. Cannot be null
| ||||||||||||||||
roleIdentity | A RoleIdentity identity object indicating the id of the role to which we must add a member. Cannot be null
| ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object containing the id of the resource that needs to be added as a member. Cannot be null
|
void ChangeCaseState | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
string | jobState | ||
) |
Changes the state of a specified case and performs any actions associated with that state.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating for which case the state needs to be changed. Cannot be null
| ||||||||||||
jobState | A string containing the name of the state to which the case has to be updated. Cannot be null or an empty string |
void CloseCase | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Closes the specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs to be closed. Cannot be null
|
bool ConfirmCaseDocument | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
DocumentTypeIdentity | documentTypeIdentity | ||
) |
Confirms the case document.
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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
| ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity identity object indicating the document type. Cannot be null
|
JobIdentity CreateCase2 | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
string | caseReference, | ||
CaseInitialization | caseInitialization | ||
) |
Creates a case on the specified case definition 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 identity object that identifies the case process to create a job for. Cannot be null
| ||||||||||||||||
caseReference | The case reference. If not provided, then the case id will be used as the case reference. | ||||||||||||||||
caseInitialization | A CaseInitialization object that contains the process initialization variables for the specified case definition process. The variables in the job will be updated with the corresponding values. Can be null
|
JobProgressOutput CreateCaseAndProgress | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
string | caseReference, | ||
CaseInitialization | caseInitialization | ||
) |
Creates a job for a specified case and executes all automatic activities and returns the pending manual activity(s) if available, job id, and job status.
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 identity object that identifies the case process to create a job for. Cannot be null
| ||||||||||||||||
caseReference | The case reference. If not provided, then the case id will be used as the case reference. | ||||||||||||||||
caseInitialization | A CaseInitialization object that contains the process initialization variables for the specified case definition process. The variables in the job will be updated with the corresponding values.
|
JobIdentity CreateCaseWithDocuments | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
string | caseReference, | ||
CaseWithDocumentsInitialization | caseWithDocumentsInitialization | ||
) |
Creates a new instance (a job) for the specified case definition process map.
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 identity object containing the case process id on which the job needs to be created along with documents. Cannot be null
| ||||||||||||||||
caseReference | The case reference. If not provided, then the case id will be used as the case reference. | ||||||||||||||||
caseWithDocumentsInitialization | A CaseWithDocumentsInitialization object that contains the initialization variables for the new case job. The variables in the job will be updated with the corresponding values. Cannot be null
|
JobWithDocumentsProgressOutput2 CreateCaseWithDocumentsAndProgress2 | ( | string | sessionId, |
ProcessIdentity | processIdentity, | ||
string | caseReference, | ||
CaseWithDocumentsInitialization | caseWithDocumentsInitialization, | ||
VariableIdentityCollection | variablesToReturn | ||
) |
Creates a new instance (a job) for the specified case definition process map. In addition, if automatic activities are the first actviites of the job, they will be performed until the job is finished or only manual activities are pending.
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 identity object containing the case process id on which the job needs to be created (along with documents). Cannot be null
| ||||||||||||||||
caseReference | The case reference. If not provided, then the case id will be used as the case reference. | ||||||||||||||||
caseWithDocumentsInitialization | A CaseWithDocumentsInitialization object that contains the initialization variables for the new case job. The variables in the job will be updated with the corresponding values. Cannot be null
| ||||||||||||||||
variablesToReturn | A VariableIdentityCollection collection of variables whose values are to be returned. VariableIdentity members.
|
void DeleteLinkedCase | ( | string | sessionId, |
CaseIdentity | sourceCase, | ||
CaseIdentity | targetCase | ||
) |
Deletes the link between the source case and the target case.
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. | ||||||||||||
sourceCase | A CaseIdentity identity object for which the link needs to be removed with the target case. Cannot be null
| ||||||||||||
targetCase | A CaseIdentity identity object for which the link needs to be removed with the source case. Cannot be null
|
void DeleteRoleMember | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
RoleIdentity | roleIdentity, | ||
ResourceIdentity | resourceIdentity | ||
) |
Deletes the role member from a role for a specified case.
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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case for which the role member will be removed. Cannot be null
| ||||||||||||||||
roleIdentity | A RoleIdentity identity object indicating the role from which the member will be removed. Cannot be null
| ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object containing the id of the resource that needs to be removed. Cannot be null
|
bool DoesCaseExist | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Checks if there is already a case with the specified case reference.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object used to determine if a case reference is already in use. Cannot be null
|
void ForceValidCaseDocument | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
DocumentTypeIdentity | documentTypeIdentity, | ||
string | comment | ||
) |
Forces the valid case document.
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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
| ||||||||||||||||
documentTypeIdentity | A DocumentTypeIdentity identity object indicating the document type. Cannot be null
| ||||||||||||||||
comment | A comment that will be stored against the case document rule. |
JobEventCollection GetCaseEvents | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Retrieves the list of events for a specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case for which the events are to be found. Cannot be null
|
JobHistoryCollection GetCaseHistory | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
bool | associatedJobs | ||
) |
Retrieves the case history with details such as activities performed and associated jobs if specified.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case for which the case history has to be retrieved. Cannot be null
| ||||||||||||
associatedJobs | If set to true, the history of associated jobs will also be retrieved. |
JobIdentity GetCaseId | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Retrieves the case id for a specified case reference.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object containing the case reference for which the case id needs to be retrieved. Cannot be null
|
CaseIdentity GetCaseIdentity | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Gets the case identity.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object containing the case reference for which the case id needs to be retrieved. Cannot be null
|
JobProperties GetCaseJobProperties | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
JobHistoryFilter | filter | ||
) |
Retrieves the properties of the specified case.
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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case for which the properties have to be retrieved. Cannot be null
| ||||||||||||||||
filter | A JobHistoryFilter object containing the search criteria with which to filter the job details. Can be null
|
Enumeration | Description |
---|---|
-1 | None |
0 | Script Activity |
1 | Com Activity |
2 | Ordinary Activity |
4 | Transactional Activity |
5 | Create New Job Activity |
6 | Straight Through Activity |
7 | DotNet Activity |
8 | Web Service Activity |
9 | Create Sub Job Activity |
10 | Xml Activity |
11 | CSharp Activity |
12 | VBNet Activity |
13 | Data Access Activity |
14 | Design Activity |
15 | Synchronization Activity |
16 | Sleep Activity |
17 | Job Owner Activity |
18 | Job Variable Info Activity |
19 | Resource Info Activity |
20 | Event Activity |
25 | Extraction Capture Activity |
26 | Separation Classification Capture Activity |
28 | PDF Generation Activity |
29 | Scan Capture Activity |
30 | Validation Capture Activity |
31 | Verification Capture Activity |
32 | Document Review Capture Activity |
108 | Image Processing Capture Activity |
109 | Composite Capture Activity |
122 | Export Capture Activity |
123 | Sign Documents Activity |
124 | CCM Compose And Sign Activity |
125 | CCM Distribute Activity |
JobMilestoneCollection GetCaseMilestones | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Retrieves the list of milestones for a specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object containing the case id or case reference for which the milestones have to be retrieved. Cannot be null
|
Name | Type | Comment |
---|---|---|
Name | String | The name of the milestone |
DisplayName | String | The display name of the milestone |
ActualDateTime | DateTime | The actual datetime of the milestone. |
TargetDateTime | DateTime | The target finish datetime of the milestone. |
JobNoteCollection GetCaseNotes | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
CaseNoteFilter | caseNoteFilter | ||
) |
Retrieves the case notes for the specified case.
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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case for which the job notes are to be retrieved. Cannot be null
| ||||||||||||||||
caseNoteFilter | A CaseNoteFilter object used to filter the case notes. Can be null
|
Name | Type | Comment |
---|---|---|
CreatedDateTime | DateTime | The date the note was created |
NoteText | String | The note text |
NoteTypeDescription | String | The note type description |
NoteTypeId | String | The note type Id |
Resource | ResourceIdentity | The resource who added the note |
Enumeration | Description |
---|---|
0 | All Resources |
1 | Include Resource |
2 | Exclude Resource |
JobRole2 GetCaseRole2 | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
RoleIdentity | roleIdentity | ||
) |
Retrieves the details of a role for the specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object containing the case id or case reference for which the role details have to be retrieved. Cannot be null
| ||||||||||||
roleIdentity | A RoleIdentity identity object containing the role id for which the role details are to be retrieved. Cannot be null
|
JobRole2Collection GetCaseRoles2 | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Retrieves the details of all roles for a specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object containing the case id or case reference for which to retrieve all roles. Cannot be null
|
Name | Type | Comment |
---|---|---|
AssociatedResources | ResourceIdentityCollection | The associated member resources of the Role |
DynamicRoleId | String | The dynamic Role Id |
Identity | RoleIdentity | The identity of the Role |
RoleType | RoleType | The numerated value for the RoleType. See Remarks. |
Enumeration | Description |
---|---|
0 | Fixed |
1 | Floating |
StateCollection GetCaseStates | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Retrieves all states for the specified case definition.
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 identity object that identifies the process to get all the possible states for. Cannot be null
|
Name | Type | Comment |
---|---|---|
Action | StateAction | The action of the State. See Remarks. |
Identity | StateIdentity | The State identity |
Percentage | short | The percentage |
Action | Description |
---|---|
CreateJobProcess | Create Job Process. |
RestartAtNode | Restart At Node |
ActionType | Action Type. |
CreateJobInitParameters | Create Job initialization parameters. |
EventProcessInitParameters | The event process initialization parameters. |
SelectedVariable | Selected Variable. |
CreateJobType | Create Job Type. |
ReferenceType | Reference Type. |
BusinessEvent | Business event. |
RestartAtNodeAsString | The restart at node string. (For internal purposes) |
CaseSummary GetCaseSummary | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Gets the case summary.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object containing the case id or case reference for which the milestones have to be retrieved. Cannot be null
|
VariableAssociationCollection GetCaseVariableAssociations | ( | string | sessionId, |
ProcessIdentity | processIdentity | ||
) |
Retrieves all the variable associations for the specified case 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 identity object that identifies the case process to get variables for. Cannot be null
|
Name | Type | Comment |
---|---|---|
AssociationType | Short | The type of the association ( 0 for Map and 1 for Node). |
Id | String | The Id |
Identity | VariableIdentity | The identity |
Name | String | The name |
NodeIdentity | NodeIdentity | The Node identity |
ParentVariable | VariableIdentity | The parent variable |
Usage | Short | The usage |
VariableValueCollection GetCaseVariablesValues | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
VariableIdentityCollection | variableIdentityCollection | ||
) |
Retrieves the specified variables value for the specified case.
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. | ||||||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case whose variable’s values needs to be retrieved. Cannot be null
| ||||||||||||||||||||
variableIdentityCollection | A VariableIdentityCollection collection object of variables whose values need to be retrieved. Cannot be null VariableIdentity members
|
JobInfoCollection GetJobsAssociatedWithCase | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Retrieves all the jobs that are associated with the specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case whose associated jobs need to be retrieved. Cannot be null
|
LinkedCaseCollection GetLinkedCasesForCase | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Retrieves all linked cases for the specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object used to determine the case whose linked cases need to be retrieved. Cannot be null
|
ProcessIdentityCollection GetProcessesForCase | ( | string | sessionId, |
CategoryIdentity | category, | ||
CaseIdentity | caseIdentity | ||
) |
Gets the processes for specified case.
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. | ||||||||||||
category | The CategoryIdentity of the Category in TotalAgility. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that is to be placed on hold. Cannot be null
|
Name | Type | Comment |
---|---|---|
Id | String | The id of the case definition process map |
Name | String | The name of the process map. NOT used by this API |
Version | Double | The version of the process map. NOT used by this API |
void PutCaseOnHold | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
OnHoldOptions | onHoldOptions | ||
) |
The specified case is placed on hold based on the on hold options. Note: The expected finish time and the expected duration of a case will be updated by the amount of time the case was on hold when the case is taken off hold. Also escalations will not fire while the job is on hold
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. | ||||||||||||||||||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that is to be placed on hold. Cannot be null
| ||||||||||||||||||||||||||||||||
onHoldOptions | A OnHoldOptions object that specify if the case needs to be put on hold based on ActivationDate or ActivationPeriod. It also contains the information related to Activation date and period and the reason for placing the case on hold. Cannot be null
|
Enumeration | Description |
---|---|
0 | Activation Date |
1 | Activation Period |
void RaiseEvent | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
string | eventName, | ||
string | eventSource, | ||
InputVariableCollection | updatedVariables | ||
) |
Raises a case process event for the specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
| ||||||||||||
eventName | The event name (maximum of 40 characters). Is required. | ||||||||||||
eventSource | The event source (maximum of 40 characters). Is required. | ||||||||||||
updatedVariables | A collection of 0 or more InputVariable that need to be updated. Can be null. InputVariable members.
|
void ReceivedCaseDocument | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
DocumentIdentity | documentIdentity, | ||
bool | useSource, | ||
string | source, | ||
bool | useStatus, | ||
short | status | ||
) |
Documents Received will be added with the status of Received and if the docuemnt already exists it will be updated with the given status.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object containing the case id or case reference for which the milestones have to be retrieved. Cannot be null
| ||||||||||||
documentIdentity | A DocumentIdentity object containing the document information that needs to be added/updated | ||||||||||||
useSource | if set to true [use source]. | ||||||||||||
source | The source message. | ||||||||||||
useStatus | if set to true considers the passed in status. | ||||||||||||
status | The status of the document that needs to be updated with. When we are adding a new document the status will by default be set as Received. When we are updating the existing the document, the possible status will be as below: Waiting - 1, Validated - 2, Verified -3, Rejected - 4 If any value other than the above are passed than as exception will be thown. |
void ReevaluateCaseDocumentRequiredDates | ( | string | sessionId, |
CaseIdentity | caseIdentity | ||
) |
Reevaluate the required dates for documents on a document set in a running case
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
|
void ReplaceRoleMembers | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
RoleIdentity | roleIdentity, | ||
ResourceIdentityCollection | resourceIdentityCollection | ||
) |
Replaces the members for the 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. | ||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case whose role members need to be replaced. Cannot be null
| ||||||||||||||||
roleIdentity | A RoleIdentity identity object indicating the role whose members need to be replaced. Cannot be null
| ||||||||||||||||
resourceIdentityCollection | A ResourceIdentityCollection collection object of resources that are to be used in the role. Cannot be null ResourceIdentity members.
|
void SuspendCase | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
bool | suspendAllAssociatedJobs | ||
) |
Suspends the specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs to be suspended. Cannot be null
| ||||||||||||
suspendAllAssociatedJobs | If true, suspend all associated jobs for the specified case. If false, only suspend the case itself. |
void TakeCaseOffHold | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
bool | takeOffHoldAllAssociatedJobs | ||
) |
Takes the specified case off hold.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case that needs to be be taken off hold. Cannot be null
| ||||||||||||
takeOffHoldAllAssociatedJobs | If true, reactivate all the associated jobs for the specified case. If false, only reactivate the case itself. |
void UpdateCaseMilestoneActualDate | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
JobMilestone | jobMilestone, | ||
ResourceIdentity | resourceIdentity | ||
) |
Updates the actual date of the specified case milestone.
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. | ||||||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case where a milestone's actual date needs to be changed. Cannot be null
| ||||||||||||||||||||
jobMilestone | A JobMilestone object used to identify the milestone whose actual date needs to be updated. Cannot be null
| ||||||||||||||||||||
resourceIdentity | A ResourceIdentity identity object containing the id of the resource associated with the update. Cannot be null
|
void UpdateCaseMilestoneTargetDate | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
JobMilestone | jobMilestone | ||
) |
Updates the target date of the specified case milestone.
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. | ||||||||||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case where a milestone's target finish time needs to be changed. Cannot be null
| ||||||||||||||||||||
jobMilestone | A JobMilestone object used to identify the milestone whose target finish time needs to be updated. Cannot be null
|
void UpdateCaseReference | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
string | newCaseReference | ||
) |
Updates the existing case reference with the new case reference value.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case to be updated. Cannot be null. If the case is not live, an exception is raised.
| ||||||||||||
newCaseReference | The new case reference. If not provided, an exception is raised. |
void UpdateCaseSpend | ( | string | sessionId, |
CaseIdentity | caseIdentity, | ||
double | newSpendValue | ||
) |
Updates the amount spent for the specified case.
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. | ||||||||||||
caseIdentity | A CaseIdentity identity object indicating the case whose amount spent needs to be updated. Cannot be null
| ||||||||||||
newSpendValue | The new value for amount spent on case. |
void UpdateLinkedCase | ( | string | sessionId, |
CaseIdentity | sourceCase, | ||
CaseIdentity | oldTargetCase, | ||
CaseIdentity | newTargetCase, | ||
string | linkDescription | ||
) |
Replaces the old target case with a new target case for the specified source case.
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. | ||||||||||||
sourceCase | A CaseIdentity identity object for which the link needs to be removed with the target case. Cannot be null
| ||||||||||||
oldTargetCase | A CaseIdentity identity object that contains the old target case information. Cannot be null
| ||||||||||||
newTargetCase | A CaseIdentity identity object that contains the new target case information. Cannot be null
| ||||||||||||
linkDescription | A description of the link. Can be null |