Example: Querying for custom metadata content
Here’s a sample metadata query API request that retrieves metadata for all objects that:
- Are in namespaces owned by the europe tenant
- Have custom metadata that contains an element named
department
with a value ofAccounting
The query uses an XML request body and requests results in JSON format.
In addition to the basic information about the objects in the result set, this request returns the shred
and retention
settings for each object in the result set. The request also specifies that objects in the result set be listed in reverse chronological order based on change time.
Request body in the XML file named Accounting.xml
<queryRequest> <object> <query>customMetadataContent: "department.Accounting.department" </query> <objectProperties>shred,retention</objectProperties> <sort>changeTimeMilliseconds+desc</sort> </object> </queryRequest>
Request with cURL command line
curl -k -H "Authorization: HCP bXl1c2Vy:3f3c6784e97531774380db177774ac8d" -H "Content-Type: application/xml" -H "Accept: application/json" -d @Accounting.xml "https://europe.hcp.example.com/query?prettyprint"
Request in Python using PycURL
import pycurl import os curl = pycurl.Curl() # Set the URL, command, and headers curl.setopt(pycurl.URL, "https://europe.hcp.example.com/" + "query?prettyprint") curl.setopt(pycurl.SSL_VERIFYPEER, 0) curl.setopt(pycurl.SSL_VERIFYHOST, 0) curl.setopt(pycurl.POST, 1) curl.setopt(pycurl.HTTPHEADER, ["Authorization: HCP bXl1c2Vy:3f3c6784e97531774380db177774ac8d", "Content-Type: application/xml", "Accept: application/json"]) # Set the request body from an XML file filehandle = open("Accounting.xml", 'rb') curl.setopt(pycurl.UPLOAD, 1) curl.setopt(pycurl.CUSTOMREQUEST, "POST") curl.setopt(pycurl.INFILESIZE, os.path.getsize("Accounting.xml")) curl.setopt(pycurl.READFUNCTION, filehandle.read) curl.perform() print curl.getinfo(pycurl.RESPONSE_CODE) curl.close() filehandle.close()
Request headers
POST /query?prettyprint HTTP/1.1 Host: europe.hcp.example.com Authorization: HCP bXl1c2Vy:3f3c6784e97531774380db177774ac8d Content-Type: application/xml Accept: application/json Content-Length: 192
Response headers
HTTP/1.1 200 OK Transfer-Encoding: chunked
JSON response body
To limit the example size, the JSON below shows only one object in the result set.
{"queryResult: {"query": {"expression":"customMetadataContent: "department.Accounting.department""}, "resultSet":[ {"version":84689494804123, "operation":"CREATED", "urlName":"https://finance.europe.hcp.example.com/rest/presentations/ Q1_2012.ppt", "changeTimeMilliseconds":"1334244924615.00", "retention":0, "shred":false}, . . . ], "status":{ "message":"", "results":12, "code":"COMPLETE"} } }
Custom metadata file for the Q1_2012.ppt object
<?xml version="1.0"> <presentation> <presentedBy>Lee Green</presentedBy> <department>Accounting</department> <slides>23</slides> <date>04-01-2012</date> </presentation>