FindItemRevisionsBySearchConditions

POST {{Host}}/AutodeskDM/Services/v26/ItemService.svc

Gets a set of Item revisions based on a property or multiple properties search.
The search is based off of property definition Ids and search text that is defined by conditional operators.


Required Vault Permissions

Item Read Permission


Returns

An array of Item[] or null if there were no matches.


searchConditions

Optional
A set of search criteria as SrchCond[]. If this parameter is null, all Items will be returned.

Example

<SrchCond PropDefId="156" SrchOper="3" SrchTxt="605-D-M110" PropTyp="SingleProperty" SrchRule="Must"/>

SrchCond Attributes Table

Use the table below to define each SrchCond for the searchConditions array parameter.

Attribute NameTypeDescription
PropDefIdIntegerThe ID of the property definition to search on.
SrchOperIntegerThe type of search to perform, see Search Operator Table below.
SrchTxtStringThe text to search for in the specified properties.
PropTypeStringScope of search, see PropertySearchType table below.
SrchRuleIntegerTells if the condition must or may be true, see SearchRuleType table below.

SrchOper Attributes Table

Number column is used in the request.

Search OperatorNumberSearch Text RequiredValid For Types
Contains1YesString
Does not contain2YesString
Is exactly (or equals)3YesNumeric, Bool, DateTime, String
Is empty4NoImage, String
Is not empty5NoImage, String
Greater than6YesNumeric, DateTime, String
Greater than or equal to7YesNumeric, DateTime, String
Less than8YesNumeric, DateTime, String
Less than or equal to9YesNumeric, DateTime, String
Not equal to10YesNumeric, Bool, String

PropertySearchType Table

PropertySeachType column is used in the request.

PropertySearchTypeDescription
AllPropertiesSearches all properties.
AllPropertiesAndContentSearches all properties and text inside the file.
SinglePropertySearches a single property.

SearchRuleType Table

SearchRuleType column is used in the request.

SearchRuleTypeDescription
MayThe search condition may be true (aka. OR
search).
MustThe search condition must be true (aka. AND
search).
MustNotReserved 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 NameTypeDescription
PropDefIdIntegerThe ID of the property definition to sort on.
SortAscBooleanIf true, the sort is ascending. If false, the sort is descending.

bRequestLatestOnly

Optional If true, then only the latest revision of an Item will be returned.
Otherwise all revisions of a matching Item 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 CodeNameDescription
106TransactionInvalidPrincipalAn 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.
300BadAuthenticationTokenThis can happen when the web services are restarted, a user has logged out, or a bad token is supplied in the SecurityHeader.
303PermissionDeniedThe current user does not have permission to view the Vault Item.
308RestrictionsOccurredThe Vault Item could not be viewed due to some other settings in Vault restricting access to the Item.

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
SOAPActionstring

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        \u003cFindItemRevisionsBySearchConditionsResponse xmlns=\&quot;http://AutodeskDM/Services/Item/1/7/2020/\&quot;\u003e\n            \u003cFindItemRevisionsBySearchConditionsResult\u003e\n                \u003cItem RevId=\&quot;95\&quot; RevNum=\&quot;A\&quot; LastModUserName=\&quot;Administrator\&quot; LastModUserId=\&quot;2\&quot; LastModDate=\&quot;2021-10-26T03:31:47.51+00:00\&quot; MasterId=\&quot;1058\&quot; ItemNum=\&quot;605-D-M110\&quot; Title=\&quot;605-D-M110\&quot; Detail=\&quot;\&quot; Id=\&quot;1062\&quot; VerNum=\&quot;3\&quot; Comm=\&quot;In review\&quot; Units=\&quot;Each\&quot; LfCycStateId=\&quot;33\&quot; UnitId=\&quot;1\&quot; NumSchmId=\&quot;-1\&quot; CadBOMStruct=\&quot;Normal\&quot; ControlledByChangeOrder=\&quot;false\&quot; MaxCommittedId=\&quot;1062\&quot; IsCloaked=\&quot;false\&quot; Locked=\&quot;false\&quot;\u003e\n                    \u003cCat CatId=\&quot;9\&quot; CatName=\&quot;Assembly\&quot;/\u003e\n                    \u003cLfCyc LfCycStateId=\&quot;33\&quot; LfCycDefId=\&quot;8\&quot; Consume=\&quot;false\&quot; Obsolete=\&quot;false\&quot;/\u003e\n                \u003c/Item\u003e\n            \u003c/FindItemRevisionsBySearchConditionsResult\u003e\n            \u003cbookmark/\u003e\n            \u003csearchstatus TotalHits=\&quot;1\&quot; IndxStatus=\&quot;IndexingComplete\&quot;/\u003e\n        \u003c/FindItemRevisionsBySearchConditionsResponse\u003e\n    \u003c/s:Body\u003e\n\u003c/s:Envelope\u003e\n&quot;