FindItemRevisionsBySearchConditions
POST {{Host}}/AutodeskDM/Services/v26/ItemService.svc
Gets a set of Item revisions based on a property search.
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 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 Types |
|---|---|---|---|
| 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. |
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 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 the Vault Item. |
| 308 | RestrictionsOccurred | The Vault Item could not be viewed due to some other settings in Vault restricting access to the Item. |
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 \u003cFindItemRevisionsBySearchConditionsResponse xmlns=\"http://AutodeskDM/Services/Item/1/7/2020/\"\u003e\n \u003cFindItemRevisionsBySearchConditionsResult\u003e\n \u003cItem RevId=\"95\" RevNum=\"A\" LastModUserName=\"Administrator\" LastModUserId=\"2\" LastModDate=\"2021-10-26T03:31:47.51+00:00\" MasterId=\"1058\" ItemNum=\"605-D-M110\" Title=\"605-D-M110\" Detail=\"\" Id=\"1062\" VerNum=\"3\" Comm=\"In review\" Units=\"Each\" LfCycStateId=\"33\" UnitId=\"1\" NumSchmId=\"-1\" CadBOMStruct=\"Normal\" ControlledByChangeOrder=\"false\" MaxCommittedId=\"1062\" IsCloaked=\"false\" Locked=\"false\"\u003e\n \u003cCat CatId=\"9\" CatName=\"Assembly\"/\u003e\n \u003cLfCyc LfCycStateId=\"33\" LfCycDefId=\"8\" Consume=\"false\" Obsolete=\"false\"/\u003e\n \u003c/Item\u003e\n \u003c/FindItemRevisionsBySearchConditionsResult\u003e\n \u003cbookmark/\u003e\n \u003csearchstatus TotalHits=\"1\" IndxStatus=\"IndexingComplete\"/\u003e\n \u003c/FindItemRevisionsBySearchConditionsResponse\u003e\n \u003c/s:Body\u003e\n\u003c/s:Envelope\u003e\n"