...
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. This flag is disregarded if an engagement is specified. EngagementId/EngagementUid/EngagementCode. If specified, the identified engagement will be returned (QueryString and IncludeClosedFlag will be ignored)in EngagementIdentity. | true |
MaxRowsToReturn | Int32 | No | The maximum number of engagements to be retrieved. This flag value is disregarded if an engagement is specified in EngagementIdentity. | 5 | |
QueryString | String | No | A search string to narrow down the results. An engagement will be included in the results if the search string matches the engagement code or engagement name, or if it matches the client name or number for the engagement's client or any parent client thereof, or if it matches the contract line item name or code or project name or code of any contract line item or project contained in the engagement. This value is disregarded if a cost center an engagement is specified in EngagementIdentity. Click here for more information. | ||
LastUpdatedSinceTimestamp | DateTime | No | Only engagements that have been updated on or after the specified date/time will be retrieved. This flag value is disregarded if an engagement is specified. | 2018-01-01 | |
PurchaseOrderNumber | String | No | The purchase order number(s) associated with the engagement(s). This flag An exact match filter on the engagement purchase order number. If specified, only engagements whose purchase order number exactly matches the specified value will be included in the response. This value is disregarded if an engagement is specified. |
...