Global Settings

Manage global settings. It includes operations such as listing all data source settings for a specific organization.

List Data Source Settings

List all data source settings for a specific organization.

SecurityapiKey
Request
path Parameters
id
required
string (OrganizationId)

Organization ID.

Example: cdq_monitor
query Parameters
page
integer
Default: 0

Page number.

Example: page=0
pageSize
integer
Default: 50

Number of items per page.

Example: pageSize=50
header Parameters
Authorization
required
string

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
Responses
200

successful operation

get/v2/organizations/{id}/globalsettings/datapoolaccesssettings
Request samples
Response samples
application/json
{
  • "page": "1",
  • "pageSize": "100",
  • "total": "67",
  • "values": [
    ]
}

Read Data Source Settings

Read data source settings for a specific organization.

SecurityapiKey
Request
path Parameters
dataSourceTechnicalKey
required
string (DataSourceTechnicalKey)

Data Source Technical Key.

Example: BR_RF
id
required
string (OrganizationId)

Organization ID.

Example: cdq_monitor
header Parameters
Authorization
required
string

Authorization header with Bearer Token.

Example: Bearer eyJhbGciOiJIUzI1(...)
Responses
200

successful operation

get/v2/organizations/{id}/globalsettings/datapoolaccesssettings/{dataSourceTechnicalKey}
Request samples
Response samples
application/json
{
  • "dataSource": {},
  • "activationStatus": "ACTIVE",
  • "activatedAt": "2024-10-29T14:15:21Z",
  • "activatedBy": "tom.sawyer@twain.com",
  • "deactivatedAt": "2024-10-29T14:15:21Z",
  • "deactivatedBy": "tom.sawyer@twain.com",
  • "termsAcceptanceStatus": "ACCEPTED",
  • "termsAcceptedAt": "2024-10-29T14:15:21Z",
  • "termsAcceptedBy": "huckleberry.finn@twain.com",
  • "termsUnacceptedAt": "2024-10-29T14:15:21Z",
  • "termsUnacceptedBy": "huckleberry.finn@twain.com",
  • "allowedCredentialTypes": [
    ],
  • "credentials": [
    ]
}