Manage global settings. It includes operations such as listing all data source settings for a specific organization.
List all data source settings for a specific organization.
successful operation
{- "page": "1",
- "pageSize": "100",
- "total": "67",
- "values": [
- {
- "dataSource": {
- "name": "Receita Federal Brazil",
- "technicalKey": "BR_RF"
}, - "activationStatus": "ACTIVE",
- "activatedAt": "2024-11-20T14:46:29Z",
- "activatedBy": "tom.sawyer@twain.com",
- "deactivatedAt": "2024-11-20T14:46:29Z",
- "deactivatedBy": "tom.sawyer@twain.com",
- "termsAcceptanceStatus": "ACCEPTED",
- "termsAcceptedAt": "2024-11-20T14:46:29Z",
- "termsAcceptedBy": "huckleberry.finn@twain.com",
- "termsUnacceptedAt": "2024-11-20T14:46:29Z",
- "termsUnacceptedBy": "huckleberry.finn@twain.com",
- "allowedCredentialTypes": [
- "BVD_CREDENTIALS"
], - "credentials": [
- {
- "type": {
- "technicalKey": "AT.FON.TID",
- "label": "API Key"
}, - "fields": [
- {
- "type": {
- "technicalKey": null,
- "label": null,
- "type": null
}, - "value": "********"
}
]
}
]
}
]
}
Read data source settings for a specific organization.
successful operation
{- "dataSource": {
- "name": "Receita Federal Brazil",
- "technicalKey": "BR_RF"
}, - "activationStatus": "ACTIVE",
- "activatedAt": "2024-11-20T14:46:29Z",
- "activatedBy": "tom.sawyer@twain.com",
- "deactivatedAt": "2024-11-20T14:46:29Z",
- "deactivatedBy": "tom.sawyer@twain.com",
- "termsAcceptanceStatus": "ACCEPTED",
- "termsAcceptedAt": "2024-11-20T14:46:29Z",
- "termsAcceptedBy": "huckleberry.finn@twain.com",
- "termsUnacceptedAt": "2024-11-20T14:46:29Z",
- "termsUnacceptedBy": "huckleberry.finn@twain.com",
- "allowedCredentialTypes": [
- "BVD_CREDENTIALS"
], - "credentials": [
- {
- "type": {
- "technicalKey": "AT.FON.TID",
- "label": "API Key"
}, - "fields": [
- {
- "type": {
- "technicalKey": "USERNAME",
- "label": "API Key",
- "type": "API Key"
}, - "value": "********"
}
]
}
]
}