API docs by Redocly

Sharing instance and setting integration API (0.0.1)

Sharing instance and setting integration API

Get list of sharing instances

Sharing instances

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

query Parameters
instanceIdentifier
string <uuid> (uuid)

The UUID of the instance

sourceTenantId
string

The ID of the source tenant

targetTenantId
string

The ID of the target tenant

status
string (Status)
Enum: "IN_PROGRESS" "COMPLETE" "ERROR"

The status of the sharing instance

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 100

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "sharingInstances": [
    ],
  • "totalRecords": 0
}

start instance sharing

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

Request Body schema: application/json
required

Sharing Instance object

id
string <uuid>
instanceIdentifier
required
string <uuid>
sourceTenantId
required
string
targetTenantId
required
string
status
string (Status)
Enum: "IN_PROGRESS" "COMPLETE" "ERROR"
error
string
object (Metadata)

Metadata about creation and changes to records

createdDate
required
string

Date and time when the record was created

createdByUserId
string <uuid> (uuid)
createdByUsername
string

Username of the user who created the record (when available)

object (userInfo)

User Display Information

updatedDate
string

Date and time when the record was last updated

updatedByUserId
string <uuid> (uuid)
updatedByUsername
string

Username of the user who updated the record (when available)

object (userInfo)

User Display Information

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "instanceIdentifier": "bc2b559c-bc61-4594-a6fe-3a828efd5796",
  • "sourceTenantId": "string",
  • "targetTenantId": "string",
  • "status": "IN_PROGRESS",
  • "error": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "instanceIdentifier": "bc2b559c-bc61-4594-a6fe-3a828efd5796",
  • "sourceTenantId": "string",
  • "targetTenantId": "string",
  • "status": "IN_PROGRESS",
  • "error": "string",
  • "metadata": {
    }
}

Get Sharing instance by action ID

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

actionId
required
string <uuid> (uuid)

The ID of sharing instance

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "instanceIdentifier": "bc2b559c-bc61-4594-a6fe-3a828efd5796",
  • "sourceTenantId": "string",
  • "targetTenantId": "string",
  • "status": "IN_PROGRESS",
  • "error": "string",
  • "metadata": {
    }
}