Organizations

List Data Source Settings

SecurityapiKey
Request
path Parameters
id
required
string

Organization ID

query Parameters
maskedCredentials
boolean
Default: false
page
integer
Default: 0
pageSize
integer
Default: 50
Responses
200

successful operation

get/organizations/{id}/globalsettings/datapoolaccesssettings
Request samples 
Response samples 
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "total": 0,
  • "values": [
    ]
}
Read Data Source Settings
SecurityapiKey 
Request 
path Parameters
dataSourceTechnicalKey
required
string
 
id
required
string
Organization ID


 
query Parameters
maskedCredentials
boolean
 Default:  false
 
Responses 
200
successful operation


get/organizations/{id}/globalsettings/datapoolaccesssettings/{dataSourceTechnicalKey}
Request samples 
Response samples 
application/json
{
  • "dataSource": {},
  • "activationStatus": "ACTIVE",
  • "activatedAt": "2021-04-11T12:34-56:00",
  • "activatedBy": "tom.sawyer@twain.com",
  • "termsAcceptanceStatus": "ACCEPTED",
  • "termsAcceptedAt": "2021-04-11T12:34-56:00",
  • "termsAcceptedBy": "huckleberry.finn@twain.com",
  • "licenceUrl": "https://www.cdq.ch/legal/dsc-terms-of-use",
  • "termsType": "string",
  • "allowedCredentialTypes": [
    ],
  • "credentials": [
    ]
}
Update data pool access settings
SecurityapiKey 
Request 
path Parameters
dataSourceTechnicalKey
required
string
 
id
required
string
Organization ID


 
Request Body schema: application/json
activationStatus
string (DataSourceActivationStatus) 
 Default:  "INACTIVE"
Whether an organization has activated a data source.


 Enum: Description
ACTIVE
The data source is activated for the organization.


INACTIVE
The data source is not activated for the organization.


 
Array of objects (DataSourceCredential) 
 
termsAcceptanceStatus
string (schemas-TermsAcceptanceStatus) 
 Default:  "NOT_ACCEPTED"
Whether an organization has accepted the terms of use of a data source.


 Enum: Description
ACCEPTED
The terms of use of the data source are accepted by the organization.


NOT_ACCEPTED
The terms of use of the data source are not accepted by the organization.


 
Responses 
200
successful operation


put/organizations/{id}/globalsettings/datapoolaccesssettings/{dataSourceTechnicalKey}
Request samples 
application/json
{
  • "activationStatus": "ACTIVE",
  • "termsAcceptanceStatus": "ACCEPTED",
  • "credentials": [
    ]
}
Response samples 
application/json
{
  • "dataSourceSettings": [
    ]
}