Connections

A holder’s connection to a source.

Get all connections

You can retrieve all connections.

GET /connection/ HTTP/1.1
Host: [DIGITA_HOST]
Authorization: Bearer [ACCESS_TOKEN]
[
    {
        "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
        "configuration": { ... },
        "state": "CONNECTED",
        "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
        "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
    },
    {
        "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
        "configuration": { ... },
        "state": "CONNECTED",
        "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
        "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
    }
]

Get one connection

You can retrieve a single connection.

GET /connection/[CONNECTION_URI] HTTP/1.1
Host: [DIGITA_HOST]
Authorization: Bearer [ACCESS_TOKEN]
{
    "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
    "configuration": { ... },
    "state": "CONNECTED",
    "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
    "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
}

Create one connection

You can create a single connection.

POST /connection/ HTTP/1.1
Host: [DIGITA_HOST]
Authorization: Bearer [ACCESS_TOKEN]

{
    "configuration": { ... },
    "state": "CONNECTED",
    "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
    "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
}
{
    "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
    "configuration": { ... },
    "state": "CONNECTED",
    "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
    "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
}

Update one connection

You can update a single connection.

PUT /connection/[CONNECTION_URI] HTTP/1.1
Host: [DIGITA_HOST]
Authorization: Bearer [ACCESS_TOKEN]

{
    "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
    "configuration": { ... },
    "state": "CONNECTED",
    "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
    "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
}
{
    "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
    "configuration": { ... },
    "state": "CONNECTED",
    "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
    "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
}

Get all connections for a holder

You can retrieve all connections which belong to a specific holder.

GET /holder/[HOLDER_URI]/connections HTTP/1.1
Host: [DIGITA_HOST]
Authorization: Bearer [ACCESS_TOKEN]
[
    {
        "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
        "configuration": { ... },
        "state": "CONNECTED",
        "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
        "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
    },
    {
        "uri": "https%3A%2F%2Fexample.org%2Fconnection%2F1234-5678-9012-3456",
        "configuration": { ... },
        "state": "CONNECTED",
        "source": "https%3A%2F%2Fexample.org%2Fsource%2F1234-5678-9012-3456",
        "holder": "https%3A%2F%2Fexample.org%2Fholder%2F1234-5678-9012-3456",
    }
]