Page History

...

Include Page

	Interface Style
	Interface Style

HTML Table

id	serviceMetaTable

Table Row (tr)

Table Head (th)

class	h

Name

Table Cell (td)

colspan	2
id	serviceName

Workset Service

Table Row (tr)

Table Head (th)

class	h

Version

Table Cell (td)

id	serviceVersion

Dev (0.1)

Table Cell (td)

id	serviceVersionHistory

Release Notes

Wiki Markup

{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

...

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
borderStyle	solid
title	Workset	borderStyle	solid

Workset Management
#createWorkset
#deleteWorkset
#archiveWorkset
#listWorksets
#showWorkset
#addWorksetObj
#delWorksetObj
#addWorksetRule
#deleteWorksetRule
#updateWorksetfromRules
#showWorksetChanges
#showAccessChanges
#showBalanceExceptions
#showWorksetCOSummary
#showWorksetApptSummary

...

Anchor

	createWorkset
	createWorkset

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

createWorkset

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Define a new, empty, workset

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The short string identifying the workset

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_Title

Table Cell (td)

class	methodParamDesc

The name of the workset

Table Row (tr)

Table Cell (td)

class	methodParamType

longText

Table Cell (td)

class	methodParamName

Workset_Desc

Table Cell (td)

class	methodParamDesc

Long description of this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status along with the object reference

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

Workset with this workset key already exists

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	dropWorkset
	dropWorkset

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropWorkset

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Drop an existing workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The short string identifying the workset

Table Row (tr)

Table Cell (td)

class	methodParamType

CONSTRAINT_TYPE

Table Cell (td)

class	methodParamName

Constraint type

Table Cell (td)

class	methodParamDesc

Identifies whether or not to remove this workset from any parent workset rules

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No workset with this key exists in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

HAS_CHILDREN

Table Cell (td)

class	methodErrorDesc

Workset has associated child objects that must be removed first

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User can not perform this action

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}dropWorkset {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

Anchor

	archiveWorkset
	archiveWorkset

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

archiveWorkset

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Archive an existing workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The short string identifying the workset

Table Row (tr)

Table Cell (td)

class	methodParamType

CONSTRAINT_TYPE

Table Cell (td)

class	methodParamName

Constraint type

Table Cell (td)

class	methodParamDesc

Identifies whether or not to archive all children worksets as well

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status along with the object reference

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No workset with this key exists in the system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User can not perform this action

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PARENT_REQUIRES

Table Cell (td)

class	methodErrorDesc

This workset is required by another workset that has not been archived

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	listWorksets
	listWorksets

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listWorksets

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Show details for all worksets accessible by this person

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Table Cell (td)

class	methodParamName

Table Cell (td)

class	methodParamDesc

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

worksetSummaryResultType

Table Cell (td)

class	methodReturnDesc

Returns all worksets accessible by the current user

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	showWorkset
	showWorkset

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorkset

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns structure containing all cost objects, people, and scenarios owned by this workset

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

worksetDetailResultType

Table Cell (td)

class	methodReturnDesc

Returns the objects contained by this workset

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No workset with this key exists in the system

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	addWorksetObjects
	addWorksetObjects

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addWorksetObjects

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds cost objects or people to the workset

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Cell (td)

class	methodParamType

REF_TYPE

Table Cell (td)

class	methodParamName

REF_TYPE

Table Cell (td)

class	methodParamDesc

The object type to add

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

REF_KEY

Table Cell (td)

class	methodParamDesc

The unique identifiers of object_type to add

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the completion status of the identified task along with the associated references

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

MISSING

Table Cell (td)

class	methodErrorDesc

Certain objects identified do not exist in the system

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	delWorksetObjects
	delWorksetObjects

Wiki Markup

{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}

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

delWorksetObjects

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes cost objects or people from the workset

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Cell (td)

class	methodParamType

REF_TYPE

Table Cell (td)

class	methodParamName

REF_TYPE

Table Cell (td)

class	methodParamDesc

The object type to drop

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

REF_KEY

Table Cell (td)

class	methodParamDesc

The unique identifiers of the object_type to drop

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the completion status of the identified task along with the associated references

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

MISSING

Table Cell (td)

class	methodErrorDesc

Certain objects identified do not exist in the system

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back Back to Operations

Anchor

	listWorksetObjects
	listWorksetObjects

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listWorksetObjects

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Show the objects in the workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Cell (td)

class	methodParamType

REF_TYPE

Table Cell (td)

class	methodParamName

REF_TYPE

Table Cell (td)

class	methodParamDesc

(optional) The object type to restrict by

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns a structure containing the list of objects, by type, in the workset

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No such workset in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

EMPTY

Table Cell (td)

class	methodErrorDesc

Contains no child objects

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User does not have access to workset objects

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Wiki Markup

{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

Anchor

	addWorksetRule
	addWorksetRule

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addWorksetRule

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes cost objects or people from the workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Cell (td)

class	methodParamType

longText

Table Cell (td)

class	methodParamName

criteria

Table Cell (td)

class	methodParamDesc

Basically, a where clause sql snippet

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the completion status of the identified task along with the associated references

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

MISSING

Table Cell (td)

class	methodErrorDesc

Rule has no matches in the system currently

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	dropWorksetRule
	dropWorksetRule

Wiki Markup

{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}

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropWorksetRule

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes cost objects or people from the workset

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the completion status of the identified task along with the associated references

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Rule does not exist in system

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Back to Operations

Anchor

	showWorksetRules
	showWorksetRules

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorksetRules

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Shows the definition rules in place for the specified workset

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

worksetRulesResultType

Table Cell (td)

class	methodReturnDesc

Returns the list of defined rules in the system.

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Workset does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User does not have access to objects in this workset

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INCORRECT_TYPE

Table Cell (td)

class	methodErrorDesc

This workset type does not have rules

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	updateWorksetfromRules
	updateWorksetfromRules

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateWorksetfromRules

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Processes all of the associated workset rules, logging the changes to the change_log

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the completion status of the identified task along with the associated references

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Rule does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CHANGE

Table Cell (td)

class	methodErrorDesc

No objects added or removed from the workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	convertWorksettoStatic
	convertWorksettoStatic

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

convertWorksettoStatic

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Converts a workset from dynamic

Wiki Markup

{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}

static

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the completion status of the identified task along with the associated references

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Rule does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot perform this action

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INCORRECT_TYPE

Table Cell (td)

class	methodErrorDesc

Workset is already static

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showWorksetChanges
	showWorksetChanges

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorksetChanges

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

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.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

changeResultType

Table Cell (td)

class	methodReturnDesc

Returns the list of object changes to this workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Workset does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CHANGE

Table Cell (td)

class	methodErrorDesc

No objects added or removed from the workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Anchor

	showWorksetAccessChanges
	showWorksetAccessChanges

Wiki Markup

{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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorksetAccessChanges

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

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.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

changeResultType

Table Cell (td)

class	methodReturnDesc

Returns the list of access changes to this workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Workset does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CHANGE

Table Cell (td)

class	methodErrorDesc

No objects added or removed from the workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showWorksetBalanceExceptions
	showWorksetBalanceExceptions

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorksetBalanceExceptions

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Show the list of cost objects whose balance < 0 currently or are expected to be < 0 on the project end date.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

changeResultType

Table Cell (td)

class	methodReturnDesc

Returns the list of balance exceptions on this workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Workset does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_CHANGE

Table Cell (td)

class	methodErrorDesc

No issues identified

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

...

Wiki Markup

{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

Anchor

	showWorksetCOSummary
	showWorksetCOSummary

Wiki Markup

{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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorksetCOSummary

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Show summary information about the COs in the workset

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_Key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

worksetCOSummaryResultType

Table Cell (td)

class	methodReturnDesc

Returns a summary of cost objects in the workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Workset does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access workset information

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	showWorksetApptSummary
	showWorksetApptSummary

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorksetApptSummary

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Shows a summary of People/Appt information in the workset

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

worksetApptSummaryResultType

Table Cell (td)

class	methodReturnDesc

Returns a summary of people/appts in the workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Workset does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in this workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

...

Wiki Markup

{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

Anchor

	showWorksetScenarioSummary
	showWorksetScenarioSummary

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

showWorksetScenarioSummary

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Show the list of defined of defined Scenarios in the workset

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_key

Table Cell (td)

class	methodParamDesc

The unique identifier for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

worksetScenarioResultType

Table Cell (td)

class	methodReturnDesc

Returns the list of scenarios in the workset

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

Workset does not exist in system

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

NO_AUTH

Table Cell (td)

class	methodErrorDesc

User cannot access objects in the workset

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Wiki Markup

{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

Child pages

Versions Compared

Old Version 11

New Version 12

Key