Skip to content

Commit

Permalink
docs(ContractDefinitons): Desciption of private Properties (#1707)
Browse files Browse the repository at this point in the history
  • Loading branch information
gerbigf authored Dec 6, 2024
1 parent a5b1daa commit 474f786
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/usage/management-api-walkthrough/03_contractdefinitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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).
Expand Down

0 comments on commit 474f786

Please sign in to comment.