Administer EDM

post https://{host}/riskmodeler/v2/datasources

Administers an EDM data source.

The service supports three administrative operations:

The CREATE operation creates a new EDM datasource on the specified server.
The DOWNLOAD_EDM operation downloads the specified EDM as a database artifact in the specified format.
The EDM_DATA_UPGRADE operation upgrades the specified EDM to the latest version.

The datasourcename and operation query parameters are required. The datasourcename identifies the name of the EDM to create, download, or upgrade. The operation specifies the administrative operation: CREATE, DOWNLOAD_EDM, or EDM_DATA_UPGRADE.

Create EDM operation

If the CREATE option is specified, the datasourcename specifies the name of the EDM created and the servername parameter specifies the server on which the new EDM is created.

Download EDM operation

If the DOWNLOAD_EDM option is specified, the datasourcename identifes the EDM to download and the filename specifies the name of the database artifact.

The service supports several different formats for the database artifact. One of BAK, CSV, MDF or PARQUET.

Upgrade EDM operation

If the EDM_DATA_UPGRADE option is specified, the datasourcename specifies the name of the EDM to upgrade using the latest database schema.

Query Params

datasourcename

string

required

length between 1 and 80

Unique name of EDM data source. Valid characters: 0-9, A-Z, a-z, _ (underscore), - (hyphen), and ' ' (space). Maximum length is 80 characters.

filename

string

Name of the file for download. Valid characters: 0-9, A-Z, a-z, _ (underscore), - (hyphen), and '' '' (space).

operation

string

required

Database operation to perform. One of CREATE, DOWNLOAD_EDM, or EDM_DATA_UPGRADE.

servername

string

Name of server instance hosting the EDM.

format

string

Defaults to BAK

File format downloaded database artifact. By default, BAK.

sqlversion

string

Defaults to 2016

SQL server version of exported BAK or MDF.

detachOnly

boolean

Defaults to false

If true, the database is taken offline for the duration of the export job and not backed up. If false or undefined, the database is backed up before it is detached.

Body Params

Specify the edm request

boolean

Indicates if the exposure set is shared with other groups.

tagIds

array of int32s

List of data tag IDs.

tagIds

groups

array of strings

List of groups that may access the exposure set.

groups

Responses

`CREATE_EDM`, `DOWNLOAD_EDM`, or EDM_DATA_UPGRADE`job was added to the workflow engine queue for processing. Returns a URL in the`Location`header that enables you to track the status of the job, e.g.`/{host}/v1/workflows/100000`. Send periodic HTTP GET requests to the URL for the job status. See Workflow Engine Jobs.

xxxxxxxxxx
curl --request POST \
     --url 'https://api-euw1.rms.com/riskmodeler/v2/datasources?operation=CREATE&format=BAK&sqlversion=2016&detachOnly=false' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Create EDM operation

Download EDM operation

Upgrade EDM operation

400Bad Request: Please check that you are provided all required values.

403Forbidden: Access to this resource has been denied.