Versions Compared

Version Old Version 17 New Version 18
Changes made by

Bettina Borces

Luke Wright

Saved on

Key

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

...

  • QueryString: Find all projects matching specified string in project's code or name, associated contract line item code or name, the associated engagement code or name, or the client name or number for the associated engagement's client or any parent client thereof.
  • IncludeClosedFlag: If set to 'true', projects that are open or considered closed according to the project stage settings will be returnedincluded in the results. Otherwise, only projects that are considered not closed will be returnedopen will be included.
  • LastUpdatedTimestamp: If specified, only projects updated on after the specified timestamp will be included.
  • ProjectIdentity: If specified, only the identified engagement project will be returned. And QueryString, IncludeClosedFlag and IncludeClosedFlag LastUpdatedTimestamp will be ignored.

Request Format

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

 No


Click here for more information.


SessionTicket

String

 Yes


Click here for more information.

ARM5cmQi4CD5BoGl6bHk4w==

IncludeClosedFlag

Boolean

 No

 false

If set to 'true', projects that are open or considered closed according to the project stage settings will be returnedincluded. Otherwise, only projects that are considered not closed open will be returnedincluded. This flag is disregarded if a project is specified in ProjectIdentity.

 false

MaxRowsToReturn

Int32

 No


The maximum number of projects to be retrieved. This flag value is disregarded if a project is specified in ProjectIdentity.

 10

ProjectIdentity

PwsProjectRef

 No


The unique keys used to identify projects(s) to be retrievedMay be specified to retrieve a single project summary. Click here for more information.


QueryString

String (255)

 No


A search string to narrow down the results. A project will be included in the results if the search string matches the project's code or name, of if it matches the associated contract line item code or name, or if it matches the associated engagement code or name, of if it matches the client name or number for the associated engagement's client or any parent client thereof. This value is disregarded if a project is specified in ProjectIdentity.

 P001053-001|P001053-002

LastUpdatedSinceTimestamp

DateTime

 No


Only projects that have been updated on or after the specified date/time will be retrieved. This value is disregarded if a project is specified in ProjectIdentity.

 2018-01-01z

...