Overview
Request Format
PwsSearchDocuments Request
- PwsSearchDocuments
- serviceRequest: PwsSearchDocumentsRq
- RequestId: Int32
- SessionTicket: String
- FolderTypeCode: String
- ProjectIdentity: PwsProjectRef
- ResourceIdentity: PwsResourceRef
- SearchString: String
- IncludeInactiveFlag: Boolean
- serviceRequest: PwsSearchDocumentsRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Click here for more information. | |||
FolderTypeCode | String | ||||
ProjectIdentity | |||||
ResourceIdentity | |||||
SearchString | String | ||||
IncludeInactiveFlag | Boolean |
Request Usage Example(s)
Response Format
PwsSearchDocuments Response
- PwsSearchDocumentsResponse
- PwsSearchDocumentsResult: PwsSearchDocumentsRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Results: PwsSearchResult
- PwsSearchDocumentsResult: PwsSearchDocumentsRs
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | |||
ResponseId | Int32 | Click here for more information. | |
Status | Click here for more information | ||
ServerTimestampUtc | DateTime | Click here for more information. | |
Results |
Response Usage Example(s)
PwsGetDocumentHistory - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 21017 | InvalidValueForFolderTypeCode | The specified folder type code is not recognized. |
| 21030 | SearchStringRequiredForSearchDocuments | A search string must be specified. |
| 75240 | ResourceMayNotBeSpecifiedWhenSearchingWorkspaces | Resource may not be specified when searching project workspaces. |
| 75241 | ProjectmayNotBeSpecifiedWhenSearchingResumes | Project may not be specified when searching resource resumes. |