From b0bd1c267cb570ddf8b441988446d190030bbf9c Mon Sep 17 00:00:00 2001 From: Felix Gerbig <48456355+gerbigf@users.noreply.github.com> Date: Fri, 6 Dec 2024 11:08:15 +0100 Subject: [PATCH] docs(ContractDefinitons): Desciption of private Properties --- .../03_contractdefinitions.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/usage/management-api-walkthrough/03_contractdefinitions.md b/docs/usage/management-api-walkthrough/03_contractdefinitions.md index 6853047e1..90bd78d86 100644 --- a/docs/usage/management-api-walkthrough/03_contractdefinitions.md +++ b/docs/usage/management-api-walkthrough/03_contractdefinitions.md @@ -88,6 +88,22 @@ part of the `edc:QuerySpec` objects that also allow pagination: - `POST /v3/policydefinitions/request` - `POST /v3/contractdefinitions/request` +## Using Private Properties as Asset Selectors +When using a private property as an asset selector, the property defined in the left operator must be prefixed as follows: `"privateProperties.'https://w3id.org/edc/v0.0.1/ns/myCommonProperty'"`. + +```json +{ + "assetsSelector": + { + "@type": "Criterion", + "operandLeft": "privateProperties.'https://w3id.org/edc/v0.0.1/ns/myCommonProperty'", + "operator": "=", + "operandRight": "sharedValue" + } +} +``` + + ## Side-Effects The [Domain Model](../README) shows the basic connection between the core concepts of @@ -100,6 +116,7 @@ After contract definition, an EDC will automatically allow data access if a requ Contract Definitions thus must be created with great care. It is essential to align the backend-credentials with the Access and Contract Policies to manage access consistently from the Dataspace to the backend data. + ## Notice This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).