Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This structure represents the unique key fields associated with identifying an engagement stage. Engagement Stages can be identified by EngagementStageName, EngagementStageShortName or EngagementStageUid. When specifying a PwsEngagementStageRef as an input to a web service, you may specify any combination of one or all three fields the more of EngagementStageName, EngagementStageShortName and/or EngagementStageUid. However, if you do specify all threemore than one, they must refer to the same engagement stage or the engagement stage reference will not be considered valid. When a PwsEngagementStageRef is returned in the response to a web service, the EngagementStageName, EngagementStageShortName and /or EngagementStageUid will all be populated, and guaranteed to refer to a single engagement stage.

...

Element

Data Type

Required?

Description

Sample Data

EngagementStageId

Int32

No

The engagement stage Id is a unique identifier for an engagement stage. For internal use only.


EngagementStageName

String (50)

One of EngagementName, EngagementStageShortName or EngagementStageUid is required


The engagement stage name is a unique identifier for an engagement stage.

Open

EngagementStageShortName

String (15)

See EngagementStageName

The engagement stage short name is a unique identifier for an engagement stage.

Open

EngagementStageUid

Int64

See EngagementStageName


A unique and immutable identifier for an engagement stage.

1152921504606849675

Usage Example(s)

...