Skip to content

connector/provider/wizard

Step Summary
connector/provider/wizard/create_asset Register an asset described field by field rather than as a document.
connector/provider/wizard/create_policy Register an ODRL policy written as rule lists rather than as a document.

connector/provider/wizard/create_asset

Register an asset described field by field rather than as a document.

The guided sibling of connector/provider/create_asset: it assembles the asset document from its fields and hands it to the same registration, so the two steps cannot drift apart in what they actually create.

Inputs

Parameter Type Required Default Also accepts Description
asset_id string no '' — Asset ID; derived from 'name', or a fresh UUID, when omitted.
name string yes — — Human-readable asset name.
description string no '' — What the asset offers.
base_url string yes — — URL of the data source behind the asset.
content_type string no '' — MIME type of the data, e.g. 'application/json'.
properties object no {} — Further EDC asset properties, e.g. 'dct:type' or 'cx-common:version'.

Output — the value assertions and returns: read

Output contract of connector/provider/create_asset.

Field Type Description
asset_id string ID of the asset that now exists at the provider.

connector/provider/wizard/create_policy

Register an ODRL policy written as rule lists rather than as a document.

The guided sibling of connector/provider/create_policy, registering through the same call.

Inputs

Parameter Type Required Default Also accepts Description
policy_id string no '' — Policy ID; a fresh UUID is used when omitted.
permissions list of object yes — — ODRL permission rules: what the consumer is allowed to do.
prohibitions list of object no [] — ODRL prohibition rules.
obligations list of object no [] — ODRL obligation rules.

Output — the value assertions and returns: read

Output contract of connector/provider/create_policy.

Field Type Description
policy_id string ID of the policy that now exists at the provider.