18.01.2015 Views

Content Management Interoperability Services (CMIS) Version 1.1

Content Management Interoperability Services (CMIS) Version 1.1

Content Management Interoperability Services (CMIS) Version 1.1

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

2.2.6.1 query<br />

Description: Executes a <strong>CMIS</strong> query statement against the contents of the repository.<br />

2.2.6.<strong>1.1</strong> Inputs<br />

Required:<br />

• Id repositoryId: The identifier for the repository.<br />

• String statement: <strong>CMIS</strong> query to be executed. See section 2.<strong>1.1</strong>4 Query.<br />

Note: The AtomPub and the Browser Binding also use the name q.<br />

Optional:<br />

• Boolean searchAll<strong>Version</strong>s: If TRUE, then the repository MUST include latest and non-latest<br />

versions of document objects in the query search scope.<br />

If FALSE (default), then the repository MUST only include latest versions of documents in the query<br />

search scope.<br />

If the repository does not support the optional capabilityAll<strong>Version</strong>sSearchable capability,<br />

then this parameter value MUST be set to FALSE.<br />

• Enum includeRelationships: See section 2.2.1.2.2 Relationships.<br />

For query statements where the SELECT clause contains properties from only one virtual table reference<br />

(i.e. referenced object-type), any value for this enum may be used. If the SELECT clause<br />

contains properties from more than one table, then the value of this parameter MUST be none. Defaults<br />

to none.<br />

• String renditionFilter: See section 2.2.1.2.4 Renditions.<br />

If the SELECT clause contains properties from more than one table, then the value of this parameter<br />

MUST not be set.<br />

• Boolean includeAllowableActions: See section 2.2.1.2.6 Allowable Actions.<br />

For query statements where the SELECT clause contains properties from only one virtual table reference<br />

(i.e. referenced object-type), any value for this parameter may be used. If the SELECT clause<br />

contains properties from more than one table, then the value of this parameter MUST be "FALSE".<br />

Defaults to FALSE.<br />

• Integer maxItems: See section 2.2.<strong>1.1</strong> Paging.<br />

• Integer skipCount: See section 2.2.<strong>1.1</strong> Paging.<br />

2.2.6.1.2 Outputs<br />

• Object queryResults: The set of results for the query. (See section 2.2.1.2.2 Relationships.)<br />

Each object result MUST include the following elements if they are requested:<br />

Relationships See section 2.2.1.2.2 Relationships.<br />

Renditions See section 2.2.1.2.4 Renditions.<br />

AllowableActions See section 2.2.1.2.6 Allowable Actions.<br />

• Boolean hasMoreItems: See section 2.2.<strong>1.1</strong> Paging.<br />

• Integer numItems: See section 2.2.<strong>1.1</strong> Paging.<br />

<strong>CMIS</strong>-v<strong>1.1</strong>-csprd01<br />

Standards Track Work Product<br />

Copyright © OASIS Open 2012. All Rights Reserved.<br />

18 August 2012<br />

Page 180 of 331

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!