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 Stageengagement 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 one or all three fields the EngagementStageName, EngagementStageShortName and/or EngagementStageUid. However, if you do specify all three, they must refer to the same Engagement Stage engagement stage or the Engagement Stage 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 be populated, and guaranteed to refer to a single Engagement Stageengagement stage.

Format


Panel
titlePwsEngagementStageRef
  • PwsEngagementStageRef
    • EngagementStageId: Int32
    • EngagementStageName: String (50)
    • EngagementStageShortName: String (15)
    • EngagementStageUid: Int64

...

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)


The Engagement Stage Name is a unique identifier for an Engagement.

Open

EngagementStageShortName

String (15)

On Insert: No

On Update: No


The Engagement Stage Short Name is a unique identifier for an Engagement.

OP

EngagementStageUid

Int64

On Insert: No

On Update: Yes (if EngagementStageName is not supplied)


The Engagement Stage Uid is a unique and immutable identifier for an Engagement.

1152921504606849675

...