Versions Compared

Key

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

Overview


The PwsEngagementSummary data type This structure includes basic information about an engagement. The information represented in this structure is not comprehensive and only includes certain key attributes of an engagement deemed to be useful in a listing of engagements.

Format


Panel
titlePwsEngagementSummary
  • PwsEngagementSummary
    • EngagementCode: String (20)
    • EngagementId: Int32
    • EngagementUid: Int64
    • ClientIdentity: PwsClientRef
    • EngagementName: String (255)

...

Element

Data Type

Required?Default

Description

Sample Data

EngagementCode

String (20)

On Insert: Yes

On Update: Yes (if EngagementUid is not supplied)One of EngagementCode or EngagementUid is required

The engagement code is a unique identifier for an engagement. See "NewEngagementCode" in PwsEngagementDetail for guidance on how to change the engagement code of an existing engagement. 

P001320

EngagementId

Int32

On Insert: No

On Update: No

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


EngagementUid

Int64

On Insert: No

On Update: Yes (if EngagementCode is not supplied)See EngagementCode

A unique and immutable identifier for an engagement.

1152921504607326368


ClientIdentity

PwsClientRef

On Insert: Yes

On Update: No

The client associated with the engagement.


EngagementName

String (255)

On Insert: Yes

On Update: No

The engagement name.

Web Services Documentation


...