Query parameters - REST Query service for web content
The following parameters can be used with the REST Query service.
Parameter Description Example approver Query items with a specific approver. A user ID must be specified when using this parameter. ?approver=userid authoringtemplateid Query items with a specific authoring template ID. ?authoringtemplateid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53 author Query items with a specific author. A user UID must be specified when using this parameter. ?author=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm categoryid Query items with a specific category ID. ?categoryid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53 createdafter Query items created after a specific date and time. ?createdafter=2011-01-11T11:43:29.0150Z createdbefore Query items created before a specific date and time. ?createdbefore=2011-01-11T11:43:29.0150Z creator Query items with a specific creator. A user UID must be specified when using this parameter. ?creator=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm dateformat This parameter is used to define the date format of query parameters. If a date format not specified, then the default format yyyy-MM-dd'T'HH:mm:ssz is used. ?dateformat=mm-dd-yyyy&createdbefore=12-31-2011 depth Used with the parentid. Define whether to search for all descendants of a parent, or just the immediate children of a parent item. ?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=CHILDREN
?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=DESCENDANTSexpireafter Query items that have expired after a specific date and time. ?expireafter=2011-01-11T11:43:29.0150Z expirebefore Query items that were expired before a specific date and time. ?expirebefore=2011-01-11T11:43:29.0150Z id Query an item with a specific ID. ?id=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53 keyword Query items that are profiled with a specific keyword. ?keyword=keywordValue lastmodifiedafter Query items last modified after a specific date and time. ?lastmodifiedafter=2011-01-11T11:43:29.0150Z lastmodifiedbefore Query items last modified before a specific date and time. ?lastmodifiedbefore=2011-01-11T11:43:29.0150Z lastmodifier Query items last modified by a specific user. A user UID must be specified when using this parameter. ?lastmodifier=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm libraryid Query items stored in a specific library. ?libraryid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53 namelike This parameter is used as a wildcard query for items with names like the specified namelike parameter. ?namelike=nameApproxValue% name Query an item with a specific name. ?name=nameValue owner Query items with a specific owner. A user UID must be specified when using this parameter. ?owner=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm pagesize Restrict the number of items returned by a query to a set number. It can be used with the page parameter to return specific pages of results. ?type=PresentationTemplate&pagesize=5 page This parameter is used with the pagesize parameter to define what set of results to display. For example, if pagesize is set to 5, and the page parameter is set to 2, then only results 6 to 10 will be displayed. ?type=PresentationTemplate&pagesize=5&page=2 parentid Query items that are the children of a specific parent item. Use the depth parameter to define whether to search for all descendants of a parent, or just the immediate children of a parent item. ?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53 projectid Query items that are linked to a specific project. ?projectid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53 projectstate Query items that are linked to a project with a specific state. The following values can be used with this parameter: ACTIVE, SYNDICATING, PENDING, PUBLISHING, PUBLISHED, PUBLISHED_FAILED, ?projectstate=ACTIVE publishafter Query items that have been published after a specific date and time. ?publishafter=2011-01-11T11:43:29.0150Z publishbefore Query items that were published before a specific date and time. ?publishbefore=2011-01-11T11:43:29.0150Z sort The sort parameter is appended to queries to determine how query results are sorted. The following values can be used with the sort parameter: author, created, modified, name, title, parents, position. The values _ascending or _descending are appended to the query to determine sort order. If _ascending or _descending are not specified, the results as displayed in ascending order. ?type=PresentationTemplate&sort=created_ascending
?type=PresentationTemplate&sort=created_descendingstate Query items in a specific state. The following values can be used with this parameter: DRAFT, PUBLISHED, EXPIRED ?state=PUBLISHED titlelike This parameter is used as a wildcard query for items with titles like the specified titlelike parameter. ?titlelike=nameApproxValue% title Query an item with a specific title. ?title=titleValue type Query items of a specific item type. ?type=LibraryHTMLComponent workflowid Query items that use a specific workflow. ?workflowid=wcmrest:8d25860b-7a5c-4015-9cd5-bdcc60ce14bb workflowstageid Query items currently active within a specific workflow stage. ?workflowstageid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
Use multiple parameters
Multiple instances of the same parameter type in a query can only be specified as "OR" queries, with the following exceptions:
- Only one value allowed
- Only one instance of the following parameters can be used in a single query. If multiple instances are used, only the first instance is used by the query:
- dateformat
- depth
- page
- pagesize
- "AND" queries allowed
- The following queries can be used as "AND" queries:
- Sort values
- Sort values are comma separated.
?sort=created_ascending,title_descending