The agreement of a data flow

GET

/signaling/v1/transfers/{id}/agreement

curl --request GET \
  --url https://example.com/signaling/v1/transfers/example/agreement \
  --header 'Authorization: Bearer <token>'

Data Plane Signaling agreement retrieval: the data plane of a provider transfer fetches the agreement it serves. The answer is signed with BL-Evidence; a supplier that delivers on our behalf keeps it as proof of what it delivers for.

Authorizations

• signaling

Parameters

Path Parameters

id

required

string

Our transfer process id.

Responses

200

The agreement as ODRL.

Media typeapplication/json

object

Example ^generated

{}

401

Not authenticated.

Media typeapplication/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Not allowed.

Media typeapplication/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

404

Unknown transfer, or not ours as provider.

Media typeapplication/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}