REST Query parameters

REST Query parameters

The following parameters can be used with REST queries.

Parameter Details
approver Query items with a specific approver. A user ID must be specified when using this parameter. For example:
/query?approver=userid

authoringtemplateid Query items with a specific authoring template ID. For example:
/query?authoringtemplateid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53

author Query items with a specific author. A user UID must be specified when using this parameter. For example:
/query?author=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm

categoryid Query items with a specific category ID. For example:
query?categoryid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53

createdafter Query items created after a specific date and time. For example:
/query?createdafter=2011-01-11T11:43:29.0150Z

createdbefore Query items created before a specific date and time. For example:
/query?createdbefore=2011-01-11T11:43:29.0150Z

creator Query items with a specific creator. A user UID must be specified when using this parameter. For example:
/query?creator=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm

dateformat This parameter is used to define the date format of query parameters. For example:
/query?dateformat=mm-dd-yyyy&createdbefore=12-31-2011
If a date format not specified, then the default format yyyy-MM-dd'T'HH:mm:ssz is used.
depth This parameter is used with the parentid and is used to define whether to search for all descendants of a parent, or just the immediate children of a parent item. For example, to query only the immediate children of an item, we add &depth=CHILDREN to the query:
/query?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=CHILDREN

To query all descendants of an item, we add &depth=DESCENDANTS to the query::
/query?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=DESCENDANTS

expireafter Query items that have expired after a specific date and time. For example:
/query?expireafter=2011-01-11T11:43:29.0150Z

expirebefore Query items that were expired before a specific date and time. For example:
/query?expirebefore=2011-01-11T11:43:29.0150Z

id Query an item with a specific ID. For example:
/query?id=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53

keyword Query items that are profiled with a specific keyword. For example:
/query?keyword=keywordValue

lastmodifiedafter Query items that were last modified after a specific date and time. For example:
/query?lastmodifiedafter=2011-01-11T11:43:29.0150Z

lastmodifiedbefore Query items that were last modified before a specific date and time. For example:
/query?lastmodifiedbefore=2011-01-11T11:43:29.0150Z

lastmodifier Query items that were last modified by a specific user. A user UID must be specified when using this parameter. For example:
/query?lastmodifier=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm

libraryid Query items that are stored in a specific library. For example:
/query?libraryid=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm

namelike This parameter is used as a wildcard query for items with names like the specified namelike parameter. For example:
/query?namelike=nameApproxValue%

name Query an item with a specific name. For example:
/query?name=nameValue

owner Query items with a specific owner. A user UID must be specified when using this parameter. For example:
/query?owner=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm

pagesize This parameter is used to 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. For example, to restrict the number of queries to be returned to 5:
/query?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. For example:
/query?type=PresentationTemplate&pagesize=5&page=2

parentid Query items that are the children of a specific parent item. For example:
/query?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53

We can use the depth parameter to define whether to search for all descendants of a parent, or just the immediate children of a parent item.
projectid Query items that are linked to a specific project. For example:
/query?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

For example, to query items linked to projects with a state of "active" we would use the following query:
/query?projectstate=ACTIVE

publishafter Query items that have been published after a specific date and time. For example:
/query?publishafter=2011-01-11T11:43:29.0150Z

publishbefore Query items that were published before a specific date and time. For example:
/query?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

The values _ascending or _descending are appended to the query to determine sort order. For example, to sort a presentation template query in ascending order of creation, we would use:
/query?type=PresentationTemplate&sort=created_ascending

To sort a presentation template query in descending order of creation, we would use:
/query?type=PresentationTemplate&sort=created_descending
If _ascending or _descending are not specified, the results as displayed in ascending order.
state Query items that are in a specific state. The following values can be used with this parameter:

DRAFT
PUBLISHED
EXPIRED

For example:
/query?state=PUBLISHED

titlelike This parameter is used as a wildcard query for items with titles like the specified titlelike parameter. For example:
/query?titlelike=nameApproxValue%

title Query an item with a specific title. For example:
/query?title=titleValue

type Query items of a specific item type. For example, to query a list of components::
/query?type=LibraryHTMLComponent

workflowid Query items that use a specific workflow. For example:
/query?workflowid=wcmrest:8d25860b-7a5c-4015-9cd5-bdcc60ce14bb

workflowstageid Query items that are currently active within a specific workflow stage. For example:
/query?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:

createdafter
createdbefore
expireafter
expirebefore
lastmodifiedafter
lastmodifiedbefore
publishafter
publishbefore

Sort values

Sort values are comma separated. For example:
?sort=created_ascending,title_descending

Parent: REST Query services for web content

Parameter	Details
approver	Query items with a specific approver. A user ID must be specified when using this parameter. For example: /query?approver=userid
authoringtemplateid	Query items with a specific authoring template ID. For example: /query?authoringtemplateid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
author	Query items with a specific author. A user UID must be specified when using this parameter. For example: /query?author=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
categoryid	Query items with a specific category ID. For example: query?categoryid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
createdafter	Query items created after a specific date and time. For example: /query?createdafter=2011-01-11T11:43:29.0150Z
createdbefore	Query items created before a specific date and time. For example: /query?createdbefore=2011-01-11T11:43:29.0150Z
creator	Query items with a specific creator. A user UID must be specified when using this parameter. For example: /query?creator=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
dateformat	This parameter is used to define the date format of query parameters. For example: /query?dateformat=mm-dd-yyyy&createdbefore=12-31-2011 If a date format not specified, then the default format yyyy-MM-dd'T'HH:mm:ssz is used.
depth	This parameter is used with the parentid and is used to define whether to search for all descendants of a parent, or just the immediate children of a parent item. For example, to query only the immediate children of an item, we add &depth=CHILDREN to the query: /query?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=CHILDREN To query all descendants of an item, we add &depth=DESCENDANTS to the query:: /query?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=DESCENDANTS
expireafter	Query items that have expired after a specific date and time. For example: /query?expireafter=2011-01-11T11:43:29.0150Z
expirebefore	Query items that were expired before a specific date and time. For example: /query?expirebefore=2011-01-11T11:43:29.0150Z
id	Query an item with a specific ID. For example: /query?id=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
keyword	Query items that are profiled with a specific keyword. For example: /query?keyword=keywordValue
lastmodifiedafter	Query items that were last modified after a specific date and time. For example: /query?lastmodifiedafter=2011-01-11T11:43:29.0150Z
lastmodifiedbefore	Query items that were last modified before a specific date and time. For example: /query?lastmodifiedbefore=2011-01-11T11:43:29.0150Z
lastmodifier	Query items that were last modified by a specific user. A user UID must be specified when using this parameter. For example: /query?lastmodifier=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
libraryid	Query items that are stored in a specific library. For example: /query?libraryid=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
namelike	This parameter is used as a wildcard query for items with names like the specified namelike parameter. For example: /query?namelike=nameApproxValue%
name	Query an item with a specific name. For example: /query?name=nameValue
owner	Query items with a specific owner. A user UID must be specified when using this parameter. For example: /query?owner=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
pagesize	This parameter is used to 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. For example, to restrict the number of queries to be returned to 5: /query?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. For example: /query?type=PresentationTemplate&pagesize=5&page=2
parentid	Query items that are the children of a specific parent item. For example: /query?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53 We can use the depth parameter to define whether to search for all descendants of a parent, or just the immediate children of a parent item.
projectid	Query items that are linked to a specific project. For example: /query?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 For example, to query items linked to projects with a state of "active" we would use the following query: /query?projectstate=ACTIVE
publishafter	Query items that have been published after a specific date and time. For example: /query?publishafter=2011-01-11T11:43:29.0150Z
publishbefore	Query items that were published before a specific date and time. For example: /query?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 The values _ascending or _descending are appended to the query to determine sort order. For example, to sort a presentation template query in ascending order of creation, we would use: /query?type=PresentationTemplate&sort=created_ascending To sort a presentation template query in descending order of creation, we would use: /query?type=PresentationTemplate&sort=created_descending If _ascending or _descending are not specified, the results as displayed in ascending order.
state	Query items that are in a specific state. The following values can be used with this parameter: DRAFT PUBLISHED EXPIRED For example: /query?state=PUBLISHED
titlelike	This parameter is used as a wildcard query for items with titles like the specified titlelike parameter. For example: /query?titlelike=nameApproxValue%
title	Query an item with a specific title. For example: /query?title=titleValue
type	Query items of a specific item type. For example, to query a list of components:: /query?type=LibraryHTMLComponent
workflowid	Query items that use a specific workflow. For example: /query?workflowid=wcmrest:8d25860b-7a5c-4015-9cd5-bdcc60ce14bb
workflowstageid	Query items that are currently active within a specific workflow stage. For example: /query?workflowstageid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53