API docs by Redocly

Sharing policy integration API (0.0.1)

Sharing policy integration API

start sharing policy

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

Request Body schema: application/json
required

Sharing policies object

policyId
required
string <uuid>

id of sharing policy record

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body

Responses

Request samples

Content type
application/json
{
  • "policyId": "2844767a-8367-4926-9999-514c35840399",
  • "url": "/policy",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "createPCId": "c734a41e-16ba-4a02-beb0-2d45081e39b1",
  • "updatePCId": "53e0f091-ffee-448c-a0f8-562d9ad6bf3f"
}

delete sharing policy

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

policyId
required
string <uuid> (uuid)

The ID of policy

Request Body schema: application/json
required

Sharing policies object

policyId
required
string <uuid>

id of sharing policy record

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body

Responses

Request samples

Content type
application/json
{
  • "policyId": "2844767a-8367-4926-9999-514c35840399",
  • "url": "/policy",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "pcId": "c734a41e-16ba-4a02-beb0-2d45081e39b1"
}