API docs by Redocly

Sharing instance and setting integration API (0.0.1)

Sharing instance and setting integration API

start setting sharing

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

Request Body schema: application/json
required

Sharing settings object

settingId
required
string <uuid>

id of sharing setting record

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body

Responses

Request samples

Content type
application/json
{
  • "settingId": "d95c2f35-4f41-47ad-8ae0-f642dbc3c5a6",
  • "url": "string",
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "createSettingsPCId": "2dfdf5ac-3829-49fa-b08f-db0dcd89a02f",
  • "updateSettingsPCId": "2478be12-97a3-4951-9b16-9951e88861bb"
}

delete sharing setting

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

settingId
required
string <uuid> (uuid)

The ID of setting

Request Body schema: application/json
required

Sharing settings object

settingId
required
string <uuid>

id of sharing setting record

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body

Responses

Request samples

Content type
application/json
{
  • "settingId": "d95c2f35-4f41-47ad-8ae0-f642dbc3c5a6",
  • "url": "string",
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "pcId": "5472b8bc-d25f-44d5-9798-1e93854292b3"
}