/AWS1/CL_PTSGETENGAGEMENTRSP¶
GetEngagementResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_id TYPE /AWS1/PTSENGAGEMENTIDENTIFIER /AWS1/PTSENGAGEMENTIDENTIFIER¶
The unique resource identifier of the engagement retrieved.
iv_arn TYPE /AWS1/PTSENGAGEMENTARN /AWS1/PTSENGAGEMENTARN¶
The Amazon Resource Name (ARN) of the engagement retrieved.
iv_title TYPE /AWS1/PTSENGAGEMENTTITLE /AWS1/PTSENGAGEMENTTITLE¶
The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.
iv_description TYPE /AWS1/PTSENGAGEMENTDESCRIPTION /AWS1/PTSENGAGEMENTDESCRIPTION¶
A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.
iv_createdat TYPE /AWS1/PTSDATETIME /AWS1/PTSDATETIME¶
The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.
iv_createdby TYPE /AWS1/PTSAWSACCOUNT /AWS1/PTSAWSACCOUNT¶
The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.
iv_membercount TYPE /AWS1/PTSINTEGER /AWS1/PTSINTEGER¶
Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.
it_contexts TYPE /AWS1/CL_PTSENGAGEMENTCTXDETS=>TT_ENGAGEMENTCONTEXTS TT_ENGAGEMENTCONTEXTS¶
A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
Queryable Attributes¶
Id¶
The unique resource identifier of the engagement retrieved.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Arn¶
The Amazon Resource Name (ARN) of the engagement retrieved.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
Title¶
The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLE() |
Getter for TITLE, with configurable default |
ASK_TITLE() |
Getter for TITLE w/ exceptions if field has no value |
HAS_TITLE() |
Determine if TITLE has a value |
Description¶
A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
CreatedAt¶
The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
CreatedBy¶
The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDBY() |
Getter for CREATEDBY, with configurable default |
ASK_CREATEDBY() |
Getter for CREATEDBY w/ exceptions if field has no value |
HAS_CREATEDBY() |
Determine if CREATEDBY has a value |
MemberCount¶
Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MEMBERCOUNT() |
Getter for MEMBERCOUNT, with configurable default |
ASK_MEMBERCOUNT() |
Getter for MEMBERCOUNT w/ exceptions if field has no value |
HAS_MEMBERCOUNT() |
Determine if MEMBERCOUNT has a value |
Contexts¶
A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTEXTS() |
Getter for CONTEXTS, with configurable default |
ASK_CONTEXTS() |
Getter for CONTEXTS w/ exceptions if field has no value |
HAS_CONTEXTS() |
Determine if CONTEXTS has a value |