{"openapi":"3.0.2","info":{"title":"Exchange Data API","version":"2023.12.b"},"servers":[{"url":"https://{host}/platform/exchangedata/v1","variables":{"host":{"enum":["api-euw1.rms.com","api-use1.rms.com"],"default":"api-euw1.rms.com","description":"Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com"}}}],"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["curl","java","csharp","node","python"],"proxy-enabled":true,"samples-enabled":true},"security":[{"rms_api_key":[]},{"rms_bearer_token":[]}],"paths":{"/sharekeys":{"get":{"tags":["Share Keys"],"summary":"Search share keys","operationId":"getShareKeys","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Operators depend on the data type of the property. \n\n| Property       | Comparison                 | List          | Logical    |\n| -------------- | -------------------------- | ------------- | ---------- |\n| `email`        | `=` `!=` `LIKE` `NOT LIKE` | `IN` `NOT IN` | `AND` `OR` |\n| `shareKeyName` | `=` `!=` `LIKE` `NOT LIKE` | `IN` `NOT IN` | `AND` `OR` |\n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `email`, `shareKeyName`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination).","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting _0_.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShareKeyDetail"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys OR Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Share Keys"],"summary":"Create share key","operationId":"createShareKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareKeyDetail"}}},"required":true},"responses":{"201":{"description":"Share key created","headers":{"Location":{"description":"Share key","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharekeys/{shareKey}":{"get":{"tags":["Share Keys"],"summary":"Get share key","operationId":"getShareKey","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareKeyDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys OR Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Share Keys"],"summary":"Update share key","operationId":"updateShareKey","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ShareKeyDetail"}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharekeys/{shareKey}/recipients":{"get":{"tags":["Recipients"],"summary":"Search recipients","operationId":"getRecipients","parameters":[{"name":"shareKey","in":"path","description":"ID of share key","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Operators depend on the data type of the property. \n\n| Property                | Comparison                 | List          | Logical    |\n| ----------------------- | -------------------------- | ------------- | ---------- |\n| `recipientShareKeyName` | `=` `!=` `LIKE` `NOT LIKE` | `IN` `NOT IN` | `AND` `OR` |\n| `status`                | `=` `!=` `LIKE` `NOT LIKE` | `IN` `NOT IN` | `AND` `OR` |\n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `recipientShareKeyName, `status`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string","default":"status ASC"}},{"name":"limit","in":"query","description":"Number of retrieved records to display on the page.","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at 0.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecipientDetail"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys OR Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Recipients"],"summary":"Create recipient","operationId":"createRecipient","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientDetail"}}},"required":true},"responses":{"201":{"description":"Recipient got added","headers":{"Location":{"description":"Recipient share key","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharekeys/{shareKey}/recipients/{recipientShareKey}":{"get":{"tags":["Recipients"],"summary":"Get recipient","operationId":"getRecipient","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","example":"NRBQ WEST NY","required":true,"schema":{"type":"string"}},{"name":"recipientShareKey","in":"path","description":"ID of recipient's share key.","example":"YIF9LMCA15","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys OR Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Recipients"],"summary":"Update recipient","operationId":"updateRecipient","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","required":true,"schema":{"type":"string"}},{"name":"recipientShareKey","in":"path","description":"ID of recipient's share key.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UpdateRecipientDetail"}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharekeys/{shareKey}/sharerequests":{"get":{"tags":["Share Requests"],"summary":"Search share requests","operationId":"getShareRequests","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Operators depend on the data type of the property. \n\nSupported properties: `comment`, `createdAt`, `createdBy`, `recipientEmail`, `shareRequestId`, `shareRequestName`, `status`, `updatedAt`, `updatedBy`. See [Filtering Responses](doc:response-filtering#share-keys).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `comment`, `createdAt`, `createdBy`, `recipientEmail`, `shareRequestId`, `shareRequestName`, `status`, `updatedAt`, `updatedBy`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string","default":"shareRequestId DESC"}},{"name":"shareRequestType","in":"query","description":"Type of share request.\n\n* If `INBOUND`, exchange data is imported from another tenant.\n* If `OUTBOUND`, exchange data is exported to another tenant.","required":true,"schema":{"type":"string","enum":["INBOUND","OUTBOUND"]}},{"name":"limit","in":"query","description":"Number of retrieved records to display on the page.","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at 0.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShareRequestDetails"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys OR Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Share Requests"],"summary":"Create share request","operationId":"createShareRequest","parameters":[{"name":"shareKey","in":"path","description":"ID of tenant's share key.\n\nIdentifies the share key shared with recipient.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareRequest"}}},"required":true},"responses":{"201":{"description":"Share Request got added","headers":{"Location":{"description":"Share Request id","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharekeys/{shareKey}/sharerequests/{shareRequestId}":{"get":{"tags":["Share Requests"],"summary":"Get share request","operationId":"getShareRequest","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","required":true,"schema":{"type":"string"}},{"name":"shareRequestId","in":"path","description":"ID of share request.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareRequestDetails"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys OR Access Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharekeys/{shareKey}/sharerequests/{shareRequestId}/review":{"post":{"tags":["Share Requests"],"summary":"Review share request","operationId":"reviewShareRequest","parameters":[{"name":"shareKey","in":"path","description":"ID of share key.","required":true,"schema":{"type":"string"}},{"name":"shareRequestId","in":"path","description":"ID of share request.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. Operation is assigned to this resource group's quota. See [Resource Groups](doc:resource-management)","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InboundAcceptShareReview"},{"$ref":"#/components/schemas/InOutBoundShareReview"}],"discriminator":{"propertyName":"reviewType","mapping":{"inbound-reject":"#/components/schemas/InOutBoundShareReview","outbound-reject":"#/components/schemas/InOutBoundShareReview","outbound-accept":"#/components/schemas/InOutBoundShareReview","inbound-accept":"#/components/schemas/InboundAcceptShareReview"}}}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Manage Data Exchange Share Keys\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"components":{"schemas":{"RecipientDetail":{"type":"object","properties":{"recipientShareKey":{"type":"string","description":"ID of recipient share key.","example":"YIF9LMCA13"},"recipientShareKeyName":{"type":"string","description":"Name of recipient share key.","readOnly":true},"status":{"type":"string","description":"Status of recipient's share key. If `INACTIVE`, tenant cannot send or receive exchange data with recipient.","readOnly":true,"enum":["ACTIVE","INACTIVE"]}}},"UpdateRecipientDetail":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":"Status of recipient's share key. If `INACTIVE`, tenant cannot send or receive exchange data with recipient.","enum":["ACTIVE","INACTIVE"]}}},"ShareKeyDetail":{"required":["email","shareKeyName"],"type":"object","properties":{"shareKey":{"type":"string","description":"Code that identifies tenant enabled to send and receive exchange data through Risk Data Exchange.","readOnly":true},"shareKeyName":{"description":"Name of share key. \n\nThis name is displayed to Data Exchange partners.","maxLength":40,"minLength":0,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string"},"email":{"maxLength":512,"minLength":0,"type":"string","description":"Email address of Data Exchange Admin for this tenant. \n\nNotification emails are sent to this address for outbound and inbound share requests."}}},"ShareRequest":{"required":["resources","shareRequestName"],"type":"object","properties":{"shareRequestName":{"maxLength":80,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string"},"senderShareKey":{"type":"string","readOnly":true},"recipientShareKey":{"type":"string"},"recipientEmail":{"maxLength":512,"minLength":0,"type":"string"},"createdEmail":{"type":"string","readOnly":true},"comment":{"maxLength":512,"minLength":0,"description":"Brief explanation of share request review.","type":"string"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/ShareRequestEntity"}}}},"ShareRequestEntity":{"required":["resourceType","resourceUris"],"type":"object","properties":{"resourceType":{"type":"string","description":"Type of resource shared. One of `ANALYSIS` or `EXPOSURE`.","enum":["ANALYSIS","EXPOSURE"]},"resourceSize":{"type":"string","description":"Size of shared exchange data.","readOnly":true},"resourceUris":{"description":"URI of exposures or results to share. See [Resource URIs](doc:resource-uris).","type":"array","items":{"type":"string","format":"uri","example":"/platform/riskdata/v1/analyses/5555"}},"resourceMap":{"type":"array","description":"Maps specified list of analysis IDs (`analysisIds`) to an EDM (`exposureId`). Optional if `resourceType` is `ANALYSIS`.","items":{"type":"object","properties":{"exposureId":{"type":"integer","description":"ID of <<glossary:EDM>>.","format":"int64"},"analysisIds":{"type":"array","description":"List of analysis IDs.","items":{"type":"integer","format":"int64"}}}}},"resourceProperties":{"type":"array","description":"List of shared exchange data (`ANALYSIS` or `EXPOSURE`).","readOnly":true,"items":{"$ref":"#/components/schemas/ResourceProperties"}}}},"ResourceProperties":{"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of shared resource. See [Resource URIs](resource-uris)","format":"uri","example":"/platform/riskdata/v1/exposures/21323"},"resourceName":{"type":"string","description":"Name of shared resource."},"resourceSize":{"type":"string","description":"Size of shared resource."},"exposureName":{"type":"string","description":"Name of EDM."},"edmVersion":{"type":"string","description":"Version of EDM. Only for EXPOSURE"},"analysisFramework":{"type":"string","enum":["ELT","PLT"],"description":"Framework used to model exposure. Only for `ANALYSIS`."},"analysisType":{"type":"string","description":"Type of analysis. Only for `ANALYSIS`."},"analysisEngineType":{"type":"string","description":"Engine used to model exposure. Only for `ANALYSIS`."},"exposureId":{"type":"integer","description":"ID of <<glossary:EDM>>.","format":"int64"}}},"ShareRequestDetails":{"type":"object","properties":{"shareRequestId":{"type":"integer","description":"ID of share request.","format":"int32"},"shareRequestName":{"type":"string","description":"Name of share request."},"shareKey":{"type":"string","description":"ID that identifies a Data Exchange partner (an Intelligent Risk Platform tenant)."},"shareKeyName":{"description":"Public name of Data Exchange partner defined by share key.","type":"string"},"recipientShareKey":{"type":"string","description":"ID of recipient share key."},"recipientShareKeyName":{"type":"string","description":"Name of recipient share key."},"status":{"type":"string","description":"Status of share request.","enum":["Accepted","Expired","Pending","Rejected"]},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that submitted share request, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"recipientEmail":{"type":"string","example":"user.name@company.com"},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated share request, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"createdAt":{"type":"string","description":"Time that share request was created.","example":"025-06-20T12:53:50.353994Z"},"updatedAt":{"type":"string","description":"Time that share request was updated.","example":"2025-06-20T13:06:11.315914Z"},"comment":{"type":"string","description":"Comment added to share request review."},"shareRequestType":{"type":"string","description":"Type of share request.\n\n* If `INBOUND`, exchange data is imported from another tenant.\n* If `OUTBOUND`, exchange data is exported to another tenant.","enum":["OUTBOUND","INBOUND"]},"isPackage":{"type":"boolean","description":"If `true`, shared data is <<glossary:exchange package>> consisting of multiple artifacts. If `false`, then we wont allow package exchange.","example":false},"resources":{"type":"array","items":{"$ref":"#/components/schemas/ShareRequestEntity"}}}},"BaseShareReviewSettings":{"type":"object","properties":{"comment":{"description":"Comment added to share request review.","maxLength":1024,"minLength":0,"type":"string"}}},"InOutBoundShareReview":{"type":"object","allOf":[{"type":"object","properties":{"reviewType":{"type":"string","description":"Type of review","enum":["inbound-reject","outbound-reject","outbound-accept"]}}},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/BaseShareReviewSettings"}}}]},"InboundAcceptShareReview":{"required":["settings"],"type":"object","allOf":[{"type":"object","properties":{"reviewType":{"type":"string","description":"Type of review.","enum":["inbound-accept"]}}},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/InboundAcceptShareReviewSettings"}}}]},"InboundAcceptShareReviewSettings":{"required":["name"],"type":"object","properties":{"comment":{"maxLength":1024,"minLength":0,"type":"string","description":"Brief explanation of share request review."},"name":{"maxLength":80,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","description":"Name of share request review.","type":"string"},"serverId":{"minimum":1,"type":"integer","format":"int64","description":"ID of server."},"securableId":{"minimum":1,"type":"integer","format":"int64","description":"ID of securable."},"resources":{"type":"array","items":{"type":"object","properties":{"resourceType":{"type":"string","description":"Type of resource shared through the request.","enum":["EXPOSURE","ANALYSIS"]},"resourceMap":{"type":"array","description":"List of resource map objects.\n\nResource map parameters depend on resource type (`EXPOSURE` or `ANALYSIS`):\n\n- If `EXPOSURE`, `exposureId` is required.\n- If `ANALYSIS`, `analysisIds` is required. Object can specify `analysisIds`, `analysisIds` and `exposureId`, or `analysisIds` and `securableId`.","items":{"type":"object","properties":{"exposureId":{"type":"integer","description":"ID of exposure.\n\nRequired if resource type is `EXPOSURE`. Optional if resource type is `ANALYSIS`.","format":"int64"},"resourceName":{"type":"string","description":"Name of resource. Renames specified `exposureId`.\n\nOptional if resource type is `EXPOSURE`."},"securableId":{"type":"integer","description":"ID of securable.\n\nRequired if resource type is `EXPOSURE`. Optional if resource type is `ANALYSIS`.","format":"int64"},"analysisIds":{"type":"array","description":"List of analysis results.\n\nRequired if resource type  is `ANALYSIS`.","items":{"type":"integer","format":"int64","example":5671}}}}}}}}}},"ErrorMessage":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"}}}},"securitySchemes":{"rms_bearer_token":{"type":"http","description":"RMS tenant specific bearer token to make authorized requests with temporary life span","scheme":"bearer","bearerFormat":"JWT"},"rms_api_key":{"type":"apiKey","name":"Authorization","description":"RMS tenant specific api key to make authorized requests","in":"header"}}}}