/AWS1/CL_PTSSTRTENGAGEMENTBY01¶
StartEngagementByAcceptingInvitationTaskResponse
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
iv_taskid
TYPE /AWS1/PTSTASKIDENTIFIER
/AWS1/PTSTASKIDENTIFIER
¶
The unique identifier of the task, used to track the task’s progress.
iv_taskarn
TYPE /AWS1/PTSTASKARN
/AWS1/PTSTASKARN
¶
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
iv_starttime
TYPE /AWS1/PTSDATETIME
/AWS1/PTSDATETIME
¶
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
iv_taskstatus
TYPE /AWS1/PTSTASKSTATUS
/AWS1/PTSTASKSTATUS
¶
Indicates the current status of the task.
iv_message
TYPE /AWS1/PTSSTRING
/AWS1/PTSSTRING
¶
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
iv_reasoncode
TYPE /AWS1/PTSREASONCODE
/AWS1/PTSREASONCODE
¶
Indicates the reason for task failure using an enumerated code.
iv_opportunityid
TYPE /AWS1/PTSOPPORTUNITYIDENTIFIER
/AWS1/PTSOPPORTUNITYIDENTIFIER
¶
Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.
iv_resourcesnapshotjobid
TYPE /AWS1/PTSRESOURCESNAPSHOTJOBID
/AWS1/PTSRESOURCESNAPSHOTJOBID
¶
The identifier of the Resource Snapshot Job created as part of this task.
iv_engagementinvitationid
TYPE /AWS1/PTSENGAGEMENTINVITATIO01
/AWS1/PTSENGAGEMENTINVITATIO01
¶
Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.
Queryable Attributes¶
TaskId¶
The unique identifier of the task, used to track the task’s progress.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TASKID() |
Getter for TASKID, with configurable default |
ASK_TASKID() |
Getter for TASKID w/ exceptions if field has no value |
HAS_TASKID() |
Determine if TASKID has a value |
TaskArn¶
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TASKARN() |
Getter for TASKARN, with configurable default |
ASK_TASKARN() |
Getter for TASKARN w/ exceptions if field has no value |
HAS_TASKARN() |
Determine if TASKARN has a value |
StartTime¶
The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STARTTIME() |
Getter for STARTTIME, with configurable default |
ASK_STARTTIME() |
Getter for STARTTIME w/ exceptions if field has no value |
HAS_STARTTIME() |
Determine if STARTTIME has a value |
TaskStatus¶
Indicates the current status of the task.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TASKSTATUS() |
Getter for TASKSTATUS, with configurable default |
ASK_TASKSTATUS() |
Getter for TASKSTATUS w/ exceptions if field has no value |
HAS_TASKSTATUS() |
Determine if TASKSTATUS has a value |
Message¶
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MESSAGE() |
Getter for MESSAGE, with configurable default |
ASK_MESSAGE() |
Getter for MESSAGE w/ exceptions if field has no value |
HAS_MESSAGE() |
Determine if MESSAGE has a value |
ReasonCode¶
Indicates the reason for task failure using an enumerated code.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REASONCODE() |
Getter for REASONCODE, with configurable default |
ASK_REASONCODE() |
Getter for REASONCODE w/ exceptions if field has no value |
HAS_REASONCODE() |
Determine if REASONCODE has a value |
OpportunityId¶
Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_OPPORTUNITYID() |
Getter for OPPORTUNITYID, with configurable default |
ASK_OPPORTUNITYID() |
Getter for OPPORTUNITYID w/ exceptions if field has no value |
HAS_OPPORTUNITYID() |
Determine if OPPORTUNITYID has a value |
ResourceSnapshotJobId¶
The identifier of the Resource Snapshot Job created as part of this task.
Accessible with the following methods¶
Method | Description |
---|---|
GET_RESOURCESNAPSHOTJOBID() |
Getter for RESOURCESNAPSHOTJOBID, with configurable default |
ASK_RESOURCESNAPSHOTJOBID() |
Getter for RESOURCESNAPSHOTJOBID w/ exceptions if field has |
HAS_RESOURCESNAPSHOTJOBID() |
Determine if RESOURCESNAPSHOTJOBID has a value |
EngagementInvitationId¶
Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ENGAGEMENTINVITATIONID() |
Getter for ENGAGEMENTINVITATIONID, with configurable default |
ASK_ENGAGEMENTINVITATIONID() |
Getter for ENGAGEMENTINVITATIONID w/ exceptions if field has |
HAS_ENGAGEMENTINVITATIONID() |
Determine if ENGAGEMENTINVITATIONID has a value |