A message on a transfer

POST

/dsp/transfers/{pid}/{action}

curl --request POST \
  --url https://example.com/dsp/transfers/example/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

The other messages of a transfer, for both roles: start (TransferStartMessage, with the data address), suspension, completion and termination. The same message again gets the same answer.

Authorizations

• dcp

Parameters

Path Parameters

pid

required

string

Our process id (providerPid or consumerPid).

action

required

string

start, suspension, completion or termination.

Request Body^required

The message that action names.

Media typeapplication/json

object

Example ^generated

{}

Responses

200

The TransferProcess.

Media typeapplication/json

object

Example ^generated

{}

400

Not a valid message, or not allowed in the state of the process.

Media typeapplication/json

A DSP error (dspace:…Error): code and reason, as JSON-LD.

object

@context

required

object

@type

required

E.g. ContractNegotiationError.

string

code

required

string

reason

required

Array<string>

Example ^generated

{
  "@context": {},
  "@type": "example",
  "code": "example",
  "reason": [
    "example"
  ]
}

401

No valid token.

Media typeapplication/json

A DSP error (dspace:…Error): code and reason, as JSON-LD.

object

@context

required

object

@type

required

E.g. ContractNegotiationError.

string

code

required

string

reason

required

Array<string>

Example ^generated

{
  "@context": {},
  "@type": "example",
  "code": "example",
  "reason": [
    "example"
  ]
}

404

Unknown process.

Media typeapplication/json

A DSP error (dspace:…Error): code and reason, as JSON-LD.

object

@context

required

object

@type

required

E.g. ContractNegotiationError.

string

code

required

string

reason

required

Array<string>

Example ^generated

{
  "@context": {},
  "@type": "example",
  "code": "example",
  "reason": [
    "example"
  ]
}

503

The message could not be recorded as evidence, so it was not processed.

Media typeapplication/json

A DSP error (dspace:…Error): code and reason, as JSON-LD.

object

@context

required

object

@type

required

E.g. ContractNegotiationError.

string

code

required

string

reason

required

Array<string>

Example ^generated

{
  "@context": {},
  "@type": "example",
  "code": "example",
  "reason": [
    "example"
  ]
}