{"openapi":"3.0.1","info":{"title":"Admin Data API","version":"2025.04.c"},"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["json","curl","python","java","csharp","node"],"proxy-enabled":true,"samples-enabled":true},"servers":[{"url":"https://{host}/platform/admindata/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."}}}],"security":[{"RMS_Auth":[]}],"paths":{"/securables":{"get":{"tags":["Securables"],"summary":"Search securables","operationId":"getSecurables","parameters":[{"name":"filter","in":"query","description":"\n<<glossary:Query string>> to select response data based on property values.\n\nSupported properties: `groupId`, `owner`, `ownerStatus`, `securableId`, `securableName`, `securableType`. Supported logical operators depend on the data type of property:\n\n|Property|Type|Comparison|List|Identity|\n|:------|:------|:------|:-----|:----| \n|`groupId`|`string`|`=` |`IN`|`IS NULL`, `IS NOT NULL`|\n|`owner`|`string`|`=`  |`IN`||\n|`ownerStatus`|`string`|`=`  |||\n|`securableId`|`number`|`=`  |`IN`||\n|`securableName`|`string`|`=`, `LIKE`|`IN` ||\n|`securableType`|`string`|`=`  |`IN` ||\n\nThe `IS NULL` and `IS NOT NULL` filter based on whether or not a securable is assigned to a group or not. See [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\n Supported properties: `owner`, `securableId`, `securableName`, `securableType`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records to display per page","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilteredSecurables"}}}},"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","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"}}}}}}},"/securables/{securableId}":{"get":{"tags":["Securables"],"summary":"Get securable","operationId":"getSecurable","parameters":[{"$ref":"#/components/parameters/SecurableIdPathParam"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Securable"}}}},"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","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":["Securables"],"summary":"Update securable","operationId":"updateSecurable","parameters":[{"$ref":"#/components/parameters/SecurableIdPathParam"}],"requestBody":{"description":"Updates to securable's owner or group.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PatchSecurableOwnerValue"},{"$ref":"#/components/schemas/PatchSecurableGroupValue"}],"discriminator":{"propertyName":"targetProperty","mapping":{"owner":"#/components/schemas/PatchSecurableOwnerValue","groupId":"#/components/schemas/PatchSecurableGroupValue"}}}}}}},"responses":{"204":{"description":"Success"},"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","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"}}}}}},"delete":{"tags":["Securables"],"summary":"Delete securable","operationId":"deleteSecurable","parameters":[{"$ref":"#/components/parameters/SecurableIdPathParam"}],"responses":{"202":{"description":"Accepted: A job with the specified ID for processing. Send periodic HTTP GET requests to the URI for the job status. See [Workflow Engine Jobs](https://developer.rms.com/rms-developers/docs/workflow-engine).","headers":{"Location":{"description":"URL containing identifier of the submitted workflow.","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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/securables/{securableId}/archive":{"post":{"tags":["Securables"],"summary":"Archive Securable","operationId":"archiveSecurable","parameters":[{"$ref":"#/components/parameters/SecurableIdPathParam"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveSecurableRequest"}}}},"responses":{"202":{"description":"Accepted","headers":{"Location":{"description":"URI of `ARCHIVE_SECURABLE` job.","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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/databasesnapshots":{"get":{"tags":["Snapshots"],"summary":"Search snapshots","operationId":"searchDatabaseSnapshots","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Depending on the property, you may use comparison operators, list operators, and logical operators.\n\n| Property                  | Data Type    | Comparison                       | List | \n| :-------------------------| :----------- | :--------------------------------| :---------------| \n| `databaseSnapshotId`      | `Number`     | `=`, `!=`                        | `IN`, `NOT IN`  |\n| `serverType`              | `Number`     | `=`, `!=`                        | `IN`, `NOT IN`  | \n| `serverName`              | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `createdAt`               | `YYYY-MM-DD` | `=`, `!=`, `>`, `<`, `>=`, `<=`  |                 |\n| `createdBy`               | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `databaseName`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `exposureName`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `sizeInMb`                | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=`  |                 |\n| `snapshotId`              | `Number`     | `=`, `!=`                        | `IN`, `NOT IN`  |\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: `databaseSnapshotId`, `serverType`, `serverName`, `createdAt  `, `createdBy`, `databaseName`,`snapshotId`","schema":{"type":"string","default":"databaseSnapshotId DESC"}},{"name":"limit","in":"query","description":"Number of records to display per 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":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseSnapshot"}}}}},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"security":[{"RMS_Auth":[]}]}},"/snapshots/{snapshotId}/databasesnapshots/{databaseSnapshotId}":{"get":{"tags":["Snapshots"],"summary":"Get database by snapshot","operationId":"getDatabaseSnapshot","parameters":[{"name":"snapshotId","in":"path","required":true,"description":"ID of snapshot.\n","schema":{"type":"integer","format":"int64"}},{"name":"databaseSnapshotId","in":"path","required":true,"description":"ID of snapshot database.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseSnapshot"}}}},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/snapshots/{snapshotId}/databasesnapshots":{"get":{"tags":["Snapshots"],"summary":"Search snapshot databases by snapshot","operationId":"searchDatabaseSnapshotsBySnapshot","parameters":[{"name":"snapshotId","in":"path","required":true,"description":"ID of snapshot.","schema":{"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Depending on the property, you may use comparison operators, list operators, and logical operators.\n\n| Property                  | Data Type    | Comparison                       | List | \n| :-------------------------| :----------- | :--------------------------------| :---------------| \n| `databaseSnapshotId`      | `Number`     | `=`, `!=`                        | `IN`, `NOT IN`  |\n| `serverType`              | `Number`     | `=`, `!=`                        | `IN`, `NOT IN`  | \n| `serverName`              | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `createdAt`               | `YYYY-MM-DD` | `=`, `!=`, `>`, `<`, `>=`, `<=`  |                 |\n| `createdBy`               | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `databaseName`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `exposureName`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`    | `IN`, `NOT IN`  | \n| `sizeInMb`                | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=`  |                 |\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: `databaseSnapshotId`, `serverType`, `serverName`, `createdAt  `, `createdBy`, `databaseName`","schema":{"type":"string","default":"databaseSnapshotId DESC"}},{"name":"limit","in":"query","description":"Number of records to display per 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":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseSnapshot"}}}}},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"security":[{"RMS_Auth":[]}]}},"/snapshots/{snapshotId}/copy-to-archive":{"post":{"tags":["Snapshots"],"summary":"Create archives from snapshot","operationId":"copySnapshotToArchive","parameters":[{"name":"snapshotId","in":"path","required":true,"description":"ID of snapshot.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyToArchiveRequest"}}},"required":true},"responses":{"202":{"description":"Accepted","headers":{"Location":{"description":"Url of job.","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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/archives":{"get":{"tags":["Archives"],"summary":"Search archives","operationId":"searchArchives","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Supported properties: `archiveName`, `archiveId`, `archivedBy`, `serverName`, `createdAt`, `createdBy`, `expirationDate`, `serverType`, `sourceTypeId`, `storageTypeId`, `tagIds` . Depending on the property, you may use comparison operators, list operators, and logical operators.\n\n| Property                 | Type    | Comparison                      | List | \n| :----------------------- | :----------- | :------------------------------ | :------------- | \n| `archiveId`             | `Number`     | `=`, `!=`                        | `IN`, `NOT IN` | \n| `archiveName`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `archiveSubType`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `archiveType`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `archivedBy`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `createdAt`             | `YYYY-MM-DD` | `=`, `!=`, `>`, `>=`, `<`, `<=`, `LIKE`, `NOT LIKE`  |                | \n| `createdBy`             | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `databaseType`             | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `expirationDate`         | `YYYY-MM-DD`| `=`, `!=`, `>`, `>=`, `<`, `<=`, `LIKE`, `NOT LIKE` |                |\n| `owner`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `serverName`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `serverType`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `sizeInMb`            | `Number`     | `=`, `!=`, `>`, `>=`, `<`, `<=`   |  | \n| `sourceTypeId`             | `Number`     | `=`, `!=`, `LIKE`, `NOT LIKE` | `IN`, `NOT IN` | \n| `sourceType`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `storageTypeId`             | `Number`     | `=`, `!=`, `LIKE`, `NOT LIKE`  | `IN`, `NOT IN` | \n| `storageType`             | `Number`     | `=`, `!=`, `LIKE`, `NOT LIKE`  | `IN`, `NOT IN` | \n| `tagIds`             | `Number`     | `=`, `!=`                        | `IN`, `NOT IN` | \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: `archivedBy`, `archiveId`,  `archiveName`, `archiveSubType`, `archiveType`, `createdAt`, `createdBy`, `databaseType`, `expirationDate`, `owner`, `serverName`, `serverType`, `sizeInMb`,  `storageType`, `storageTypeId`, `tagIds`. \nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string","default":"archiveName ASC"}},{"name":"limit","in":"query","description":"Number of 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":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ArchiveSummary"}}}}},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/archives/{archiveId}":{"get":{"tags":["Archives"],"summary":"Get archive","operationId":"getArchive","parameters":[{"name":"archiveId","in":"path","description":"ID of archive.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Archive"}}}},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was 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":["Archives"],"summary":"Update archive","operationId":"updateArchive","parameters":[{"name":"archiveId","in":"path","description":"ID of archive.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivePatch"}}},"required":true},"responses":{"202":{"description":"Archive successfully updated."},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Archives"],"summary":"Delete archive","operationId":"deleteArchive","parameters":[{"name":"archiveId","in":"path","description":"ID of archive.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"202":{"description":"Accepted","headers":{"Location":{"description":"URI of `DELETE_SECURABLE` job.","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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/archives/{archiveId}/restore":{"post":{"tags":["Archives"],"summary":"Restore archive","operationId":"restoreArchive","parameters":[{"name":"archiveId","in":"path","description":"ID of archive.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreArchive"}}}},"responses":{"202":{"description":"Accepted: A job with the specified ID for processing. Send periodic HTTP GET requests to the URI for the job status. See [Workflow Engine Jobs](https://developer.rms.com/rms-developers/docs/workflow-engine).","headers":{"Location":{"description":"URL containing identifier of the submitted workflow.","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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/jobs":{"get":{"tags":["Admin Data Jobs"],"summary":"Search admin data jobs","operationId":"searchAdminJobs","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Supported properties: `endedAt`, `jobId`, `name`, `startedAt`, `status`, `type`, `userName` Depending on the property, you may use comparison operators, list operators, and logical operators.\n\n| Property| Data Type| Comparison| List| \n| :------ | :-------| :---------- | :--- | \n| `endedAt` | `YYY-MM-DD` | `=` | |\n| `jobId` | `string` | `=` | `IN` |\n| `name` | `string` | `=` |  |\n| `startedAt` | `YYY-MM-DD` | `=` | |\n| `status` | `string` | `=` |  |\n| `type` | `string` | `=` |  |\n| `userName` | `string` | `=` |  |\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: `endedAt`, `jobId`, `name`, `startedAt`, `status`, `type`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records to display per page.","schema":{"type":"integer","format":"int32"}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobSummary"}}}}},"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","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"}}}}}}},"/jobs/{jobId}":{"get":{"tags":["Admin Data Jobs"],"summary":"Get admin data job","operationId":"getAdminJob","parameters":[{"name":"jobId","in":"path","description":"ID of job. See [Platform Jobs](ref:platform-jobs).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Admin Data Jobs"],"summary":"Update admin data job","operationId":"updateAdminJob","parameters":[{"name":"jobId","in":"path","description":"ID of job. See [Platform Jobs](doc:platform-jobs).","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of import job","enum":["CANCELED"]},"priority":{"type":"string","description":"Priority of import job","enum":["HIGH","MEDIUM","LOW","VERYHIGH","VERYLOW"]}}}}},"required":true},"responses":{"202":{"description":"Job successfully updated."},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"components":{"parameters":{"ResourceGroupIdPathParam":{"in":"path","schema":{"type":"string","format":"uuid"},"name":"resourceGroupId","required":true},"EntitlementParam":{"in":"path","schema":{"type":"string","enum":["RI-RISKMODELER","RI-UNDERWRITEIQ","RI-EXPOSUREIQ","RI-TREATYIQ"]},"name":"entitlement","required":true},"JobSummaryTypeParam":{"in":"query","name":"jobsType","required":false,"schema":{"$ref":"#/components/schemas/JobType"}},"SecurableTypeParam":{"in":"query","name":"securableType","required":false,"schema":{"$ref":"#/components/schemas/SecurableType"}},"GroupNameQueryParam":{"in":"query","schema":{"type":"string"},"name":"groupName","required":false},"SecurableIdPathParam":{"in":"path","schema":{"type":"string"},"name":"securableId","description":"ID of securable.","required":true}},"schemas":{"CopyToArchiveRequest":{"required":["databaseSnapshotIds"],"type":"object","properties":{"expirationDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"databaseSnapshotIds":{"maxItems":10,"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}},"copyAllDatabaseSnapshots":{"type":"boolean","description":"If `true`, all database snapshots are copied to archive and the `databaseSnapshotIds` are not required."}}},"DatabaseSnapshot":{"type":"object","properties":{"snapshotId":{"type":"string","description":"ID of snapshot database.","example":89999},"expiresAt":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z","description":"Date database expires in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `2020-01-01T00:00:00.000Z`."},"databaseSnapshotId":{"type":"integer","format":"int64","description":"ID of snapshot database."},"databaseName":{"type":"string","description":"Name of database."},"sizeInMb":{"type":"string","description":"Size of database in MB.","example":19},"serverType":{"type":"string","description":"Type of database server. One of `databridge` or `platform`.","enum":["databridge","platform"]},"serverName":{"type":"string","description":"Name of database server."},"owner":{"type":"string","description":"Name of <<glossary:role>> or <<glossary:login>> that owns database, e.g. `user.name@company.com` or `SSO_user.name@company.com` (federated tenants). Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"databaseType":{"type":"string","description":"Type of database.","enum":["EDM","RDM","UNKNOWN"]},"exposureName":{"type":"string","description":"Name of <<glossary:EDM>>. Returned only if database is registered."},"createdAt":{"type":"string","description":"Date database was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `2020-01-01T00:00:00.000Z`.","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created  database, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"}}},"RestoreArchive":{"oneOf":[{"$ref":"#/components/schemas/RestoreDatabase"},{"$ref":"#/components/schemas/RestoreSecurable"}]},"RestoreSecurable":{"type":"object","properties":{"owner":{"description":"Update owner during restore.","type":"string"},"databasename":{"description":"Update database name during restore.","type":"string"}}},"RestoreDatabase":{"type":"object","properties":{"serverId":{"description":"ID of server instance to host the restored database.","type":"integer","format":"int64"},"databaseName":{"description":"Name of restored database.","maxLength":80,"minLength":0,"pattern":"^$|^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string"},"owner":{"type":"string","format":"email","description":"Name of <<glossary:role>> or login of  <<glossary:principal>> that owns restored database, e.g. `user.name@company.com` or `SSO_user.name@company.com` (federated tenants). Login strings are lowercase. See [Logins](ref:principals)."},"groups":{"uniqueItems":true,"type":"array","description":"List of groups that can access the restored database.","items":{"$ref":"#/components/schemas/GroupSummary"}},"skipRegister":{"type":"boolean","description":"If `true`, the restored database is not registered with Risk Modeler."}}},"FileUrl":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"}}},"GroupSummary":{"type":"object","properties":{"groupId":{"type":"string"},"groupName":{"type":"string","readOnly":true}}},"Archive":{"allOf":[{"$ref":"#/components/schemas/ArchiveSummary"}]},"ArchivePatch":{"type":"object","properties":{"storageType":{"type":"string","description":"Type of archive.","enum":["Permanent"]},"expirationDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sssZ`"}}},"Task":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of <<glossary:task>>.","format":"int32"},"guid":{"type":"string","description":"Unique ID of task.","format":"uuid"},"jobId":{"type":"string","description":"ID of job. See [Platform Jobs](ref:platform jobs).","format":"int64"},"status":{"type":"string","description":"Status of task. One of `PENDING`, `QUEUED`, `RUNNING`, `FINISHED`, `FAILED`, `CANCEL_REQUESTED`, `CANCELLING`, `CANCELLED`."},"submittedAt":{"type":"string","description":"Time task was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"createdAt":{"type":"string","description":"Time task was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"name":{"type":"string","description":"Name of task."},"percentComplete":{"type":"integer","format":"int32","description":"Percent of task completion."},"priorTaskGuids":{"type":"array","description":"List of tasks in batch job.","items":{"type":"string","format":"uuid"}},"output":{"type":"object","description":"List of tasks in batch job.","properties":{"summary":{"type":"string"},"errors":{"type":"array","description":"List of error messages.","items":{"type":"object","properties":{"message":{"type":"string"}}}},"log":{"type":"object","description":"Log of task processing."}}}}},"JobSummary":{"type":"object","properties":{"jobId":{"type":"string","format":"int64","description":"ID of job. See [Platform Jobs](ref:platform jobs)."},"priority":{"type":"string","description":"Priority of job.","enum":["verylow","low","medium","high","veryhigh"]},"userName":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that submitted job, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"status":{"type":"string","description":"Status of job.","enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELLED","PENDING","CANCELLING","CANCEL_REQUESTED"]},"submittedAt":{"type":"string","description":"Time job was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"startedAt":{"type":"string","description":"Time job was started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"endedAt":{"type":"string","description":"Time job was completed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"name":{"type":"string","description":"Name of job."},"type":{"type":"string","description":"Type of job. See [Platform Jobs](doc:platform-jobs)."},"progress":{"type":"integer","format":"int32","description":"Percent of job completion."},"resourceGroupId":{"type":"string","format":"uuid","description":"ID of <<glossary:resource group>> that submitted job. See [Resource Groups](doc:resource-management)."},"entitlement":{"type":"string","description":"Licensed Intelligent Risk Platform program. One of `RI-EXPOSUREIQ`, `RI-RISKMODELER`, `RI-TREATYIQ`, `RI-UNDERWRITEIQ`."},"details":{"type":"object","description":"Detailed information about job and child tasks.","properties":{"resources":{"type":"array","description":"List of <<glossary:resource URI>>s.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}},"summary":{"type":"string"},"log":{"type":"object","description":"Log of job details.","nullable":true,"properties":{"archiveId":{"type":"string","description":"ID of archive.","format":"int64","nullable":true},"databaseName":{"type":"string","description":"Name of database archived.","nullable":true},"owner":{"type":"string","format":"email","nullable":true,"description":"Login of <<glossary:principal>> that owns archive, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"serverId":{"type":"string","description":"ID of database server that hosted the deleted database.","format":"int64","nullable":true},"serverName":{"type":"string","description":"Name of database server that hosted the deleted database.","nullable":true},"serverType":{"type":"string","nullable":true,"enum":["DATABRIDGE","PLATFORM"]}}}}}}},"Job":{"type":"object","allOf":[{"$ref":"#/components/schemas/JobSummary"},{"type":"object","properties":{"tasks":{"type":"array","description":"List of task objects. A batch job consists of multiple child tasks.","items":{"$ref":"#/components/schemas/Task"}}}}]},"PatchSingleValue":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that owns securable, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@compay.com"},"PatchSecurableGroupValue":{"properties":{"operation":{"type":"string","description":"Change to property.","enum":["add","remove"]},"targetProperty":{"description":"Property to update.","type":"string","enum":["groupId"]},"value":{"description":"ID of <<glossary:user group>>.","type":"string","example":234}}},"PatchSecurableOwnerValue":{"properties":{"operation":{"type":"string","description":"Change to property.","enum":["update"]},"targetProperty":{"description":"Property to update.","type":"string","enum":["owner"]},"value":{"$ref":"#/components/schemas/PatchSingleValue"}}},"FilteredSecurables":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/SecurableSummary"},{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/GroupSummary"}}}}]}},"SecurableType":{"type":"string","nullable":false,"enum":["exposureSet","programSet","businessHierarchySet","DataBridgeDatabase","DataBridgeServer","shareSet"]},"SecurableSummary":{"type":"object","properties":{"securableId":{"type":"number","description":"ID of securable.","nullable":false,"format":"int64"},"securableName":{"description":"Name of securable.","type":"string","nullable":true},"securableType":{"$ref":"#/components/schemas/SecurableType"},"owner":{"type":"string","format":"email","nullable":false,"description":"Login of <<glossary:principal>> that owns securable, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"ownerStatus":{"type":"string","description":"Status of owner.","nullable":false,"enum":["active","inactive"]},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created securable, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com","nullable":true},"createdAt":{"type":"string","format":"date-time","description":"Date securable was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z","example":"2024-04-10T20:45:28.775Z","nullable":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that modified securable, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"modifiedAt":{"type":"string","format":"date-time","description":"Date securable was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z","example":"2024-04-10T20:45:28.775Z"}}},"Securable":{"type":"object","allOf":[{"$ref":"#/components/schemas/SecurableSummary"},{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/GroupSummary"}}}}]},"JobType":{"type":"string"},"ArchiveSummary":{"type":"object","properties":{"archiveName":{"type":"string","description":"Name of archive.","example":"archive-of-edm"},"archiveId":{"description":"ID of archive.","type":"integer","example":5555,"format":"int64"},"archiveType":{"type":"string","description":"Type of archive.","example":"database"},"archiveSubType":{"description":"Subtype of archive.","example":"EDM","enum":["EDM","RDM","UNKNOWN"]},"archivedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created archive, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"createdAt":{"type":"string","example":"2024-04-10T20:45:28.775Z","description":"Date archive was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"},"createdBy":{"type":"string","description":"Login of <<glossary:principal>> that created archive, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"databaseType":{"type":"string","description":"Type of database.","enum":["EDM","RDM","UNKNOWN"]},"expiresAt":{"type":"string","description":"Date archive is to expire in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"},"serverType":{"type":"string","description":"Type of server.","example":"platform","enum":["databridge","platform"]},"serverName":{"type":"string","description":"Name of managed server instance.","example":"sql-instance-1"},"sizeInMb":{"type":"number","format":"double","description":"Size of database in MB.","example":1833},"sourceTypeId":{"type":"number","format":"double","description":"Data source of archive. One of `1` (Deleted Database), `2` (Snapshot Database), `3` (Archive Database).","enum":[1,2,3],"example":3},"sourceType":{"type":"string","description":"Data source of archive. One of Deleted Database, Snapshot Database, Archive Database.","example":"Archive Database"},"storageTypeId":{"type":"number","format":"double","description":"Type of archive. One of `0` (temporary) or `1` (permanent). If `0`, archive is deleted on `expiresDate`.","default":0,"enum":[0,1],"example":1},"storageType":{"type":"string","description":"Type of archive. One of temporary or permanent.","enum":["temporary","permanent"]},"owner":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that owns database, e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com"},"groupIds":{"type":"array","description":"List of group ids that are part of archive.","items":{"type":"string","format":"uuid"}},"tagIds":{"type":"array","description":"List of tags applied to database. See [Tags](ref:reference-data-api-overview).","items":{"type":"number","format":"int32"},"example":[52,53]},"thumbprint":{"type":"string","description":"Thumbprint identifier for the archive.","example":"EUW1.20251024.57"},"archiveDetails":{"oneOf":[{"$ref":"#/components/schemas/EDMTypeDetail"},{"$ref":"#/components/schemas/ExposureSetDetail"},{"$ref":"#/components/schemas/UnknownTypeDetail"},{"$ref":"#/components/schemas/RDMTypeDetail"}]}}},"EDMTypeDetail":{"type":"object","properties":{"exposureName":{"type":"string","description":"Name of the exposure/EDM","example":"001_EDM"},"databaseSchemaVersion":{"type":"string","description":"Version of the database schema","example":"25"},"dataVersion":{"type":"string","description":"Version of the data","example":"21.0.0"},"appRegisteredFrom\"":{"type":"string","description":"Where the app was registered from","example":"RM"},"files":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the file","example":"https://example.com/file.mdf"},"type":{"type":"string","description":"Type of the file","example":"MDF"}}}}}},"ExposureSetDetail":{"type":"object","properties":{"exposureDatabaseCount":{"type":"integer","description":"Count of exposure databases","example":1},"exposureName":{"type":"string","description":"Name of the exposure database","example":"001_ExposureDatabaseName"},"exposureVariationsCount":{"type":"integer","description":"Count of exposure variations","example":8},"resultsCount":{"type":"integer","description":"Count of results","example":0}}},"UnknownTypeDetail":{"type":"object","properties":{"name":{"type":"string","description":"Name of the database (same as archive name for RDM)","example":"_001_Database_xyz"},"files":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the file","example":"https://example.com/file.mdf"},"type":{"type":"string","description":"Type of the file","example":"MDF"}}}}}},"RDMTypeDetail":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL of the file","example":"https://example.com/file.mdf"},"type":{"type":"string","description":"Type of the file","example":"MDF"}}}},"exposureName":{"type":"string","description":"Name of the exposure/EDM","example":"001_EDM"},"databaseSchemaVersion":{"type":"string","description":"Version of the database schema","example":"25"},"dataVersion":{"type":"string","description":"Version of the data","example":"21.0.0"},"appRegisteredFrom":{"type":"string","description":"Application the archive is registered from","example":"RM"}}},"ArchiveSecurableRequest":{"type":"object","properties":{"expirationDate":{"type":"string","description":"Date archive is to expire in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"}}},"ErrorMessage":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"}}}},"securitySchemes":{"RMS_Auth":{"type":"apiKey","name":"Authorization","in":"header","description":"An API key is a token that enables a client application to make requests to tenant applications running on Intelligent Risk Platform.","x-default":"XXXXXXXXXX"}}}}