4.8.2. “depth”查询参数

depth”查询参数用于限制服务器返回的子树的深度。深度值大于“depth”参数的数据节点不会在GET方法的响应中返回。

所请求的数据节点具有“1”的depth级别。如果使用“fields”参数(第4.8.3节)选择后代数据节点,则这些节点及其所有祖先节点的“depth”值为“1”。 (即使“depth”值小于指定字段的实际深度级别,也具有包括由字段指定的节点的效果)。其他任何子节点具有比其depth值大1的“depth”值父节点。

depth”参数的值是165535之间的整数或字符串“unbounded”。 “unbounded”是默认的。

此参数仅适用于API,数据存储区和数据资源上的GET方法。如果用于其他方法或资源类型,则返回“400 Bad Request”状态行。

默认情况下,服务器将包含检索资源中与请求资源具有相同资源类型的所有子资源。 数据存储资源是个例外。 如果检索到此资源类型,则默认返回数据存储和所有子数据资源。

如果“depth”查询参数URI9.3节定义的“capability”叶子列表中列出,则服务器支持“depth”查询参数。