FindFilesBySearchConditions
POST {{Host}}/AutodeskDM/Services/v26/DocumentService.svc
Searches the Vault for files based on the passed search conditions.
Parameters
SrchCond
Required
The search parameters.
Entering an array of length 0 is legal, but a null array is illegal.
SrchCond Attributes Table
| Attribute Name | Type | Description |
|---|---|---|
| PropDefId | Integer | The ID of the property definition to search on. |
| SrchOper | Integer | The type of search to perform, see Search Operator Table below. |
| SrchTxt | String | The text to search for in the specified properties. |
| PropType | String | Scope of search, see PropertySearchType table below. |
| SrchRule | Integer | Tells if the condition must or may be true, see SearchRuleType table below. |
**SrchOper Attributes Table
Number column is used in the request.
| Search Operator | Number | SearchText Required | Valid For Searched Property Types of |
|---|---|---|---|
| Contains | 1 | Yes | String |
| Does not contain | 2 | Yes | String |
| Is exactly (or equals) | 3 | Yes | Numeric, Bool, DateTime, String |
| Is empty | 4 | No | Image, String |
| Is not empty | 5 | No | Image, String |
| Greater than | 6 | Yes | Numeric, DateTime, String |
| Greater than or equal to | 7 | Yes | Numeric, DateTime, String |
| Less than | 8 | Yes | Numeric, DateTime, String |
| Less than or equal to | 9 | Yes | Numeric, DateTime, String |
| Not equal to | 10 | Yes | Numeric, Bool, String |
PropertySearchType Table
PropertySeachType column is used in the request.
| PropertySearchType | Description |
|---|---|
| AllProperties | Searches all properties. |
| AllPropertiesAndContent | Searches all properties and text inside the file. |
| SingleProperty | Searches a single property. |
SearchRuleType Table
SearchRuleType column is used in the request.
| SearchRuleType | Description |
|---|---|
| May | The search condition may be true (aka. OR search). |
| Must | The search condition must be true (aka. AND search). |
| MustNot | Reserved for future use. |
SrchSort
OptionalThe properties to sort on. The first value in the array is the primary sort, the second value is the secondary sort, etc.
<SrchSort PropDefId="9" SortAsc="true"/>
SrchSort Attributes Table
| Attribute Name | Type | Description |
|---|---|---|
| PropDefId | Integer | The ID of the property definition to sort on. |
| SortAsc | Boolean | If true, the sort is ascending. If false, the sort is descending. |
folderIds
Optional
A list of folders to search in.
recurseFolders
OptionalIf false, only files in the specified folders will be searched.
If true the specified folders and their sub-folders will be searched.
latestOnly
OptionalIf true, than only the latest version of a file will be returned.
Otherwise all matching versions will be returned.
bookmark
[in/out]
Used to continue a search if the results are too large for a single
call. Pass in null for the first call of the search. Pass in the returned
bookmark string for subsequent calls on that search.
searchstatus
[out]
Returns status information about the search.
Error Responses Values
Below are common error codes that can be returned for this request.
| Error Code | Name | Description |
|---|---|---|
| 106 | TransactionInvalidPrincipal | An example would be making a call without being logged into a vault for methods that require a vault or excluding the SecurityHeader in a SOAP based API call. |
| 300 | BadAuthenticationToken | This can happen when the web services are restarted, a user has logged out, or a bad token is supplied in the SecurityHeader. |
| 303 | PermissionDenied | The current user does not have permission to view or download the file. |
| 308 | RestrictionsOccurred | The file could not be viewed or downloaded due to some other settings in Vault restricting access to the file. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
SOAPAction | string |
RESPONSES
status: OK
"\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003cs:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\"\u003e\n \u003cs:Body xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\u003e\n \u003cFindFilesBySearchConditionsResponse xmlns=\"http://AutodeskDM/Services/Document/1/7/2020/\"\u003e\n \u003cFindFilesBySearchConditionsResult\u003e\n \u003cFile Id=\"1093\" Name=\"TestPart.pdf\" VerName=\"TestPart.pdf\" MasterId=\"1092\" VerNum=\"1\" MaxCkInVerNum=\"1\" CkInDate=\"2021-12-07T06:26:58.12+00:00\" Comm=\"\" CreateDate=\"2021-12-07T06:26:58.12+00:00\" CreateUserId=\"2\" Cksum=\"1835196236\" FileSize=\"1055173\" ModDate=\"2021-10-11T07:01:25.23+00:00\" CreateUserName=\"Administrator\" CheckedOut=\"false\" FolderId=\"1091\" CkOutSpec=\"\" CkOutMach=\"\" CkOutUserId=\"-1\" FileClass=\"None\" Locked=\"false\" Hidden=\"false\" Cloaked=\"false\" FileStatus=\"Unknown\" IsOnSite=\"true\" DesignVisAttmtStatus=\"None\" ControlledByChangeOrder=\"false\"\u003e\n \u003cFileRev RevId=\"97\" Label=\"\" MaxConsumeFileId=\"-1\" MaxFileId=\"1093\" RevDefId=\"0\" MaxRevId=\"97\" Order=\"1\"/\u003e\n \u003cFileLfCyc LfCycStateId=\"-1\" LfCycDefId=\"0\" LfCycStateName=\"\" Consume=\"false\" Obsolete=\"false\"/\u003e\n \u003cCat CatId=\"1\" CatName=\"Base\"/\u003e\n \u003c/File\u003e\n \u003cFile Id=\"1017\" Name=\"TestPart.pdf\" VerName=\"TestPart.pdf\" MasterId=\"1016\" VerNum=\"1\" MaxCkInVerNum=\"1\" CkInDate=\"2021-10-11T07:01:27.333+00:00\" Comm=\"Generated by coolOrange powerVault\" CreateDate=\"2021-10-11T07:01:27.333+00:00\" CreateUserId=\"2\" Cksum=\"1835196236\" FileSize=\"1055173\" ModDate=\"2021-10-11T07:01:25.23+00:00\" CreateUserName=\"Administrator\" CheckedOut=\"false\" FolderId=\"7\" CkOutSpec=\"\" CkOutMach=\"\" CkOutUserId=\"-1\" FileClass=\"None\" Locked=\"false\" Hidden=\"false\" Cloaked=\"false\" FileStatus=\"Unknown\" IsOnSite=\"true\" DesignVisAttmtStatus=\"None\" ControlledByChangeOrder=\"false\"\u003e\n \u003cFileRev RevId=\"85\" Label=\"\" MaxConsumeFileId=\"-1\" MaxFileId=\"1017\" RevDefId=\"0\" MaxRevId=\"85\" Order=\"1\"/\u003e\n \u003cFileLfCyc LfCycStateId=\"-1\" LfCycDefId=\"0\" LfCycStateName=\"\" Consume=\"false\" Obsolete=\"false\"/\u003e\n \u003cCat CatId=\"1\" CatName=\"Base\"/\u003e\n \u003c/File\u003e\n \u003c/FindFilesBySearchConditionsResult\u003e\n \u003cbookmark/\u003e\n \u003csearchstatus TotalHits=\"2\" IndxStatus=\"IndexingComplete\"/\u003e\n \u003c/FindFilesBySearchConditionsResponse\u003e\n \u003c/s:Body\u003e\n\u003c/s:Envelope\u003e"