h4. {color:#000066}{_}Workset Management{_}{color}
h2. Workset Service


{include:Interface Style}
{table:id=serviceMetaTable}
{tr}
{th:class=h}Name
{th}
{td:id=serviceName|colspan=2}Workset Service
{td}
{tr}
{tr}
{th:class=h}Version
{th}
{td:id=serviceVersion}Dev ([0.1|Workset Service 0.1])
{td}
{td:id=serviceVersionHistory}[Release Notes|Search Service Release Notes#current]
{td}
{tr}
{table}
| [#References] | [#Operations] | [#Capabilities] |



h3. Description

The Workset Service allows the definition and manipulation of user defined groups of cost objects and people (worksets). Worksets can be defined statically (picking a list of specific cost objects and/or people) or dynamicaly (storing a collection of attributes. For dynamically defined worksets the attributes are stacked in a manner similar to an AND clause, returning only those records that match all the specified criteria.


h3. References

see RAFT Requirements Documentation (RAFT-*)

h3. Operations

{include:Method Table Style Page}
{panel:title=Scenario|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
*Workset Management*
createWorkset
deleteWorkset
archiveWorkset
listWorksets
showWorkset
addWorksetObj
delWorksetObj
addWorksetRule
deleteWorksetRule
updateWorksetfromRules
showWorksetChanges
showAccessChanges
showBalanceExceptions
showworksetCOSummary
showworksetApptSummary





{panel}


Workset Management
{include:Method Table Style Page}

{anchor:createWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}createWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Define a new, empty, workset
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The short string identifying the workset
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_Title
{td}
{td:class=methodParamDesc}The name of the workset
{td}
{tr}
{tr}
{td:class=methodParamType}longText
{td}
{td:class=methodParamName}Workset_Desc
{td}
{td:class=methodParamDesc}Long description of this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Workset with this workset key already exists
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}createWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Drop an existing workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The short string identifying the workset
{td}
{tr}
{tr}
{td:class=methodParamType}CONSTRAINT_TYPE
{td}
{td:class=methodParamName}Constraint type
{td}
{td:class=methodParamDesc}Identifies whether or not to remove this workset from any parent workset rules
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No workset with this key exists in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}HAS_CHILDREN
{td}
{td:class=methodErrorDesc}Workset has associated child objects that must be removed first
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User can not perform this action
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:archiveWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}archiveWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Archive an existing workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The short string identifying the workset
{td}
{tr}
{tr}
{td:class=methodParamType}CONSTRAINT_TYPE
{td}
{td:class=methodParamName}Constraint type
{td}
{td:class=methodParamDesc}Identifies whether or not to archive all children worksets as well
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No workset with this key exists in the system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User can not perform this action
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}PARENT_REQUIRES
{td}
{td:class=methodErrorDesc}This workset is required by another workset that has not been archived
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listWorksets}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorksets
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show details for all worksets accessible by this person
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}
{td}
{td:class=methodParamName}
{td}
{td:class=methodParamDesc}
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetSummaryResultType|worksetSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns all worksets accessible by the current user
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:showWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns structure containing all cost objects, people, and scenarios owned by this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetDetailResultType|worksetDetailResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the objects contained by this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No workset with this key exists in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addWorksetObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addWorksetObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds cost objects or people to the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The object type to add
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}REF_KEY
{td}
{td:class=methodParamDesc}The unique identifiers of object_type to add
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING
{td}
{td:class=methodErrorDesc}Certain objects identified do not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:delWorksetObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}delWorksetObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes cost objects or people from the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The object type to drop
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}REF_KEY
{td}
{td:class=methodParamDesc}The unique identifiers of the object_type to drop
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING
{td}
{td:class=methodErrorDesc}Certain objects identified do not exist in the system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:listWorksetObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorksetObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show the objects in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}REF_TYPE
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}(optional) The object type to restrict by
{td}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a structure containing the list of objects, by type, in the workset 
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No such workset in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}EMPTY
{td}
{td:class=methodErrorDesc}Contains no child objects
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to workset objects
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:addWorksetRule}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addWorksetRule
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes cost objects or people from the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{td:class=methodParamType}longText
{td}
{td:class=methodParamName}criteria
{td}
{td:class=methodParamDesc}Basically, a where clause sql snippet
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}MISSING
{td}
{td:class=methodErrorDesc}Rule has no matches in the system currently
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:dropWorksetRule}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropWorksetRule
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Removes cost objects or people from the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Rule does not exist in system
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetRules}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetRules
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Shows the definition rules in place for the specified workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetRulesResultType|worksetRulesResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of defined rules in the system.
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to objects in this workset
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INCORRECT_TYPE
{td}
{td:class=methodErrorDesc}This workset type does not have rules
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:updateWorksetfromRules}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateWorksetfromRules
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Processes all of the associated workset rules, logging the changes to the change_log
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Rule does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No objects added or removed from the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:convertWorksettoStatic}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}convertWorksettoStatic
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Converts a workset from dynamic (rules-based) to static
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the completion status of the identified task along with the associated references
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Rule does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot perform this action
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INCORRECT_TYPE
{td}
{td:class=methodErrorDesc}Workset is already static
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetChanges}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetChanges}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Pull the last set of changes on this workset from the change_log. The change_log will return any changes from the user's last access date.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[changeResultType|changeResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of object changes to this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No objects added or removed from the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetAccessChanges}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetAccessChanges}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Pull the last set of authorization changes on this workset from the change_log. The change_log will return any changes from the user's last access date.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[changeResultType|changeResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of access changes to this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No objects added or removed from the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetBalanceExceptions}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetBalanceExceptions}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show the list of cost objects whose balance < 0 currently or are expected to be < 0 on the project end date.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[changeResultType|changeResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of balance exceptions on this workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_CHANGE
{td}
{td:class=methodErrorDesc}No issues identified
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:showWorksetCOSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetCOSummary}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show summary information about the COs in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_Key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetCOSummaryResultType|worksetCOSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a summary of cost objects in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access workset information
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:showWorksetApptSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetApptSummary}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Shows a summary of People/Appt information in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetApptSummaryResultType|worksetApptResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns a summary of people/appts in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in this workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]


{anchor:showWorksetScenarioSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}showWorksetScenarioSummary}
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Show the list of defined of defined Scenarios in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_key
{td}
{td:class=methodParamDesc}The unique identifier for this workset
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[worksetScenarioResultType|worksetResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the list of scenarios in the workset
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Workset does not exist in system
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot access objects in the workset
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]