- 1. Introduction
- 2. About Data Gateway
- 3. Key Features
- 4. Glossary
- 5. System Requirements
- 6. Application Access
- 7. Roles
- 8. Dashboard Reports (Statistics)
- 9. Cloud Configurations
- 10. Access Management
-
11. Endpoint Management Module
- 11.1 Create Endpoint
- 11.2 Manage Endpoint
-
11.3 Protocols
- 11.3.1 FTP (File Transfer Protocol)
- Pull-Push
- Push-Pull
- Push–Push Scenario
- 11.3.2 FTPS (FTP Secure)
- Pull-Push
- Push-Pull
- Push-Push Scenario
- 11.3.3 SFTP (SSH File Transfer Protocol)
- Pull-Push
- Push-Pull
- Push-Push Scenario
- 11.3.4 API Based File Transfers
- 11.3.4.1 Pull-Push
- 11.3.4.2 Scenario: File Transfer through API, where You connect to Remote Server
- 11.3.4.3 Scenario: File Transfer through API, where Partner connects to Your Server
- 11.3.4.4 Push-Pull
- 11.3.5 AS2 (Applicability Statement 2)
- 11.3.5.1 AS2 Organizations
- 11.3.5.2 AS2 Endpoints
- 11.3.5.3 AS2 Relationships
- 11.4 GUID
- 12. File Management Module
-
13. Settings
- 13.1 Scheduler Configuration
- 13.2 PGP Manager
- 13.3 Application Configuration
- 13.4 Queue Management
- 13.4.1 Queue Management – Field Descriptions
- 13.4.2 Operational Summary
- 13.4.3 Key Benefits
- 13.5 Priority Handling
- 13.5.1 Priority Handling – Field Descriptions
- 13.5.2 Operational Summary
- 13.5.3 Key Benefits
- 13.6 Adapter Configuration
- 13.6.1 Adapter Configurations – Field Descriptions
- 13.6.2 Operational Behavior Example
- 13.6.3 Key Benefits
- 13.7 License Module
- 13.7.1 License Management – Field Descriptions
- 13.7.2 Operational Workflow
- 13.7.3 Key Benefits
- 14. Data Gateway Components
-
15. Connectivity and Authentication
- 15.1 Scenario: File Transfer through File Client, where Partner Connects to Your Server
- 15.2 Scenario: File Transfer through File Client, where You connect to Partner’s Remote Server
- 15.3 Push-Push Scenario
- 15.4 Scenario: File Transfer through AS2, push to partner and push to gateway
- 15.5 IP Allowlist & Rate Limiting
- 15.5.1 IP allowlisting
- 15.5.2 Rate Limiting
-
16. SAML Authentication and Authorization with Okta
- 16.1 What is SAML?
- 16.2 What is SAML Used For?
- 16.3 How SAML Works
- 16.4 Configuring SAML Authentication and Authorization in Okta
- 16.4.1 Prerequisites
- 16.4.2 Steps to Configure SAML in Okta
- 16.4.3 Download Identity Provider Metadata
- 16.4.4 Application Configuration (application.yml)
- 16.5 User Management for IDP Users
- 16.6 Common Troubleshooting Issues
-
17. Alert Management
- 17.1 File Not Received (FNR) Alert
- 17.2 File Not Received (FNR) Alert Timing Options
- 17.2.1 FNR Current Day Minutes
- 17.2.2 FNR Current Day Hours Scenario
- 17.2.3 FNR Daily Days Scenario
- 17.2.4 FNR Daily Weekdays Scenario
- 17.2.5 FNR Weekly Between Scenario
- 17.2.6 FNR Weekly Day of Week Scenario
- 17.2.7 FNR Monthly Specific Day Scenario
- 17.2.8 FNR Monthly On Scenario
- 17.2.9 FNR Monthly Interval Check Scenario
- 17.2.10 FNR Quarterly Scenario
- 17.2.11 FNR Yearly Every Scenario
- 17.2.12 FNR Yearly On The Scenario
- 17.3 File Load Alert (FLA Alert)
- 17.4 Manage Alerts
- 18. Cloud-Cloud File Transfer
- 19. OAuth 2.0 Authentication
- 20. ICAP Integration
- 21. Data Gateway APIs
21. Data Gateway APIs
This section describes the APIs available in DATA GATEWAY. The Swagger UI contains an updated list of APIs. This UI can be accessed using the Swagger URL – http://<hostname:port>/swagger-ui.html.
Note: To enable base authentication, the username and password of the Data Gateway user can be used for accessing swagger.
Token-Based Authentication for DATA GATEWAY APIs
JWTs or JSON Web Tokens are most commonly used to identify an authenticated user. They are issued by an authentication server and are consumed by the client-server (to secure its APIs).
Perform the following to generate JWT:
1. Navigate to Access Token Generator → (POST) Generate JWT token in Swagger.
2. Use the following JSON request and provide it in the body with the valid username and password of Swagger:
Json Request:
{
“password”: “string”,
“userName”: “string”
}
3. Click on execute button to generate JWT Token as shown below:
Json Response:
{
“userId”: ” {userid} “,
“token”: ” {token} “,
“email”: “{email}”,
“userRole”: “{user role}”,
“userName”: “{user id}”,
“lang”: “en”,
“color”: “black”,
“appVersion”: null,
“appCustomName”: null,
“dbInfo”: null,
“sfgEnabled”: false,
“errorInfo”: null,
“apiConnect”: false,
“sfgPcDReports”: true,
“partnerList”: [],
“cmDeployment”: true
}
4. From the Generated response, copy the token.
Note: For JWT Authentication, all the authorize requests should contain an authorization header. In this case, it is the token that is generated from the Token
method.
5. Use JWT Bearer Authorization in Swagger. To Authorize your request, use the generated token from the response. The format should be: Bearer 123xyzx2sff.
6. Select the Authorize button to set your Authorization header on all the requests from methods displayed in a swagger dashboard.
DATA GATEWAY APIs
This section provides details about the APIs that are bundled with DATA GATEWAY
API Name | /adg/group-Update Group | |
Method | PUT | |
Description | It is used to update a Group in Data Gateway | |
Table(s) | “TP_GROUPS” | |
Request | { “pkId”: “string”, “groupName”: “string”, “storageType”: “string”, “storageServiceId”: “string”, “partnerList”: [ “string” ] } | PkId: Unique ID of the Group GroupName: Unique Name of the Group
|
Response | { “statusCode”: 0, “statusMessage”: “string” } | |
API Name | /adg/group-Create Group | |
Method | POST | |
Description | It is used to create a Group in Data Gateway
| |
Table(s) | “TP_GROUPS”
| |
Request | { “string” } | GroupName : Provide the name of group |
Response | { | |
API Name | /adg/group-Search Group | |
Method | POST | |
Description | To Search Group values | |
Table(s) | “TP_GROUPS”
| |
Request | { | Search with any value to get group details based on the value. |
Response | {
| |
API Name | /adg/group/{pkId}-Get Group By Id | |
Method | GET | |
Description | Get Group values by Giving Group ID | |
Table(s) | “TP_GROUPS”
| |
Request | Query Params | PkId : Provide pkid value to get group values |
Response | {
| |
API Name | /adg/group /{pkID}-Delete Group | |
Method | DELETE | |
Description | To Delete Group by Giving ID | |
Table(s) | “TP_GROUPS”
| |
Request | Query Params | PkId : Provide pkid value to delete group
|
Response | {
| |
API Name | /adg/group-groups-maps | |
Method | GET | |
Description | Get Group names based on Storage Service ID | |
Table(s) | “TP_GROUPS”
| |
Request | Query Params | storageServiceId: Provide storageServiceId value to get group
|
Response | {
| |
API Name | /adg/group/group-list |
Method | GET |
Description | To get list of Groups |
Table(s) | “TP_GROUPS” |
API Name | /adg/set-log-level | |
Method | POST | |
Description | To change Log Levels | |
Request | { “key”: “string”, “value”: “string” } | Key:Key is the protocol |
Response | {
| |
API Name | /adg/set-chunk-size | |
Method | POST | |
Description | Using this configuration User can set the Chunk Size | |
Request | Query Params | ChunkSize:User can select there own chunk size for large files |
Response | {
| |
API Name | /adg/getLogs/{loggerName} | |
Method | GET | |
Description | Get logger based on Logger Name | |
Request | Query Param | LoggerName: provide the logger name |
Response | {
| |
API Name | /adg/get-log-levels |
Method | GET |
Description | Get Log levels |
API Name | /adg/get-chunk-size |
Method | GET |
Description | To get Chunk Size value |
Table(s) | “APPLICATION_CONFIGURATION”
|
API Name | /adg/user-Update Internal/External User | |
Method | PUT | |
Description | Update user values | |
Table(s) | “USERS” | |
Request | { “userId”: “string”, “userRole”: “string”, “firstName”: “string”, “lastName”: “string”, “middleName”: “string”, “email”: “string”, “phone”: “string”, “status”: true, “lang”: “string”, “userType”: “string”, “externalId”: “string”, “partnersList”: [ “string” ], “groupsList”: [ “string” ], “storageType”: “string”, “storageServiceId”: “string”, “auth”: true, “uploadBucketList”: [ { “pkId”: “string”, “tpId”: “string”, “directories”: [ { “pkId”: “string”, “tpId”: “string”, “directory”: “string” } ] } ], “downloadBucketList”: [ { “pkId”: “string”, “tpId”: “string”, “directories”: [ { “pkId”: “string”, “tpId”: “string”, “directory”: “string” } ] } ] } | userId: A unique identifier for the user UserRole: The role assigned to the user, indicating their level of access
|
Response | {
| |
API Name | /adg/user-Create Internal/External User
| |
Method | POST | |
Description | To Create User values | |
Table(s) | “USERS”
| |
Request | { “userId”: “string”, “userRole”: “string”, “firstName”: “string”, “lastName”: “string”, “middleName”: “string”, “email”: “string”, “phone”: “string“, “status”: true, “lang”: “string”, “userType”: “string”, “externalId”: “string”, “partnersList”: [ “string” ], “groupsList”: [ “string” ], “storageType”: “string”, “storageServiceId”: “string”, “auth”: true, “uploadBucketList”: [ { “pkId”: “string”, “tpId”: “string”, “directories”: [ { “pkId”: “string”, “tpId”: “string”, “directory”: “string” } ] } ], “downloadBucketList”: [ { “pkId”: “string”, “tpId”: “string”, “directories”: [ { “pkId”: “string”, “tpId”: “string”, “directory”: “string” } ] } ] } | userId: A unique identifier for the user UserRole: The role assigned to the user, indicating their level of access
|
Response | {
| |
API Name | /adg/user/status-Update Internal/External User Status
| |
Method | POST | |
Description | Update User Status based on pkId | |
Table(s) | “USERS”
| |
Request | { “pkId”: “string”, “status”: true } | pkId : A unique Id |
Response | {
| |
API Name | /adg/user/search-Search Internal/External User
| |
Method | POST | |
Description | It is used to Search Users | |
Table(s) | “USERS”
| |
Request | { “userId”: “string”, “userRole”: “string”, “firstName”: “string”, “lastName”: “string”, “middleName”: “string”, “email”: “string”, “phone”: “string”, “status”: true, “lang”: “string”, “userType”: “string”, “externalId”: “string”, “partnersList”: [ “string” ], “groupsList”: [ “string” ], “storageType”: “string”, “storageServiceId”: “string”, “auth”: true, “uploadBucketList”: [ { “pkId”: “string”, “tpId”: “string”, “directories”: [ { “pkId”: “string”, “tpId”: “string”, “directory”: “string” } ] } ], “downloadBucketList”: [ { “pkId”: “string”, “tpId”: “string”, “directories”: [ { “pkId”: “string”, “tpId”: “string”, “directory”: “string” } ] } ] } | Search with any value to get details based on the value.
|
Response | {
| |
API Name | /adg/user/lang – Update Internal/External User language | |
Method | POST | |
Description | Update User Lang based on UserId | |
Table(s) | “USERS”
| |
Request | { “userId”: “string”, “lang”: “string” } | UserId :provide unique userId |
Response | {
| |
API Name | /adg/user/change-password –Change
| |
Method | POST | |
Description | To Update the Password | |
Table(s) | “USERS”
| |
Request | { “userId”: “string”, “oldPassword”: “string”, “newPassword”: “string” } | UserId : A unique identifier for the user |
Response | {
| |
API Name | /adg/user/{userId} – Get Internal/External User By User-ID | |
Method | GET | |
Description | Get User Details based on Id | |
Table(s) | “USERS”
| |
Request | Query Params | UserId : Provide userId to get user details |
Response | {
| |
API Name | /adg/user/password-status | |
Method | GET | |
Description | Get User Set Password Status | |
Table(s) | “USERS”
| |
Request | Query Params | UserId : Provide userId to get user details |
Response | {
| |
API Name | /adg/user/{userId} – Delete Internal/External User
| |
Method | DELETE | |
Description | Delete User based on Id | |
Table(s) | “USERS” | |
Request | Query Params | UserId : Provide userId to delete user
|
Response | {
| |
Table(s) | “USERS”
| |
Request | Query param | UserId : Provide userId to unlock the user
|
Response | {
| |
API Name | /adg/user/roles – Data |
Method | GET |
Description | To get all the Roles |
Table(s) | “USERS”
|
API Name | /adg/user/get-assigned- uploadBuckets |
Method | GET
|
Description | Get the Bucket list assigned to User |
Table(s) | “USERS”
|
API Name | /adg/user/get-assigned-
|
Method | GET
|
Description | Get the Bucket list to Download assigned to User
|
Table(s) | “USERS”
|
API Name | /adg/cloud/update-config | |
Method | PUT | |
Description | It is used to Update Cloud Configurations values | |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | { “cloudConfig”: { “pkId”: “string”, “storageType”: “string”, “region”: “string”, “configId”: “-<e3Bc<d=?j6A“WwSdg’CaeyWEP2YPR24rGE,]wikJuM-67,|`NFLZf;u=ke18YGq6u>/};C5”, “authJson”: “string”, “fileName”: “string”, “gcsBucketName”: “string”, “projectId”: “string”, “topicName”: “string”, “subscriptionName”: “string”, “gcsArchiveFileAge”: 1073741824, “gcsKeyManagerService”: true, “accessKey”: “string”, “secretKey”: “string”, “s3BucketName”: “string”, “queueName”: “string”, “queueUrl”: “string”, “queueArn”: “string”, “awsKeyManagerService”: true, “connectionString”: “string”, “containerName”: “string”, “keyVaultName”: “string”, “clientSecret”: “string”, “tenantId”: “string”, “azureArchiveFileAge”: 1073741824, “subscriptionId”: “string”, “resourceGroupName”: “string”, “eventHub”: “string”, “eventConnectionString”: “string”, “azureKeyManagerService”: true, “ibmAccessKeyId”: “string”, “ibmSecretKey”: “string”, “ibmEndpointUrl”: “string”, “ibmBucketName”: “string”, “appClientId”: “string”, “apikey”: “string”, “serviceUrl”: “string”, “secretType”: “string”, “secretGroupName”: “string”, “ibmArchiveFileAge”: 1073741824, “ibmKeyManagerService”: true }, “file”: “string” }
| PkId: Primary key or unique identifier for the cloud configuration
|
Response | {
| |
API Name | /adg/cloud/search | |
Method | POST | |
Description | To Search Cloud Details | |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | { “cloudConfig”: { “pkId”: “string”, “storageType”: “string”, “region”: “string”, “configId”: “-<e3Bc<d=?j6A“WwSdg’CaeyWEP2YPR24rGE,]wikJuM-67,|`NFLZf;u=ke18YGq6u>/};C5”, “authJson”: “string”, “fileName”: “string”, “gcsBucketName”: “string”, “projectId”: “string”, “topicName”: “string”, “subscriptionName”: “string”, “gcsArchiveFileAge”: 1073741824, “gcsKeyManagerService”: true, “accessKey”: “string”, “secretKey”: “string”, “s3BucketName”: “string”, “queueName”: “string”, “queueUrl”: “string”, “queueArn”: “string”, “awsKeyManagerService”: true, “connectionString”: “string”, “containerName”: “string”, “keyVaultName”: “string”, “clientSecret”: “string”, “tenantId”: “string”, “azureArchiveFileAge”: 1073741824, “subscriptionId”: “string”, “resourceGroupName”: “string”, “eventHub”: “string”, “eventConnectionString”: “string”, “azureKeyManagerService”: true, “ibmAccessKeyId”: “string”, “ibmSecretKey”: “string”, “ibmEndpointUrl”: “string”, “ibmBucketName”: “string”, “appClientId”: “string”, “apikey”: “string”, “serviceUrl”: “string”, “secretType”: “string”, “secretGroupName”: “string”, “ibmArchiveFileAge”: 1073741824, “ibmKeyManagerService”: true }, “file”: “string” }
| PkId: Primary key or unique identifier for the cloud configuration
|
Response | {
| |
API Name | /adg/cloud/config | |
Method | POST | |
Description | To Create Cloud Configurations | |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | { “cloudConfig”: { “pkId”: “string”, “storageType”: “string”, “region”: “string”, “configId”: “-<e3Bc<d=?j6A“WwSdg’CaeyWEP2YPR24rGE,]wikJuM-67,|`NFLZf;u=ke18YGq6u>/};C5”, “authJson”: “string”, “fileName”: “string”, “gcsBucketName”: “string”, “projectId”: “string”, “topicName”: “string”, “subscriptionName”: “string”, “gcsArchiveFileAge”: 1073741824, “gcsKeyManagerService”: true, “accessKey”: “string”, “secretKey”: “string”, “s3BucketName”: “string”, “queueName”: “string”, “queueUrl”: “string”, “queueArn”: “string”, “awsKeyManagerService”: true, “connectionString”: “string”, “containerName”: “string”, “keyVaultName”: “string”, “clientSecret”: “string”, “tenantId”: “string”, “azureArchiveFileAge”: 1073741824, “subscriptionId”: “string”, “resourceGroupName”: “string”, “eventHub”: “string”, “eventConnectionString”: “string”, “azureKeyManagerService”: true, “ibmAccessKeyId”: “string”, “ibmSecretKey”: “string”, “ibmEndpointUrl”: “string”, “ibmBucketName”: “string”, “appClientId”: “string”, “apikey”: “string”, “serviceUrl”: “string”, “secretType”: “string”, “secretGroupName”: “string”, “ibmArchiveFileAge”: 1073741824, “ibmKeyManagerService”: true }, “file”: “string” } | PkId: Primary key or unique identifier for the cloud configuration |
Response | {
| |
API Name | /adg/cloud/getCloudProvidersconfigs | |
Method | GET | |
Description | Get Cloud Config values based on Storage Type | |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | Query Param | StorageType: Based on the storage type, retrieve all the storage service names |
Response | {
| |
API Name | /adg/cloud/get-config | |
Method | GET | |
Description | Get Cloud Configurations values based on PkID | |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | Query param | PkId:Based on the PkId retrieve cloud configuration details |
Response | {
| |
API Name | /adg/cloud/get-all-config |
Method | GET |
Description | Get all Cloud Configurations values |
Table(s) | “CLOUDS_CONFIGURATIONS”
|
API Name | /adg/cloud/delete-config | |
Method | DELETE | |
Description | To Delete Cloud Configurations Values based on PkId | |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | Query param | PkId:Based on the PkId delete cloud configuration
|
Response | { | |
API Name | /adg /partner/update-status | |
Method | PUT | |
Description | To Update Profile Status (Active or Inactive) | |
Table(s) | “TRADING_PARTNER”
| |
Request | { “pkId“: “string”, “status”: true } | Based on the pkId update the status |
Response | {
| |
API Name | /adg /partner/search
| |
Method | POST | |
Description | To get Partner Profiles
| |
Table(s) | “TRADING_PARTNER”
| |
Request | { “endpointName“: “string”, “customProfileName“: “string”, “endpointId“: “string”, “emailId“: “string”, “phone“: “string”, “protocol“: “string”, “addressLine1“: “string”, “addressLine2“: “string”, “status”: true, “hubInfo“: true, “hubToPartner“: true, “partnerToHub“: true, “storageType“: “string”, “storageServiceId“: “string”, “permissions”: [ “string” ] } | Search with any value to get details based on the value.
|
Response | {
| |
API Name | /adg /partner/partners-by-protocol
| |
Method | POST | |
Description | To get Partner Profiles by Protocol
| |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| Protocol: The communication protocol used by the profile(e.g., FTP, FTPS, SFTP)
|
Response | {
| |
API Name | /adg /partner/find-by-protocol
| |
Method | POST | |
Description | To get Partner Profiles by Protocol | |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| Protocol: The communication protocol used by the profile(e.g., FTP, FTPS, SFTP)
|
Response | {
| |
API Name | /adg /partner/activity/{pkId}
| |
Method | POST | |
Description | To get partner Activity History | |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| PkId: Based on the pkId, retrieve the partner activity history |
Response | { | |
API Name | /adg /partner/partners-map
| |
Method | GET | |
Description | To get partners Map | |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| StorageServiceName: Represents the name of the specific storage service being referenced. This could be a name like AWS S3, Google Cloud Storage, Azure Blob
|
Response | {
| |
API Name | /adg /partner/partners-list
|
Method | GET |
Description | To get list of Partners |
Table(s) | “TRADING_PARTNER”
|
API Name | /adg /partner/partners-dirs-map
| |
Method | GET | |
Description | To get Partner Map list
| |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| StorageServiceName: Represents the name of the specific storage service being referenced. This could be a name like AWS S3, Google Cloud Storage, Azure Blob |
Response | {
| |
API Name | /adg /partner/partner-email
| |
Method | GET | |
Description | To get Partner Email based on Id
| |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| Based on the Id retrieve the Partner email |
Response | {
| |
API Name | /adg /partner/getPartnerName/{id} | |
Method | GET | |
Description | To get Partner Name based on Id | |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| Based on the Id retrieve the Partner name
|
Response | {
| |
API Name | /adg/partner/ftp – Update FTP/FTPS/SFTP Profile
| |
Method | PUT | |
Description | To Update Partner profile | |
Table(s) | “TRADING_PARTNER”
| |
Request | { “endpointName”: “string”, “endpointId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “knownHostKey”: “string”, “status”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “connectionType”: “string”, “remoteFilePattern”: “string”, “preferredMacAlgorithm”: “string”, “remoteUser”: “string”, “characterEncoding”: “string”, “localPortRange”: “string”, “retryDelay”: “string”, “connectionRetryCount”: “string”, “preferredCipher”: “string”, “authType”: “string”, “responseTimeOut”: “string”, “sshAuthorizedKeys”: “string”, “passPhrase”: “string”, “privateKey”: “string”, “customProfileName”: “string”, ” pullPush “: true, ” pushPull “: true, “storageType”: “string”, “storageServiceId”: “string”, “appendGuid”: true, “pickupDirectoryList”: [ { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], “partnerDropDirectoriesList”: [ { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], “hubDropDirectoriesList”: [ { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], “fileName”: “string”, “remotePassword”: “string”, “remoteAuthType”: “string”, “remoteTransferType”: “string”, “remoteDeleteAfterCollection”: true, “userIdentityKey”: “string”, “remotePoolingInterval”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “encryptionStrength”: “string”, “virtualRoot”: “string”, “ipRangeWhitelist”: “string”, “rateLimit”: “string”, “remoteArchiveFileAge”: 0, “archiveFileAge”: 0, “caCertificate”: “string”, “caCertificateName”: “string”, “outboundURL”: “string”, “certificate”: “string”, “certificateName”: “string” }
| File: Choose any file
|
Response | { | |
API Name | /adg/partner/ftp – Create FTP/FTPS/SFTP Profile
| |
Method | POST | |
Description | To Create Endpoint
| |
Table(s) | “TRADING_PARTNER”
| |
Request | { “endpointName”: “string”, “endpointId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “knownHostKey”: “string”, “status”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “connectionType”: “string”, “remoteFilePattern”: “string”, “preferredMacAlgorithm”: “string”, “remoteUser”: “string”, “characterEncoding”: “string”, “localPortRange”: “string”, “retryDelay”: “string”, “connectionRetryCount”: “string”, “preferredCipher”: “string”, “authType”: “string”, “responseTimeOut”: “string”, “sshAuthorizedKeys”: “string”, “passPhrase”: “string”, “privateKey”: “string”, “customProfileName”: “string”, ” pullPush “: true, ” pushPull “: true, “storageType”: “string”, “storageServiceId”: “string”, “appendGuid”: true, “pickupDirectoryList”: [ { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], “partnerDropDirectoriesList”: [ { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], “hubDropDirectoriesList”: [ { “directory”: “string”, “pickupDirectory”: “string”, “dropDirectory”: “string”, “write”: true, “read”: true, “view”: true, “delete”: true, “selectAll”: true } ], “fileName”: “string”, “remotePassword”: “string”, “remoteAuthType”: “string”, “remoteTransferType”: “string”, “remoteDeleteAfterCollection”: true, “userIdentityKey”: “string”, “remotePoolingInterval”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “encryptionStrength”: “string”, “virtualRoot”: “string”, “ipRangeWhitelist”: “string”, “rateLimit”: “string”, “remoteArchiveFileAge”: 0, “archiveFileAge”: 0, “caCertificate”: “string”, “caCertificateName”: “string”, “outboundURL”: “string”, “certificate”: “string”, “certificateName”: “string” } | File: Choose any file |
Response | {
| |
API Name | /adg/partner/ftp/delete-dir
| |
Method | POST | |
Description | To Delete Directory | |
Table(s) | “TRADING_PARTNER”
| |
Request | { “cloudStorageType”: “string”, “dirToDelete”: “string”, “storageServiceId”: “string” } | CloudStorageType: Represents the type of cloud storage being used (e.g., AWS S3, Google Cloud Storage, Azure Blob Storage). This helps identify which cloud provider’s service is relevant for the operation
|
Response | {
| |
API Name | /adg/partner/ftp/check-file-presence
| |
Method | POST | |
Description | To check Folders for File presence
| |
Table(s) | “TRADING_PARTNER”
| |
Request | { “pkId”: “string”, }
| Based on pkId get the partner profile
|
Response | {
| |
API Name | /adg/partner/ftp/check-file-presence-in-dir
| |
Method | POST | |
Description | To check Folders for File presence | |
Table(s) | “TRADING_PARTNER”
| |
Request | { “cloudStorageType”: “string”, “dirToDelete”: “string”, “storageServiceId”: “string” } | CloudStorageType: Represents the type of cloud storage being used (e.g., AWS S3, Google Cloud Storage, Azure Blob Storage). This helps identify which cloud provider’s service is relevant for the operation |
Response | {
| |
API Name | /adg/partner/ftp/{pkId}
| |
Method | GET | |
Description | To Get FTP, FTPS, SFTP Profile | |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param | Based on pkId get the partner profile |
Response | { | |
API Name | /adg/partner/ftp/getPartnePickupDirs
|
Method | GET |
Description | To Get User Group Pickup Dirs permissions
|
Table(s) | “TRADING_PARTNER”
|
API Name | /adg/partner/ftp/getPartnerDropDirs
|
Method | GET |
Description | To get User Group Drop Dirs permissions |
Table(s) | “TRADING_PARTNER”
|
API Name | /adg/partner/ftp/getPartnerBuckets
| |
Method | GET | |
Description | To get all the Buckets | |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| Based on the storage type retrieve all the buckets |
Response | {
| |
API Name | /adg/partner/ftp/getEmails
| |
Method | GET | |
Description | To retrieve the email and send the key or user details to the corresponding email address | |
Table(s) | “TRADING_PARTNER”
| |
Request | EndpointId: “string” | Based on endpointId and pkId it retrives the email and send it |
Response | {
| |
API Name | /adg/partner/ftp/{pkId}/{isDeleteDirs} | |
Method | DELETE | |
Description | To Delete the Partner | |
Table(s) | “TRADING_PARTNER”
| |
Request | Query Param
| PkId: Represents the primary key identifier for a specific record |
Response | {
| |
API Name | /adg /reports/tp-Tran-stats | |
Method | POST | |
Description | Protocol based Trading Partner Transaction Stats | |
Table(s) |
| |
Request | { “dateRange”: “string”, “protocol”: “string” } | DateRange: Represents a specified range of dates |
Response | {
| |
API Name | /adg /reports/search | |
Method | POST | |
Description | File Operator Transfer Search | |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD”
| |
Request | { “dateRangeStart”: “string”, “dateRangeEnd”: “string”, “flowInOut”: “string”, “status”: “string”, “srcProtocol”: “string”, “destProtocol”: “string”, “srcFileName”: “string”, “destFileName”: “string”, “destArcFileLoc”: “string”, “cloudStorageType”: “string”, “senderId”: “string”, “partner”: “string”, “bucketName”: “string”, “errorStatus”: “string” } | Search with any value to get details based on the value.
|
Response | {
| |
API Name | /adg/reports/upload/activity
| |
Method | GET | |
Description | To Get User File Activity | |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” | |
Request | Query Param | ActivityName: Represents the name or type of the activity being performed |
Response | {
| |
API Name | /adg/reports/file-activity
| |
Method | GET | |
Description | To Get User File Activity | |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” | |
Request | Query Param | ActivityName: Represents the name or type of the activity being performed |
Response | {
| |
API Name | /adg/reports/file-activity/superAdminInbound
|
Method | GET |
Description | To Get Inbound Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/superAdminOutbound
|
Method | GET |
Description | To Get Outbound Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/cloud-cloud-gcs-stats
|
Method | GET |
Description | To Get Gcs Cloud To CloudTranscation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/cloud-cloud-s3-stats
|
Method | GET |
Description | To Get S3 Cloud To CloudTranscation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileManagerUpload
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileManagerDownload
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileManagerInbound
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileManagerOutbound
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileOperatortUpload
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileOperatorDownload
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileOperatorInbound
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg/reports/file-activity/fileOperatopOutbound
|
Method | GET |
Description | To Get Transcation Report |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD” |
Response | {
|
API Name | /adg /reports/tp-protocol-stats
|
Method | GET
|
Description | Protocol based Trading Partner Stats |
Table(s) | “TRANSACTION_SEARCH”
|
API Name | /adg /reports/tp-file-stats
| |
Method | GET
| |
Description | Trading Partner Dashboard Stats
| |
Table(s) | “TRANSACTION_SEARCH”
| |
Request | Query Param | PartnerId: Represents the unique identifier of the partner |
Response | {
| |
API Name | /adg /reports/tp-by-storage-type
| |
Method | GET
| |
Description | Trading Partner count by Storage Type | |
Table(s) | “TRANSACTION_SEARCH”
| |
Request | Query Param
| Based on the storage type, retrieve Protocol, active count and inactive count |
Response | {
| |
API Name | /adg /reports/file-activity/upload
|
Method | GET |
Description | User upload Dashboard Stats |
Table(s) | “TRANSACTION_SEARCH”
|
API Name | /adg /reports/file-activity/download
|
Method | GET |
Description | User download Dashboard Stats
|
API Name | /adg /reports/activity/{activityType}
| |
Method | GET | |
Description | Number Of Files upload/download | |
Table(s) | “TRANSACTION_SEARCH”
| |
Request | Query Param
| ActivityType: Represents the type of activity or action being tracked or processed |
Response | {
| |
API Name | /adg /file/generateSignedUrl
| |
Method | GET | |
Description | To Download File From GCS Bucket | |
Table(s) | “TRANSACTION_SEARCH”
| |
Request | folderPath: “string” | Provide values to download file |
Response | {
| |
API Name | /adg/proxy | |
Method | POST | |
Description | To validate the Endpoint | |
Request | Query Param
| PartnerId: Represents the unique identifier of the partner |
Response | {
| |
API Name | /adg /endpoint/access/pull-from-tp /generate-token
| |
Method | POST | |
Description | To initiate Pull from Partner via Api Call | |
Request | Query Param
| PartnerId: The unique identifier for the partner |
Response | {
| |
API Name | /adg /endpoint/access /generate-token /generate-token | |
Method | POST | |
Description | To generate Endpoint Token | |
Request | Query Param | PartnerId: Represents the unique identifier of the partner |
Response | {
| |
API Name | /adg /mfa/generate-token | |
Method | POST | |
Description | To access all REST resources using OTP
| |
Table(s) | “TWO_FACTOR_AUTH” | |
Request | { “userName”: “string”, “password“: “string” } | UserName: provide username
|
Response | {
| |
API Name | /adg /mfa/get-resend-otp-validation | |
Method | GET | |
Description | Two Factor Resend OTP response to access all REST Resource | |
Table(s) | “TWO_FACTOR_AUTH”
| |
Request | Query Param | UserId: provide a unique identifier for the user to resend the otp |
Response | {
| |
API Name | /adg /mfa/get-otp- Validation-response/{userid}/{otp}
| |
Method | GET | |
Description | It is used to get Two Factor OTP response | |
Table(s) | “TWO_FACTOR_AUTH”
| |
Request | Query Param 0tp = “String” | UserId: provide a unique identifier for the user |
Response | {
| |
API Name | /adg /generate-Token/enable-disable-mfa | |
Method | POST | |
Description | To access all REST resources, if isMfaEnabled is set to true in the YAML file, the user must log in using OTP. Otherwise, the user can log in directly to the application. | |
Table(s) | “TWO_FACTOR_AUTH”
| |
Request | { “userName”: “string”, “password”: “string” } | UserName: provide username |
Response | {
| |
API Name | /adg/ general/forgot/update-password
| |
Method | POST | |
Description | To update the password | |
Table(s) | “USERS”
| |
Request | { “userId”: “string”, “newPassword”: “string”, “otp”: “string” } | UserId: A unique identifier for the user whose password is being updated |
Response | {
| |
API Name | /adg/ general/forgot-password/{email} | |
Method | POST | |
Description | To reset password using email | |
Table(s) | “USERS”
| |
Request | Query Params | Email: Using email, you can reset the password |
Response | {
| |
API Name | /adg/gcs/create-bucket
| |
Method | POST | |
Description | To create Buckets and Folders | |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | Query Param
| BucketName: The name of the storage bucket where the file is stored |
Response | {
| |
API Name | /adg/gcs/create-bucket-lifeCycle | |
Method | POST | |
Description | To create archive Buckets and Folders
| |
Table(s) | “CLOUDS_CONFIGURATIONS”
| |
Request | Query Param | BucketName: The name of the storage bucket where the file is stored |
Response | {
| |
API Name | /adg/gcs/getPartnerBuckets |
Method | GET |
Description | To get all buckets |
Table(s) | “CLOUDS_CONFIGURATIONS”
|
API Name | /adg /file/upload/chunk
| |
Method | POST | |
Description | To upload a file in chunks | |
Table(s) |
| |
Request | Query Param tmpDirectoryName = ”String” | tmpDirectoryName: provide the name of the temporary directory where the file is temporarily stored to upload the chunk size
|
Response | {
| |
API Name | /adg /file/upload/stop-process
| |
Method | GET
| |
Description | Cancel the chunk uploading | |
Table(s) |
| |
Request | Query Param tmpDirectoryName = ”String” | tmpDirectoryName: provide the name of the temporary directory where the file is temporarily stored to cancel the chunk size |
Response | {
| |
API Name | /adg /file/upload/start
|
Method | GET
|
Description | Create the process for upload file as chunk |
Table(s) |
|
API Name | /adg /file/upload/gcs-bucket | |
Method | GET | |
Description | Merge chunks into Single File and upload to Google Cloud Bucket | |
Table(s) |
| |
Request | Query Param
| tmpDirectoryName: The name of the temporary directory where the file is temporarily stored |
Response | {
| |
API Name | /adg/file-search/search
| |
Method | POST | |
Description | It is used to search File Transfers | |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD”
| |
Request | { “dateRangeStart”: “string” “dateRangeEnd”: “string” “flowInOut”: “string”, “status”: “string”, “srcProtocol”: “string”, “destProtocol”: “string”, “srcFileName”: “string”, “destFileName”: “string”, “destArcFileLoc”: “string”, “cloudStorageType”: “string”, “senderId”: “string”, “endpointId”: “string”, “bucketName”: “string”, “errorStatus”: “string” } | Search with any value to get details based on the value.
|
Response | {
| |
API Name | /adg/file-search/details
| |
Method | GET | |
Description | To get Detailed Transfer Activity with the description by SeqId | |
Table(s) | “TRANSINFOD”
| |
Request | Query Param
| SeqId: Based on the seqId, retrieve the detailed transfer activity
|
Response | {
| |
API Name | /adg/file-search/activity | |
Method | GET | |
Description | To get File Transfer Activity | |
Table(s) | “TRANSACTION_SEARCH”, “TRANSINFOD”
| |
Request | Query Param
| SeqId: Based on the seqId, retrieve the transfer activity |
Response | {
| |
API Name | /adg//file-replay/multiFile- reprocess | |
Method | POST | |
Description | To Replay Multiple Files from Archive
| |
Request | [ { “bucketName”: “string”, “fileName”: “string”, “cloudType”: “string” } ] | BucketName: The name of the storage bucket
|
Response | {
| |
API Name | /adg /file-replay/reprocess | |
Method | POST | |
Description | To Replay Files from Archive | |
Table(s) |
| |
Request | [ { “fileName”: “string”, “cloudType”: “string” } ] | BucketName: The name of the storage bucket |
Response | {
| |
API Name | /adg /utility/protocols-map |
Method | GET |
Description | To get Protocols Names |
Table(s) | “TRADING_PARTNER”
|
API Name | /adg /utility/protocols-data |
Method | GET
|
Description | To get Protocol Data |
Table(s) | “TRADING_PARTNER” |
API Name | /adg /utility/get-logo
|
Method | GET
|
Description | To get Logo |
API Name | /adg /utility/endpoint-statistics |
Method | GET |
Description | Get Protocol Statistics Count |
Table(s) | “TRADING_PARTNER” |
API Name | /adg /utility/cloud-storage-map
|
Method | GET |
Description | To get Cloud Storage Names |
Table(s) | “TRADING_PARTNER”
|
API Name | /adg /utility/active-profile |
Method | GET |
Description | It is used to return the current Active Profiles |
Table(s) | “TRADING_PARTNER” |
API Name | /adg/ file- download/getFilesFromBucketsById
| |
Method | GET | |
Description | To get available Files from Buckets | |
Request |
Query param
|
Folderpath: The path of the folder where the file is stored
|
Response | {
| |
API Name | /adg/ file-download/downloadFile | |
Method | GET | |
Description | To Download Files from GCS Buckets | |
Request | Query params | Folderpath: The path of the folder where the file is stored |
Response | {
| |
API Name | /adg /fnrAlert | |
Method | POST | |
Description | Create File Not Receive Alert | |
Table(s) | “FNR_ALERT “
| |
Request | { “pkId”: “string”, “alertName”: “string”, “description”: “string”, “endpointId”: “string”, “endpointName”: “string”, “fileName”: “string”, “fileType”: “string”, “expectedFilesCount”: “string”, “expectedTime”: “string”, “dailyCount”: “string”, “dailyType”: “string”, “weekIdEvery”: “string”, “weekDays”: [ “string” ], “monthIdOccurrence”: “string”, “everyDayOfMonth”: “string”, “monthIdEveryMonth”: “string”, “monthIdOnTheDay”: “string”, “monthIdOnTheWeek”: “string”, “yearIdOccurrence”: “string”, “yearIdEveryMonth”: “string”, “yearIdEveryDay”: “string”, “yearIdOnThePosition”: “string”, “yearIdOnTheWeek”: “string”, “yearIdOnTheMonth”: “string”, “startTime”: “string”, “endTime”: “string”, “startDate”: “string”, “haveEndDate”: “string”, “endDate”: “string”, “notificationFr”: “string”, “priority”: “string”, “subject”: “string”, “body”: “string”, “dashboardAlert”: true, “emailAlert”: true, “apiAlert”: true, “email”: “string”, “toDay”: “string”, “fromDay”: “string”, “lastProcessedDate”: “string“, “weeklyCheck”: “string”, “fromWeekday”: “string”, “toWeekday”: “string”, “apiAlertConfigId”: “string“, “dayType”: “string”, “dayCount”: “string”, “groupName”: “string” } |
PkId: Unique identifier for the alert AlertName: Name of the alert Description: Detailed description of the alert EndpointId: ID of the associated endpoint MonthIdOnTheWeek: Weekday for “on the” monthly type DashboardAlert: Default Enable dashboard alert |
Response | {
| |
API Name | /adg /fnrAlert/ | |
Method | PUT | |
Description | Update File Not Receive Alert
| |
Table(s) | “FNR_ALERT “
| |
Request | { “pkId”: “string”, “alertName”: “string”, “description”: “string”, “endpointId”: “string”, “endpointName”: “string”, “fileName”: “string”, “fileType”: “string”, “expectedFilesCount”: “string”, “expectedTime”: “string”, “dailyCount”: “string”, “dailyType”: “string”, “weekIdEvery”: “string”, “weekDays”: [ “string” ], “monthIdOccurrence”: “string”, “everyDayOfMonth”: “string”, “monthIdEveryMonth”: “string”, “monthIdOnTheDay”: “string”, “monthIdOnTheWeek”: “string”, “yearIdOccurrence”: “string”, “yearIdEveryMonth”: “string”, “yearIdEveryDay”: “string”, “yearIdOnThePosition”: “string”, “yearIdOnTheWeek”: “string”, “yearIdOnTheMonth”: “string”, “startTime”: “string”, “endTime”: “string”, “startDate”: “string”, “haveEndDate”: “string”, “endDate”: “string”, “notificationFr”: “string”, “priority”: “string”, “subject”: “string”, “body”: “string”, “dashboardAlert”: true, “emailAlert”: true, “apiAlert”: true, “email”: “string”, “toDay”: “string”, “fromDay”: “string”, “lastProcessedDate”: “string“, “weeklyCheck”: “string”, “fromWeekday”: “string”, “toWeekday”: “string”, “apiAlertConfigId”: “string“, “dayType”: “string”, “dayCount”: “string”, “groupName”: “string” } | PkId: Unique identifier for the alert AlertName: Name of the alert Description: Detailed description of the alert EndpointId: ID of the associated endpoint MonthIdOnTheWeek: Weekday for “on the” monthly type DashboardAlert: Default Enable dashboard alert
|
Response | {
| |
API Name | /adg /fnrAlert/search | |
Method | POST | |
Description | It is used to search File Not Receive Created Alerts | |
Table(s) | “FNR_ALERT “
| |
Request | { “pkId”: “string”, “alertName”: “string”, “description”: “string”, “endpointId”: “string”, “endpointName”: “string”, “fileName”: “string”, “fileType”: “string”, “expectedFilesCount”: “string”, “expectedTime”: “string”, “dailyCount”: “string”, “dailyType”: “string”, “weekIdEvery”: “string”, “weekDays”: [ “string” ], “monthIdOccurrence”: “string”, “everyDayOfMonth”: “string”, “monthIdEveryMonth”: “string”, “monthIdOnTheDay”: “string”, “monthIdOnTheWeek”: “string”, “yearIdOccurrence”: “string”, “yearIdEveryMonth”: “string”, “yearIdEveryDay”: “string”, “yearIdOnThePosition”: “string”, “yearIdOnTheWeek”: “string”, “yearIdOnTheMonth”: “string”, “startTime”: “string”, “endTime”: “string”, “startDate”: “string”, “haveEndDate”: “string”, “endDate”: “string”, “notificationFr”: “string”, “priority”: “string”, “subject”: “string”, “body”: “string”, “dashboardAlert”: true, “emailAlert”: true, “apiAlert”: true, “email”: “string”, “toDay”: “string”, “fromDay”: “string”, “lastProcessedDate”: “string“, “weeklyCheck”: “string”, “fromWeekday”: “string”, “toWeekday”: “string”, “apiAlertConfigId”: “string“, “dayType”: “string”, “dayCount”: “string”, “groupName”: “string” } | PkId: Unique identifier for the alert AlertName: Name of the alert Description: Detailed description of the alert EndpointId: ID of the associated endpoint MonthIdOnTheWeek: Weekday for “on the” monthly type DashboardAlert: Default Enable dashboard alert
|
Response | {
| |
API Name | /adg /fnrAlert/{pkId} | |
Method | GET | |
Description | To Get File Not Receive Alert Based on pkId | |
Table(s) | “FNR_ALERT “
| |
Request | “pkId”: “string” |
PkId : A unique identifier to get specific alert
|
Response | {
| |
API Name | /adg /fnrAlert/{id} | |
Method | DELETE | |
Description | To Delete File Not Receive Alert Based on pkId | |
Table(s) | “FNR_ALERT “
| |
Request | “id”: “string” |
PkId : A unique identifier to get delete specific alert
|
Response | {
| |
API Name | /adg /alerts/dashboard | |
Method | POST | |
Description | It is used to search File Not Receive Raised Alerts | |
Table(s) | “ALL_ALERTS “
| |
Request | { “pkId”: “string”, “alertName”: “string”, “description”: “string”, “priority”: “string”, “endpointId”: “string”, “endpointName”: “string”, “timestamp”: “string”, “alertType”: “string”, “fileName”: “string”, “fileType”: “string”, “expectedTime”: “string”, “expectedFilesCount”: “string”, “receivedFilesCount”: “string”, “fromDate”: “string”, “toDate”: “string”, “createdTime”: “string”, “email”: “string”, “condition”: “string”, “subject”: “string”, “body”: “string”, “groupName”: “string”, “dateRangeStart”: “string”, “”: “string” } |
PkId: Primary key or unique identifier for the alert Description: Detailed description of the alert’s purpose fileType: Type or extension of the file Condition: Rule or condition that triggered the alert |
Response | {
| |
API Name | /adg /alerts/viewAlert/{pkId} | |
Method | GET | |
Description | Fetches And Returns The complete Alert Details Corresponding To The Provided pkId. | |
Table(s) | “ALL_ALERTS “
| |
Request | “pkId”: “string” |
PkId : A unique identifier to get specific alert details
|
Response | {
| |
API Name | /adg/fileNamePatterns
| |
Method | POST
| |
Description | Creates a new file name pattern | |
Table(s) | “FILE_PATTERN “
| |
Request | { “pkId”: “string”, “fileNamePattern”: “string” }
|
PkId: A unique identifier to create file patterns
|
Response | {
| |
API Name | /adg/fileNamePatterns
| |
Method | PUT
| |
Description | Update existing file name pattern | |
Table(s) | “FILE_PATTERN “
| |
Request | { “pkId”: “string”, “fileNamePattern”: “string” }
|
PkId: A unique identifier to update file patterns
|
Response | {
| |
API Name | /adg/fileNamePatterns
| |
Method | POST
| |
Description | Search file name pattern | |
Table(s) | “FILE_PATTERN “
| |
Request | { “pkId”: “string”, “fileNamePattern”: “string” }
|
PkId: A unique identifier to search file patterns
|
Response | {
| |
API Name | /adg/fileNamePatterns/{id}
| |
Method | GET
| |
Description | Retrive File Pattern Based On Id | |
Table(s) | “FILE_PATTERN “
| |
Request | { “id”: “string” }
|
id: A unique identifier to retrive file patterns
|
Response | {
| |
API Name | /adg/fileNamePatterns/{id}
| |
Method | DELETE
| |
Description | Delete file pattern based on id | |
Table(s) | “FILE_PATTERN “
| |
Request | { “id”: “string” }
|
PkId: A unique identifier to delete file patterns |
Response | {
| |
API Name | /adg/fileNamePatterns/partnerFileTypeMape
| |
Method | GET
| |
Description | To Retrive list of file patterns | |
Table(s) | “FILE_PATTERN “
| |
Response | {
| |
API Name | /adg/apiAlert/create
| |
Method | POST
| |
Description | Creates a Api Alert Configuration | |
Table(s) | “APIALERT_CONFIG”
| |
Request | { “pkid”: “string”, “apiAlertConfigName”: “string”, “methodType”: “string”, “url”: “string”, “authType”: “string”, “username”: “string”, “passwordBasic”: “string”, “tokenApiUrl”: “string”, “grantType”: “string”, “clientId”: “string”, “clientSecret”: “string”, “usernameOauth”: “string”, “passwordOauth”: “string”, “resource”: “string”, “scopeOauth”: “string”, “tokenResponseParser”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string”, “tokenUrl”: “string”, “usernameJwt”: “string”, “passwordJwt”: “string”, “tokenResponseParserJwt”: “string”, “tokenPrefixJwt”: “string”, “tokenHeaderJwt”: “string” } |
PkId: A unique identifier to create api alert configuration MethodType: HTTP method used to trigger the API |
Response | {
| |
API Name | /adg/apiAlert/update
| |
Method | PUT
| |
Description | Updates an Existing Api Alert Configuration | |
Table(s) | “APIALERT_CONFIG”
| |
Request | { “pkid”: “string”, “apiAlertConfigName”: “string”, “methodType”: “string”, “url”: “string”, “authType”: “string”, “username”: “string”, “passwordBasic”: “string”, “tokenApiUrl”: “string”, “grantType”: “string”, “clientId”: “string”, “clientSecret”: “string”, “usernameOauth”: “string”, “passwordOauth”: “string”, “resource”: “string”, “scopeOauth”: “string”, “tokenResponseParser”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string”, “tokenUrl”: “string”, “usernameJwt”: “string”, “passwordJwt”: “string”, “tokenResponseParserJwt”: “string”, “tokenPrefixJwt”: “string”, “tokenHeaderJwt”: “string” } |
PkId: A unique identifier to create api alert configuration MethodType: HTTP method used to trigger the API
|
Response | {
| |
API Name | /adg/apiAlert/search
| |
Method | POST
| |
Description | Search a Api Alert Configuration | |
Table(s) | “APIALERT_CONFIG”
| |
Request | { “apiAlertConfigName”: “string”, “methodType”: “string”, “url”: “string”, “authType”: “string” } | Based on these field you can search records |
Response | {
| |
API Name | /adg/apiAlert/{id}
| |
Method | GET
| |
Description | Get an Api Alert Configuration By Id | |
Table(s) | “APIALERT_CONFIG”
| |
Request | “id”: “string” |
Id: A unique identifier to get an api alert configuration based on id |
Response | {
| |
API Name | /adg/apiAlert/{id}
| |
Method | DELETE
| |
Description | Delete an Api Alert Configuration By Id | |
Table(s) | “APIALERT_CONFIG”
| |
Request | “id”: “string” |
Id: A unique identifier to delete an api alert configuration |
Response | {
| |
API Name | /adg/apiAlert/apiAlertConfigurationNames
| |
Method | GET
| |
Description | Get List Of Api Alert Configuration Names | |
Table(s) | “APIALERT_CONFIG”
| |
Response | {
| |
API Name | /adg/flaAlert
| |
Method | POST
| |
Description | Creates File Load Alert | |
Table(s) | “FILE_LOAD_ALERT”
| |
Request | { “pkId”: “string”, “alertName”: “string”, “description”: “string”, “configurationType”: “string”, “endpointId”: “string”, “endpointName”: “string”, “fileType”: “string”, “condition”: “string”, “priority”: “string”, “subject”: “string”, “body”: “string”, “email”: “string”, “dashboardAlert”: true, “emailAlert”: true, “errorCode”: “string”, “errorType”: “string”, “recipients”: “string”, “restApiAlert”: true, “method”: “string”, “apiAlertConfigId”: “string”, “groupName”: “string”, “timeType”: “string”, “timePeriod”: “string” } | PkId: Unique identifier for the alert entry |
Response | {
| |
API Name | /adg/flaAlert
| |
Method | PUT
| |
Description | Updated Alerady Existing File Load Alert | |
Table(s) | “FILE_LOAD_ALERT”
| |
Request | { “pkId”: “string”, “alertName”: “string”, “description”: “string”, “configurationType”: “string”, “endpointId”: “string”, “endpointName”: “string”, “fileType”: “string”, “condition”: “string”, “priority”: “string”, “subject”: “string”, “body”: “string”, “email”: “string”, “dashboardAlert”: true, “emailAlert”: true, “errorCode”: “string”, “errorType”: “string”, “recipients”: “string”, “restApiAlert”: true, “method”: “string”, “apiAlertConfigId”: “string”, “groupName”: “string”, “timeType”: “string”, “timePeriod”: “string” } | PkId: Unique identifier for the alert entry |
Response | {
| |
API Name | /adg/flaAlert/{id}
| |
Method | GET
| |
Description | Retrivies File Load Alert Based on id | |
Table(s) | “FILE_LOAD_ALERT”
| |
Request | id: “string” | PkId: Unique identifier for the alert to retrive data |
Response | {
| |
API Name | /adg/flaAlert/{id}
| |
Method | DELETE
| |
Description | Delete File Load Alert Based on id
| |
Table(s) | “FILE_LOAD_ALERT”
| |
Request | id: “string”
| PkId: Unique identifier for the alert to retrive data
|
Response | {
| |
API Name | /adg/pgp/generate-key-pair
| |
Method | POST
| |
Description | To Creates pgp keys | |
Table(s) | “USER_KEYS”
| |
Request | { “userId”: “string”, “userEmail”: “string”, “passphrase”: “string”, “keySize”: 1073741824, “keyAlgorithm”: “string”, “forSigning”: true, “forEncryption”: true, “fingerprint”: “string”, “expirationDate”: “string”, “keyName”: “string”, “endpointId”: [ “string” ] } | userId: Unique identifier for the user creating or owning the key |
Response | {
| |
API Name | /adg/pgp/check-pgpKeyValue
| |
Method | POST
| |
Description | Used to check if the key is already assigned. If it is, a message will be shown — but you can still proceed with selection if desired | |
Table(s) | “USER_KEYS”
| |
Request | [ “string” ] | Add List of endpointIds |
Response | {
| |
API Name | /adg/pgp/public-key-details
| |
Method | GET
| |
Description | When a public key name is provided, if the corresponding key is expired, a message is displayed: ‘Expired PGP Key Selected. The selected PGP key has expired and cannot be used. Please choose a valid key | |
Table(s) | “USER_KEYS”
| |
Request | “keyName”: “string”, | By giving input as public keyname |
Response | {
| |
API Name | /adg/pgp/private-key-details
| |
Method | GET
| |
Description | When a private key name is provided, if the corresponding key is expired, a message is displayed: ‘Expired PGP Key Selected. The selected PGP key has expired and cannot be used. Please choose a valid key
| |
Table(s) | “USER_KEYS”
| |
Request | “keyName”: “string”,
| By giving input as private keyname
|
Response | {
| |
|
API Name |
/adg/pgp/getEmails
|
|
|
Method |
POST
|
|
|
Description |
Used to retrieve the email addresses to which the key should be sent. |
|
|
Table(s) |
“USER_KEYS”
|
|
|
Request |
“pkId”: “string”, “endpointId”: “string” |
pkId: Unique primary key identifier for the record |
|
Response |
{
|
|
|
API Name |
/adg/pgp/getAll-public-keys
|
|
Method |
GET
|
|
Description |
To Retrive All Public Keys |
|
Table(s) |
“USER_KEYS”
|
|
Response |
{
|
|
API Name |
/adg/pgp/getAll-private-keys
|
|
|
Method |
GET
|
|
|
Description |
To Retrive All PrivateKeys
|
|
|
Table(s) |
“USER_KEYS”
|
|
|
Response |
{
|
|
|
API Name |
/adg/pgp/downloadKey
|
|
|
Method |
GET
|
|
|
Description |
To Download Public Key |
|
|
Table(s) |
“USER_KEYS”
|
|
|
Request |
“keyName”: “string” |
Provide keyName as input |
|
Response |
{
|
|
|
API Name |
/adg/pgp/delete
|
|
|
Method |
POST
|
|
|
Description |
To Delete pgp keys |
|
|
Table(s) |
“USER_KEYS”
|
|
|
Request |
{ “pkid”: “string”,
|
By Provide pkid as input |
|
Response |
{
|
|
|
API Name |
/adg/pgp/upload
|
|
|
Method |
POST
|
|
|
Description |
To upload Public key |
|
|
Table(s) |
“USER_KEYS”
|
|
|
Request |
{ “pgpKeyModel”: { “endpointId”: [ “string” ], “keyName”: “string” }, “pgpKey”: “string” } |
EndpointId: List of endpoint IDs to which this PGP key should be assigned |
|
Response |
{
|
|
|
API Name |
/adg/pgp/search
|
|
|
Method |
POST
|
|
|
Description |
To Search pgp keys |
|
|
Table(s) |
“USER_KEYS”
|
|
|
Request |
{ “userId”: “string”, “keyAlgorithm”: “string”, “keyName”: “string”, “endpointId”:“string”, } |
userId: Unique identifier for the user creating or owning the key |
|
Response |
{
|
|
|
API Name |
/adg/pooling-interval
|
|
|
Method |
POST
|
|
|
Description |
To Creates Pooling Interval |
|
|
Table(s) |
“POOLING_INTERVAL”
|
|
|
Request |
{ “pkId”: “string”, “schedulerId”: “string”, “schedulerName”: “string”, “schedulerType”: “string”, “cronExpression”: “string”, “schedulerConfiguration”: “string”, “seq”: 1073741824, “description”: “string”, “status”: true } |
pkId: Primary key or unique identifier for the scheduler entity schedulerType: Type of scheduler |
|
Response |
{
|
|
|
API Name |
/adg/pooling-interval
|
|
|
Method |
PUT
|
|
|
Description |
To Update Existing Pooling Interval |
|
|
Table(s) |
“POOLING_INTERVAL”
|
|
|
Request |
{ “poolingInterval”: “string”, “status”: true } |
|
|
Response |
{
|
|
|
API Name |
/adg/pooling-interval/update-status
|
|
|
Method |
POST
|
|
|
Description |
To update Pooling Interval Status |
|
|
Table(s) |
“POOLING_INTERVAL”
|
|
|
Request |
{ “poolingInterval”: “string”, “status”: true }
|
Provide scheduler name and status to enable or disable |
|
Response |
{
|
|
|
API Name |
/adg/pooling-interval/search
|
|
|
Method |
POST
|
|
|
Description |
To Search Existing Pooling Interval |
|
|
Table(s) |
“POOLING_INTERVAL”
|
|
|
Request |
{ “pkId”: “string”, “schedulerId”: “string”, “schedulerName”: “string”, “schedulerType”: “string”, “cronExpression”: “string”, “schedulerConfiguration”: “string”, “seq”: 1073741824, “description”: “string”, “status”: true } |
pkId: Primary key or unique identifier for the scheduler entity schedulerType: Type of scheduler |
|
Response |
{
|
|
|
API Name |
/adg/pooling-interval/{pkId}
|
|
|
Method |
GET
|
|
|
Description |
To Retrive Pooling Interval based on Pkid |
|
|
Table(s) |
“POOLING_INTERVAL”
|
|
|
Request |
“pkId”: “string”
|
Provide pkId as input
|
|
Response |
{
|
|
|
API Name |
/adg/pooling-interval/{pkId}
|
|
|
Method |
POST
|
|
|
Description |
To Delete Pooling Interval Based on Pkid |
|
|
Table(s) |
“POOLING_INTERVAL”
|
|
|
Request |
“pkId”: “string” |
Provide pkId as input |
|
Response |
{
|
|
|
API Name |
/adg/pooling-interval/list
|
|
|
Method |
GET
|
|
|
Description |
To Retrive List of Pooling Intervals |
|
|
Table(s) |
“POOLING_INTERVAL”
|
|
|
Response |
{
|
|
|
API Name |
/adg/partner/lock-manager/search
|
|
|
Method |
POST
|
|
|
Description |
Search Locked Endpoint and Users |
|
|
Table(s) |
“USERS_ATTEMPTS”
|
|
|
Request |
{ “username”: “string”, “userStatus”: “string”, “expirationTime”: “string”, “lockedBy”: “string”, “resourceType”: “string” } |
Username: The name of the endpoint or user |
|
Response |
{
|
|
|
API Name |
/adg/partner/lock-manager/update-status
|
|
|
Method |
POST
|
|
|
Description |
To update the user status (Lock or Unlock) |
|
|
Table(s) |
“USERS_ATTEMPTS”
|
|
|
Request |
{ “userId”: “string”, “userStatus”: “string”, “isPartner”: true } |
UserId: Provide endpointId or UserId |
|
Response |
{
|
|
|
API Name |
/adg/queue – CREATE QUEUE
|
|
|
Method |
POST
|
|
|
Description |
To Create Queue |
|
|
Table(s) |
“QUEUE_MANAGER“ |
|
|
Request |
{ “pkId”: “string”, “queueName”: “string”, “maxThreads”: 1073741824, “resourceAllocation”: 1073741824, “transferThreadPoolSize”: 1073741824 } |
PkId: Primary key or unique identifier for the record
|
|
Response |
{
|
|
|
API Name |
/adg/queue – UPDATE QUEUE
|
|
|
Method |
PUT
|
|
|
Description |
To Update Queue |
|
|
Table(s) |
“QUEUE_MANAGER“
|
|
|
Request |
{ “pkId”: “string”, “queueName”: “string”, “maxThreads”: 1073741824, “resourceAllocation”: 1073741824, “transferThreadPoolSize”: 1073741824 } |
PkId: Primary key or unique identifier for the record
|
|
Response |
{
|
|
|
API Name |
/adg/queue/search – GET QUEUE
|
|
|
Method |
POST
|
|
|
Description |
To Retrive all the Queues |
|
|
Table(s) |
“QUEUE_MANAGER“
|
|
|
Request |
{ “pkId”: “string”, “queueName”: “string”, “maxThreads”: 1073741824, “resourceAllocation”: 1073741824, “transferThreadPoolSize”: 1073741824 } |
PkId: Primary key or unique identifier for the record
|
|
Response |
{
|
|
|
API Name |
/adg/queue/{pkId} – GET QUEUE
|
|
|
Method |
GET
|
|
|
Description |
To Retrive Queue based on Pkid |
|
|
Table(s) |
“QUEUE_MANAGER“
|
|
|
Request |
“pkId”: “string” |
PkId: Primary key or unique identifier for the record to retrive
|
|
Response |
{
|
|
|
API Name |
/adg/queue/{pkId} – DELETE QUEUE
|
|
|
Method |
DELETE
|
|
|
Description |
To Delete Queue Based on Pkid |
|
|
Table(s) |
“QUEUE_MANAGER“
|
|
|
Request |
“pkId”: “string” |
PkId: Primary key or unique identifier for the record to delete |
|
Response |
{
|
|
|
API Name |
/adg/queue/queue-list – Get Queue List
|
|
|
Method |
GET
|
|
|
Description |
To Retrive All the Queues |
|
|
Table(s) |
“QUEUE_MANAGER“
|
|
|
Response |
{
|
|
|
API Name |
/adg/priority – Assign Priority
|
|
|
Method |
POST
|
|
|
Description |
To Assign Priority |
|
|
Table(s) |
“ TP_QUEUE_PRIORITY “ |
|
|
Request |
{ “pkId”: “string”, “queueName”: “string”, “tpId”: “string”, “priority”: 1073741824 |
PkId: Primary key or unique identifier for the record
|
|
Response |
{
|
|
|
API Name |
/adg/priority – Update Priority
|
|
|
Method |
PUT
|
|
|
Description |
To Update Existing Priority |
|
|
Table(s) |
“ TP_QUEUE_PRIORITY “ |
|
|
Request |
{ “pkId”: “string”, “queueName”: “string”, “tpId”: “string”, “priority”: 1073741824 |
PkId: Primary key or unique identifier for the record
|
|
Response |
{
|
|
|
API Name |
/adg/priority /search – Get Priority
|
|
|
Method |
POST
|
|
|
Description |
To Retrive all the Priorities |
|
|
Table(s) |
“ TP_QUEUE_PRIORITY “ |
|
|
Request |
{ “pkId”: “string”, “queueName”: “string”, “tpId”: “string”, “priority”: 1073741824 |
PkId: Primary key or unique identifier for the record
|
|
Response |
{
|
|
|
API Name |
/adg/priority/{plId} – Get Priority
|
|
|
Method |
GET
|
|
|
Description |
Based on Pkid to retrive the priority |
|
|
Table(s) |
“ TP_QUEUE_PRIORITY “ |
|
|
Request |
“pkId”: “string” |
PkId: Primary key or unique identifier for the record to retrive
|
|
Response |
{
|
|
|
API Name |
/adg/priority /{pkId} – Delete Priority
|
|
|
Method |
DELETE
|
|
|
Description |
To Delete Priority based on pkid |
|
|
Table(s) |
“ TP_QUEUE_PRIORITY “ |
|
|
Request |
“pkId”: “string”,
|
PkId: Primary key or unique identifier for the record to delete |
|
Response |
{
|
|
