All Classes Namespaces Functions Properties Pages
Public Member Functions | List of all members
CaseService Class Reference

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...
 

Description

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.

Member Functions

void ActivateCase ( string  sessionId,
CaseIdentity  caseIdentity,
bool  activateAllAssociatedJobs 
)

Activates the specified case and associated jobs, if any exist.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs to be activated. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. One of CaseId or CaseReference must be supplied
CaseReference String A unique case reference for the case Yes/No. One of CaseId or CaseReference must be supplied
activateAllAssociatedJobsIf true then all associated jobs (fragments and business processes) are activated.
Remarks
Will only activate cases that are currently in suspended state
Security
No restrictions apply.
void AddCaseNote ( string  sessionId,
CaseIdentity  caseIdentity,
NoteInfo  noteInfo 
)

Adds a note to a specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case to which the note has to be added. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
noteInfoA NoteInfo object that specifies the note text and type. Cannot be null
Name Type Comment Required
NoteText String The text for the note Yes
TypeId String The note type id. See Remarks section for the 3 installed type Ids No
Remarks
If no TypeId supplied with noteInfo parameter, then the API will use the Default note type.

A note can be added to a live or completed case.

The note type Ids that are installed by KTA are:
4DE75A7E7AB049B1BEDDF017D69FC1EB – Resource
9E298F8BC47F49B3BAD91B852862B4D6 – Default
AB9842C19321454DB5D56EE94FDC1391 – Collaboration
Security
No restrictions apply.
void AddCaseRoleMember ( string  sessionId,
CaseIdentity  caseIdentity,
RoleIdentity  roleIdentity,
ResourceIdentity  resourceIdentity 
)

Adds a member to a specified role for a specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA 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
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
roleIdentityA RoleIdentity identity object indicating the id of the role to which we must add a member. Cannot be null
Name Type Comment Required
Id String The role id Yes/No. Either Id or Name needs to be supplied
Name String The role name Yes/No. Either Id or Name needs to be supplied
resourceIdentityA ResourceIdentity identity object containing the id of the resource that needs to be added as a member. Cannot be null
Name Type Comment Required
Id String The Id of the resource Yes
Name String Name of resource. NOT used by this API No
ResourceType Int16 The type of resource. NOT used by this API No
Remarks
You can only add a new member to a floating role and to a pending case job.
Security
No restrictions apply.
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.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
sourceCaseA CaseIdentity identity object indicating the case that needs to be linked to the target case. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
targetCaseA CaseIdentity identity object indicating the case that needs to be linked to the source case. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
linkDescriptionA description of the link between the cases. Can be null
Remarks
Only cases that are live or complete can be linked.
A case cannot be linked to itself.
The cases will be marked as being linked by the current logged on user
Security
No restrictions apply.
void AddRoleMember ( string  sessionId,
CaseIdentity  caseIdentity,
RoleIdentity  roleIdentity,
ResourceIdentity  resourceIdentity 
)

Adds a member to a role for a specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA 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
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
roleIdentityA RoleIdentity identity object indicating the id of the role to which we must add a member. Cannot be null
Name Type Comment Required
Id String The role id Yes/No. Either Id or Name needs to be supplied
Name String The role name Yes/No. Either Id or Name needs to be supplied
resourceIdentityA ResourceIdentity identity object containing the id of the resource that needs to be added as a member. Cannot be null
Name Type Comment Required
Id String The Id of the resource Yes/No. Either Id or Name needs to be supplied
Name String Name of resource. Yes/No. Either Id or Name needs to be supplied
ResourceType Int16 The type of resource. NOT used by this API No
Remarks
You can only add a new member to a floating role and to a pending case job.
Security
No restrictions apply.
void ChangeCaseState ( string  sessionId,
CaseIdentity  caseIdentity,
string  jobState 
)

Changes the state of a specified case and performs any actions associated with that state.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating for which case the state needs to be changed. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
jobStateA string containing the name of the state to which the case has to be updated. Cannot be null or an empty string
Remarks
State change is recorded to state history with the details such as case id, state name, datetime, logged on user.
Case is restarted if requirements for restarting are met
Security
No restrictions apply.
void CloseCase ( string  sessionId,
CaseIdentity  caseIdentity 
)

Closes the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs to be closed. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. One of CaseId or CaseReference must be supplied
CaseReference String A unique case reference for the case Yes/No. One of CaseId or CaseReference must be supplied
Remarks
The case is terminated using this method. The associated jobs are not affected directly but if the case has any case completion actions defined, those will be executed.
If the user (identified by the sessionId) does not have appropriate permissions to terminate the case then an exception will be raised.
Security
No restrictions apply.
bool ConfirmCaseDocument ( string  sessionId,
CaseIdentity  caseIdentity,
DocumentTypeIdentity  documentTypeIdentity 
)

Confirms the case document.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes
CaseReference String A unique case reference for the case. NOT used by this API No
documentTypeIdentityA DocumentTypeIdentity identity object indicating the document type. Cannot be null
Name Type Comment Required
Id String The id of the document type Yes/No. One of Id or Name must be supplied
Name String The name of the document type Yes/No. One of Id or Name must be supplied
Version Double The version of the document type No.
Returns
True, if Case Document is confirmed, otherwise false.
Security
No restrictions apply.
JobIdentity CreateCase2 ( string  sessionId,
ProcessIdentity  processIdentity,
string  caseReference,
CaseInitialization  caseInitialization 
)

Creates a case on the specified case definition process.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA ProcessIdentity identity object that identifies the case process to create a job for. Cannot be null
Name Type Comment Required
Id String The id of the case definition process map Yes/No. One of Id or Name must be supplied
Name String The name of the case definition process map. Yes/No. One of Id or Name must be supplied
Version Double The version of the case definition process map. No. If 0 or -1 supplied, then create a job on the most recent released version of the case definition process. Otherwise create the case with the version supplied.
caseReferenceThe case reference. If not provided, then the case id will be used as the case reference.
caseInitializationA 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
Name Type Comment Required
InputVariables Collection A collection of InputVariable No
StartDate DateTime The start date of the case No
Returns
An instance of type JobIdentity that holds the case job id.
Security
No restrictions apply.
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.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA ProcessIdentity identity object that identifies the case process to create a job for. Cannot be null
Name Type Comment Required
Id String The id of the case definition process map Yes/No. One of Id or Name must be supplied
Name String The name of the case definition process map. Yes/No. One of Id or Name must be supplied
Version Double The version of the case definition process map. No. If 0 supplied, then create a job on the most recent released version of the case definition process. Otherwise create the case with the version supplied.
caseReferenceThe case reference. If not provided, then the case id will be used as the case reference.
caseInitializationA 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.
Name Type Comment Required
InputVariables Collection A collection of InputVariable No
StartDate DateTime The start date of the case No
Returns
A JobProgressOutput object with the pending manual activity if available, job id, and job status.
Security
No restrictions apply.
JobIdentity CreateCaseWithDocuments ( string  sessionId,
ProcessIdentity  processIdentity,
string  caseReference,
CaseWithDocumentsInitialization  caseWithDocumentsInitialization 
)

Creates a new instance (a job) for the specified case definition process map.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA ProcessIdentity identity object containing the case process id on which the job needs to be created along with documents. Cannot be null
Name Type Comment Required
Id String The id of the case definition process map Yes
Name String The name of the case definition process map. NOT used by this API No
Version Double The version of the case definition process map No. See Remarks section of this API to get more information.
caseReferenceThe case reference. If not provided, then the case id will be used as the case reference.
caseWithDocumentsInitializationA 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
Name Type Comment Required
Documents Collection A collection of RuntimeDocument Yes
InputVariables Collection A collection of InputVariable Yes. Must have at least the document/folder initialization variable
StartDate DateTime The start date of the job No
Returns
An instance of type JobIdentity that holds the case job id.
Remarks
You must supply at least 1 RuntimeDocument
If pass a Version greater than 0 then use that particular map version. If pass 0, use the latest released map version.
Security
No restrictions apply.
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.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA ProcessIdentity identity object containing the case process id on which the job needs to be created (along with documents). Cannot be null
Name Type Comment Required
Id String The id of the case definition process map Yes
Name String The name of the case definition process map. NOT used by this API No
Version Double The version of the case definition process map No. See Remarks section of this API to get more information.
caseReferenceThe case reference. If not provided, then the case id will be used as the case reference.
caseWithDocumentsInitializationA 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
Name Type Comment Required
Documents Collection A collection of RuntimeDocument Yes
InputVariables Collection A collection of InputVariable Yes. Must have at least the document/folder initialization variable
StartDate DateTime The start date of the job No
variablesToReturnA VariableIdentityCollection collection of variables whose values are to be returned.
VariableIdentity members.
Name Type Comment Required
Id String The variable id Yes
Name String The variable name. NOT used by this API No
Returns
Returns a JobWithDocumentsProgressOutput object which is the pending manual activity(s) if available, job id, and job status.
Remarks
You must supply at least 1 RuntimeDocument
If pass a Version greater than 0 then use that particular map version. If pass 0, the call will use the latest released map version.
Security
No restrictions apply.
void DeleteLinkedCase ( string  sessionId,
CaseIdentity  sourceCase,
CaseIdentity  targetCase 
)

Deletes the link between the source case and the target case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
sourceCaseA CaseIdentity identity object for which the link needs to be removed with the target case. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
targetCaseA CaseIdentity identity object for which the link needs to be removed with the source case. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Security
No restrictions apply.
void DeleteRoleMember ( string  sessionId,
CaseIdentity  caseIdentity,
RoleIdentity  roleIdentity,
ResourceIdentity  resourceIdentity 
)

Deletes the role member from a role for a specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case for which the role member will be removed. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id. NOT used by this API No
CaseReference String A unique case reference for the case Yes
roleIdentityA RoleIdentity identity object indicating the role from which the member will be removed. Cannot be null
Name Type Comment Required
Id String The role id Yes/No. Either Id or Name needs to be supplied
Name String The role name Yes/No. Either Id or Name needs to be supplied
resourceIdentityA ResourceIdentity identity object containing the id of the resource that needs to be removed. Cannot be null
Name Type Comment Required
Id String The Id of the resource Yes
Name String Name of resource. NOT used by this API No
ResourceType Int16 The type of resource. NOT used by this API No
Security
No restrictions apply.
bool DoesCaseExist ( string  sessionId,
CaseIdentity  caseIdentity 
)

Checks if there is already a case with the specified case reference.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object used to determine if a case reference is already in use. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id. NOT used by this API No
CaseReference String A unique case reference for the case Yes
Returns
True, if exists, otherwise false.
Remarks
Live and completed cases are checked. Case reference must be unique in the system.
Security
No restrictions apply.
void ForceValidCaseDocument ( string  sessionId,
CaseIdentity  caseIdentity,
DocumentTypeIdentity  documentTypeIdentity,
string  comment 
)

Forces the valid case document.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes
CaseReference String A unique case reference for the case. NOT used by this API No
documentTypeIdentityA DocumentTypeIdentity identity object indicating the document type. Cannot be null
Name Type Comment Required
Id String The id of the document type Yes/No. One of Id or Name must be supplied
Name String The name of the document type Yes/No. One of Id or Name must be supplied
Version Double The version of the document type No.
commentA comment that will be stored against the case document rule.
Security
No restrictions apply.
JobEventCollection GetCaseEvents ( string  sessionId,
CaseIdentity  caseIdentity 
)

Retrieves the list of events for a specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case for which the events are to be found. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
A JobEventCollection object that contains a collection of JobEvent (if any) that have been raised so far for the identified case.
Security
No restrictions apply.
JobHistoryCollection GetCaseHistory ( string  sessionId,
CaseIdentity  caseIdentity,
bool  associatedJobs 
)

Retrieves the case history with details such as activities performed and associated jobs if specified.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case for which the case history has to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
associatedJobsIf set to true, the history of associated jobs will also be retrieved.
Returns
A collection of JobHistory objects detailing the case history
Security
No restrictions apply.
JobIdentity GetCaseId ( string  sessionId,
CaseIdentity  caseIdentity 
)

Retrieves the case id for a specified case reference.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object containing the case reference for which the case id needs to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
An instance of type JobIdentity that holds the case id.
Security
No restrictions apply.
CaseIdentity GetCaseIdentity ( string  sessionId,
CaseIdentity  caseIdentity 
)

Gets the case identity.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object containing the case reference for which the case id needs to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
An instance of type CaseIdentity that holds the Case Id and Case Reference.
Security
No restrictions apply.
JobProperties GetCaseJobProperties ( string  sessionId,
CaseIdentity  caseIdentity,
JobHistoryFilter  filter 
)

Retrieves the properties of the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case for which the properties have to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
filterA JobHistoryFilter object containing the search criteria with which to filter the job details. Can be null
Name Type Comment Required
AssociatedJobs Boolean If true, then the associated jobs history should be retrieved as well No
ActivityType ActivityType If set to a value other than None (-1), then we only get job history details for this type of job activity. See Remarks section of this API to get more information on ActivityType enumeration. No
Resource Identity NOT used by this API. No
Returns
A JobProperties object that contains the properties of the case. This includes general details and a list of history, events, notes, roles, variables and milestones.
Remarks
If the user (identified by the sessionId) does not have the appropriate permissions to view the details then an exception is raised.
This API will get case details from both the live and finished databases.
If ActivityType set to None (-1) then we get details for all activities.
The enumeration for ActivityType filter setting follows.
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
Security
No restrictions apply.
JobMilestoneCollection GetCaseMilestones ( string  sessionId,
CaseIdentity  caseIdentity 
)

Retrieves the list of milestones for a specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object containing the case id or case reference for which the milestones have to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
A JobMilestoneCollection collection object that contains details of the JobMilestone for the specified case.
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.
Remarks
Milestones can be retrieved for a case that is live or complete. If the case is live then the resource (identified by the sessionId) must have appropriate permissions to view any case details.
Security
No restrictions apply.
JobNoteCollection GetCaseNotes ( string  sessionId,
CaseIdentity  caseIdentity,
CaseNoteFilter  caseNoteFilter 
)

Retrieves the case notes for the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case for which the job notes are to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
caseNoteFilterA CaseNoteFilter object used to filter the case notes. Can be null
Name Type Comment Required
TypeId String If specified, then get this type of note. See Remarks section for the 3 installed type Ids No
ResourceFilter Int16 Should we get notes for all resources, notes just for a specified resource or notes for everyone except for a specified resource. See Remarks section for the enumeration No
Resource Identity If ResourceFilter is true, then this indicates the resource to be used No
Returns
A collection of JobNote objects.
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
Remarks
The default note type Ids installed by KTA are:

4DE75A7E7AB049B1BEDDF017D69FC1EB – Resource
9E298F8BC47F49B3BAD91B852862B4D6 – Default
AB9842C19321454DB5D56EE94FDC1391 – Collaboration

If caseNoteFilter parameter is null, no notes will be retrieved.

The ResourceFilterType enumeration for ResourceFilter is:
Enumeration Description
0 All Resources
1 Include Resource
2 Exclude Resource
Security
No restrictions apply.
JobRole2 GetCaseRole2 ( string  sessionId,
CaseIdentity  caseIdentity,
RoleIdentity  roleIdentity 
)

Retrieves the details of a role for the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object containing the case id or case reference for which the role details have to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
roleIdentityA RoleIdentity identity object containing the role id for which the role details are to be retrieved. Cannot be null
Name Type Comment Required
Id String The role id No
Name String The role name No
Returns
A JobRole2 object that contains details about the role.
Remarks
This API will look at both the fixed roles for the associated case process and the floating roles for the case
The role details can be retrieved for a case that is live or complete. If the case is live then the resource (identified by the sessionId) must have appropriate permissions to view any case details
If neither role id or role name is supplied, then the first role found for the case will be returned
Security
No restrictions apply.
JobRole2Collection GetCaseRoles2 ( string  sessionId,
CaseIdentity  caseIdentity 
)

Retrieves the details of all roles for a specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object containing the case id or case reference for which to retrieve all roles. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
A JobRole2Collection object that contains all the roles of type JobRole2 for the specified case.
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.
Remarks
This API will get the fixed roles for the associated case process and the floating roles for the case job
The role details can be retrieved for a case that is live or complete. If the case is live then the resource (identified by the sessionId) must have appropriate permissions to view any case details.

The RoleType enumeration is:
Enumeration Description
0 Fixed
1 Floating
Security
No restrictions apply.
StateCollection GetCaseStates ( string  sessionId,
ProcessIdentity  processIdentity 
)

Retrieves all states for the specified case definition.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA ProcessIdentity identity object that identifies the process to get all the possible states for. Cannot be null
Name Type Comment Required
Id String The id of the case definition process map Yes
Name String The name of the process map. NOT used by this API No
Version Double The version of the process map. NOT used by this API No
Returns
A StateCollection object that contains all the case States.
Name Type Comment
Action StateAction The action of the State. See Remarks.
Identity StateIdentity The State identity
Percentage short The percentage
Remarks
The possible State Actions are:
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)
Security
No restrictions apply.
CaseSummary GetCaseSummary ( string  sessionId,
CaseIdentity  caseIdentity 
)

Gets the case summary.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object containing the case id or case reference for which the milestones have to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
A CaseSummary object that contains the summary of the case. Which can be used to display information in case worker landing page.
Security
No restrictions apply.
VariableAssociationCollection GetCaseVariableAssociations ( string  sessionId,
ProcessIdentity  processIdentity 
)

Retrieves all the variable associations for the specified case process.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
processIdentityA ProcessIdentity identity object that identifies the case process to get variables for. Cannot be null
Name Type Comment Required
Id String The id of the case definition process map Yes
Name String The name of the process map. NOT used by this API No
Version Double The version of the process map. NOT used by this API No
Returns
A VariableAssociationCollection object that contains the all Variable Associations with the below properties:
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
Remarks
The results returned will be for the most recent version, not the most recently released version of the case definition
The variable details returned will include input and output variables, expected duration for the activity, job owner details etc.
Security
No restrictions apply.
VariableValueCollection GetCaseVariablesValues ( string  sessionId,
CaseIdentity  caseIdentity,
VariableIdentityCollection  variableIdentityCollection 
)

Retrieves the specified variables value for the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case whose variable’s values needs to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. One of CaseId or CaseReference must be supplied
CaseReference String A unique case reference for the case Yes/No. One of CaseId or CaseReference must be supplied
variableIdentityCollectionA VariableIdentityCollection collection object of variables whose values need to be retrieved. Cannot be null
VariableIdentity members
Name Type Comment Required
Id String The variable id Yes
Name String The variable name No
OwnerId String The onwer id can be server id, process id, job id, case id, or case job id Yes
Version Double The variable owner version (if greater than zero then it will be the process version). For job variables and server variables, the version will be 0. Yes
Returns
A collection of VariableValue objects containing the variables values
Remarks
If the case Id is passed in use this to get variable values. If not, then use case refernce value.
Check if logged in user has job detail access rights for parent process map. If they do, then get job variables
Security
No restrictions apply.
JobInfoCollection GetJobsAssociatedWithCase ( string  sessionId,
CaseIdentity  caseIdentity 
)

Retrieves all the jobs that are associated with the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case whose associated jobs need to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
A collection of JobInfo objects
Security
No restrictions apply.
LinkedCaseCollection GetLinkedCasesForCase ( string  sessionId,
CaseIdentity  caseIdentity 
)

Retrieves all linked cases for the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object used to determine the case whose linked cases need to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
Returns
A LinkedCaseCollection object that contains all the linked cases.
Security
No restrictions apply.
ProcessIdentityCollection GetProcessesForCase ( string  sessionId,
CategoryIdentity  category,
CaseIdentity  caseIdentity 
)

Gets the processes for specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
categoryThe CategoryIdentity of the Category in TotalAgility.
caseIdentityA CaseIdentity identity object indicating the case that is to be placed on hold. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. One of CaseId or CaseReference must be supplied
CaseReference String A unique case reference for the case Yes/No. One of CaseId or CaseReference must be supplied
Returns
A ProcessIdentityCollection list of ProcessIdentity objects that belongs to specified Case.
Remarks
The ProcessIdentity identity object.
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
Security
No restrictions apply.
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

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that is to be placed on hold. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. One of CaseId or CaseReference must be supplied
CaseReference String A unique case reference for the case Yes/No. One of CaseId or CaseReference must be supplied
onHoldOptionsA 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
Name Type Comment Required
OnHoldType Int16 Can specify if case being put on hold until an Activation Date or after an Activation Period. See Remarks section of this API for enumeration values Yes
ActivationDate DateTime The activation date Yes/No. Yes, if OnHoldType member has the value 0 (ActivationDate)
ActivationPeriodDays Int16 Number of days until case will be re-activated Yes/No. If OnHoldType member has the value 1 (ActivationPeriod) then this may be used
ActivationPeriodHours Int16 Number of hours until case will be re-activated Yes/No. If OnHoldType member has the value 1 (ActivationPeriod) then this may be used
ActivationPeriodWeeks Int16 Number of weeks until case will be re-activated Yes/No. If OnHoldType member has the value 1 (ActivationPeriod) then this may be used
PlaceOnHoldAllAssociatedJobs Boolean If true, place all the case' associated jobs on hold No
ReasonForHold String Explanation for putting on hold Yes
Remarks
Will not put on hold unless the user has HoldAccess rights
You can put a job on hold until a specified activation date or put on hold until a time period for re-activation has expired.
You must supply either 0 (ActivationDate) or 1 (ActivationPeriod) for OnHoldType member of onHoldOptions parameter.
If OnHoldType has the value 1 (ActivationPeriod), then at least one of ActivationPeriodHours, ActivationPeriodDays or ActivationPeriodWeeks must have a value greater than zero.
If OnHoldType has the value 1 (ActivationPeriod) and the system setting to use the business calendar is active, then the business calendar will be used in working out the time for re-activation.
If OnHoldType has the value 0 (ActivationDate), then the ActivationDate has to be at least an hour greater than the time when the API is called.

The OnHoldOptions enumeration is:
Enumeration Description
0 Activation Date
1 Activation Period
Security
No restrictions apply.
void RaiseEvent ( string  sessionId,
CaseIdentity  caseIdentity,
string  eventName,
string  eventSource,
InputVariableCollection  updatedVariables 
)

Raises a case process event for the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes
CaseReference String A unique case reference for the case. NOT used by this API No
eventNameThe event name (maximum of 40 characters). Is required.
eventSourceThe event source (maximum of 40 characters). Is required.
updatedVariablesA collection of 0 or more InputVariable that need to be updated. Can be null. InputVariable members.
Name Type Comment Required
Id String The variable id Yes, if we have an InputVariable
Value Object The variable id Yes, if we have an InputVariable
Security
No restrictions apply.
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.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object containing the case id or case reference for which the milestones have to be retrieved. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
documentIdentityA DocumentIdentity object containing the document information that needs to be added/updated
useSourceif set to true [use source].
sourceThe source message.
useStatusif set to true considers the passed in status.
statusThe 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.
Security
No restrictions apply.
void ReevaluateCaseDocumentRequiredDates ( string  sessionId,
CaseIdentity  caseIdentity 
)

Reevaluate the required dates for documents on a document set in a running case

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs the event to be raised for. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes
CaseReference String A unique case reference for the case. NOT used by this API No
Security
No restrictions apply.
void ReplaceRoleMembers ( string  sessionId,
CaseIdentity  caseIdentity,
RoleIdentity  roleIdentity,
ResourceIdentityCollection  resourceIdentityCollection 
)

Replaces the members for the specified role.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case whose role members need to be replaced. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id. NOT used by this API No
CaseReference String A unique case reference for the case Yes
roleIdentityA RoleIdentity identity object indicating the role whose members need to be replaced. Cannot be null
Name Type Comment Required
Id String The role id Yes/No. Either Id or Name needs to be supplied
Name String The role name Yes/No. Either Id or Name needs to be supplied
resourceIdentityCollectionA ResourceIdentityCollection collection object of resources that are to be used in the role. Cannot be null
ResourceIdentity members.
Name Type Comment Required
Id String The Id of the resource Yes
Name String Name of resource. NOT used by this API No
ResourceType Int16 The type of resource. NOT used by this API No
Security
No restrictions apply.
void SuspendCase ( string  sessionId,
CaseIdentity  caseIdentity,
bool  suspendAllAssociatedJobs 
)

Suspends the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs to be suspended. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. One of CaseId or CaseReference must be supplied
CaseReference String A unique case reference for the case Yes/No. One of CaseId or CaseReference must be supplied
suspendAllAssociatedJobsIf true, suspend all associated jobs for the specified case. If false, only suspend the case itself.
Remarks
Will not suspend unless the user has SuspendAccess rights
Security
No restrictions apply.
void TakeCaseOffHold ( string  sessionId,
CaseIdentity  caseIdentity,
bool  takeOffHoldAllAssociatedJobs 
)

Takes the specified case off hold.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case that needs to be be taken off hold. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. One of CaseId or CaseReference must be supplied
CaseReference String A unique case reference for the case Yes/No. One of CaseId or CaseReference must be supplied
takeOffHoldAllAssociatedJobsIf true, reactivate all the associated jobs for the specified case. If false, only reactivate the case itself.
Security
No restrictions apply.
void UpdateCaseMilestoneActualDate ( string  sessionId,
CaseIdentity  caseIdentity,
JobMilestone  jobMilestone,
ResourceIdentity  resourceIdentity 
)

Updates the actual date of the specified case milestone.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case where a milestone's actual date needs to be changed. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
jobMilestoneA JobMilestone object used to identify the milestone whose actual date needs to be updated. Cannot be null
Name Type Comment Required
Name String The name of the milestone Yes
DisplayName String The display name of the milestone No
ActualDateTime DateTime The actual datetime of the milestone. Yes
TargetDateTime DateTime The target finish datetime of the milestone. No
resourceIdentityA ResourceIdentity identity object containing the id of the resource associated with the update. Cannot be null
Name Type Comment Required
Id String The Id of the resource Yes
Name String Name of resource. NOT used by this API No
ResourceType Int16 The type of resource. NOT used by this API No
Security
No restrictions apply.
void UpdateCaseMilestoneTargetDate ( string  sessionId,
CaseIdentity  caseIdentity,
JobMilestone  jobMilestone 
)

Updates the target date of the specified case milestone.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case where a milestone's target finish time needs to be changed. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
jobMilestoneA JobMilestone object used to identify the milestone whose target finish time needs to be updated. Cannot be null
Name Type Comment Required
Name String The name of the milestone Yes
DisplayName String The display name of the milestone No
ActualDateTime DateTime The actual datetime of the milestone. No. Can be null
TargetDateTime DateTime The target finish datetime of the milestone. Yes
Security
No restrictions apply.
void UpdateCaseReference ( string  sessionId,
CaseIdentity  caseIdentity,
string  newCaseReference 
)

Updates the existing case reference with the new case reference value.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case to be updated. Cannot be null. If the case is not live, an exception is raised.
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case. NOT used by this API Yes/No. Either CaseId or CaseReference needs to be supplied
newCaseReferenceThe new case reference. If not provided, an exception is raised.
Remarks
The new CaseReference value must be unique.
The new CaseReference will be updated across all associated items as well as the case itself, i.e. associated jobs and linked cases.
If auditing is enabled, then a new entry will be added to indicate the resource that changed the CaseReference and when changed.
The value of SPP_CASE_REFERENCE will be updated.
CaseReference cannot be changed for completed cases.
Security
No restrictions apply.
void UpdateCaseSpend ( string  sessionId,
CaseIdentity  caseIdentity,
double  newSpendValue 
)

Updates the amount spent for the specified case.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
caseIdentityA CaseIdentity identity object indicating the case whose amount spent needs to be updated. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
newSpendValueThe new value for amount spent on case.
Security
No restrictions apply.
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.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
sourceCaseA CaseIdentity identity object for which the link needs to be removed with the target case. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
oldTargetCaseA CaseIdentity identity object that contains the old target case information. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
newTargetCaseA CaseIdentity identity object that contains the new target case information. Cannot be null
Name Type Comment Required
CaseId String The case id i.e. the case job id Yes/No. Either CaseId or CaseReference needs to be supplied
CaseReference String A unique case reference for the case Yes/No. Either CaseId or CaseReference needs to be supplied
linkDescriptionA description of the link. Can be null
Remarks
The cases will be marked as being linked by the logged on user
Security
No restrictions apply.