...
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 | |
SessionTicket | String | Yes | Click here for more information. | Ab54WRQ1LlgW9CoQrXhyzw== | |
EngagementIdentity | No | The unique keys used to identify the engagement(s) to be retrieved. Click here for more information. | |||
IncludeClosedFlag | Boolean | Yes | false | If set to 'true', engagements that are open or closed according to the current engagement stage settings will be returned. Otherwise, only engagements that are not considered closed will be returned.
| true |
MaxRowsToReturn | Int32 | No | The maximum number of engagements to be retrieved | 5 | |
QueryString | String | No | The engagements that are returned will contain the value in this field | ||
LastUpdatedSinceTimestamp | DateTime | No | Only engagements that have been updated on or after the specified date/time will be retrieved | 2018-01-01 | |
PurchaseOrderNumber | String | No | The purchase order number(s) associated with the engagement(s) |
...
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | RequestStatus | Click here for more information. | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-01-19T16:51:13.0252909Z |
Engagements | The engagements that were fetched by the service. Click here for more information. |
Response Usage Example(s)
...