Domain model

Domain Model Diagram

Resource

Both exchanged data and its metadata are modeled as resources.

Attribute Description Example

uri

A uri which uniquely identifies the resource.

https://api.digita.ai/holder/1

shape

A uri which identifies the Linked Data Shape to which the resource complies.

https://digita.ai/voc/shapes#contact-information

exchange

A uri which identifies the data exchange of which the resource was part.

https://api.digita.ai/exchange/1

triples

The content of the resource as a list of triples.

[
    {
        "object": {},
        "predicate": "https://digita.ai/voc/a-predicate",
        "subject": {},
    }
]

Purpose

A purpose for which certain types of data can be used. For example, an email address can be used in the context of direct marketing.

Attribute Description Example

label

A label to describe the purpose.

Use of contact information in the context of direct marketing

forShape

Determines the shape of resources exchanged in this context.

https://digita.ai/voc/shapes#contact-information

predicates

A list of predicates which describes the data which can be used in this context.

[
    "https://digita.ai/voc/email-address",
    "https://digita.ai/voc/phone-number"
]

Holder

A holder is something or someone who holds one or more identities. For example, both Bill Gates (a person) or Microsoft (an organisation) could be a holder.

Source

An internal or external source which contains data about holders. For example, a source could be Inrupt’s Enterprise Solid server, an on-premise SQL-database or a social media platform, such as Facebook.

Attribute Description Example

configuration

Configuration of the connection.

{
    ...
}

Connection

A holder’s connection to a source. For example, Bill Gates has a Solid pod with WebID https://use.id/bgates.

Attribute Description Example

source

The source which is connected.

https://api.digita.ai/source/1

holder

The holder to which the connection belongs.

https://api.digita.ai/holder/1

type

The type of connection.

solid

configuration

Configuration of the connection.

{
    ...
}

Exchange

An exchange defines how data was exchanged and for what purpose it can be used. For example Bill gates exchanges his contact information with his Solid-pod in the context of direct marketing.

Attribute Description Example

purpose

The purpose for which this data was exchanged.

https://api.digita.ai/purpose/1

holder

The holder which exchanges data.

https://api.digita.ai/exchange/1

source

The source data is exchanged from.

https://api.digita.ai/source/1

connection

The connection data is exchanged from.

https://api.digita.ai/connection/1