Retrieve the namespace patterns for a specific policy entry
Returns the namespace patterns of the policy entry identified by the
policyId path parameter and the label path parameter.
Namespace patterns restrict which thing namespaces this entry applies to. An empty list (or absent field) means the entry applies to all namespaces.
com.acmematches only that exact namespacecom.acme.*matches namespaces belowcom.acme, but notcom.acmeitself
Parameters
policyIdstringrequiredpathThe ID of the policy needs to follow the namespaced entity ID notation (see Ditto documentation on namespaced entity IDs).
The namespace needs to:
- conform to the reverse domain name notation
labelstringrequiredpathThe label of a policy entry
If-MatchstringheaderThe If-Match header which has to conform to RFC-7232 (Conditional Requests). Common usages are:
- optimistic locking by specifying the
ETagfrom a previous HTTP response, e.g.If-Match: "hash:a75ece4e" - retrieving or modifying a resource only if it already exists, e.g.
If-Match: *
If-None-MatchstringheaderThe If-None-Match header, which has to conform to RFC-7232 (Conditional Requests). A common usage scenario is to modify a resource only if it does not yet exist, thus to create it, by specifying If-None-Match: *.
timeoutstringqueryDefines how long the backend should wait for completion of the request, e.g. applied when waiting for requested
acknowledgements via the requested-acks param. Can be specified without unit (then seconds are assumed) or
together with s, ms or m unit. Example: 42s, 1m.
The default (if omitted) and maximum timeout is 60s. A value of 0 applies fire and forget semantics for
the command resulting in setting response-required=false.
Response
The request successfully returned. The namespace patterns are returned.
The (sub-)resource has not been modified. This happens when you specified a If-None-Match header which matches the current ETag of the (sub-)resource.
The request could not be completed. Possible reasons:
- the
policyIddoes not conform to the namespaced entity ID notation (see Ditto documentation on namespaced entity IDs)
The request could not be completed due to missing authentication.
The request could not be completed. The policy with the given ID or the policy entry was not found in the context of the authenticated user.
A precondition for reading or writing the (sub-)resource failed. This will happen for write requests, if you specified an If-Match or If-None-Match header, which fails the precondition check against the current ETag of the (sub-)resource. For read requests, this error may only happen for a failing If-Match header. In case of a failing If-None-Match header for a read request, status 304 will be returned instead.
Authorization
OpenIDConnectopenIdConnectOpenID Connect Discovery URL. The placeholder is replaced by Swagger UI when configured.
NginxBasichttp (basic)Eclipse Ditto sandbox demo user (demo1 ... demo9) + password (demo)
Bearerhttp (bearer)A JSON Web Token issued by a supported OAuth 2.0 Identity Provider.