Learn

Configuration

Specifies paths and operations for managing VICAL configuration.

Update VICAL configuration

Update the VICAL configuration for the requested ecosystem

Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
Request Body schema: application/json
required
vicalProvider
required
string

VICAL provider name.

object

Configuration for automatic scheduled publishing of VICALs.

Responses
200

VICAL configuration updated

400

Bad Request. The request was malformed or missing required parameters.

put/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples
application/json
{
  • "vicalProvider": "Mattr",
  • "autoPublish": {
    }
}
Response samples
application/json
{
  • "vicalProvider": "Mattr",
  • "autoPublish": {
    }
}

Retrieve VICAL configuration

Retrieve the VICAL configuration from the requested ecosystem

Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses
200

VICAL configuration retrieved

404

Not Found. The specified resource was not found.

get/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples 
Response samples 
application/json
{
  • "vicalProvider": "Mattr",
  • "autoPublish": {
    }
}
Delete VICAL configuration
Delete the VICAL configuration for the requested ecosystem


Roles:  ["admin","dts-provider"]
SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses 
204
VICAL configuration deleted


404
Not Found. The specified resource was not found.


delete/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to Signers