Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Overview


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 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 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 be populated, and guaranteed to refer to a single engagement stage.

Format


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


Element


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

Usage Example(s)


Example 01 
                     <EngagementStageIdentity>
                        <EngagementStageId i:nil="true"/>
                        <EngagementStageName>Open</EngagementStageName>
                        <EngagementStageShortName>OP</EngagementStageShortName>
                        <EngagementStageUid>1152921504606849675</EngagementStageUid>
                     </EngagementStageIdentity>
  • No labels