Qodex.ai

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 Search Text 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

Optional The 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

Optional If false, only files in the specified folders will be searched.

If true the specified folders and their sub-folders will be searched.

latestOnly

Optional If 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

&quot;\u003c?xml version=\&quot;1.0\&quot; encoding=\&quot;utf-8\&quot;?\u003e\n\u003cs:Envelope xmlns:s=\&quot;http://schemas.xmlsoap.org/soap/envelope/\&quot;\u003e\n    \u003cs:Body xmlns:xsi=\&quot;http://www.w3.org/2001/XMLSchema-instance\&quot; xmlns:xsd=\&quot;http://www.w3.org/2001/XMLSchema\&quot;\u003e\n        \u003cFindFilesBySearchConditionsResponse xmlns=\&quot;http://AutodeskDM/Services/Document/1/7/2020/\&quot;\u003e\n            \u003cFindFilesBySearchConditionsResult\u003e\n                \u003cFile Id=\&quot;1093\&quot; Name=\&quot;TestPart.pdf\&quot; VerName=\&quot;TestPart.pdf\&quot; MasterId=\&quot;1092\&quot; VerNum=\&quot;1\&quot; MaxCkInVerNum=\&quot;1\&quot; CkInDate=\&quot;2021-12-07T06:26:58.12+00:00\&quot; Comm=\&quot;\&quot; CreateDate=\&quot;2021-12-07T06:26:58.12+00:00\&quot; CreateUserId=\&quot;2\&quot; Cksum=\&quot;1835196236\&quot; FileSize=\&quot;1055173\&quot; ModDate=\&quot;2021-10-11T07:01:25.23+00:00\&quot; CreateUserName=\&quot;Administrator\&quot; CheckedOut=\&quot;false\&quot; FolderId=\&quot;1091\&quot; CkOutSpec=\&quot;\&quot; CkOutMach=\&quot;\&quot; CkOutUserId=\&quot;-1\&quot; FileClass=\&quot;None\&quot; Locked=\&quot;false\&quot; Hidden=\&quot;false\&quot; Cloaked=\&quot;false\&quot; FileStatus=\&quot;Unknown\&quot; IsOnSite=\&quot;true\&quot; DesignVisAttmtStatus=\&quot;None\&quot; ControlledByChangeOrder=\&quot;false\&quot;\u003e\n                    \u003cFileRev RevId=\&quot;97\&quot; Label=\&quot;\&quot; MaxConsumeFileId=\&quot;-1\&quot; MaxFileId=\&quot;1093\&quot; RevDefId=\&quot;0\&quot; MaxRevId=\&quot;97\&quot; Order=\&quot;1\&quot;/\u003e\n                    \u003cFileLfCyc LfCycStateId=\&quot;-1\&quot; LfCycDefId=\&quot;0\&quot; LfCycStateName=\&quot;\&quot; Consume=\&quot;false\&quot; Obsolete=\&quot;false\&quot;/\u003e\n                    \u003cCat CatId=\&quot;1\&quot; CatName=\&quot;Base\&quot;/\u003e\n                \u003c/File\u003e\n                \u003cFile Id=\&quot;1017\&quot; Name=\&quot;TestPart.pdf\&quot; VerName=\&quot;TestPart.pdf\&quot; MasterId=\&quot;1016\&quot; VerNum=\&quot;1\&quot; MaxCkInVerNum=\&quot;1\&quot; CkInDate=\&quot;2021-10-11T07:01:27.333+00:00\&quot; Comm=\&quot;Generated by coolOrange powerVault\&quot; CreateDate=\&quot;2021-10-11T07:01:27.333+00:00\&quot; CreateUserId=\&quot;2\&quot; Cksum=\&quot;1835196236\&quot; FileSize=\&quot;1055173\&quot; ModDate=\&quot;2021-10-11T07:01:25.23+00:00\&quot; CreateUserName=\&quot;Administrator\&quot; CheckedOut=\&quot;false\&quot; FolderId=\&quot;7\&quot; CkOutSpec=\&quot;\&quot; CkOutMach=\&quot;\&quot; CkOutUserId=\&quot;-1\&quot; FileClass=\&quot;None\&quot; Locked=\&quot;false\&quot; Hidden=\&quot;false\&quot; Cloaked=\&quot;false\&quot; FileStatus=\&quot;Unknown\&quot; IsOnSite=\&quot;true\&quot; DesignVisAttmtStatus=\&quot;None\&quot; ControlledByChangeOrder=\&quot;false\&quot;\u003e\n                    \u003cFileRev RevId=\&quot;85\&quot; Label=\&quot;\&quot; MaxConsumeFileId=\&quot;-1\&quot; MaxFileId=\&quot;1017\&quot; RevDefId=\&quot;0\&quot; MaxRevId=\&quot;85\&quot; Order=\&quot;1\&quot;/\u003e\n                    \u003cFileLfCyc LfCycStateId=\&quot;-1\&quot; LfCycDefId=\&quot;0\&quot; LfCycStateName=\&quot;\&quot; Consume=\&quot;false\&quot; Obsolete=\&quot;false\&quot;/\u003e\n                    \u003cCat CatId=\&quot;1\&quot; CatName=\&quot;Base\&quot;/\u003e\n                \u003c/File\u003e\n            \u003c/FindFilesBySearchConditionsResult\u003e\n            \u003cbookmark/\u003e\n            \u003csearchstatus TotalHits=\&quot;2\&quot; IndxStatus=\&quot;IndexingComplete\&quot;/\u003e\n        \u003c/FindFilesBySearchConditionsResponse\u003e\n    \u003c/s:Body\u003e\n\u003c/s:Envelope\u003e&quot;