diff --git a/_docs_explore/61-runtime.md b/_docs_explore/61-runtime.md index 28579e705..2cbb8df52 100644 --- a/_docs_explore/61-runtime.md +++ b/_docs_explore/61-runtime.md @@ -83,7 +83,7 @@ Find a description of the available Modules in the following sections. **Note:** This Module is responsible for important logic in the enmeshed ecosystem and is therefore enabled by default in every official enmeshed Application. {: .notice--warning} -This Module makes heavy use of Requests, LocalRequests and Response. Head over to the description of our [data model]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}), where you can find a detailed description of them. +This Module makes heavy use of Requests, LocalRequests and Response. Head over to the description of our [data model]({% link _docs_integrate/data-model-overview.md %}), where you can find a detailed description of them. The Module is responsible for: @@ -113,6 +113,6 @@ The Message Module is responsible for processing `transport.MessageReceived` eve In every case the MessageModule will publish a `consumption.relationshipEvent.` for e.g. reloading the Relationship including its newest Messages in an UI. -When the Message is a [Mail]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#Mail) a `consumption.mailReceived` event will be published. This is useful if you only want to refresh your UI that is rendering structured Mails. +When the Message is a [Mail]({% link _docs_integrate/data-model-overview.md %}#Mail) a `consumption.mailReceived` event will be published. This is useful if you only want to refresh your UI that is rendering structured Mails. If you are interested in these events you need to enable this module, because it is not enabled by default. diff --git a/_docs_integrate/attribute-values.md b/_docs_integrate/attribute-values.md index b43c0981d..a428ffe24 100644 --- a/_docs_integrate/attribute-values.md +++ b/_docs_integrate/attribute-values.md @@ -9,7 +9,7 @@ toc: true properties: - id: SC092 - category: Data Model - - description: https//enmeshed.eu/integrate/attribute-values + - description: https//enmeshed.eu/integrate/data-model-attribute-values - customer: - component: integrate - level: diff --git a/_docs_integrate/introducing-the-enmeshed-data-model.md b/_docs_integrate/data-model-overview.md similarity index 65% rename from _docs_integrate/introducing-the-enmeshed-data-model.md rename to _docs_integrate/data-model-overview.md index 285f42f51..b77f8255d 100644 --- a/_docs_integrate/introducing-the-enmeshed-data-model.md +++ b/_docs_integrate/data-model-overview.md @@ -1,9 +1,9 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: integrate/introducing-the-enmeshed-data-model +permalink: integrate/data-model-overview redirect_from: /integrate/data-model-overview published: true -title: "Introducing the enmeshed Data Model" +title: "Data Model Overview" type: scenario toc: true properties: @@ -16,9 +16,9 @@ properties: - implementation status: - documentation status: - published: true - - link: integrate/introducing-the-enmeshed-data-model + - link: integrate/data-model-overview require: required_by: --- -{% include scenarios/integrate/introducing-the-enmeshed-data-model.md %} +{% include scenarios/integrate/data-model-overview.md %} diff --git a/_docs_integrate/event-introduction.md b/_docs_integrate/event-introduction.md index e8efcb11b..723657421 100644 --- a/_docs_integrate/event-introduction.md +++ b/_docs_integrate/event-introduction.md @@ -14,7 +14,7 @@ properties: - level: - implementation status: - documentation status: - - published: true + - published: - link: integrate/event-introduction require: required_by: diff --git a/_docs_integrate/faq.md b/_docs_integrate/faq.md index a27404b5c..177c154aa 100644 --- a/_docs_integrate/faq.md +++ b/_docs_integrate/faq.md @@ -14,7 +14,7 @@ properties: - level: - implementation status: - documentation status: - - published: true + - published: - link: integrate/faq require: required_by: diff --git a/_docs_integrate/overview-of-attribute-values.md b/_docs_integrate/overview-of-attribute-values.md new file mode 100644 index 000000000..52e6afdc1 --- /dev/null +++ b/_docs_integrate/overview-of-attribute-values.md @@ -0,0 +1,23 @@ +--- +# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! +permalink: integrate/overview-of-attribute-values +published: false +title: "Overview of Attribute Values" +type: scenario +toc: true +properties: + - id: SC048 + - category: Manage attributes of yourself + - description: + - customer: All + - component: integrate + - level: Beginner + - implementation status: DOCS ONLY + - documentation status: OPEN + - published: + - link: integrate/overview-of-attribute-values +require: +required_by: +--- + +{% include scenarios/integrate/overview-of-attribute-values.md %} diff --git a/_docs_integrate/request-items.md b/_docs_integrate/overview-of-request-items.md similarity index 66% rename from _docs_integrate/request-items.md rename to _docs_integrate/overview-of-request-items.md index f3b4f9b4b..9ef1c8a79 100644 --- a/_docs_integrate/request-items.md +++ b/_docs_integrate/overview-of-request-items.md @@ -1,8 +1,8 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: integrate/request-items +permalink: integrate/overview-of-request-items published: false -title: "Request items" +title: "Overview of request items" type: scenario toc: true properties: @@ -15,9 +15,9 @@ properties: - implementation status: DOCS ONLY - documentation status: OPEN - published: - - link: integrate/request-items + - link: integrate/overview-of-request-items require: required_by: --- -{% include scenarios/integrate/request-items.md %} +{% include scenarios/integrate/overview-of-request-items.md %} diff --git a/_docs_integrate/support.md b/_docs_integrate/support.md index 0b1c5885d..a5b802c08 100644 --- a/_docs_integrate/support.md +++ b/_docs_integrate/support.md @@ -14,7 +14,7 @@ properties: - level: - implementation status: - documentation status: - - published: true + - published: - link: integrate/support require: required_by: diff --git a/_docs_operate/configuration.md b/_docs_operate/configuration.md index 2472c12a2..9c316b45f 100644 --- a/_docs_operate/configuration.md +++ b/_docs_operate/configuration.md @@ -8,7 +8,7 @@ type: scenario toc: true properties: - id: SC079 - - category: 1Connector Set-up + - category: 1Connector Setup - description: https//enmeshed.eu/integrate/connector-configuration - customer: - component: operate diff --git a/_docs_operate/faq.md b/_docs_operate/faq.md index 3d1d5c706..43ec0f148 100644 --- a/_docs_operate/faq.md +++ b/_docs_operate/faq.md @@ -14,7 +14,7 @@ properties: - level: - implementation status: - documentation status: - - published: true + - published: - link: operate/faq require: required_by: diff --git a/_docs_operate/modules.md b/_docs_operate/modules.md index b2992e7c5..41085d52e 100644 --- a/_docs_operate/modules.md +++ b/_docs_operate/modules.md @@ -8,7 +8,7 @@ type: scenario toc: true properties: - id: SC080 - - category: 1Connector Set-up + - category: 1Connector Setup - description: https//enmeshed.eu/integrate/connector-modules - customer: - component: operate diff --git a/_docs_operate/set-up-connector-for-productive-use.md b/_docs_operate/setup-connector-for-productive-use.md similarity index 64% rename from _docs_operate/set-up-connector-for-productive-use.md rename to _docs_operate/setup-connector-for-productive-use.md index 103fd1a45..6cc0b455e 100644 --- a/_docs_operate/set-up-connector-for-productive-use.md +++ b/_docs_operate/setup-connector-for-productive-use.md @@ -1,8 +1,8 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: operate/set-up-connector-for-productive-use +permalink: operate/setup-connector-for-productive-use published: false -title: "Set-up Connector for productive use" +title: "Setup Connector for productive use" type: scenario toc: true properties: @@ -15,9 +15,9 @@ properties: - implementation status: DONE - documentation status: OPEN - published: - - link: operate/set-up-connector-for-productive-use + - link: operate/setup-connector-for-productive-use require: required_by: --- -{% include scenarios/operate/set-up-connector-for-productive-use.md %} +{% include scenarios/operate/setup-connector-for-productive-use.md %} diff --git a/_docs_operate/setup-with-docker-compose.md b/_docs_operate/setup-with-docker-compose.md index 807908f23..8e0efd336 100644 --- a/_docs_operate/setup-with-docker-compose.md +++ b/_docs_operate/setup-with-docker-compose.md @@ -3,7 +3,7 @@ permalink: operate/setup-with-docker-compose redirect_from: /integrate/connector-installation published: true -title: "Setup with Docker compose" +title: "Setup with Docker Compose" type: scenario toc: true properties: diff --git a/_docs_use/remove-an-onboarded-device-from-the-identity.md b/_docs_use/remove-an-onboarded-device.md similarity index 61% rename from _docs_use/remove-an-onboarded-device-from-the-identity.md rename to _docs_use/remove-an-onboarded-device.md index b30fa9614..3d5104e6d 100644 --- a/_docs_use/remove-an-onboarded-device-from-the-identity.md +++ b/_docs_use/remove-an-onboarded-device.md @@ -1,8 +1,8 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/remove-an-onboarded-device-from-the-identity +permalink: use/remove-an-onboarded-device published: false -title: "Remove an onboarded Device from the Identity" +title: "Remove an onboarded Device" type: scenario toc: true properties: @@ -15,9 +15,9 @@ properties: - implementation status: IDEA - documentation status: OPEN - published: - - link: use/remove-an-onboarded-device-from-the-identity + - link: use/remove-an-onboarded-device require: required_by: --- -{% include scenarios/use/remove-an-onboarded-device-from-the-identity.md %} +{% include scenarios/use/remove-an-onboarded-device.md %} diff --git a/_includes/scenarios/integrate/attribute-values.md b/_includes/scenarios/integrate/attribute-values.md index defaf0fac..e190955a3 100644 --- a/_includes/scenarios/integrate/attribute-values.md +++ b/_includes/scenarios/integrate/attribute-values.md @@ -1,4 +1,4 @@ -Each [Attribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#attributes) contains an instance of an Attribute Value within its `value` property. There are different types of Attribute Values. The types define the value's structural definition, rendering information and validators. For example, an email address with the value `address@company.corp` is stored with the Attribute Value type [`EMailAddress`](#emailaddress), which defines +Each [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) contains an instance of an Attribute Value within its `value` property. There are different types of Attribute Values. The types define the value's structural definition, rendering information and validators. For example, an email address with the value `address@company.corp` is stored with the Attribute Value type [`EMailAddress`](#emailaddress), which defines - the data type of the actual value (a String) - how it is validated (the pattern of an email address and a maximum length) @@ -10,7 +10,7 @@ Most Attribute Value types are atomic, which means that they have only one prope # Identity Attributes -The Attribute Values in this chapter can only be used in an [Identity Attribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute). +The Attribute Values in this chapter can only be used in an [Identity Attribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute). ## Affiliation @@ -289,7 +289,7 @@ The telephone number which can be used to reach the Identity via fax systems. ## IdentityFileReference -A IdentityFileReference is a link to an enmeshed [`File`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#files) and can be used to add a File as an Attribute of an Identity. One example for a use case is some kind of certificate. +A IdentityFileReference is a link to an enmeshed [`File`]({% link _docs_integrate/data-model-overview.md %}#files) and can be used to add a File as an Attribute of an Identity. One example for a use case is some kind of certificate. **Properties** @@ -676,20 +676,20 @@ It is not recommended to send a ZipCode to another Identity by its own. Instead, # Relationship Attributes -The Attribute Values in this chapter can only be used in a [Relationship Attribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute). Most of them are generic. You can recognize those by the prefix `Proprietary` (e.g. `ProprietaryInteger`, `ProprietaryString`, ...). In order to add some validation, you have the option to add [`valueHints`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehints). +The Attribute Values in this chapter can only be used in a [Relationship Attribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute). Most of them are generic. You can recognize those by the prefix `Proprietary` (e.g. `ProprietaryInteger`, `ProprietaryString`, ...). In order to add some validation, you have the option to add [`valueHints`]({% link _docs_integrate/data-model-overview.md %}#valuehints). ## Consent -Represents the consent of a person to a specific topic. If you want to obtain a consent, you can send a [`ReadAttributeRequestItem`]({% link _docs_integrate/requests-and-requestitems.md %}#readattributerequestitem) with a Consent-[RelationshipAttribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) where the owner is the peer. +Represents the consent of a person to a specific topic. If you want to obtain a consent, you can send a [`ReadAttributeRequestItem`]({% link _docs_integrate/requests-and-requestitems.md %}#readattributerequestitem) with a Consent-[RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) where the owner is the peer. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ---------------------------------------------------------- | -| `@type` | `"Consent"` | ✓ | | -| `consent` | `string` | ✓ | max. length: 2000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `link` | `string` | ✗ | min. length: 3
max. length: 1024
must be a valid URL | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ---------------------------------------------------------- | +| `@type` | `"Consent"` | ✓ | | +| `consent` | `string` | ✓ | max. length: 2000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `link` | `string` | ✗ | min. length: 3
max. length: 1024
must be a valid URL | ## ProprietaryBoolean @@ -697,13 +697,13 @@ An arbitrary boolean value. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ----------------- | -| `@type` | `"ProprietaryBoolean"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `boolean` | ✓ | | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ----------------- | +| `@type` | `"ProprietaryBoolean"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `boolean` | ✓ | | ## ProprietaryCountry @@ -711,13 +711,13 @@ A two-letter country code according to [ISO 3166-1 alpha-2](https://en.wikipedia **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------- | -| `@type` | `"ProprietaryCountry"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | only [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country codes | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------- | +| `@type` | `"ProprietaryCountry"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | only [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) country codes | ## ProprietaryEMailAddress @@ -725,27 +725,27 @@ An email address. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ----------------------------------------------------------------------------------------- | -| `@type` | `"ProprietaryEMailAddress"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | min. length: 3
max. length: 100
must match `^[A-Z0-9._%+-]+@[A-Z0-9.-]+.[A-Z]{2,}$` | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ----------------------------------------------------------------------------------------- | +| `@type` | `"ProprietaryEMailAddress"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | min. length: 3
max. length: 100
must match `^[A-Z0-9._%+-]+@[A-Z0-9.-]+.[A-Z]{2,}$` | ## ProprietaryFileReference -A FileReference is a link to an enmeshed [`File`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#files) and can be used to add a File as an Attribute of a Relationship. +A FileReference is a link to an enmeshed [`File`]({% link _docs_integrate/data-model-overview.md %}#files) and can be used to add a File as an Attribute of a Relationship. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ----------------- | -| `@type` | `"ProprietaryFileReference"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | max. length: 100 | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ----------------- | +| `@type` | `"ProprietaryFileReference"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | max. length: 100 | ## ProprietaryFloat @@ -753,13 +753,13 @@ An arbitrary floating-point number. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ----------------- | -| `@type` | `"ProprietaryFloat"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `number` | ✓ | | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ----------------- | +| `@type` | `"ProprietaryFloat"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `number` | ✓ | | ## ProprietaryHEXColor @@ -767,13 +767,13 @@ A hexadecimal color code. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ------------------------------------------------------------------------ | -| `@type` | `"ProprietaryHEXColor"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | min.length: 4
must match `^#([0-9A-F]{3}){1,2}$`
max. length: 100 | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ------------------------------------------------------------------------ | +| `@type` | `"ProprietaryHEXColor"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | min.length: 4
must match `^#([0-9A-F]{3}){1,2}$`
max. length: 100 | ## ProprietaryInteger @@ -781,13 +781,13 @@ An arbitrary integer number. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ------------------ | -| `@type` | `"ProprietaryInteger"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `number` | ✓ | must be an integer | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ------------------ | +| `@type` | `"ProprietaryInteger"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `number` | ✓ | must be an integer | ## ProprietaryJSON @@ -847,13 +847,13 @@ A two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | -------------------------------------------------------------------------------------- | -| `@type` | `"ProprietaryLanguage"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | only [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | -------------------------------------------------------------------------------------- | +| `@type` | `"ProprietaryLanguage"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | only [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes | ## ProprietaryPhoneNumber @@ -861,13 +861,13 @@ A phone number. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ----------------------------------------------------------------------------- | -| `@type` | `"ProprietaryPhoneNumber"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | min. length: 3
max. length: 100
must match `^[\d+\-x#*()/[\] ]{3,100}$` | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ----------------------------------------------------------------------------- | +| `@type` | `"ProprietaryPhoneNumber"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | min. length: 3
max. length: 100
must match `^[\d+\-x#*()/[\] ]{3,100}$` | ## ProprietaryString @@ -875,13 +875,13 @@ An arbitrary string. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ----------------- | -| `@type` | `"ProprietaryString"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | max. length: 100 | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ----------------- | +| `@type` | `"ProprietaryString"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | max. length: 100 | ## ProprietaryURL @@ -889,13 +889,13 @@ A URL. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ---------------------------------------------------------- | -| `@type` | `"ProprietaryURL"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | min. length: 3
max. length: 1024
must be a valid URL | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ---------------------------------------------------------- | +| `@type` | `"ProprietaryURL"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | min. length: 3
max. length: 1024
must be a valid URL | ## ProprietaryXML @@ -903,11 +903,11 @@ A XML. **Properties** -| Name | Type | Required | Validation | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ---------------------------------------------------------- | -| `@type` | `"ProprietaryXML"` | ✓ | | -| `title` | `string` | ✓ | max. length: 100 | -| `description` | `string` | ✗ | max. length: 1000 | -| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) | ✗ | | -| `value` | `string` | ✓ | max. length: 50000
must be a valid XML encoded string | -| `schemaURL` | `string` | ✗ | min. length: 3
max. length: 1024
must be a valid URL | +| Name | Type | Required | Validation | +| -------------------- | -------------------------------------------------------------------------------------------- | :------: | ---------------------------------------------------------- | +| `@type` | `"ProprietaryXML"` | ✓ | | +| `title` | `string` | ✓ | max. length: 100 | +| `description` | `string` | ✗ | max. length: 1000 | +| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/data-model-overview.md %}#valuehintsoverride) | ✗ | | +| `value` | `string` | ✓ | max. length: 50000
must be a valid XML encoded string | +| `schemaURL` | `string` | ✗ | min. length: 3
max. length: 1024
must be a valid URL | diff --git a/_includes/scenarios/integrate/connector-events.md b/_includes/scenarios/integrate/connector-events.md index 702d347ee..a865c650c 100644 --- a/_includes/scenarios/integrate/connector-events.md +++ b/_includes/scenarios/integrate/connector-events.md @@ -1,21 +1,21 @@ -| Event | Data | Description (This event is triggered when ...) | -| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| consumption.attributeCreated | [LocalAttribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalAttribute) | ... an Attribute was created manually or through a Request. | -| consumption.attributeDeleted | [LocalAttribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalAttribute) | ... an Attribute was deleted manually or through a Request. | -| consumption.attributeSucceded | [LocalAttribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalAttribute) | ... an Attribute was succeeded manually or through a Request. | -| consumption.attributeUpdated | [LocalAttribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalAttribute) | ... an Attribute was updated manually or through a Request. | -| consumption.incomingRequestReceived | [LocalRequest]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalRequest) | ... an incoming Request was received either by loading a Relationship Template or by receiving a Message | -| consumption.incomingRequestStatusChanged | [RequestStatusChangedEventData](#requeststatuschangedeventdata) | ... the status of an incoming Request has changed. | -| consumption.messageProcessed | [MessageProcessedEventData](#messageprocessedeventdata) | ... a Message was processed by Modules like the `RequestModule` or `DeciderModule`. | -| consumption.outgoingRequestCreated | [LocalRequest]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalRequest) | ... an outgoing Request was created. | -| consumption.
outgoingRequestFromRelationshipCreationChange
CreatedAndCompleted | [LocalRequest]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalRequest) | ... an outgoing Request was created and directly completed.
This happens if the Response came in with a new Relationship. | -| consumption.outgoingRequestStatusChanged | [RequestStatusChangedEventData](#requeststatuschangedeventdata) | ... the status of an outgoing Request has changed. | -| consumption.relationshipTemplateProcessed | [RelationshipTemplateProcessedEventData](#relationshiptemplateprocessedeventdata) | ... a RelationshipTemplate was processed by Modules like the `RequestModule` or `DeciderModule`. | -| consumption.sharedAttributeCopyCreated | [LocalAttribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalAttribute) | ... an Attribute is copied for sharing with another identity. | -| transport.messageReceived | [Message]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#Message) | ... a Message is received during synchronization. | -| transport.messageSent | [Message]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#Message) | ... a Message was sent. | -| transport.peerRelationshipTemplateLoaded | [RelationshipTemplate]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#RelationshipTemplate) | ... a Relationship Template was loaded that belongs to another identity. | -| transport.relationshipChanged | [Relationship]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#Relationship) | ... a Relationship has changed. This can be due to one of the following cases:
• you create a Relationship
• you accept, reject or revoke a Relationship Change
• a Relationship Change is received during synchronization | +| Event | Data | Description (This event is triggered when ...) | +| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| consumption.attributeCreated | [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#LocalAttribute) | ... an Attribute was created manually or through a Request. | +| consumption.attributeDeleted | [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#LocalAttribute) | ... an Attribute was deleted manually or through a Request. | +| consumption.attributeSucceded | [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#LocalAttribute) | ... an Attribute was succeeded manually or through a Request. | +| consumption.attributeUpdated | [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#LocalAttribute) | ... an Attribute was updated manually or through a Request. | +| consumption.incomingRequestReceived | [LocalRequest]({% link _docs_integrate/data-model-overview.md %}#LocalRequest) | ... an incoming Request was received either by loading a Relationship Template or by receiving a Message | +| consumption.incomingRequestStatusChanged | [RequestStatusChangedEventData](#requeststatuschangedeventdata) | ... the status of an incoming Request has changed. | +| consumption.messageProcessed | [MessageProcessedEventData](#messageprocessedeventdata) | ... a Message was processed by Modules like the `RequestModule` or `DeciderModule`. | +| consumption.outgoingRequestCreated | [LocalRequest]({% link _docs_integrate/data-model-overview.md %}#LocalRequest) | ... an outgoing Request was created. | +| consumption.
outgoingRequestFromRelationshipCreationChange
CreatedAndCompleted | [LocalRequest]({% link _docs_integrate/data-model-overview.md %}#LocalRequest) | ... an outgoing Request was created and directly completed.
This happens if the Response came in with a new Relationship. | +| consumption.outgoingRequestStatusChanged | [RequestStatusChangedEventData](#requeststatuschangedeventdata) | ... the status of an outgoing Request has changed. | +| consumption.relationshipTemplateProcessed | [RelationshipTemplateProcessedEventData](#relationshiptemplateprocessedeventdata) | ... a RelationshipTemplate was processed by Modules like the `RequestModule` or `DeciderModule`. | +| consumption.sharedAttributeCopyCreated | [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#LocalAttribute) | ... an Attribute is copied for sharing with another identity. | +| transport.messageReceived | [Message]({% link _docs_integrate/data-model-overview.md %}#Message) | ... a Message is received during synchronization. | +| transport.messageSent | [Message]({% link _docs_integrate/data-model-overview.md %}#Message) | ... a Message was sent. | +| transport.peerRelationshipTemplateLoaded | [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#RelationshipTemplate) | ... a Relationship Template was loaded that belongs to another identity. | +| transport.relationshipChanged | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... a Relationship has changed. This can be due to one of the following cases:
• you create a Relationship
• you accept, reject or revoke a Relationship Change
• a Relationship Change is received during synchronization | ## Event structure @@ -31,7 +31,7 @@ interface Event { ### RequestStatusChangedEventData -> [LocalRequest]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#LocalRequest) +> [LocalRequest]({% link _docs_integrate/data-model-overview.md %}#LocalRequest) ```ts export interface RequestStatusChangedEventData { @@ -43,7 +43,7 @@ export interface RequestStatusChangedEventData { ### MessageProcessedEventData -> [Message]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#Message) +> [Message]({% link _docs_integrate/data-model-overview.md %}#Message) ```ts export interface MessageProcessedEventData { @@ -54,7 +54,7 @@ export interface MessageProcessedEventData { ### RelationshipTemplateProcessedEventData -> [RelationshipTemplate]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#RelationshipTemplate) +> [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#RelationshipTemplate) ```ts export interface RelationshipTemplateProcessedEventData { diff --git a/_includes/scenarios/integrate/introducing-the-enmeshed-data-model.md b/_includes/scenarios/integrate/data-model-overview.md similarity index 100% rename from _includes/scenarios/integrate/introducing-the-enmeshed-data-model.md rename to _includes/scenarios/integrate/data-model-overview.md diff --git a/_includes/scenarios/integrate/integration-example.md b/_includes/scenarios/integrate/integration-example.md index 5f8fb2f00..cf57aaf4a 100644 --- a/_includes/scenarios/integrate/integration-example.md +++ b/_includes/scenarios/integrate/integration-example.md @@ -47,10 +47,10 @@ You can query the Connector's Address under the route `/api/v2/Account/IdentityI ### Connector: Test your Request's Validity -In order to make sure the Request and its items are valid you can validate it by calling the `POST /api/v2/Requests/Outgoing/Validate` route. You can define your own payload for this Request, or you can just use the one below, which contains two [RequestItemGroups]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#requestitemgroup): +In order to make sure the Request and its items are valid you can validate it by calling the `POST /api/v2/Requests/Outgoing/Validate` route. You can define your own payload for this Request, or you can just use the one below, which contains two [RequestItemGroups]({% link _docs_integrate/data-model-overview.md %}#requestitemgroup): -- one with a [ShareAttributeRequestItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#shareattributerequestitem) that contains Attributes that will be shared with the peer -- one with [ReadAttributeRequestItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#readattributerequestitem)s that query Attributes of the peer +- one with a [ShareAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#shareattributerequestitem) that contains Attributes that will be shared with the peer +- one with [ReadAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#readattributerequestitem)s that query Attributes of the peer ```json { @@ -212,7 +212,7 @@ Now the Relationship is in the `Active` state, so we can start to communicate wi ## Sending and Receiving Messages -After you have established a Relationship to an Identity, you can start to exchange Messages. Enmeshed defines [different types of Messages]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#message). For this tutorial we will focus on Messages of type [Mail]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#mail), which you can compare to a classic email: you can specify one or more recipients, a subject and a body, as well as add some attachments. +After you have established a Relationship to an Identity, you can start to exchange Messages. Enmeshed defines [different types of Messages]({% link _docs_integrate/data-model-overview.md %}#message). For this tutorial we will focus on Messages of type [Mail]({% link _docs_integrate/data-model-overview.md %}#mail), which you can compare to a classic email: you can specify one or more recipients, a subject and a body, as well as add some attachments. ### Sending a Message with a Connector @@ -248,6 +248,6 @@ The response should contain a Message with the content you entered in the App. Now that you have successfully established a Relationship and exchanged Messages, you can further explore the enmeshed API. You can for example: -- explore the [enmeshed data model]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}) and learn more about the objects you used during this tutorial and the objects you will encounter in the future +- explore the [enmeshed data model]({% link _docs_integrate/data-model-overview.md %}) and learn more about the objects you used during this tutorial and the objects you will encounter in the future - learn how to send [Requests over Messages]({% link _docs_integrate/sending-messages.md %}) with your established Relationship - dive deeper into creating and sending [Requests over RelationshipTemplates]({% link _docs_integrate/requests-over-templates.md %}) diff --git a/_includes/scenarios/integrate/request-persistent-consent-of-peer.md b/_includes/scenarios/integrate/request-persistent-consent-of-peer.md index 5a53256ae..9e2ac496b 100644 --- a/_includes/scenarios/integrate/request-persistent-consent-of-peer.md +++ b/_includes/scenarios/integrate/request-persistent-consent-of-peer.md @@ -4,7 +4,7 @@ Here is an explanation of how to obtain a person's persistent consent on a parti To request an accept/reject decision from a peer to a free text, the ConsentRequestItem is used. -Represents the consent of a person to a specific topic. If you want to obtain a consent, you can send a [`ProposeAttributeRequestItem`]({% link _docs_integrate/requests-and-requestitems.md %}#proposeattributerequestitem) [RelationshipAttribute]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) with a [Consent]({% link _docs_integrate/attribute-values.md %}#consent) value where the owner is the peer. +Represents the consent of a person to a specific topic. If you want to obtain a consent, you can send a [`ProposeAttributeRequestItem`]({% link _docs_integrate/requests-and-requestitems.md %}#proposeattributerequestitem) [RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) with a [Consent]({% link _docs_integrate/attribute-values.md %}#consent) value where the owner is the peer. diff --git a/_includes/scenarios/integrate/requests-and-requestitems.md b/_includes/scenarios/integrate/requests-and-requestitems.md index 492dee72d..c33be439a 100644 --- a/_includes/scenarios/integrate/requests-and-requestitems.md +++ b/_includes/scenarios/integrate/requests-and-requestitems.md @@ -1,4 +1,4 @@ -All the RequestItems listed below inherit from the [RequestItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#requestitem) and are therefore sharing its properties. +All the RequestItems listed below inherit from the [RequestItem]({% link _docs_integrate/data-model-overview.md %}#requestitem) and are therefore sharing its properties. ## AuthenticationRequestItem @@ -19,9 +19,9 @@ With this item the sender can request the peer for an authentication in a busine #### Item Properties {#authenticationrequestitem-response-itemproperties} -- To accept this RequestItem an [AcceptResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#acceptresponseitem) will be transferred. -- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#rejectresponseitem) will be transferred. -- In case of an error an [ErrorResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#errorresponseitem) will be transferred. +- To accept this RequestItem an [AcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#acceptresponseitem) will be transferred. +- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. +- In case of an error an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. #### Parameters {#authenticationrequestitem-response-parameters} @@ -57,9 +57,9 @@ The ConsentRequestItem is also not meant for contractual agreements. #### Item Properties {#consentrequestitem-response-itemproperties} -- To accept this RequestItem an [AcceptResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#acceptresponseitem) will be transferred. -- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#rejectresponseitem) will be transferred. -- In case of an error an [ErrorResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#errorresponseitem) will be transferred. +- To accept this RequestItem an [AcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#acceptresponseitem) will be transferred. +- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. +- In case of an error an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. #### Parameters {#consentrequestitem-response-parameters} @@ -80,10 +80,10 @@ To create an Attribute with a fixed value defined by the sender, an Identity use ### Properties {#createattributerequestitem-properties} -| Name | Type | Description | -| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| `@type` | `"CreateAttributeRequestItem"` | Specifies the type of the RequestItem for internal processing. | -| `attribute` | [`IdentityAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute to create for the peer within the Identity of the peer. | +| Name | Type | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `@type` | `"CreateAttributeRequestItem"` | Specifies the type of the RequestItem for internal processing. | +| `attribute` | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute to create for the peer within the Identity of the peer. | ### Response {#createattributerequestitem-response} @@ -96,8 +96,8 @@ To create an Attribute with a fixed value defined by the sender, an Identity use | `@type` | `"CreateAttributeAcceptResponseItem"` | The type of the ResponseItem. | | `attributeId` | `string` | The id of the created Attribute. | -- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#rejectresponseitem) will be transferred. -- In case of an error an [ErrorResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#errorresponseitem) will be transferred. +- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. +- In case of an error an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. #### Parameters {#createattributerequestitem-response-parameters} @@ -139,8 +139,8 @@ With the FreeTextRequestItem it is possible to send a free text to the peer. The | `@type` | `"FreeTextAcceptResponseItem"` | The type of the ResponseItem. | | `freeText` | `string` | The free text that is used to answer the RequestItem. | -- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#rejectresponseitem) will be transferred. -- In case of an error an [ErrorResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#errorresponseitem) will be transferred. +- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. +- In case of an error an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. #### Parameters {#freetextrequestitem-response-parameters} @@ -166,11 +166,11 @@ To create an Attribute with a value proposed by the sender, an Identity uses the ### Properties {#proposeattributerequestitem-properties} -| Name | Type | Description | -| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| `@type` | `"ProposeAttributeRequestItem"` | Specifies the type of the RequestItem for internal processing. | -| `attribute` | [`IdentityAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute to propose for the peer as the queried Attribute. | -| `query` | [`IdentityAttributeQuery`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattributequery) \| [`RelationshipAttributeQuery`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattributequery) \| [`ThirdPartyRelationshipAttributeQuery`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#thirdpartyrelationshipattributequery) | The structured query of the Attribute the sender would like to receive. | +| Name | Type | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| `@type` | `"ProposeAttributeRequestItem"` | Specifies the type of the RequestItem for internal processing. | +| `attribute` | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute to propose for the peer as the queried Attribute. | +| `query` | [`IdentityAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#identityattributequery) \| [`RelationshipAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#relationshipattributequery) \| [`ThirdPartyRelationshipAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#thirdpartyrelationshipattributequery) | The structured query of the Attribute the sender would like to receive. | ### Response {#proposeattributerequestitem-response} @@ -178,14 +178,14 @@ To create an Attribute with a value proposed by the sender, an Identity uses the - To accept this RequestItem a `ProposeAttributeAcceptResponseItem` will be transferred. - | Name | Type | Description | - | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | - | `@type` | `"ProposeAttributeAcceptResponseItem"` | The type of the ResponseItem. | - | `attributeId` | `string` | The id of the created Attribute. | - | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute to propose for the peer as the queried Attribute.
The owner of the Attribute which is proposed can only be the recipient Identity. | + | Name | Type | Description | + | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | + | `@type` | `"ProposeAttributeAcceptResponseItem"` | The type of the ResponseItem. | + | `attributeId` | `string` | The id of the created Attribute. | + | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute to propose for the peer as the queried Attribute.
The owner of the Attribute which is proposed can only be the recipient Identity. | -- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#rejectresponseitem) will be transferred. -- In case of an error an [ErrorResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#errorresponseitem) will be transferred. +- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. +- In case of an error an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. #### Parameters {#proposeattributerequestitem-response-parameters} @@ -193,15 +193,15 @@ To create an Attribute with a value proposed by the sender, an Identity uses the - If you want to create a new Attribute. - | Name | Type | Description | - | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | - | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that shall be created. | + | Name | Type | Description | + | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | + | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that shall be created. | - If you want to use the proposed Attribute. - | Name | Type | Description | - | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | - | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that was provided in the RequestItem. | + | Name | Type | Description | + | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | + | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that was provided in the RequestItem. | - If you want to use an existing Attribute. @@ -234,10 +234,10 @@ To query Attributes which are not known to the sender, an Identity uses the Read ### Properties {#readattributerequestitem-properties} -| Name | Type | Description | -| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `@type` | `"ReadAttributeRequestItem"` | Specifies the type of the RequestItem for internal processing. | -| `query` | [`IdentityAttributeQuery`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattributequery) \| [`RelationshipAttributeQuery`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattributequery) \| [`ThirdPartyRelationshipAttributeQuery`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#thirdpartyrelationshipattributequery) | The structured query of the Attribute the sender would like to receive. | +| Name | Type | Description | +| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `@type` | `"ReadAttributeRequestItem"` | Specifies the type of the RequestItem for internal processing. | +| `query` | [`IdentityAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#identityattributequery) \| [`RelationshipAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#relationshipattributequery) \| [`ThirdPartyRelationshipAttributeQuery`]({% link _docs_integrate/data-model-overview.md %}#thirdpartyrelationshipattributequery) | The structured query of the Attribute the sender would like to receive. | ### Response {#readattributerequestitem-response} @@ -245,14 +245,14 @@ To query Attributes which are not known to the sender, an Identity uses the Read - To accept this RequestItem a `ReadAttributeAcceptResponseItem` will be transferred. - | Name | Type | Description | - | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | - | `@type` | `"ReadAttributeAcceptResponseItem"` | The type of the ResponseItem. | - | `attributeId` | `string` | The id of the returned Attribute. | - | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that will be shared to the peer. | + | Name | Type | Description | + | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- | + | `@type` | `"ReadAttributeAcceptResponseItem"` | The type of the ResponseItem. | + | `attributeId` | `string` | The id of the returned Attribute. | + | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that will be shared to the peer. | -- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#rejectresponseitem) will be transferred. -- In case of an error an [ErrorResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#errorresponseitem) will be transferred. +- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem) will be transferred. +- In case of an error an [ErrorResponseItem]({% link _docs_integrate/data-model-overview.md %}#errorresponseitem) will be transferred. #### Parameters {#readattributerequestitem-response-parameters} @@ -266,9 +266,9 @@ To query Attributes which are not known to the sender, an Identity uses the Read - If you want to create a new Attribute. - | Name | Type | Description | - | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | - | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that shall be created. | + | Name | Type | Description | + | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | + | `attribute` | [`IdentityAttribute`]({% link _docs_integrate/data-model-overview.md %}#identityattribute) \| [`RelationshipAttribute`]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) | The IdentityAttribute or RelationshipAttribute that shall be created. | - To reject this RequestItem you can send `{ "accept": false }` as parameters. @@ -285,7 +285,7 @@ To query Attributes which are not known to the sender, an Identity uses the Read -This guide will explain the end to end flow of sharing and answering a [Request]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#request) over a Template. This flow usually happens between the App and a Connector, but for simplicity and more transparency we will use two Connectors. Therefore you have to start two Connectors that don't have a Relationship yet. +This guide will explain the end to end flow of sharing and answering a [Request]({% link _docs_integrate/data-model-overview.md %}#request) over a Template. This flow usually happens between the App and a Connector, but for simplicity and more transparency we will use two Connectors. Therefore you have to start two Connectors that don't have a Relationship yet. You can use the [Connector Installation Guide]({% link _docs_operate/setup-with-docker-compose.md %}) if you need help for the setup the Connectors.