Retrieve a specific policy import.
Returns the policy import of the policy identified by the policyId path
parameter and imported policy identified by the importedPolicyId path parameter.
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
importedPolicyIdstringrequiredpathThe ID of the imported 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
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: *.
if-equalstringupdateskipskip-minimizing-mergeheaderThe if-equal header can take the values 'update' (which is the default if omitted), 'skip' or 'skip-minimizing-merge'. If 'update' is defined, the entity will always be updated, even if it is equal before the update. If 'skip' is defined, the entity not be updated if it is equal before the update. In this case a 'Precondition Failed' 412 status is returned. If 'skip-minimizing-merge' is defined, the entity will not be updated if it is equal before the update. In this case a 'Precondition Failed' 412 status is returned. Additionally, merge/patch commands will be minimized to only the fields which actually changed, compared to the current state of the entity.
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 completed and returned is the policy import.
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
policyIdor theimportedPolicyIddoes 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 due to exceeded data volume or exceeded transaction count.
The request could not be completed due to a missing or invalid API Token.
The request could not be completed. The policy with the given ID or the policy import 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.