Search share requests

get

https://{host}/platform/exchangedata/v1/sharekeys/{shareKey}/sharerequests

Returns a list of share requests.

A share request is a request to transfer a copy of exposure or analysis data to another Intelligent Risk Platform tenant via Data Exchange. Every share request is identified by a share key, which enables a the recipient to access the data.

This operation supports response filtering. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

Path Params

shareKey

string

required

ID of share key.

Query Params

filter

string

Query string to select response data based on property values. Operators depend on the data type of the property.

Supported properties: comment, createdAt, createdBy, recipientEmail, shareRequestId, shareRequestName, status, updatedAt, updatedBy. See Filtering Responses.

sort

string

Defaults to shareRequestId DESC

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: comment, createdAt, createdBy, recipientEmail, shareRequestId, shareRequestName, status, updatedAt, updatedBy. See Response Pagination.

shareRequestType

string

enum

required

Type of share request.

If INBOUND, exchange data is imported from another tenant.
If OUTBOUND, exchange data is exported to another tenant.

Allowed:

limit

int32

1 to 1000

Defaults to 100

Number of retrieved records to display on the page.

offset

int32

Defaults to 0

Number of the page displaying the returned records, starting at 0.

Responses

Language

Credentials

URL

Response

Choose an example:

application/json

200Success

400Bad Request

401Unauthorized

403Forbidden: Access to this resource is denied or not authorized to perform the "Manage Data Exchange Share Keys OR Access Data Exchange Share Keys" action.

404Not found

500Internal Server Error