Previous Topic: OpenQueryResultListNext Topic: Security


SetQuery

The SetQuery method updates the properties of a query definition.

Parameters

xsd:string sessionId (m)

The session identifier.

SetQueryProperties setQueryProperties (m)

The properties that are updated for the specified query.

Return Values

This is a void method that does not expose a return value.

Remarks

None

More information:

SetQueryProperties

SetQuery2

The SetQuery method updates the properties of a query definition. We can update the link query using this method.

Parameters

xsd:string sessionId

The session identifier.

xsd:string queryId

UUID of the query to be updated

dsm:SetQueryProperties3 setQueryProperties

The properties that are updated for the specified query.

Return Values

None.

GetQueryFolderId

The GetQueryFolderId method returns the ID of the specified query folder.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string folderName

Specifies the name of the query folder, the ID of which you want to retrieve.

Xsd:string parentFolderName

Specifies the parent folder name.

Return Values

Xsd:long folderId

Contains the ID of the specified query folder.

GetQueries2

The GetQueries2 method retrieves the queries in a query folder. This method supports the sort and filter operations also.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string folderId

Specifies the ID of the folder from which you want to retrieve the queries. Specify 0 for the All Queries folder.

dsm: ArrayOfQueryFilter filterArray

Specifies an array of filters on query properties.

dsm:QueryProperty sortProperty

Specifies the property based on which you want to sort the results.

xsd:boolean sortAscending

Specifies whether you want to sort the list in ascending order.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

xsd:long numRequired

Specifies the number of objects you want to retrieve from the startIndex position.

Return Values

xsd:long totalNumQueries

Returns the total number of queries available for the specified filter condition.

dsm:ArrayOfQueries queryArray

Contains an array of queries in the specified folder, filtered and sorted as specified.

GetQueryFolders

The "GetQueryFolders" API returns the query folders.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string folderId

Specifies the ID of the parent folder from which you want to retrieve the query folders. Specify 0 to retrieve from the Queries root folder.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

xsd:long numRequired

Specifies the number of objects you want to retrieve from the startIndex position.

Return Values

xsd:long totalNumFolders

Contains the total number of folders available.

dsm: ArrayOfQueryFolderProperties queryFolderArray

Contains an array of query folder properties inside the specified folder.