...
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.
In association with PwsSaveEngagement here are the rules:
- If an Engagement Stage is specified, the web service will use it
- Otherwise, the following rules will be in effect:
- If there is a default engagement stage for the engagement type (due to enterprise configuration), use it
- OR
- Select the first allowed engagement stage (specifically, or via ‘(all engagement stages)’) ordered by sort order, if any
- If there is a default engagement stage for the engagement type (due to enterprise configuration), use it
- Otherwise, throw an error
Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
EngagementStageId | Int32 | On Insert: No On Update: No | The engagement stage Id is a unique identifier for an engagement stage. For internal use only. | ||
EngagementStageName | String (50) | On Insert: Yes On Update: Yes (if EngagementStageUid is not supplied)One of EngagementName, EngagementStageShortName or EngagementStageUid is required | The engagement stage name is a unique identifier for an engagement stage. | Open | |
EngagementStageShortName | String (15) | On Insert: No On Update: NoSee EngagementStageName | The engagement stage short name is a unique identifier for an engagement stage. | Open | |
EngagementStageUid | Int64 | On Insert: No On Update: Yes (if EngagementStageName is not supplied) | The engagement stage Uid is a See EngagementStageName | A unique and immutable identifier for an engagement stage. | 1152921504606849675 |
Usage Example(s)
...