Community Manager API Document
This guide provides a comprehensive overview of all available APIs of PCM, designed to help developers, integrators, and technical stakeholders understand and interact with the system effectively. Each API is crafted to support key functionalities across various modules, enabling seamless integration, automation, and data exchange. Whether you’re building new features, connecting external systems, or optimizing workflows, this documentation serves as your go-to resource for understanding endpoints, request/response formats, authentication mechanisms, and usage examples. Our goal is to ensure clarity, consistency, and ease of use as you work with our APIs.
The Swagger UI contains an updated list of APIs. This UI can be accessed using the Swagger URL – http://<hostname:port>/swagger-ui.html
Authentication is a critical part of securing APIs. It ensures that only authorized users or systems can access the API and perform allowed operations.
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:
Navigate to Access Token Generator → (POST) Generate JWT token in Swagger.
JSON Request:
{
“password”: “string”,
“userName”: “string”
}
Json Response:
{
“userId”: “{userid}”,
“token”: “{token}”,
“email”: null,
“userRole”: “{user role}”,
“userName”: “{userid}”,
“b2bUser”: true,
“faxUser”: false,
“siUser”: true,
“faxQueue”: “IGNORE”,
“faxQueueAccess”: “IGNORE”,
“faxQueueName”: “IGNORE”,
“lang”: “en”,
“color”: “black”,
“appVersion”: “Version: 6.2.2”,
“appCustomName”: null,
“dbInfo”: “db2”,
“sfgEnabled”: true,
“errorInfo”: null,
“apiConnect”: false,
“sfgPcDReports”: false,
“partnerList”: [],
“cmDeployment”: true
}
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.
Use JWT Bearer Authorization in Swagger. To Authorize your request, use the generated token from the response. The format should be: Bearer <token>.Select the Authorize button to set your Authorization header on all the requests from methods displayed in a swagger dashboard.
| API Name | /pcm/heap/memory-status |
| Method | GET |
| Description | API retrieves the current status of the heap memory. It provides details on memory usage, available memory, and potential memory issues within the system. |
| Request | No parameters |
| Response | { |
| API Name | /pcm/partner/goggle-drive |
| Method | PUT |
| Description | API is used to update partner details related to Google Drive integration. It allows modifications to partner configurations, such as drive access settings or other related parameters. |
| Request | File : choose File { “ipWhiteList”: “string”, “pemIdentifier”: “string”, “hubInfo”: true, “customProfileName”: “string”, “profileId”: “string”, “clientId”: “string”, “pgpInfo”: “string”, “inDirectory”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “poolingInterval”: “string”, “partnerPriority”: true, “phone”: “string”, “onlyPCM”: true, “fileInput”: “string”, “deleteAfterCollection”: true, “clientEmail”: “string”, “status”: true, “projectId”: “string”, “profileName”: “string”, “pkId”: “string”, “fileType”: “string”, “emailId”: “string”, “like”: true, “protocol”: “string”, “outDirectory”: “string” } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/goggle-drive |
| Method | POST |
| Description | API with the POST method is used to create a new partner integration with Google Drive. It allows the registration of a new partner, setting up necessary configurations for Google Drive access and collaboration. |
| Request | { “ipWhiteList”: “string”, “pemIdentifier”: “string”, “hubInfo”: true, “customProfileName”: “string”, “profileId”: “string”, “clientId”: “string”, “pgpInfo”: “string”, “inDirectory”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “poolingInterval”: “string”, “partnerPriority”: true, “phone”: “string”, “onlyPCM”: true, “fileInput”: “string”, “deleteAfterCollection”: true, “clientEmail”: “string”, “status”: true, “projectId”: “string”, “profileName”: “string”, “pkId”: “string”, “fileType”: “string”, “emailId”: “string”, “like”: true, “protocol”: “string”, “outDirectory”: “string” } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/goggle-drive/pemPartnerUpdate |
| Method | PUT |
| Description | Endpoint is used to update the details of an existing PEM partner. It allows modifications to the partner’s configuration or settings related to Google Drive integration. |
| Request | { “pkId”: “TPRcq3K3”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/goggle-drive/saveall |
| Method | POST |
| Description | Endpoint is used to create and save multiple partner configurations for Google Drive integration at once. It allows batch creation of partners, streamlining the process of setting up multiple partners in a single request. |
| Request | { “ipWhiteList”: “string”, “pemIdentifier”: “string”, “hubInfo”: true, “customProfileName”: “string”, “profileId”: “string”, “clientId”: “string”, “pgpInfo”: “string”, “inDirectory”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “poolingInterval”: “string”, “partnerPriority”: true, “phone”: “string”, “onlyPCM”: true, “fileInput”: “string”, “deleteAfterCollection”: true, “clientEmail”: “string”, “status”: true, “projectId”: “string”, “profileName”: “string”, “pkId”: “string”, “fileType”: “string”, “emailId”: “string”, “like”: true, “protocol”: “string”, “outDirectory”: “string” } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/goggle-drive/pemPartnerCreate |
| Method | POST |
| Description | POST API creates a new PEM Partner. It initiates the partner creation process within the Google Drive integration. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/goggle-drive/{pkId} |
| Method | GET |
| Description | GET API retrieves details of a specific PEM Partner. It uses the pkId path parameter to identify the partner. |
| Request | { PkId : “ “ } |
| Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } |
| API Name | /pcm/partner/goggle-drive/{pkId} |
| Method | DELETE |
| Description | DELETE API removes a specific PEM Partner. It identifies the partner to delete using the pkId path parameter. |
| Request | { PkId : “ “ } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/google-drive/getAllByProfileId/{profileId} |
| Method | GET |
| Description | GET API retrieves all PEM Partners linked to a specific profile. It uses the profileId path parameter to fetch associated partners. |
| Request | { profileId : “ “ } |
| Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true }
|
| API Name | /pem/proxy/codeList |
| Method | PUT |
| Description | PUT API updates the Proxy CodeList. It modifies existing code list entries used in the PEM system. |
| Request | { “codeSet”: [ { “description”: “string”, “id”: “string”, “receiverCode”: “string”, “senderCode”: “string”, “text1”: “string”, “text2”: “string”, “text3”: “string”, “text4”: “string”, “text5”: “string”, “text6”: “string”, “text7”: “string”, “text8”: “string”, “text9”: “string” } ], “CodeList”: “string” } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pem/proxy/codeList |
| Method | POST |
| Description | POST API creates a new Proxy CodeList. It adds a new set of code list entries to the PEM system. |
| Request | { “codeSet”: [ { “description”: “string”, “id”: “string”, “receiverCode”: “string”, “senderCode”: “string”, “text1”: “string”, “text2”: “string”, “text3”: “string”, “text4”: “string”, “text5”: “string”, “text6”: “string”, “text7”: “string”, “text8”: “string”, “text9”: “string” } ], “CodeList”: “string” } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pem/proxy/codeList |
| Method | POST |
| Description | POST API deletes a Proxy Code List. It removes specified code list entries from the PEM system. |
| Request | { codeListName : “” } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/http |
| Method | PUT |
| Description | API updates an HTTP/HTTPS Application Profile. It modifies the configuration of the specified application profile. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/http |
| Method | POST |
| Description | API creates a new HTTP/HTTPS Application Profile. It adds a new application profile configuration. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/http/saveMultipleProfiles |
| Method | POST |
| Description | API creates multiple HTTP/HTTPS Application Profiles. It allows adding several application profiles in a single request. |
| Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ] |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/http/{pkId} |
| Method | GET |
| Description | GET API retrieves HTTP/HTTPS Application Profile. It uses the pkId path parameter to fetch the specific profile details. |
| Request | Parameter { pkId : “” } |
| Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
| API Name | /pcm/application/http/{pkId} |
| Method | DELETE |
| Description | DELETE API deletes an HTTP/HTTPS Application Profile. It removes the profile identified by the pkId path parameter. |
| Request | Parameter { pkId : “” } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/http/getAllByApplicationId/{applicationId}/{protocol} |
| Method | GET |
| Description | GET API retrieves all HTTP/HTTPS Application Profiles. It filters profiles by the given applicationId and protocol. |
| Request | Parameters applicationId , protocol |
| Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ] |
| API Name | /pcm/application/google-drive |
| Method | PUT |
| Description | API updates a Google Drive Application Profile. It modifies the existing profile configuration. |
| Request | { “file”: “string”, “googleDriveModel”: { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/google-drive |
| Method | POST |
| Description | API creates a new Google Drive Application Profile. It adds a new profile configuration for Google Drive. |
| Request | { “file”: “string”, “googleDriveModel”: { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } } |
| Response | { “statusCode”: 0, |
“statusMessage”: “string”
}
| API Name | /pcm/application/google-drive/pemApplicationUpdate |
| Method | PUT |
| Description | API updates a Google Drive PEM Application Profile. It modifies the PEM-specific application profile settings for Google Drive. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/google-drive/saveMultipleProfiles |
| Method | POST |
| Description | API creates multiple Google Drive Application Profiles. It allows adding several profiles in a single request. |
| Request | { “file”: “string”, “googleDriveModels”: [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } ] } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/google-drive/pemApplicationCreate |
| Method | POST |
| Description | API creates a new Google Drive PEM Application Profile. It adds a PEM-specific application profile for Google Drive. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/google-drive/{pkId} |
| Method | GET |
| Description | API retrieves a Google Drive Application Profile. It uses the pkId path parameter to fetch the specific profile details. |
| Request | Parameter pkId |
| Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } |
| API Name | /pcm/application/google-drive/{pkId} |
| Method | DELETE |
| Description | DELETE API deletes a Google Drive Application Profile. It removes the profile identified by the pkId path parameter. |
| Request | Parameter pkId |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/application/google-drive/getAllByApplicationId/{applicationId}/{protocol} |
| Method | GET |
| Description | API retrieves all Google Drive Application Profiles. It filters profiles by the specified applicationId and protocol. |
| Request | Parameters applicationId , protocol |
| Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “poolingInterval”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “clientId”: “string”, “projectId”: “string”, “clientEmail”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “deleteAfterCollection”: true, “fileInput”: “string”, “like”: true } ] |
| API Name | /pcm/partner/http |
| Method | PUT |
| Description | API updates an HTTP/HTTPS Partner Profile. It modifies the existing partner profile configuration. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/http |
| Method | POST |
| Description | API creates a new HTTP/HTTPS Partner Profile. It adds a new partner profile configuration. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/http/saveAll |
| Method | POST |
| Description | API creates multiple HTTP/HTTPS Partner Profiles. It allows adding several partner profiles in a single request. |
| Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ] |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/http/{pkId} |
| Method | GET |
| Description | Retrieves an HTTP/HTTPS Partner Profile. It fetches the profile details using the pkId path parameter. |
| Request | Parameter pkId |
| Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
| API Name | /pcm/partner/http/{pkId} |
| Method | DELETE |
| Description | Deletes an HTTP/HTTPS Partner Profile. It removes the profile identified by the pkId path parameter. |
| Request | Parameter: pkId |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/http/getAllByProfileId/{profileId}/{protocol} |
| Method | GET |
| Description | Retrieves all HTTP/HTTPS Partner Profiles. It filters profiles by the given profileId and protocol. |
| Request | Parameters profileId , protocol |
| Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outBoundUrl”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “certificate”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ] |
Application Profile with IBM Sterling B2B Integrator FTP/FTPS/SFTP
| API Name | /pcm/si/application/remote-ftp |
| Method | PUT |
| Description | Updates an IBM Sterling B2B Integrator FTP/FTPS/SFTP Application Profile. It modifies the configuration of the specified remote FTP application profile |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/si/application/remote-ftp |
| Method | POST |
| Description | Creates a new IBM Sterling B2B Integrator FTP/FTPS/SFTP Application Profile. It adds a new remote FTP application profile configuration. |
| Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/si/application/remote-ftp |
| Method | DELETE |
| Description | Deletes an IBM Sterling B2B Integrator FTP/FTPS/SFTP Application Profile. It removes the specified remote FTP application profile. |
| Request | Parameters pkId , deletUser , deleteMailboxes |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/si/application/remote-ftp/saveMultipleProfiles |
| Method | POST |
| Description | Creates multiple IBM Sterling B2B Integrator FTP/FTPS/SFTP Application Profiles. It allows adding several profiles in a single request |
| Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } ] |
| Response | { “statusCode”: 0, |
“statusMessage”: “string”
}
| API Name | /pcm/si/application/remote-ftp/{pkId} |
| Method | GET |
| Description | Retrieves an IBM Sterling B2B Integrator FTP/FTPS/SFTP Application Profile. It fetches the profile details using the pkId path parameter. |
| Request | Parameter pkId |
| Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
| API Name | /pcm/si/application/remote-ftp/getAllByApplicationId/{applicationId}/{protocol} |
| Method | GET |
| Description | Retrieves all IBM Sterling B2B Integrator FTP/FTPS/SFTP Application Profiles. It filters profiles by the specified applicationId and protocol. |
| Request | Parameters application , protocol |
| Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } ] |
Manage Partner
| API Name | /pcm/partner/status |
| Method | POST |
| Description | Updates the status of a profile. It modifies the current status of the specified partner profile. |
| Request | Paramter pkId , status |
| Response | { “statusCode”: 0, “statusMessage”: “string” } |
| API Name | /pcm/partner/search |
| Method | POST |
| Description | Retrieves partner profiles based on search criteria. It returns a list of matching partner profiles. |
| Request | Parameters pageable request paylaod { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
| Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “createdBy”: “string”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-22T10:26:48.523Z”, “tpName”: “string”, “customTpName”: “string”, “pgpInfo”: “string”, “ipWhitelist”: “string”, “tpId”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “email”: “string”, “phone”: “string”, “tpProtocol”: “string”, “tpPickupFiles”: “string”, “fileTpServer”: “string”, “partnerProtocolRef”: “string”, “status”: “string”, “isProtocolHubInfo”: “string”, “isOnlyPcm”: “string”, “pemIdentifier”: “string”, “getpartnerPriority”: “string”, “pkId”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
| API Name | /pcm/partner/partners-by-protocol |
| Method | POST |
| Description | Retrieves partner profiles filtered by protocol. It returns partner profiles matching the specified protocol criteria. |
| Request | Parameters protocol , isHubInfo |
| Response | [ { “key”: “string”, “value”: “string” } ] |
| API Name | /pcm/partner/partnerIdCheck |
| Method | POST |
| Description | Checks the validity or existence of a Partner ID. It verifies if a given partner ID is available or already in use. |
| Request | Parameter profileId |
| Response | True or False |
| API Name | /pcm/partner/partnerIdCheck |
| Method | POST |
| Description | API retrieves partner profiles filtered by protocol. |
| Request | Parameter protocol |
| Response | [ { “key”: “string”, “value”: “string” } |
| API Name | /pcm/partner/connectivity |
| Method | POST |
| Description | Retrieves the connectivity response for a partner. It checks the connection status or health of the specified partner. |
| Request | profileName |
| Response | { “status”: “string”, “bpId”: “string”, “statusCode”: “string” } |
| API Name | /pcm/partner/advanced-search |
| Method | POST |
| Description | Retrieves partner profiles using advanced search criteria. It returns filtered partner profiles based on detailed parameters. |
| Request | Paramter pageable { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “connectionType”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “adapterName”: “string”, “poolingInterval”: “string”, “encryptionStrength”: “string”, “fileType”: “string”, “preferredAuthenticationType”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “protocolType”: “string”, “as2Identifier”: “string”, “as2ProfileName”: “string”, “senderId”: “string”, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “bucketName”: “string”, “accessKey”: “string”, “endPointUrl”: “string”, “localNodeName”: “string”, “nodeName”: “string”, “getsNodeId”: “string”, “operatingSystem”: “string”, “securityProtocol”: “string”, “isSSP”: “string”, “ecProtocol”: “string”, “ecProtocolReference”: “string”, “certificate”: “string”, “filter”: “string”, “channelName”: “string”, “queueManager”: “string”, “queueName”: “string”, “sapRoute”: “string”, “name”: “string”, “customProtocolName”: “string”, “customProtocolExtensions”: “string”, “ssp”: true, “outBoundUrl”: “string”, “like”: true } |
| Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “createdBy”: “string”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-22T10:49:21.535Z”, “tpName”: “string”, “customTpName”: “string”, “pgpInfo”: “string”, “ipWhitelist”: “string”, “tpId”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “email”: “string”, “phone”: “string”, “tpProtocol”: “string”, “tpPickupFiles”: “string”, “fileTpServer”: “string”, “partnerProtocolRef”: “string”, “status”: “string”, “isProtocolHubInfo”: “string”, “isOnlyPcm”: “string”, “pemIdentifier”: “string”, “getpartnerPriority”: “string”, “pkId”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
| API Name | /pcm/partner/activity/{pkId} |
| Method | POST |
| Description | Retrieves the activity history of a partner. It uses the pkId path parameter to fetch the specific partner’s activity records. |
| Request | Parameters pkId , pageable |
| Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “tpRefId”: “string”, “userName”: “string”, “userId”: “string”, “activity”: “string”, “activityDt”: “2025-09-22T10:57:04.074Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
| API Name | /pcm/partner/partnersListByPartnerId |
| Method | GET |
| Description | API retrieves a list of partners associated with a given PartnerId. |
| Request | parameter partnerId |
| Response | { “profileId”: “string”, “partnersCount”: 0, “partnerNames”: [ “string” ] } |
| API Name | /pcm/partner/partners-pgp-map |
| Method | GET |
| Description | Retrieves the PGP information map for partners. It provides details about partners’ PGP configurations. |
| Request | No parameters |
| Response | [ { “key”: “string”, “value”: “string” } ] |
| API Name | /pcm/partner/partners-map |
| Method | GET |
| Description | Retrieves the partners map. It provides a mapped overview of partners and their relationships or details. |
| Request | No parameters |
| Response | [ { “key”: “string”, “value”: “string” } ] |
| API Name | /pcm/partner/partners-List |
| Method | GET |
| Description | API retrieves a list of partners. It returns all available partner profiles. |
| Request | No parameters |
| Response | [ { “name”: “string” } ] |
| API Name | /PCM/partner/partner-profile/partners-List |
| Method | GET |
| Description | Retrieves AS2 Partner Profiles. It returns a list of partners using the AS2 protocol. |
| Request | No parameters |
| Response | [ { “name”: “string” } ] |
| API Name | /PCM/partner/org-profile/partners-List |
| Method | GET |
| Description | Retrieves AS2 Organization Profiles. It returns a list of organizations using the AS2 protocol. |
| Request | No parameters |
| Response | [ { “name”: “string” } ] |
| API Name | /pcm/partner/hasMultiplePartnersForUserId/{userId} |
| Method | GET |
| Description | API checks if a user has multiple partners. It uses the userId path parameter to verify partner count for that user. |
| Request | Parameters userId |
| Response | True , False |
| API Name | /pcm/partner/get-virtualroot |
| Method | GET |
| Descriptiown | Retrieves the virtual root directory associated with a username. |
| Request | Parameters username , protocol |
| Response | String |
API Name | /pcm/transaction-names |
Method | GET |
Description | Retrieves a list of transaction names. It provides available transaction name options. |
Request | No Prameters |
Response | String |
API Name | /pcm/transaction-names |
Method | GET |
Description | Retrieves transaction names. It returns a list of available transaction names. |
Request | [ “string” ] |
Response | { “errorCode”: 0, “errorDescription”: “string” } |
API Name | /pcm/partner/remote-ftp |
Method | PUT |
Description | Updates an SFGFTP/SFGFTPS/SFGSFTP Partner Profile. It modifies the existing partner profile for remote FTP protocols. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
Response | { “errorCode”: 0, “errorDescription”: “string” } |
API Name | /pcm/partner/remote-ftp |
Method | POST |
Description | Creates a new SFGFTP/SFGFTPS/SFGSFTP Partner Profile. It adds a partner profile for remote FTP protocols. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
Response | { “errorCode”: 0, “errorDescription”: “string” } |
API Name | /pcm/partner/remote-ftp |
Method | DELETE |
Description | API deletes an SFGFTP/SFGFTPS/SFGSFTP Partner Profile. It removes the specified partner profile for remote FTP protocols. |
Request | Parameters |
Response | { “errorCode”: 0, “errorDescription”: “string” } |
API Name | /pcm/partner/remoteftp/{pkId} |
Method | GET |
Description | Retrieves an SFGFTP/SFGFTPS/SFGSFTP Partner Profile. It fetches the profile details using the pkId path parameter. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
API Name | /pcm/partner/remoteftp/custom-delete |
Method | DELETE |
Description | API performs a custom deletion of an SFGFTP/SFGFTPS/SFGSFTP Partner Profile. It removes the specified partner profile using a custom delete process. |
Request | Parameters |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/b2b/si/update-contract |
Method | PUT |
Description | API performs a custom deletion of an SFGFTP/SFGFTPS/SFGSFTP Partner Profile. It removes the specified partner profile using a custom delete process. |
Request | { “bpName”: “string”, “contactName”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/b2b/si/reset-users |
Method | POST |
Description | API resets user accounts based on their names. It reinitializes or clears user account settings. |
Request | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T12:41:55.558Z”, “protocol”: “string”, “notAfter”: “2025-09-22T12:41:55.558Z”, “notBefore”: “2025-09-22T12:41:55.558Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T12:41:55.558Z” } ] } |
Response | { “content”: [ { “passwordUpdatedUsers”: [ { “name”: “string” } ], “usersNotFound”: [ { “name”: “string” } ] } ] } |
API Name | /pem/b2b/si/reset-users-updated |
Method | POST |
Description | API resets user accounts based on the partner name. It reinitializes accounts linked to the specified partner. |
Request | { “content”: [ { “profileName”: [ “string” ], “startDate”: “string”, “endDate”: “string” } ] } |
Response | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T12:44:19.389Z”, “protocol”: “string”, “notAfter”: “2025-09-22T12:44:19.389Z”, “notBefore”: “2025-09-22T12:44:19.389Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T12:44:19.389Z” } ] } |
API Name | /pem/b2b/si/reset-users-by-b2bi
|
Method | POST |
Description | Resets user accounts by name using B2BI. It reinitializes accounts through the B2B Integrator system. |
Request | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T12:47:12.527Z”, “protocol”: “string”, “notAfter”: “2025-09-22T12:47:12.527Z”, “notBefore”: “2025-09-22T12:47:12.527Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T12:47:12.527Z” } ] } |
Response | { “content”: [ { “passwordUpdatedUsers”: [ { “name”: “string” } ], “usersNotFound”: [ { “name”: “string” } ] } ] } |
API Name | /pem/b2b/si/reset-user |
Method | POST |
Description | Resets user accounts via the B2Bi API. It reinitializes individual user account settings. |
Request | { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T13:00:03.733Z”, “protocol”: “string”, “notAfter”: “2025-09-22T13:00:03.733Z”, “notBefore”: “2025-09-22T13:00:03.733Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T13:00:03.733Z” } |
Response | { “errorCode”: 0, “errorDescription”: “string” } |
API Name | /pem/b2b/si/pem/b2b/si/get-sfg-sftp-profiles/by-name |
Method | GET |
Description | Searches for remote SFTP profiles by name. It retrieves matching SFG SFTP profile details. |
Request | Parameters |
Response | { “content”: [ { “profileName”: “string”, “profileCode”: “string”, “userAccount”: “string” } ] } |
API Name | /pem/b2b/si/pem/b2b/si/get-sfg-sftp-profiles/by-name |
Method | POST |
Description | Searches for remote SFTP profiles by name. It retrieves matching SFG SFTP profiles based on the search criteria. |
Request | { “content”: [ { “profileName”: “string”, “like”: true } ] } |
Response | { “content”: [ { “profileName”: “string”, “profileCode”: “string”, “userAccount”: “string” } ] } |
API Name | /pem/b2b/si/get-cd-node |
Method | POST |
Description | API searches for Connect Direct nodes. It retrieves matching nodes based on the search criteria |
Request | { “nodeName”: “string”, “netMapName”: “string” } |
Response | { “content”: [ { “serverNodeName”: “string”, “serverHost”: “string” } ] } |
API Name | /pem/b2b/si/add-identity-to-group |
Method | POST |
Description | This API adds a specified identity to one or more groups, identified by their pkId and groupName. |
Request | { “groups”: [ { “pkId”: “string”, “groupName”: “string”, “partnerList”: [ “string” ] } ], “identity”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/b2b/si/get-user-accounts |
Method | GET |
Description | s API retrieves IBM Sterling B2B Integrator user accounts based on the given userName, with optional partial matching using the isLike parameter. |
Request | Parameters |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pem/b2b/si/get-trusted-cert-id/by-name |
Method | GET |
Description | This API searches for trusted certificates in IBM Sterling B2B Integrator by the provided certName. |
Request | Parameters |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pem/b2b/si/get-system-cert-id/by-name |
Method | GET |
Description | This API retrieves system certificates by the given certName. |
Request | Parameters |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pem/b2b/si/get-ssh-user-key/by-name |
Method | GET |
Description | This API searches for SSH user keys by the specified certName. |
Request | parameters |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pem/b2b/si/get-ssh-khost-key/by-name |
Method | GET |
Description | This API retrieves SSH KnownHost keys by the provided certName. |
Request | parameters |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pem/b2b/si/get-sfg-profiles/by-name |
Method | GET |
Description | This API searches for Remote FTP/FTPS/SFTP profiles by the given profileName. |
Request | Parameters |
Response | { “content”: [ { “profileName”: “string”, “profileCode”: “string”, “userAccount”: “string” } ] } |
API Name | /pem/b2b/si/get-rct-by-facts/by-name |
Method | GET |
Description | This API searches for RCT entries using the provided factValue. |
Request | Parameter |
Response | { “name”: “string” } |
API Name | /pem/b2b/si/get-partner-profiles-expired-users-list |
Method | GET |
Description | This API retrieves a list of partner profile users whose accounts have expired. |
Request | Parameter |
Response | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T13:36:59.683Z”, “protocol”: “string”, “notAfter”: “2025-09-22T13:36:59.683Z”, “notBefore”: “2025-09-22T13:36:59.683Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T13:36:59.683Z” } ] } |
API Name | /pem/b2b/si/get-expiry-pri-cert-list-xml |
Method | GET |
Description | This API fetches a list of expired primary certificates in XML format. |
Request | Parameter |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityMangerModelPemAccountExpiryModel> <content> <userName>string</userName> <certName>string</certName> <profileName>string</profileName> <profileId>string</profileId> <emailId>string</emailId> <pemIdentifier>string</pemIdentifier> <certType>string</certType> <pass>string</pass> <pwdLastUpdatedDate>2025-09-22T13:38:47.083Z</pwdLastUpdatedDate> <protocol>string</protocol> <notAfter>2025-09-22T13:38:47.083Z</notAfter> <notBefore>2025-09-22T13:38:47.083Z</notBefore> <expiresOn>string</expiresOn> <keyName>string</keyName> <createDate>2025-09-22T13:38:47.083Z</createDate> </content> </CommunityMangerModelPemAccountExpiryModel> |
API Name | /pem/b2b/si/get-expiry-cert-list |
Method | GET |
Description | This API retrieves a list of expired certificates. |
Request | Parameter |
Response | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T13:40:04.405Z”, “protocol”: “string”, “notAfter”: “2025-09-22T13:40:04.405Z”, “notBefore”: “2025-09-22T13:40:04.405Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T13:40:04.405Z” } ] } |
API Name | /pem/b2b/si/get-expiry-cert-list-xml |
Method | GET |
Description | This API fetches a list of expired certificates in XML format. |
Request | Parameter |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityMangerModelPemAccountExpiryModel> <content> <userName>string</userName> <certName>string</certName> <profileName>string</profileName> <profileId>string</profileId> <emailId>string</emailId> <pemIdentifier>string</pemIdentifier> <certType>string</certType> <pass>string</pass> <pwdLastUpdatedDate>2025-09-22T13:41:43.476Z</pwdLastUpdatedDate> <protocol>string</protocol> <notAfter>2025-09-22T13:41:43.476Z</notAfter> <notBefore>2025-09-22T13:41:43.476Z</notBefore> <expiresOn>string</expiresOn> <keyName>string</keyName> <createDate>2025-09-22T13:41:43.476Z</createDate> </content> </CommunityMangerModelPemAccountExpiryModel> |
API Name | /pem/b2b/si/get-ca-cert-id/by-name |
Method | GET |
Description | This API searches for CA certificates by the given CertName. |
Request | CertName , isLike |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pcm/application/remoteftp |
Method | PUT |
Description | This API updates an existing SFGFTP, SFGSFTP, or SFGFTPS application profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/remoteftp |
Method | POST |
Description | This API creates a new SFGFTP, SFGSFTP, or SFGFTPS application profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/remoteftp |
Method | DELETE |
Description | This API deletes an existing SFGFTP, SFGSFTP, or SFGFTPS application profile. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/remoteftp/{pkId} |
Method | GET |
Description | This API fetches the details of an SFGFTP, SFGSFTP, or SFGFTPS application profile by its unique pkId |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
API Name | /pem/mode/update-send Rule |
Method | PUT |
Description | This API updates an existing Send Rule via a proxy to the Lightwell Send Rule API. |
Request | Parameter request payload { “actualLightWellUrl”: “string”, “oauth2AuthModelForMode”: { “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “modeDocumentSearchModel”: { “actionFlag”: [ “string” ], “altReference”: [ “string” ], “archive”: true, “authenticated”: true, “authorities”: “string”, “clientId”: “string”, “credentials”: “string”, “currencyCode”: [ “string” ], “destination”: [ “string” ], “details”: “string”, “direction”: [ “string” ], “docCreationEndDate”: “string”, “docCreationStartDate”: “string”, “docEndDate”: “string”, “docFormat”: [ “string” ], “docStartDate”: “string”, “docStatus”: [ “string” ], “docType”: [ “string” ], “documentCount”: [ “string” ], “documentStatusReason”: [ “string” ], “docValue”: [ “string” ], “endDate”: “string”, “extensions”: “string”, “finalSize”: [ “string” ], “groupNumber”: [ “string” ], “identityFields”: “string”, “interchangeNumber”: [ “string” ], “inWfid”: [ “string” ], “maxId”: 0, “minId”: 0, “msgEndDate”: “string”, “msgInFilename”: [ “string” ], “msgOutFilename”: [ “string” ], “msgProtocol”: [ “string” ], “msgProtocolInfo”: [ “string” ], “msgStartDate”: “string”, “msgStatus”: [ “string” ], “msgStatusReason”: [ “string” ], “originalSize”: [ “string” ], “outWfid”: [ “string” ], “page”: 0, “pageSize”: 0, “parentWfid”: [ “string” ], “partner”: [ “string” ], “principal”: “string”, “reference”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ], “standard”: [ “string” ], “startDate”: “string”, “testFlag”: [ “string” ], “transactionNumber”: [ “string” ], “transactionStatus”: [ “string” ], “transactionStatusReason”: [ “string” ], “version”: [ “string” ], “wfid”: [ “string” ], “withDocExtensions”: true, “withEvents”: true, “withNotes”: true, “withReferences”: true }, “identitySearchModel”: { “authenticated”: true, “authorities”: “string”, “credentials”: “string”, “details”: “string”, “identOnly”: true, “principal”: “string” }, “identityModel”: { “activeFlag”: “string”, “b2bIdentifier”: “string”, “clientId”: 0, “id”: 0, “identityExtensions”: [ { “clientId”: 0, “id”: 0, “identityField”: { “clientId”: 0, “description”: “string”, “displayOrder”: 0, “id”: 0, “key”: “string”, “required”: true }, “key”: “string”, “value”: “string” } ], “notes”: “string”, “orgName”: “string”, “parentIdentifier”: “string” }, “sendRuleSearchModel”: { “active”: “string”, “clientId”: “string”, “coreBpParmValue”: [ “string” ], “destination”: [ “string” ], “docType”: [ “string” ], “ediBatch”: [ “string” ], “ediDeferFlag”: “string”, “ediStandard”: [ “string” ], “ediStreamFlag”: “string”, “id”: [ “string” ], “initialMessageStatus”: [ “string” ], “maxId”: 0, “minId”: 0, “page”: 0, “pageSize”: 0, “preBpParmValue”: [ “string” ], “preSendBp”: [ “string” ], “sendBp”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ] }, “addRuleModel”: { “activeFlag”: “string”, “clientId”: 0, “coreParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “destinationId”: “string”, “documentType”: “string”, “ediBatch”: “string”, “ediDeferFlag”: “string”, “ediStandard”: “string”, “ediStreamFlag”: “string”, “id”: 0, “initialMessageStatus”: “string”, “preParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “preSendBp”: “string”, “ruleVersion”: 0, “sendBp”: “string”, “sourceId”: “string”, “timestamp”: “string”, “tradacomsOverrides”: { “alias”: “string”, “id”: 0, “intStxAprf”: “string”, “intStxFrom1”: “string”, “intStxFrom2”: “string”, “intStxPrcd”: “string”, “intStxRcrf”: “string”, “intStxStds1”: “string”, “intStxStds2”: “string”, “intStxUnto1”: “string”, “intStxUnto2”: “string”, “msgAcdInlo1”: “string”, “msgAcdInlo2”: “string”, “msgBdtBkic”: “string”, “msgBdtBkin”: “string”, “msgBdtBnam”: “string”, “msgBdtCd31”: “string”, “msgBdtSvid1”: “string”, “msgBdtSvid2”: “string”, “msgCdtCadd1”: “string”, “msgCdtCadd2”: “string”, “msgCdtCadd3”: “string”, “msgCdtCadd4”: “string”, “msgCdtCadd5”: “string”, “msgCdtCidn1”: “string”, “msgCdtCidn2”: “string”, “msgCdtCnam”: “string”, “msgCdtVatr1”: “string”, “msgCdtVatr2”: “string”, “msgMhdType”: “string”, “msgSdtSadd1”: “string”, “msgSdtSadd2”: “string”, “msgSdtSadd3”: “string”, “msgSdtSadd4”: “string”, “msgSdtSadd5”: “string”, “msgSdtSidn1”: “string”, “msgSdtSidn2”: “string”, “msgSdtSnam”: “string”, “msgSdtVatn1”: “string”, “msgSdtVatn2”: “string”, “msgTypTcde”: “string”, “msgTypTtyp”: “string” }, “username”: “string”, “x12Overrides”: { “alias”: “string”, “docEncoding”: “string”, “elementSeparator”: “string”, “grpAckOverdueTime”: “string”, “grpAckOverdueTimeMinutes”: “string”, “grpExpectAck”: “string”, “grpFunctionalIdCode”: “string”, “grpReceiverId”: “string”, “grpResponsibleAgencyCode”: “string”, “grpSenderId”: “string”, “grpVersionReleaseIdCode”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequested”: “string”, “intAuthInfoQual”: “string”, “intAuthInformation”: “string”, “intControlStandardsId”: “string”, “intControlVerNum”: “string”, “intReceiverId”: “string”, “intReceiverIdQual”: “string”, “intSecurityInfoQual”: “string”, “intSecurityInformation”: “string”, “intSenderId”: “string”, “intSenderIdQual”: “string”, “intTestIndicator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “transactionSetIdCode”: “string” }, “edifactOverridesModel”: { “alias”: “string”, “decimalSeparator”: “string”, “elementSeparator”: “string”, “grpApplicationPswd”: “string”, “grpApplicationRecipientId”: “string”, “grpApplicationSenderId”: “string”, “grpControlAgency”: “string”, “grpRecipientIdCodeQual”: “string”, “grpSenderIdCodeQual”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequest”: “string”, “intAgreementId”: “string”, “intApplicationReference”: “string”, “intCharacterEncoding”: “string”, “intControlReference”: “string”, “intProcessingPriorityCode”: “string”, “intRecipientId”: “string”, “intRecipientIdCodeQual”: “string”, “intRecipientInternalId”: “string”, “intRecipientInternalSubId”: “string”, “intRecipientRefPswd”: “string”, “intRecipientRefPswdQual”: “string”, “intSenderId”: “string”, “intSenderIdCodeQual”: “string”, “intSenderInternalId”: “string”, “intSenderInternalSubId”: “string”, “intSrvCodeListDirVerNum”: “string”, “intSyntaxId”: “string”, “intSyntaxVerNum”: “string”, “intTestIndicator”: “string”, “msgAssociationAssignedCode”: “string”, “msgCodeListDirVerNum”: “string”, “msgCommonAccessReference”: “string”, “msgControlAgency”: “string”, “msgFirstAndLastTransfer”: “string”, “msgImplControlAgency”: “string”, “msgImplGuidelineId”: “string”, “msgImplGuidelineRelNum”: “string”, “msgImplGuidelineVerNum”: “string”, “msgRelNum”: “string”, “msgScenarioControlAgency”: “string”, “msgScenarioId”: “string”, “msgScenarioRelNum”: “string”, “msgScenarioVerNum”: “string”, “msgSequenceOfTransfers”: “string”, “msgSubsetControlAgency”: “string”, “msgSubsetId”: “string”, “msgSubsetRelNum”: “string”, “msgSubsetVerNum”: “string”, “msgType”: “string”, “msgTypeSubFunctionId”: “string”, “msgVerNum”: “string”, “releaseCharacter”: “string”, “repeatingElementSeparator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “una”: “string”, “useGroups”: “string” } } } |
Response | String |
API Name | /pem/mode/update-identity |
Method | PUT |
Description | This API updates an existing identity via a proxy to the Lightwell Identity API. |
Request | Parameter “actualLightWellUrl”: “string”, “oauth2AuthModelForMode”: { “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “modeDocumentSearchModel”: { “actionFlag”: [ “string” ], “altReference”: [ “string” ], “archive”: true, “authenticated”: true, “authorities”: “string”, “clientId”: “string”, “credentials”: “string”, “currencyCode”: [ “string” ], “destination”: [ “string” ], “details”: “string”, “direction”: [ “string” ], “docCreationEndDate”: “string”, “docCreationStartDate”: “string”, “docEndDate”: “string”, “docFormat”: [ “string” ], “docStartDate”: “string”, “docStatus”: [ “string” ], “docType”: [ “string” ], “documentCount”: [ “string” ], “documentStatusReason”: [ “string” ], “docValue”: [ “string” ], “endDate”: “string”, “extensions”: “string”, “finalSize”: [ “string” ], “groupNumber”: [ “string” ], “identityFields”: “string”, “interchangeNumber”: [ “string” ], “inWfid”: [ “string” ], “maxId”: 0, “minId”: 0, “msgEndDate”: “string”, “msgInFilename”: [ “string” ], “msgOutFilename”: [ “string” ], “msgProtocol”: [ “string” ], “msgProtocolInfo”: [ “string” ], “msgStartDate”: “string”, “msgStatus”: [ “string” ], “msgStatusReason”: [ “string” ], “originalSize”: [ “string” ], “outWfid”: [ “string” ], “page”: 0, “pageSize”: 0, “parentWfid”: [ “string” ], “partner”: [ “string” ], “principal”: “string”, “reference”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ], “standard”: [ “string” ], “startDate”: “string”, “testFlag”: [ “string” ], “transactionNumber”: [ “string” ], “transactionStatus”: [ “string” ], “transactionStatusReason”: [ “string” ], “version”: [ “string” ], “wfid”: [ “string” ], “withDocExtensions”: true, “withEvents”: true, “withNotes”: true, “withReferences”: true }, “identitySearchModel”: { “authenticated”: true, “authorities”: “string”, “credentials”: “string”, “details”: “string”, “identOnly”: true, “principal”: “string” }, “identityModel”: { “activeFlag”: “string”, “b2bIdentifier”: “string”, “clientId”: 0, “id”: 0, “identityExtensions”: [ { “clientId”: 0, “id”: 0, “identityField”: { “clientId”: 0, “description”: “string”, “displayOrder”: 0, “id”: 0, “key”: “string”, “required”: true }, “key”: “string”, “value”: “string” } ], “notes”: “string”, “orgName”: “string”, “parentIdentifier”: “string” }, “sendRuleSearchModel”: { “active”: “string”, “clientId”: “string”, “coreBpParmValue”: [ “string” ], “destination”: [ “string” ], “docType”: [ “string” ], “ediBatch”: [ “string” ], “ediDeferFlag”: “string”, “ediStandard”: [ “string” ], “ediStreamFlag”: “string”, “id”: [ “string” ], “initialMessageStatus”: [ “string” ], “maxId”: 0, “minId”: 0, “page”: 0, “pageSize”: 0, “preBpParmValue”: [ “string” ], “preSendBp”: [ “string” ], “sendBp”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ] }, “addRuleModel”: { “activeFlag”: “string”, “clientId”: 0, “coreParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “destinationId”: “string”, “documentType”: “string”, “ediBatch”: “string”, “ediDeferFlag”: “string”, “ediStandard”: “string”, “ediStreamFlag”: “string”, “id”: 0, “initialMessageStatus”: “string”, “preParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “preSendBp”: “string”, “ruleVersion”: 0, “sendBp”: “string”, “sourceId”: “string”, “timestamp”: “string”, “tradacomsOverrides”: { “alias”: “string”, “id”: 0, “intStxAprf”: “string”, “intStxFrom1”: “string”, “intStxFrom2”: “string”, “intStxPrcd”: “string”, “intStxRcrf”: “string”, “intStxStds1”: “string”, “intStxStds2”: “string”, “intStxUnto1”: “string”, “intStxUnto2”: “string”, “msgAcdInlo1”: “string”, “msgAcdInlo2”: “string”, “msgBdtBkic”: “string”, “msgBdtBkin”: “string”, “msgBdtBnam”: “string”, “msgBdtCd31”: “string”, “msgBdtSvid1”: “string”, “msgBdtSvid2”: “string”, “msgCdtCadd1”: “string”, “msgCdtCadd2”: “string”, “msgCdtCadd3”: “string”, “msgCdtCadd4”: “string”, “msgCdtCadd5”: “string”, “msgCdtCidn1”: “string”, “msgCdtCidn2”: “string”, “msgCdtCnam”: “string”, “msgCdtVatr1”: “string”, “msgCdtVatr2”: “string”, “msgMhdType”: “string”, “msgSdtSadd1”: “string”, “msgSdtSadd2”: “string”, “msgSdtSadd3”: “string”, “msgSdtSadd4”: “string”, “msgSdtSadd5”: “string”, “msgSdtSidn1”: “string”, “msgSdtSidn2”: “string”, “msgSdtSnam”: “string”, “msgSdtVatn1”: “string”, “msgSdtVatn2”: “string”, “msgTypTcde”: “string”, “msgTypTtyp”: “string” }, “username”: “string”, “x12Overrides”: { “alias”: “string”, “docEncoding”: “string”, “elementSeparator”: “string”, “grpAckOverdueTime”: “string”, “grpAckOverdueTimeMinutes”: “string”, “grpExpectAck”: “string”, “grpFunctionalIdCode”: “string”, “grpReceiverId”: “string”, “grpResponsibleAgencyCode”: “string”, “grpSenderId”: “string”, “grpVersionReleaseIdCode”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequested”: “string”, “intAuthInfoQual”: “string”, “intAuthInformation”: “string”, “intControlStandardsId”: “string”, “intControlVerNum”: “string”, “intReceiverId”: “string”, “intReceiverIdQual”: “string”, “intSecurityInfoQual”: “string”, “intSecurityInformation”: “string”, “intSenderId”: “string”, “intSenderIdQual”: “string”, “intTestIndicator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “transactionSetIdCode”: “string” }, “edifactOverridesModel”: { “alias”: “string”, “decimalSeparator”: “string”, “elementSeparator”: “string”, “grpApplicationPswd”: “string”, “grpApplicationRecipientId”: “string”, “grpApplicationSenderId”: “string”, “grpControlAgency”: “string”, “grpRecipientIdCodeQual”: “string”, “grpSenderIdCodeQual”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequest”: “string”, “intAgreementId”: “string”, “intApplicationReference”: “string”, “intCharacterEncoding”: “string”, “intControlReference”: “string”, “intProcessingPriorityCode”: “string”, “intRecipientId”: “string”, “intRecipientIdCodeQual”: “string”, “intRecipientInternalId”: “string”, “intRecipientInternalSubId”: “string”, “intRecipientRefPswd”: “string”, “intRecipientRefPswdQual”: “string”, “intSenderId”: “string”, “intSenderIdCodeQual”: “string”, “intSenderInternalId”: “string”, “intSenderInternalSubId”: “string”, “intSrvCodeListDirVerNum”: “string”, “intSyntaxId”: “string”, “intSyntaxVerNum”: “string”, “intTestIndicator”: “string”, “msgAssociationAssignedCode”: “string”, “msgCodeListDirVerNum”: “string”, “msgCommonAccessReference”: “string”, “msgControlAgency”: “string”, “msgFirstAndLastTransfer”: “string”, “msgImplControlAgency”: “string”, “msgImplGuidelineId”: “string”, “msgImplGuidelineRelNum”: “string”, “msgImplGuidelineVerNum”: “string”, “msgRelNum”: “string”, “msgScenarioControlAgency”: “string”, “msgScenarioId”: “string”, “msgScenarioRelNum”: “string”, “msgScenarioVerNum”: “string”, “msgSequenceOfTransfers”: “string”, “msgSubsetControlAgency”: “string”, “msgSubsetId”: “string”, “msgSubsetRelNum”: “string”, “msgSubsetVerNum”: “string”, “msgType”: “string”, “msgTypeSubFunctionId”: “string”, “msgVerNum”: “string”, “releaseCharacter”: “string”, “repeatingElementSeparator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “una”: “string”, “useGroups”: “string” } } } |
Response | String |
API Name | /pem/mode/search-sendRule |
Method | POST |
Description | This API searches for Send Rules via a proxy to the Lightwell Send Rule API. |
Request | { “actualLightWellUrl”: “string”, “oauth2AuthModelForMode”: { “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “modeDocumentSearchModel”: { “actionFlag”: [ “string” ], “altReference”: [ “string” ], “archive”: true, “authenticated”: true, “authorities”: “string”, “clientId”: “string”, “credentials”: “string”, “currencyCode”: [ “string” ], “destination”: [ “string” ], “details”: “string”, “direction”: [ “string” ], “docCreationEndDate”: “string”, “docCreationStartDate”: “string”, “docEndDate”: “string”, “docFormat”: [ “string” ], “docStartDate”: “string”, “docStatus”: [ “string” ], “docType”: [ “string” ], “documentCount”: [ “string” ], “documentStatusReason”: [ “string” ], “docValue”: [ “string” ], “endDate”: “string”, “extensions”: “string”, “finalSize”: [ “string” ], “groupNumber”: [ “string” ], “identityFields”: “string”, “interchangeNumber”: [ “string” ], “inWfid”: [ “string” ], “maxId”: 0, “minId”: 0, “msgEndDate”: “string”, “msgInFilename”: [ “string” ], “msgOutFilename”: [ “string” ], “msgProtocol”: [ “string” ], “msgProtocolInfo”: [ “string” ], “msgStartDate”: “string”, “msgStatus”: [ “string” ], “msgStatusReason”: [ “string” ], “originalSize”: [ “string” ], “outWfid”: [ “string” ], “page”: 0, “pageSize”: 0, “parentWfid”: [ “string” ], “partner”: [ “string” ], “principal”: “string”, “reference”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ], “standard”: [ “string” ], “startDate”: “string”, “testFlag”: [ “string” ], “transactionNumber”: [ “string” ], “transactionStatus”: [ “string” ], “transactionStatusReason”: [ “string” ], “version”: [ “string” ], “wfid”: [ “string” ], “withDocExtensions”: true, “withEvents”: true, “withNotes”: true, “withReferences”: true }, “identitySearchModel”: { “authenticated”: true, “authorities”: “string”, “credentials”: “string”, “details”: “string”, “identOnly”: true, “principal”: “string” }, “identityModel”: { “activeFlag”: “string”, “b2bIdentifier”: “string”, “clientId”: 0, “id”: 0, “identityExtensions”: [ { “clientId”: 0, “id”: 0, “identityField”: { “clientId”: 0, “description”: “string”, “displayOrder”: 0, “id”: 0, “key”: “string”, “required”: true }, “key”: “string”, “value”: “string” } ], “notes”: “string”, “orgName”: “string”, “parentIdentifier”: “string” }, “sendRuleSearchModel”: { “active”: “string”, “clientId”: “string”, “coreBpParmValue”: [ “string” ], “destination”: [ “string” ], “docType”: [ “string” ], “ediBatch”: [ “string” ], “ediDeferFlag”: “string”, “ediStandard”: [ “string” ], “ediStreamFlag”: “string”, “id”: [ “string” ], “initialMessageStatus”: [ “string” ], “maxId”: 0, “minId”: 0, “page”: 0, “pageSize”: 0, “preBpParmValue”: [ “string” ], “preSendBp”: [ “string” ], “sendBp”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ] }, “addRuleModel”: { “activeFlag”: “string”, “clientId”: 0, “coreParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “destinationId”: “string”, “documentType”: “string”, “ediBatch”: “string”, “ediDeferFlag”: “string”, “ediStandard”: “string”, “ediStreamFlag”: “string”, “id”: 0, “initialMessageStatus”: “string”, “preParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “preSendBp”: “string”, “ruleVersion”: 0, “sendBp”: “string”, “sourceId”: “string”, “timestamp”: “string”, “tradacomsOverrides”: { “alias”: “string”, “id”: 0, “intStxAprf”: “string”, “intStxFrom1”: “string”, “intStxFrom2”: “string”, “intStxPrcd”: “string”, “intStxRcrf”: “string”, “intStxStds1”: “string”, “intStxStds2”: “string”, “intStxUnto1”: “string”, “intStxUnto2”: “string”, “msgAcdInlo1”: “string”, “msgAcdInlo2”: “string”, “msgBdtBkic”: “string”, “msgBdtBkin”: “string”, “msgBdtBnam”: “string”, “msgBdtCd31”: “string”, “msgBdtSvid1”: “string”, “msgBdtSvid2”: “string”, “msgCdtCadd1”: “string”, “msgCdtCadd2”: “string”, “msgCdtCadd3”: “string”, “msgCdtCadd4”: “string”, “msgCdtCadd5”: “string”, “msgCdtCidn1”: “string”, “msgCdtCidn2”: “string”, “msgCdtCnam”: “string”, “msgCdtVatr1”: “string”, “msgCdtVatr2”: “string”, “msgMhdType”: “string”, “msgSdtSadd1”: “string”, “msgSdtSadd2”: “string”, “msgSdtSadd3”: “string”, “msgSdtSadd4”: “string”, “msgSdtSadd5”: “string”, “msgSdtSidn1”: “string”, “msgSdtSidn2”: “string”, “msgSdtSnam”: “string”, “msgSdtVatn1”: “string”, “msgSdtVatn2”: “string”, “msgTypTcde”: “string”, “msgTypTtyp”: “string” }, “username”: “string”, “x12Overrides”: { “alias”: “string”, “docEncoding”: “string”, “elementSeparator”: “string”, “grpAckOverdueTime”: “string”, “grpAckOverdueTimeMinutes”: “string”, “grpExpectAck”: “string”, “grpFunctionalIdCode”: “string”, “grpReceiverId”: “string”, “grpResponsibleAgencyCode”: “string”, “grpSenderId”: “string”, “grpVersionReleaseIdCode”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequested”: “string”, “intAuthInfoQual”: “string”, “intAuthInformation”: “string”, “intControlStandardsId”: “string”, “intControlVerNum”: “string”, “intReceiverId”: “string”, “intReceiverIdQual”: “string”, “intSecurityInfoQual”: “string”, “intSecurityInformation”: “string”, “intSenderId”: “string”, “intSenderIdQual”: “string”, “intTestIndicator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “transactionSetIdCode”: “string” }, “edifactOverridesModel”: { “alias”: “string”, “decimalSeparator”: “string”, “elementSeparator”: “string”, “grpApplicationPswd”: “string”, “grpApplicationRecipientId”: “string”, “grpApplicationSenderId”: “string”, “grpControlAgency”: “string”, “grpRecipientIdCodeQual”: “string”, “grpSenderIdCodeQual”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequest”: “string”, “intAgreementId”: “string”, “intApplicationReference”: “string”, “intCharacterEncoding”: “string”, “intControlReference”: “string”, “intProcessingPriorityCode”: “string”, “intRecipientId”: “string”, “intRecipientIdCodeQual”: “string”, “intRecipientInternalId”: “string”, “intRecipientInternalSubId”: “string”, “intRecipientRefPswd”: “string”, “intRecipientRefPswdQual”: “string”, “intSenderId”: “string”, “intSenderIdCodeQual”: “string”, “intSenderInternalId”: “string”, “intSenderInternalSubId”: “string”, “intSrvCodeListDirVerNum”: “string”, “intSyntaxId”: “string”, “intSyntaxVerNum”: “string”, “intTestIndicator”: “string”, “msgAssociationAssignedCode”: “string”, “msgCodeListDirVerNum”: “string”, “msgCommonAccessReference”: “string”, “msgControlAgency”: “string”, “msgFirstAndLastTransfer”: “string”, “msgImplControlAgency”: “string”, “msgImplGuidelineId”: “string”, “msgImplGuidelineRelNum”: “string”, “msgImplGuidelineVerNum”: “string”, “msgRelNum”: “string”, “msgScenarioControlAgency”: “string”, “msgScenarioId”: “string”, “msgScenarioRelNum”: “string”, “msgScenarioVerNum”: “string”, “msgSequenceOfTransfers”: “string”, “msgSubsetControlAgency”: “string”, “msgSubsetId”: “string”, “msgSubsetRelNum”: “string”, “msgSubsetVerNum”: “string”, “msgType”: “string”, “msgTypeSubFunctionId”: “string”, “msgVerNum”: “string”, “releaseCharacter”: “string”, “repeatingElementSeparator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “una”: “string”, “useGroups”: “string” } } } |
Response | String |
API Name | /pem/mode/search-identity |
Method | POST |
Description | This API searches for identities via a proxy to the Lightwell Identity API. |
Request | Parameter { “actualLightWellUrl”: “string”, “oauth2AuthModelForMode”: { “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “modeDocumentSearchModel”: { “actionFlag”: [ “string” ], “altReference”: [ “string” ], “archive”: true, “authenticated”: true, “authorities”: “string”, “clientId”: “string”, “credentials”: “string”, “currencyCode”: [ “string” ], “destination”: [ “string” ], “details”: “string”, “direction”: [ “string” ], “docCreationEndDate”: “string”, “docCreationStartDate”: “string”, “docEndDate”: “string”, “docFormat”: [ “string” ], “docStartDate”: “string”, “docStatus”: [ “string” ], “docType”: [ “string” ], “documentCount”: [ “string” ], “documentStatusReason”: [ “string” ], “docValue”: [ “string” ], “endDate”: “string”, “extensions”: “string”, “finalSize”: [ “string” ], “groupNumber”: [ “string” ], “identityFields”: “string”, “interchangeNumber”: [ “string” ], “inWfid”: [ “string” ], “maxId”: 0, “minId”: 0, “msgEndDate”: “string”, “msgInFilename”: [ “string” ], “msgOutFilename”: [ “string” ], “msgProtocol”: [ “string” ], “msgProtocolInfo”: [ “string” ], “msgStartDate”: “string”, “msgStatus”: [ “string” ], “msgStatusReason”: [ “string” ], “originalSize”: [ “string” ], “outWfid”: [ “string” ], “page”: 0, “pageSize”: 0, “parentWfid”: [ “string” ], “partner”: [ “string” ], “principal”: “string”, “reference”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ], “standard”: [ “string” ], “startDate”: “string”, “testFlag”: [ “string” ], “transactionNumber”: [ “string” ], “transactionStatus”: [ “string” ], “transactionStatusReason”: [ “string” ], “version”: [ “string” ], “wfid”: [ “string” ], “withDocExtensions”: true, “withEvents”: true, “withNotes”: true, “withReferences”: true }, “identitySearchModel”: { “authenticated”: true, “authorities”: “string”, “credentials”: “string”, “details”: “string”, “identOnly”: true, “principal”: “string” }, “identityModel”: { “activeFlag”: “string”, “b2bIdentifier”: “string”, “clientId”: 0, “id”: 0, “identityExtensions”: [ { “clientId”: 0, “id”: 0, “identityField”: { “clientId”: 0, “description”: “string”, “displayOrder”: 0, “id”: 0, “key”: “string”, “required”: true }, “key”: “string”, “value”: “string” } ], “notes”: “string”, “orgName”: “string”, “parentIdentifier”: “string” }, “sendRuleSearchModel”: { “active”: “string”, “clientId”: “string”, “coreBpParmValue”: [ “string” ], “destination”: [ “string” ], “docType”: [ “string” ], “ediBatch”: [ “string” ], “ediDeferFlag”: “string”, “ediStandard”: [ “string” ], “ediStreamFlag”: “string”, “id”: [ “string” ], “initialMessageStatus”: [ “string” ], “maxId”: 0, “minId”: 0, “page”: 0, “pageSize”: 0, “preBpParmValue”: [ “string” ], “preSendBp”: [ “string” ], “sendBp”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ] }, “addRuleModel”: { “activeFlag”: “string”, “clientId”: 0, “coreParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “destinationId”: “string”, “documentType”: “string”, “ediBatch”: “string”, “ediDeferFlag”: “string”, “ediStandard”: “string”, “ediStreamFlag”: “string”, “id”: 0, “initialMessageStatus”: “string”, “preParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “preSendBp”: “string”, “ruleVersion”: 0, “sendBp”: “string”, “sourceId”: “string”, “timestamp”: “string”, “tradacomsOverrides”: { “alias”: “string”, “id”: 0, “intStxAprf”: “string”, “intStxFrom1”: “string”, “intStxFrom2”: “string”, “intStxPrcd”: “string”, “intStxRcrf”: “string”, “intStxStds1”: “string”, “intStxStds2”: “string”, “intStxUnto1”: “string”, “intStxUnto2”: “string”, “msgAcdInlo1”: “string”, “msgAcdInlo2”: “string”, “msgBdtBkic”: “string”, “msgBdtBkin”: “string”, “msgBdtBnam”: “string”, “msgBdtCd31”: “string”, “msgBdtSvid1”: “string”, “msgBdtSvid2”: “string”, “msgCdtCadd1”: “string”, “msgCdtCadd2”: “string”, “msgCdtCadd3”: “string”, “msgCdtCadd4”: “string”, “msgCdtCadd5”: “string”, “msgCdtCidn1”: “string”, “msgCdtCidn2”: “string”, “msgCdtCnam”: “string”, “msgCdtVatr1”: “string”, “msgCdtVatr2”: “string”, “msgMhdType”: “string”, “msgSdtSadd1”: “string”, “msgSdtSadd2”: “string”, “msgSdtSadd3”: “string”, “msgSdtSadd4”: “string”, “msgSdtSadd5”: “string”, “msgSdtSidn1”: “string”, “msgSdtSidn2”: “string”, “msgSdtSnam”: “string”, “msgSdtVatn1”: “string”, “msgSdtVatn2”: “string”, “msgTypTcde”: “string”, “msgTypTtyp”: “string” }, “username”: “string”, “x12Overrides”: { “alias”: “string”, “docEncoding”: “string”, “elementSeparator”: “string”, “grpAckOverdueTime”: “string”, “grpAckOverdueTimeMinutes”: “string”, “grpExpectAck”: “string”, “grpFunctionalIdCode”: “string”, “grpReceiverId”: “string”, “grpResponsibleAgencyCode”: “string”, “grpSenderId”: “string”, “grpVersionReleaseIdCode”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequested”: “string”, “intAuthInfoQual”: “string”, “intAuthInformation”: “string”, “intControlStandardsId”: “string”, “intControlVerNum”: “string”, “intReceiverId”: “string”, “intReceiverIdQual”: “string”, “intSecurityInfoQual”: “string”, “intSecurityInformation”: “string”, “intSenderId”: “string”, “intSenderIdQual”: “string”, “intTestIndicator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “transactionSetIdCode”: “string” }, “edifactOverridesModel”: { “alias”: “string”, “decimalSeparator”: “string”, “elementSeparator”: “string”, “grpApplicationPswd”: “string”, “grpApplicationRecipientId”: “string”, “grpApplicationSenderId”: “string”, “grpControlAgency”: “string”, “grpRecipientIdCodeQual”: “string”, “grpSenderIdCodeQual”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequest”: “string”, “intAgreementId”: “string”, “intApplicationReference”: “string”, “intCharacterEncoding”: “string”, “intControlReference”: “string”, “intProcessingPriorityCode”: “string”, “intRecipientId”: “string”, “intRecipientIdCodeQual”: “string”, “intRecipientInternalId”: “string”, “intRecipientInternalSubId”: “string”, “intRecipientRefPswd”: “string”, “intRecipientRefPswdQual”: “string”, “intSenderId”: “string”, “intSenderIdCodeQual”: “string”, “intSenderInternalId”: “string”, “intSenderInternalSubId”: “string”, “intSrvCodeListDirVerNum”: “string”, “intSyntaxId”: “string”, “intSyntaxVerNum”: “string”, “intTestIndicator”: “string”, “msgAssociationAssignedCode”: “string”, “msgCodeListDirVerNum”: “string”, “msgCommonAccessReference”: “string”, “msgControlAgency”: “string”, “msgFirstAndLastTransfer”: “string”, “msgImplControlAgency”: “string”, “msgImplGuidelineId”: “string”, “msgImplGuidelineRelNum”: “string”, “msgImplGuidelineVerNum”: “string”, “msgRelNum”: “string”, “msgScenarioControlAgency”: “string”, “msgScenarioId”: “string”, “msgScenarioRelNum”: “string”, “msgScenarioVerNum”: “string”, “msgSequenceOfTransfers”: “string”, “msgSubsetControlAgency”: “string”, “msgSubsetId”: “string”, “msgSubsetRelNum”: “string”, “msgSubsetVerNum”: “string”, “msgType”: “string”, “msgTypeSubFunctionId”: “string”, “msgVerNum”: “string”, “releaseCharacter”: “string”, “repeatingElementSeparator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “una”: “string”, “useGroups”: “string” } } } |
Response | String |
API Name | /pem/mode/document-search |
Method | POST |
Description | This API performs document searches via a proxy to the Lightwell Document Search API. |
Request | { “actualLightWellUrl”: “string”, “oauth2AuthModelForMode”: { “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “modeDocumentSearchModel”: { “actionFlag”: [ “string” ], “altReference”: [ “string” ], “archive”: true, “authenticated”: true, “authorities”: “string”, “clientId”: “string”, “credentials”: “string”, “currencyCode”: [ “string” ], “destination”: [ “string” ], “details”: “string”, “direction”: [ “string” ], “docCreationEndDate”: “string”, “docCreationStartDate”: “string”, “docEndDate”: “string”, “docFormat”: [ “string” ], “docStartDate”: “string”, “docStatus”: [ “string” ], “docType”: [ “string” ], “documentCount”: [ “string” ], “documentStatusReason”: [ “string” ], “docValue”: [ “string” ], “endDate”: “string”, “extensions”: “string”, “finalSize”: [ “string” ], “groupNumber”: [ “string” ], “identityFields”: “string”, “interchangeNumber”: [ “string” ], “inWfid”: [ “string” ], “maxId”: 0, “minId”: 0, “msgEndDate”: “string”, “msgInFilename”: [ “string” ], “msgOutFilename”: [ “string” ], “msgProtocol”: [ “string” ], “msgProtocolInfo”: [ “string” ], “msgStartDate”: “string”, “msgStatus”: [ “string” ], “msgStatusReason”: [ “string” ], “originalSize”: [ “string” ], “outWfid”: [ “string” ], “page”: 0, “pageSize”: 0, “parentWfid”: [ “string” ], “partner”: [ “string” ], “principal”: “string”, “reference”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ], “standard”: [ “string” ], “startDate”: “string”, “testFlag”: [ “string” ], “transactionNumber”: [ “string” ], “transactionStatus”: [ “string” ], “transactionStatusReason”: [ “string” ], “version”: [ “string” ], “wfid”: [ “string” ], “withDocExtensions”: true, “withEvents”: true, “withNotes”: true, “withReferences”: true }, “identitySearchModel”: { “authenticated”: true, “authorities”: “string”, “credentials”: “string”, “details”: “string”, “identOnly”: true, “principal”: “string” }, “identityModel”: { “activeFlag”: “string”, “b2bIdentifier”: “string”, “clientId”: 0, “id”: 0, “identityExtensions”: [ { “clientId”: 0, “id”: 0, “identityField”: { “clientId”: 0, “description”: “string”, “displayOrder”: 0, “id”: 0, “key”: “string”, “required”: true }, “key”: “string”, “value”: “string” } ], “notes”: “string”, “orgName”: “string”, “parentIdentifier”: “string” }, “sendRuleSearchModel”: { “active”: “string”, “clientId”: “string”, “coreBpParmValue”: [ “string” ], “destination”: [ “string” ], “docType”: [ “string” ], “ediBatch”: [ “string” ], “ediDeferFlag”: “string”, “ediStandard”: [ “string” ], “ediStreamFlag”: “string”, “id”: [ “string” ], “initialMessageStatus”: [ “string” ], “maxId”: 0, “minId”: 0, “page”: 0, “pageSize”: 0, “preBpParmValue”: [ “string” ], “preSendBp”: [ “string” ], “sendBp”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ] }, “addRuleModel”: { “activeFlag”: “string”, “clientId”: 0, “coreParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “destinationId”: “string”, “documentType”: “string”, “ediBatch”: “string”, “ediDeferFlag”: “string”, “ediStandard”: “string”, “ediStreamFlag”: “string”, “id”: 0, “initialMessageStatus”: “string”, “preParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “preSendBp”: “string”, “ruleVersion”: 0, “sendBp”: “string”, “sourceId”: “string”, “timestamp”: “string”, “tradacomsOverrides”: { “alias”: “string”, “id”: 0, “intStxAprf”: “string”, “intStxFrom1”: “string”, “intStxFrom2”: “string”, “intStxPrcd”: “string”, “intStxRcrf”: “string”, “intStxStds1”: “string”, “intStxStds2”: “string”, “intStxUnto1”: “string”, “intStxUnto2”: “string”, “msgAcdInlo1”: “string”, “msgAcdInlo2”: “string”, “msgBdtBkic”: “string”, “msgBdtBkin”: “string”, “msgBdtBnam”: “string”, “msgBdtCd31”: “string”, “msgBdtSvid1”: “string”, “msgBdtSvid2”: “string”, “msgCdtCadd1”: “string”, “msgCdtCadd2”: “string”, “msgCdtCadd3”: “string”, “msgCdtCadd4”: “string”, “msgCdtCadd5”: “string”, “msgCdtCidn1”: “string”, “msgCdtCidn2”: “string”, “msgCdtCnam”: “string”, “msgCdtVatr1”: “string”, “msgCdtVatr2”: “string”, “msgMhdType”: “string”, “msgSdtSadd1”: “string”, “msgSdtSadd2”: “string”, “msgSdtSadd3”: “string”, “msgSdtSadd4”: “string”, “msgSdtSadd5”: “string”, “msgSdtSidn1”: “string”, “msgSdtSidn2”: “string”, “msgSdtSnam”: “string”, “msgSdtVatn1”: “string”, “msgSdtVatn2”: “string”, “msgTypTcde”: “string”, “msgTypTtyp”: “string” }, “username”: “string”, “x12Overrides”: { “alias”: “string”, “docEncoding”: “string”, “elementSeparator”: “string”, “grpAckOverdueTime”: “string”, “grpAckOverdueTimeMinutes”: “string”, “grpExpectAck”: “string”, “grpFunctionalIdCode”: “string”, “grpReceiverId”: “string”, “grpResponsibleAgencyCode”: “string”, “grpSenderId”: “string”, “grpVersionReleaseIdCode”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequested”: “string”, “intAuthInfoQual”: “string”, “intAuthInformation”: “string”, “intControlStandardsId”: “string”, “intControlVerNum”: “string”, “intReceiverId”: “string”, “intReceiverIdQual”: “string”, “intSecurityInfoQual”: “string”, “intSecurityInformation”: “string”, “intSenderId”: “string”, “intSenderIdQual”: “string”, “intTestIndicator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “transactionSetIdCode”: “string” }, “edifactOverridesModel”: { “alias”: “string”, “decimalSeparator”: “string”, “elementSeparator”: “string”, “grpApplicationPswd”: “string”, “grpApplicationRecipientId”: “string”, “grpApplicationSenderId”: “string”, “grpControlAgency”: “string”, “grpRecipientIdCodeQual”: “string”, “grpSenderIdCodeQual”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequest”: “string”, “intAgreementId”: “string”, “intApplicationReference”: “string”, “intCharacterEncoding”: “string”, “intControlReference”: “string”, “intProcessingPriorityCode”: “string”, “intRecipientId”: “string”, “intRecipientIdCodeQual”: “string”, “intRecipientInternalId”: “string”, “intRecipientInternalSubId”: “string”, “intRecipientRefPswd”: “string”, “intRecipientRefPswdQual”: “string”, “intSenderId”: “string”, “intSenderIdCodeQual”: “string”, “intSenderInternalId”: “string”, “intSenderInternalSubId”: “string”, “intSrvCodeListDirVerNum”: “string”, “intSyntaxId”: “string”, “intSyntaxVerNum”: “string”, “intTestIndicator”: “string”, “msgAssociationAssignedCode”: “string”, “msgCodeListDirVerNum”: “string”, “msgCommonAccessReference”: “string”, “msgControlAgency”: “string”, “msgFirstAndLastTransfer”: “string”, “msgImplControlAgency”: “string”, “msgImplGuidelineId”: “string”, “msgImplGuidelineRelNum”: “string”, “msgImplGuidelineVerNum”: “string”, “msgRelNum”: “string”, “msgScenarioControlAgency”: “string”, “msgScenarioId”: “string”, “msgScenarioRelNum”: “string”, “msgScenarioVerNum”: “string”, “msgSequenceOfTransfers”: “string”, “msgSubsetControlAgency”: “string”, “msgSubsetId”: “string”, “msgSubsetRelNum”: “string”, “msgSubsetVerNum”: “string”, “msgType”: “string”, “msgTypeSubFunctionId”: “string”, “msgVerNum”: “string”, “releaseCharacter”: “string”, “repeatingElementSeparator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “una”: “string”, “useGroups”: “string” } } } |
Response | String |
API Name | /pem/mode/create-sendRule |
Method | POST |
Description | This API creates a new Send Rule via a proxy to the Lightwell Send Rule API. |
Request | { “actualLightWellUrl”: “string”, “oauth2AuthModelForMode”: { “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “modeDocumentSearchModel”: { “actionFlag”: [ “string” ], “altReference”: [ “string” ], “archive”: true, “authenticated”: true, “authorities”: “string”, “clientId”: “string”, “credentials”: “string”, “currencyCode”: [ “string” ], “destination”: [ “string” ], “details”: “string”, “direction”: [ “string” ], “docCreationEndDate”: “string”, “docCreationStartDate”: “string”, “docEndDate”: “string”, “docFormat”: [ “string” ], “docStartDate”: “string”, “docStatus”: [ “string” ], “docType”: [ “string” ], “documentCount”: [ “string” ], “documentStatusReason”: [ “string” ], “docValue”: [ “string” ], “endDate”: “string”, “extensions”: “string”, “finalSize”: [ “string” ], “groupNumber”: [ “string” ], “identityFields”: “string”, “interchangeNumber”: [ “string” ], “inWfid”: [ “string” ], “maxId”: 0, “minId”: 0, “msgEndDate”: “string”, “msgInFilename”: [ “string” ], “msgOutFilename”: [ “string” ], “msgProtocol”: [ “string” ], “msgProtocolInfo”: [ “string” ], “msgStartDate”: “string”, “msgStatus”: [ “string” ], “msgStatusReason”: [ “string” ], “originalSize”: [ “string” ], “outWfid”: [ “string” ], “page”: 0, “pageSize”: 0, “parentWfid”: [ “string” ], “partner”: [ “string” ], “principal”: “string”, “reference”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ], “standard”: [ “string” ], “startDate”: “string”, “testFlag”: [ “string” ], “transactionNumber”: [ “string” ], “transactionStatus”: [ “string” ], “transactionStatusReason”: [ “string” ], “version”: [ “string” ], “wfid”: [ “string” ], “withDocExtensions”: true, “withEvents”: true, “withNotes”: true, “withReferences”: true }, “identitySearchModel”: { “authenticated”: true, “authorities”: “string”, “credentials”: “string”, “details”: “string”, “identOnly”: true, “principal”: “string” }, “identityModel”: { “activeFlag”: “string”, “b2bIdentifier”: “string”, “clientId”: 0, “id”: 0, “identityExtensions”: [ { “clientId”: 0, “id”: 0, “identityField”: { “clientId”: 0, “description”: “string”, “displayOrder”: 0, “id”: 0, “key”: “string”, “required”: true }, “key”: “string”, “value”: “string” } ], “notes”: “string”, “orgName”: “string”, “parentIdentifier”: “string” }, “sendRuleSearchModel”: { “active”: “string”, “clientId”: “string”, “coreBpParmValue”: [ “string” ], “destination”: [ “string” ], “docType”: [ “string” ], “ediBatch”: [ “string” ], “ediDeferFlag”: “string”, “ediStandard”: [ “string” ], “ediStreamFlag”: “string”, “id”: [ “string” ], “initialMessageStatus”: [ “string” ], “maxId”: 0, “minId”: 0, “page”: 0, “pageSize”: 0, “preBpParmValue”: [ “string” ], “preSendBp”: [ “string” ], “sendBp”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ] }, “addRuleModel”: { “activeFlag”: “string”, “clientId”: 0, “coreParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “destinationId”: “string”, “documentType”: “string”, “ediBatch”: “string”, “ediDeferFlag”: “string”, “ediStandard”: “string”, “ediStreamFlag”: “string”, “id”: 0, “initialMessageStatus”: “string”, “preParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “preSendBp”: “string”, “ruleVersion”: 0, “sendBp”: “string”, “sourceId”: “string”, “timestamp”: “string”, “tradacomsOverrides”: { “alias”: “string”, “id”: 0, “intStxAprf”: “string”, “intStxFrom1”: “string”, “intStxFrom2”: “string”, “intStxPrcd”: “string”, “intStxRcrf”: “string”, “intStxStds1”: “string”, “intStxStds2”: “string”, “intStxUnto1”: “string”, “intStxUnto2”: “string”, “msgAcdInlo1”: “string”, “msgAcdInlo2”: “string”, “msgBdtBkic”: “string”, “msgBdtBkin”: “string”, “msgBdtBnam”: “string”, “msgBdtCd31”: “string”, “msgBdtSvid1”: “string”, “msgBdtSvid2”: “string”, “msgCdtCadd1”: “string”, “msgCdtCadd2”: “string”, “msgCdtCadd3”: “string”, “msgCdtCadd4”: “string”, “msgCdtCadd5”: “string”, “msgCdtCidn1”: “string”, “msgCdtCidn2”: “string”, “msgCdtCnam”: “string”, “msgCdtVatr1”: “string”, “msgCdtVatr2”: “string”, “msgMhdType”: “string”, “msgSdtSadd1”: “string”, “msgSdtSadd2”: “string”, “msgSdtSadd3”: “string”, “msgSdtSadd4”: “string”, “msgSdtSadd5”: “string”, “msgSdtSidn1”: “string”, “msgSdtSidn2”: “string”, “msgSdtSnam”: “string”, “msgSdtVatn1”: “string”, “msgSdtVatn2”: “string”, “msgTypTcde”: “string”, “msgTypTtyp”: “string” }, “username”: “string”, “x12Overrides”: { “alias”: “string”, “docEncoding”: “string”, “elementSeparator”: “string”, “grpAckOverdueTime”: “string”, “grpAckOverdueTimeMinutes”: “string”, “grpExpectAck”: “string”, “grpFunctionalIdCode”: “string”, “grpReceiverId”: “string”, “grpResponsibleAgencyCode”: “string”, “grpSenderId”: “string”, “grpVersionReleaseIdCode”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequested”: “string”, “intAuthInfoQual”: “string”, “intAuthInformation”: “string”, “intControlStandardsId”: “string”, “intControlVerNum”: “string”, “intReceiverId”: “string”, “intReceiverIdQual”: “string”, “intSecurityInfoQual”: “string”, “intSecurityInformation”: “string”, “intSenderId”: “string”, “intSenderIdQual”: “string”, “intTestIndicator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “transactionSetIdCode”: “string” }, “edifactOverridesModel”: { “alias”: “string”, “decimalSeparator”: “string”, “elementSeparator”: “string”, “grpApplicationPswd”: “string”, “grpApplicationRecipientId”: “string”, “grpApplicationSenderId”: “string”, “grpControlAgency”: “string”, “grpRecipientIdCodeQual”: “string”, “grpSenderIdCodeQual”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequest”: “string”, “intAgreementId”: “string”, “intApplicationReference”: “string”, “intCharacterEncoding”: “string”, “intControlReference”: “string”, “intProcessingPriorityCode”: “string”, “intRecipientId”: “string”, “intRecipientIdCodeQual”: “string”, “intRecipientInternalId”: “string”, “intRecipientInternalSubId”: “string”, “intRecipientRefPswd”: “string”, “intRecipientRefPswdQual”: “string”, “intSenderId”: “string”, “intSenderIdCodeQual”: “string”, “intSenderInternalId”: “string”, “intSenderInternalSubId”: “string”, “intSrvCodeListDirVerNum”: “string”, “intSyntaxId”: “string”, “intSyntaxVerNum”: “string”, “intTestIndicator”: “string”, “msgAssociationAssignedCode”: “string”, “msgCodeListDirVerNum”: “string”, “msgCommonAccessReference”: “string”, “msgControlAgency”: “string”, “msgFirstAndLastTransfer”: “string”, “msgImplControlAgency”: “string”, “msgImplGuidelineId”: “string”, “msgImplGuidelineRelNum”: “string”, “msgImplGuidelineVerNum”: “string”, “msgRelNum”: “string”, “msgScenarioControlAgency”: “string”, “msgScenarioId”: “string”, “msgScenarioRelNum”: “string”, “msgScenarioVerNum”: “string”, “msgSequenceOfTransfers”: “string”, “msgSubsetControlAgency”: “string”, “msgSubsetId”: “string”, “msgSubsetRelNum”: “string”, “msgSubsetVerNum”: “string”, “msgType”: “string”, “msgTypeSubFunctionId”: “string”, “msgVerNum”: “string”, “releaseCharacter”: “string”, “repeatingElementSeparator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “una”: “string”, “useGroups”: “string” } } } |
Response | String |
API Name | /pem/mode/add-identity |
Method | POST |
Description | This API adds a new identity via a proxy to the Lightwell Identity API. |
Request | { “actualLightWellUrl”: “string”, “oauth2AuthModelForMode”: { “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “modeDocumentSearchModel”: { “actionFlag”: [ “string” ], “altReference”: [ “string” ], “archive”: true, “authenticated”: true, “authorities”: “string”, “clientId”: “string”, “credentials”: “string”, “currencyCode”: [ “string” ], “destination”: [ “string” ], “details”: “string”, “direction”: [ “string” ], “docCreationEndDate”: “string”, “docCreationStartDate”: “string”, “docEndDate”: “string”, “docFormat”: [ “string” ], “docStartDate”: “string”, “docStatus”: [ “string” ], “docType”: [ “string” ], “documentCount”: [ “string” ], “documentStatusReason”: [ “string” ], “docValue”: [ “string” ], “endDate”: “string”, “extensions”: “string”, “finalSize”: [ “string” ], “groupNumber”: [ “string” ], “identityFields”: “string”, “interchangeNumber”: [ “string” ], “inWfid”: [ “string” ], “maxId”: 0, “minId”: 0, “msgEndDate”: “string”, “msgInFilename”: [ “string” ], “msgOutFilename”: [ “string” ], “msgProtocol”: [ “string” ], “msgProtocolInfo”: [ “string” ], “msgStartDate”: “string”, “msgStatus”: [ “string” ], “msgStatusReason”: [ “string” ], “originalSize”: [ “string” ], “outWfid”: [ “string” ], “page”: 0, “pageSize”: 0, “parentWfid”: [ “string” ], “partner”: [ “string” ], “principal”: “string”, “reference”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ], “standard”: [ “string” ], “startDate”: “string”, “testFlag”: [ “string” ], “transactionNumber”: [ “string” ], “transactionStatus”: [ “string” ], “transactionStatusReason”: [ “string” ], “version”: [ “string” ], “wfid”: [ “string” ], “withDocExtensions”: true, “withEvents”: true, “withNotes”: true, “withReferences”: true }, “identitySearchModel”: { “authenticated”: true, “authorities”: “string”, “credentials”: “string”, “details”: “string”, “identOnly”: true, “principal”: “string” }, “identityModel”: { “activeFlag”: “string”, “b2bIdentifier”: “string”, “clientId”: 0, “id”: 0, “identityExtensions”: [ { “clientId”: 0, “id”: 0, “identityField”: { “clientId”: 0, “description”: “string”, “displayOrder”: 0, “id”: 0, “key”: “string”, “required”: true }, “key”: “string”, “value”: “string” } ], “notes”: “string”, “orgName”: “string”, “parentIdentifier”: “string” }, “sendRuleSearchModel”: { “active”: “string”, “clientId”: “string”, “coreBpParmValue”: [ “string” ], “destination”: [ “string” ], “docType”: [ “string” ], “ediBatch”: [ “string” ], “ediDeferFlag”: “string”, “ediStandard”: [ “string” ], “ediStreamFlag”: “string”, “id”: [ “string” ], “initialMessageStatus”: [ “string” ], “maxId”: 0, “minId”: 0, “page”: 0, “pageSize”: 0, “preBpParmValue”: [ “string” ], “preSendBp”: [ “string” ], “sendBp”: [ “string” ], “sortBy”: “string”, “sortDir”: “string”, “source”: [ “string” ] }, “addRuleModel”: { “activeFlag”: “string”, “clientId”: 0, “coreParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “destinationId”: “string”, “documentType”: “string”, “ediBatch”: “string”, “ediDeferFlag”: “string”, “ediStandard”: “string”, “ediStreamFlag”: “string”, “id”: 0, “initialMessageStatus”: “string”, “preParms”: [ { “id”: 0, “parmKey”: “string”, “parmValue”: “string”, “sendBpType”: “string” } ], “preSendBp”: “string”, “ruleVersion”: 0, “sendBp”: “string”, “sourceId”: “string”, “timestamp”: “string”, “tradacomsOverrides”: { “alias”: “string”, “id”: 0, “intStxAprf”: “string”, “intStxFrom1”: “string”, “intStxFrom2”: “string”, “intStxPrcd”: “string”, “intStxRcrf”: “string”, “intStxStds1”: “string”, “intStxStds2”: “string”, “intStxUnto1”: “string”, “intStxUnto2”: “string”, “msgAcdInlo1”: “string”, “msgAcdInlo2”: “string”, “msgBdtBkic”: “string”, “msgBdtBkin”: “string”, “msgBdtBnam”: “string”, “msgBdtCd31”: “string”, “msgBdtSvid1”: “string”, “msgBdtSvid2”: “string”, “msgCdtCadd1”: “string”, “msgCdtCadd2”: “string”, “msgCdtCadd3”: “string”, “msgCdtCadd4”: “string”, “msgCdtCadd5”: “string”, “msgCdtCidn1”: “string”, “msgCdtCidn2”: “string”, “msgCdtCnam”: “string”, “msgCdtVatr1”: “string”, “msgCdtVatr2”: “string”, “msgMhdType”: “string”, “msgSdtSadd1”: “string”, “msgSdtSadd2”: “string”, “msgSdtSadd3”: “string”, “msgSdtSadd4”: “string”, “msgSdtSadd5”: “string”, “msgSdtSidn1”: “string”, “msgSdtSidn2”: “string”, “msgSdtSnam”: “string”, “msgSdtVatn1”: “string”, “msgSdtVatn2”: “string”, “msgTypTcde”: “string”, “msgTypTtyp”: “string” }, “username”: “string”, “x12Overrides”: { “alias”: “string”, “docEncoding”: “string”, “elementSeparator”: “string”, “grpAckOverdueTime”: “string”, “grpAckOverdueTimeMinutes”: “string”, “grpExpectAck”: “string”, “grpFunctionalIdCode”: “string”, “grpReceiverId”: “string”, “grpResponsibleAgencyCode”: “string”, “grpSenderId”: “string”, “grpVersionReleaseIdCode”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequested”: “string”, “intAuthInfoQual”: “string”, “intAuthInformation”: “string”, “intControlStandardsId”: “string”, “intControlVerNum”: “string”, “intReceiverId”: “string”, “intReceiverIdQual”: “string”, “intSecurityInfoQual”: “string”, “intSecurityInformation”: “string”, “intSenderId”: “string”, “intSenderIdQual”: “string”, “intTestIndicator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “transactionSetIdCode”: “string” }, “edifactOverridesModel”: { “alias”: “string”, “decimalSeparator”: “string”, “elementSeparator”: “string”, “grpApplicationPswd”: “string”, “grpApplicationRecipientId”: “string”, “grpApplicationSenderId”: “string”, “grpControlAgency”: “string”, “grpRecipientIdCodeQual”: “string”, “grpSenderIdCodeQual”: “string”, “id”: 0, “intAckOverdueTime”: “string”, “intAckOverdueTimeMinutes”: “string”, “intAckRequest”: “string”, “intAgreementId”: “string”, “intApplicationReference”: “string”, “intCharacterEncoding”: “string”, “intControlReference”: “string”, “intProcessingPriorityCode”: “string”, “intRecipientId”: “string”, “intRecipientIdCodeQual”: “string”, “intRecipientInternalId”: “string”, “intRecipientInternalSubId”: “string”, “intRecipientRefPswd”: “string”, “intRecipientRefPswdQual”: “string”, “intSenderId”: “string”, “intSenderIdCodeQual”: “string”, “intSenderInternalId”: “string”, “intSenderInternalSubId”: “string”, “intSrvCodeListDirVerNum”: “string”, “intSyntaxId”: “string”, “intSyntaxVerNum”: “string”, “intTestIndicator”: “string”, “msgAssociationAssignedCode”: “string”, “msgCodeListDirVerNum”: “string”, “msgCommonAccessReference”: “string”, “msgControlAgency”: “string”, “msgFirstAndLastTransfer”: “string”, “msgImplControlAgency”: “string”, “msgImplGuidelineId”: “string”, “msgImplGuidelineRelNum”: “string”, “msgImplGuidelineVerNum”: “string”, “msgRelNum”: “string”, “msgScenarioControlAgency”: “string”, “msgScenarioId”: “string”, “msgScenarioRelNum”: “string”, “msgScenarioVerNum”: “string”, “msgSequenceOfTransfers”: “string”, “msgSubsetControlAgency”: “string”, “msgSubsetId”: “string”, “msgSubsetRelNum”: “string”, “msgSubsetVerNum”: “string”, “msgType”: “string”, “msgTypeSubFunctionId”: “string”, “msgVerNum”: “string”, “releaseCharacter”: “string”, “repeatingElementSeparator”: “string”, “segmentTerminator”: “string”, “subelementSeparator”: “string”, “una”: “string”, “useGroups”: “string” } } } |
Response | String |
API Name | /pcm/application/SMTP |
Method | PUT |
Description | This API updates an existing SMTP application profile with detailed configuration settings. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/SMTP |
Method | POST |
Description | This API creates a new SMTP application profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/smtp/{pkId} |
Method | GET |
Description | This API retrieves the details of an SMTP application profile by its pkId. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } |
API Name | /pcm/application/smtp/{pkId} |
Method | DELETE |
Description | This API deletes an existing SMTP application profile by its pkId. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/connect-direct |
Method | PUT |
Description | This API updates an existing ConnectDirect partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/connect-direct |
Method | POST |
Description | This API creates a new ConnectDirect partner profile. It allows adding partner details |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/connect-direct/saveAll |
Method | POST |
Description | This API creates multiple ConnectDirect partner profiles at once |
Request | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/connect-direct/{pkId} |
Method | GET |
Description | This API fetches a ConnectDirect partner profile using the specified pkId. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } |
API Name | /pcm/partner/connect-direct/{pkId} |
Method | DELETE |
Description | This API deletes a ConnectDirect partner profile by its pkId. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/connect-direct/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves ConnectDirect partner profiles by profileId and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } ] |
API Name | /pcm/partner/smtp |
Method | PUT |
Description | This API updates an existing SMTP partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/smtp |
Method | POST |
Description | This API creates a new SMTP partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/smtp/saveAll |
Method | POST |
Description | This API creates multiple SMTP partner profiles at once. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/smtp/{pkId} |
Method | GET |
Description | This API retrieves an SMTP partner profile by its pkId |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } |
API Name | /pcm/partner/smtp/{pkId} |
Method | DELETE |
Description | This API deletes an SMTP partner profile by its pkId. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/smtp/getAllByProfileId/{profileId/{protocol} |
Method | GET |
Description | This API retrieves SMTP partner profiles by profileId and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “name”: “string”, “accessProtocol”: “string”, “mailServer”: “string”, “mailServerPort”: “string”, “userName”: “string”, “password”: “string”, “connectionRetries”: “string”, “retryInterval”: “string”, “maxMsgsSession”: “string”, “removeMailMsgs”: “string”, “ssl”: “string”, “keyCertPassPhrase”: “string”, “cipherStrength”: “string”, “keyCert”: “string”, “caCertificates”: “string”, “uriName”: “string”, “poolingInterval”: “string”, “like”: true } ] |
API Name | /pcm/partner/sap |
Method | PUT |
Description | This API updates an existing SAP partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } |
Response | “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/sap |
Method | POST |
Description | This API creates a new SAP partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } |
Response | “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/sap/saveAll |
Method | POST |
Description | This API creates multiple SAP partner profiles at once. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } ] |
Response | “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/sap/{pkId} |
Method | GET |
Description | This API retrieves an SAP partner profile by its pkId. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } |
API Name | /pcm/partner/sap/{pkId} |
Method | DELETE |
Description | This API deletes an SAP partner profile by its pkId. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/sap/getAllByProfileId/{profileId/{protocol} |
Method | GET |
Description | This API retrieves SAP partner profiles by profileId and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } ] |
API Name | /pcm/si/group/get-names-list |
Method | GET |
Description | This API retrieves a list of group names from IBM Sterling B2B Integrator. |
Request | No parameters |
Response | [ “string” ] |
API Name | /pcm/partner/mailbox |
Method | PUT |
Description | This API updates an existing mailbox profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mailbox |
Method | POST |
Description | This API creates a new mailbox profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mailbox |
Method | DELETE |
Description | This API creates a new mailbox profile. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mailbox/saveAll |
Method | POST |
Description | This API creates multiple mailbox profiles at once.It allows bulk addition of mailbox details. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mailbox/{pkId} |
Method | GET |
Description | This API retrieves a mailbox profile by its pkId.It can be used to view the mailbox details. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } |
API Name | /pcm/partner/mailbox/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all mailbox profiles for a given profileId and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } ] |
API Name | /pcm/partner/azure |
Method | PUT |
Description | This API updates an existing Azure partner profile.It allows modifying the partner’s details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “authType”: “string”, “accountName”: “string”, “accountKey”: “string”, “endpointSuffix”: “string”, “endpoint”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “inMailbox”: “string”, “inboundPush”: true, “outboundPull”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “bucketName”: “string”, “folderName”: “string”, “adapterName”: “string”, “fileName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/azure |
Method | POST |
Description | This API creates a new Azure partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “authType”: “string”, “accountName”: “string”, “accountKey”: “string”, “endpointSuffix”: “string”, “endpoint”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “inMailbox”: “string”, “inboundPush”: true, “outboundPull”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “bucketName”: “string”, “folderName”: “string”, “adapterName”: “string”, “fileName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/azure/{pkId} |
Method | GET |
Description | This API retrieves an Azure partner profile by its pkId.It allows viewing the Azure partner’s details. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “authType”: “string”, “accountName”: “string”, “accountKey”: “string”, “endpointSuffix”: “string”, “endpoint”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “inMailbox”: “string”, “inboundPush”: true, “outboundPull”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “bucketName”: “string”, “folderName”: “string”, “adapterName”: “string”, “fileName”: “string”, “like”: true } |
API Name | /pcm/partner/azure/{pkId} |
Method | DELETE |
Description | This API deletes an Azure partner profile by its pkId. It returns a status code and message indicating the result of the deletion. |
Request | Paramater |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/webservice |
Method | PUT |
Description | This API updates an existing WebService partner profile.It allows changing the partner’s WebService information. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/webservice |
Method | POST |
Description | This API creates a new WebService partner profile.It allows adding partner details and WebService. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/webservice/saveAll |
Method | POST |
Description | This API creates multiple WebService partner profiles at once.It allows bulk addition of partner details. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/webservice/{pkId} |
Method | GET |
Description | This API retrieves a WebService partner profile by its pkId.It allows viewing the partner’s WebService details. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
API Name | /pcm/partner/webservice/{pkId} |
Method | DELETE |
Description | This API deletes a WebService partner profile by its pkId. It returns a status code and message indicating the result of the deletion. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/webservice/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all WebService partner profiles for a given profileId and protocol. It helps list WebService profiles associated with a specific partner. |
Request | Paramter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
API Name | /pcm/si/partner/custom-protocol |
Method | PUT |
Description | This API updates an existing Custom-Protocol partner profile in Sterling.It allows modifying the partner’s details. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “secondaryMail”: “string”, “partnerCode”: “string”, “communityName”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “userName”: “string”, “password”: “string”, “surname”: “string”, “givenName”: “string”, “userIdentity”: “string”, “passwordPolicy”: “string”, “sessionTimeout”: 0, “authenticationType”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “sfgMailbox”: “string”, “customProtocolName”: “string”, “customProtocolExtensions”: [ { “key”: “string”, “value”: “string” } ], “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “consumerFtpConfiguration”: { “connectionType”: “string”, “hostName”: “string”, “listenPort”: “string”, “controlPortRange”: 0, “localPortRange”: 0, “numberOfRetries”: “string”, “password”: “string”, “retryInterval”: “string”, “uploadFileUnderTemporaryNameFirst”: true, “userName”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “userName”: “string”, “password”: “string”, “hostName”: “string”, “listenPort”: “string”, “numberOfRetries”: “string”, “retryInterval”: “string”, “siteCommand”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificateNames”: [ { “name”: “string” } ], “connectionType”: “string”, “controlPortRange”: 0, “encryptionStrength”: “string”, “hostName”: “string”, “listenPort”: “string”, “localPortRange”: 0, “numberOfRetries”: “string”, “password”: “string”, “retryInterval”: “string”, “uploadFileUnderTemporaryNameFirst”: true, “useCCC”: true, “useImplicitSsl”: true, “userName”: “string” }, “producerFtpsConfiguration”: { “assignedCaCertificateNames”: [ { “name”: “string” } ], “connectionType”: “string”, “encryptionStrength”: “string”, “hostName”: “string”, “listenPort”: “string”, “numberOfRetries”: “string”, “retryInterval”: “string”, “password”: “string”, “siteCommand”: “string”, “useCCC”: true, “useImplicitSsl”: true, “userName”: “string” }, “fileType”: “string”, “transferType”: “string”, “mergeUser”: true, “createSfgProfile”: true, “createProducerProfile”: true, “adapterName”: “string”, “poolingInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/custom-protocol |
Method | POST |
Description | This API retrieves a Custom-Protocol partner profile in Sterling by its profileName.It allows viewing the partner’s details. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “secondaryMail”: “string”, “partnerCode”: “string”, “communityName”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “userName”: “string”, “password”: “string”, “surname”: “string”, “givenName”: “string”, “userIdentity”: “string”, “passwordPolicy”: “string”, “sessionTimeout”: 0, “authenticationType”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “sfgMailbox”: “string”, “customProtocolName”: “string”, “customProtocolExtensions”: [ { “key”: “string”, “value”: “string” } ], “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “consumerFtpConfiguration”: { “connectionType”: “string”, “hostName”: “string”, “listenPort”: “string”, “controlPortRange”: 0, “localPortRange”: 0, “numberOfRetries”: “string”, “password”: “string”, “retryInterval”: “string”, “uploadFileUnderTemporaryNameFirst”: true, “userName”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “userName”: “string”, “password”: “string”, “hostName”: “string”, “listenPort”: “string”, “numberOfRetries”: “string”, “retryInterval”: “string”, “siteCommand”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificateNames”: [ { “name”: “string” } ], “connectionType”: “string”, “controlPortRange”: 0, “encryptionStrength”: “string”, “hostName”: “string”, “listenPort”: “string”, “localPortRange”: 0, “numberOfRetries”: “string”, “password”: “string”, “retryInterval”: “string”, “uploadFileUnderTemporaryNameFirst”: true, “useCCC”: true, “useImplicitSsl”: true, “userName”: “string” }, “producerFtpsConfiguration”: { “assignedCaCertificateNames”: [ { “name”: “string” } ], “connectionType”: “string”, “encryptionStrength”: “string”, “hostName”: “string”, “listenPort”: “string”, “numberOfRetries”: “string”, “retryInterval”: “string”, “password”: “string”, “siteCommand”: “string”, “useCCC”: true, “useImplicitSsl”: true, “userName”: “string” }, “fileType”: “string”, “transferType”: “string”, “mergeUser”: true, “createSfgProfile”: true, “createProducerProfile”: true, “adapterName”: “string”, “poolingInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | pcm/si/partner/custom-protocol/{profileName} |
Method | GET |
Description | This API deletes a Custom-Protocol partner profile in Sterling by profileName.It includes options to delete associated mailboxes and users, returning a status code and message. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “secondaryMail”: “string”, “partnerCode”: “string”, “communityName”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “userName”: “string”, “password”: “string”, “surname”: “string”, “givenName”: “string”, “userIdentity”: “string”, “passwordPolicy”: “string”, “sessionTimeout”: 0, “authenticationType”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “sfgMailbox”: “string”, “customProtocolName”: “string”, “customProtocolExtensions”: [ { “key”: “string”, “value”: “string” } ], “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “consumerFtpConfiguration”: { “connectionType”: “string”, “hostName”: “string”, “listenPort”: “string”, “controlPortRange”: 0, “localPortRange”: 0, “numberOfRetries”: “string”, “password”: “string”, “retryInterval”: “string”, “uploadFileUnderTemporaryNameFirst”: true, “userName”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “userName”: “string”, “password”: “string”, “hostName”: “string”, “listenPort”: “string”, “numberOfRetries”: “string”, “retryInterval”: “string”, “siteCommand”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificateNames”: [ { “name”: “string” } ], “connectionType”: “string”, “controlPortRange”: 0, “encryptionStrength”: “string”, “hostName”: “string”, “listenPort”: “string”, “localPortRange”: 0, “numberOfRetries”: “string”, “password”: “string”, “retryInterval”: “string”, “uploadFileUnderTemporaryNameFirst”: true, “useCCC”: true, “useImplicitSsl”: true, “userName”: “string” }, “producerFtpsConfiguration”: { “assignedCaCertificateNames”: [ { “name”: “string” } ], “connectionType”: “string”, “encryptionStrength”: “string”, “hostName”: “string”, “listenPort”: “string”, “numberOfRetries”: “string”, “retryInterval”: “string”, “password”: “string”, “siteCommand”: “string”, “useCCC”: true, “useImplicitSsl”: true, “userName”: “string” }, “fileType”: “string”, “transferType”: “string”, “mergeUser”: true, “createSfgProfile”: true, “createProducerProfile”: true, “adapterName”: “string”, “poolingInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “like”: true } |
API Name | pcm/si/partner/custom-protocol |
Method | DELETE |
Description | This API deletes a Custom-Protocol partner profile in Sterling by profileName.It includes options to delete associated mailboxes and users, returning a status code and message. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ec |
Method | PUT |
Description | This API updates an existing EC partner profile. It allows modifying the partner’s details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “ecProtocol”: “string”, “ecProtocolReference”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ec |
Method | POST |
Description | This API creates a new EC partner profile.It allows adding the partner’s. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “ecProtocol”: “string”, “ecProtocolReference”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ec/saveAll |
Method | POST |
Description | This API creates multiple EC partner profiles at once. It allows bulk addition of partner. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “ecProtocol”: “string”, “ecProtocolReference”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ec/{pkId} |
Method | GET |
Description | This API retrieves an EC partner profile by its pkId. It allows viewing the partner’s details. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “ecProtocol”: “string”, “ecProtocolReference”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
API Name | /pcm/partner/ec/{pkId} |
Method | DELETE |
Description | This API deletes an EC partner profile by its pkId.It returns a status code and message indicating the result of the deletion. |
Request | Paramter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ec/getAllByProfileId/{profileId/{protocol} |
Method | GET |
Description | This API retrieves all EC partner profiles for a given profileId and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “ecProtocol”: “string”, “ecProtocolReference”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
API Name | /pcm/si/mailbox |
Method | POST |
Description | This API creates a mailbox in IBM Sterling B2B Integrator.It requires path, description, and mailboxType, returning a status code and message. |
Request | { “path”: “string”, “description”: “string”, “mailboxType”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/mailbox/get-list |
Method | GET |
Description | This API retrieves a list of all mailboxes in IBM Sterling B2B Integrator.No parameters are required to fetch the mailbox names. |
Request | No Parameters |
Response | [ “string” ] |
API Name | /pcm/partner/ftp |
Method | PUT |
Description | This API updates an existing FTP, FTPS, or SFTP partner profile.It returns a status code and message indicating the result of the update. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ftp |
Method | POST |
Description | This API creates a new FTP, FTPS, or SFTP partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ftp/saveAll |
Method | POST |
Description | This API creates multiple FTP, FTPS, or SFTP partner profiles at once.It allows bulk addition of partner’s. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ftp/{pkId} |
Method | GET |
Description | This API retrieves an FTP, FTPS, or SFTP partner profile by its pkId.It provides the profile details |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
API Name | /pcm/partner/ftp/[pkId} |
Method | DELETE |
Description | This API deletes an FTP, FTPS, or SFTP partner profile by its pkId. It returns a status code and message indicating the result of the deletion. |
Request | Paramter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/ftp/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all FTP, FTPS, or SFTP partner profiles for a given profileId and protocol. |
Request | Parameters |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
API Name | /pcm/si/partner/remote-ftp |
Method | PUT |
Description | This API updates an existing FTP, FTPS, or SFTP partner profile in IBM Sterling B2B Integrator. It allows modifying the partner’s details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-ftp |
Method | POST |
Description | This API creates a new FTP, FTPS, or SFTP partner profile in IBM Sterling B2B Integrator. It allows adding partner details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-ftp |
Method | DELETE |
Description | This API deletes an FTP, FTPS, or SFTP partner profile in IBM Sterling B2B Integrator. It accepts options to delete associated users and mailboxes, returning a status code and message. |
Request | Parameters |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-ftp/saveAll |
Method | POST |
Description | This API creates multiple FTP, FTPS, or SFTP partner profiles in IBM Sterling B2B Integrator at once.It allows bulk addition of partner details. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-ftp/{pkId} |
Method | GET |
Description | This API retrieves an FTP, FTPS, or SFTP partner profile in IBM Sterling B2B Integrator by its pkId.It allows viewing the partner’s profile. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } |
API Name | /pcm/si/partner/remote-ftp/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all FTP, FTPS, or SFTP partner profiles in IBM Sterling B2B Integrator for a given profileId and protocol.It lists the profiles associated with the specified partner. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } ] |
API Name | /pcm/partner/remote-connect-direct |
Method | PUT |
Description | This API updates an existing ConnectDirect partner profile.It allows modifying the partner’s. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “localNodeName”: “string”, “remoteFileName”: “string”, “nodeName”: “string”, “getsNodeId”: “string”, “getsNodeIdPassword”: “string”, “operatingSystem”: “string”, “directory”: “string”, “hostName”: “string”, “port”: 0, “copySisOpts”: “string”, “checkPoint”: “string”, “compressionLevel”: “string”, “disposition”: “string”, “submit”: “string”, “secure”: true, “runJob”: “string”, “runTask”: “string”, “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “cdMainFrameModel”: { “dcbParam”: “string”, “dnsName”: “string”, “unit”: “string”, “storageClass”: “string”, “space”: “string” }, “poolingInterval”: “string”, “adapterName”: “string”, “securityProtocol”: “string”, “caCertName”: [ { “caCertName”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “systemCertificate”: “string”, “maxLocallyInitiatedPnodeSessionsAllowed”: “string”, “maxRemotelyInitiatedSnodeSessionsAllowed”: “string”, “requireClientAuthentication”: “string”, “internal”: true, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “outDirectory”: “string”, “inboundConnectionType”: true, “outboundConnectionType”: true, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “ssp”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/remote-connect-direct |
Method | POST |
Description | This API creates a new ConnectDirect partner profile. It allows adding the partner’s. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “localNodeName”: “string”, “remoteFileName”: “string”, “nodeName”: “string”, “getsNodeId”: “string”, “getsNodeIdPassword”: “string”, “operatingSystem”: “string”, “directory”: “string”, “hostName”: “string”, “port”: 0, “copySisOpts”: “string”, “checkPoint”: “string”, “compressionLevel”: “string”, “disposition”: “string”, “submit”: “string”, “secure”: true, “runJob”: “string”, “runTask”: “string”, “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “cdMainFrameModel”: { “dcbParam”: “string”, “dnsName”: “string”, “unit”: “string”, “storageClass”: “string”, “space”: “string” }, “poolingInterval”: “string”, “adapterName”: “string”, “securityProtocol”: “string”, “caCertName”: [ { “caCertName”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “systemCertificate”: “string”, “maxLocallyInitiatedPnodeSessionsAllowed”: “string”, “maxRemotelyInitiatedSnodeSessionsAllowed”: “string”, “requireClientAuthentication”: “string”, “internal”: true, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “outDirectory”: “string”, “inboundConnectionType”: true, “outboundConnectionType”: true, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “ssp”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/remote-connect-direct |
Method | DELETE |
Description | This API deletes a ConnectDirect partner profile by its pkId.The isDeleteInSI option specifies whether to remove it from the sterling integrator, returning a status code and message. |
Request | Parameters |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/remote-connect-direct/{pkId} |
Method | GET |
Description | This API retrieves a ConnectDirect partner profile by its pkId. It allows viewing the partner’s datails. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “localNodeName”: “string”, “remoteFileName”: “string”, “nodeName”: “string”, “getsNodeId”: “string”, “getsNodeIdPassword”: “string”, “operatingSystem”: “string”, “directory”: “string”, “hostName”: “string”, “port”: 0, “copySisOpts”: “string”, “checkPoint”: “string”, “compressionLevel”: “string”, “disposition”: “string”, “submit”: “string”, “secure”: true, “runJob”: “string”, “runTask”: “string”, “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “cdMainFrameModel”: { “dcbParam”: “string”, “dnsName”: “string”, “unit”: “string”, “storageClass”: “string”, “space”: “string” }, “poolingInterval”: “string”, “adapterName”: “string”, “securityProtocol”: “string”, “caCertName”: [ { “caCertName”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “systemCertificate”: “string”, “maxLocallyInitiatedPnodeSessionsAllowed”: “string”, “maxRemotelyInitiatedSnodeSessionsAllowed”: “string”, “requireClientAuthentication”: “string”, “internal”: true, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “outDirectory”: “string”, “inboundConnectionType”: true, “outboundConnectionType”: true, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “ssp”: true, “like”: true } |
API Name | /pcm/partner/remote-connect-direct/getAllByprofileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all ConnectDirect partner profiles for a given profileId and protocol.It lists the profiles associated with the specified partner. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “localNodeName”: “string”, “remoteFileName”: “string”, “nodeName”: “string”, “getsNodeId”: “string”, “getsNodeIdPassword”: “string”, “operatingSystem”: “string”, “directory”: “string”, “hostName”: “string”, “port”: 0, “copySisOpts”: “string”, “checkPoint”: “string”, “compressionLevel”: “string”, “disposition”: “string”, “submit”: “string”, “secure”: true, “runJob”: “string”, “runTask”: “string”, “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “cdMainFrameModel”: { “dcbParam”: “string”, “dnsName”: “string”, “unit”: “string”, “storageClass”: “string”, “space”: “string” }, “poolingInterval”: “string”, “adapterName”: “string”, “securityProtocol”: “string”, “caCertName”: [ { “caCertName”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “systemCertificate”: “string”, “maxLocallyInitiatedPnodeSessionsAllowed”: “string”, “maxRemotelyInitiatedSnodeSessionsAllowed”: “string”, “requireClientAuthentication”: “string”, “internal”: true, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “outDirectory”: “string”, “inboundConnectionType”: true, “outboundConnectionType”: true, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “ssp”: true, “like”: true } ] |
API Name | /pcm/partner/aws-s3 |
Method | PUT |
Description | This API updates an existing AWS-S3 partner profile. It allows modifying the partner details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3 |
Method | POST |
Description | This API creates a new AWS-S3 partner profile.It allows adding the partner’s. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3/saveAll |
Method | POST |
Description | This API creates multiple AWS-S3 partner profiles at once. It allows multiple addition of partners. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3/{pkId} |
Method | GET |
Description | This API retrieves an AWS-S3 partner profile by its pkId.It allows viewing the partner details. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
API Name | /pcm/partner/aws-s3/{pkId} |
Method | DELETE |
Description | This API deletes an AWS-S3 partner profile by its pkId.The isDeleteInSI option specifies whether to remove it from the sterling integrator, returning a status code and message. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all AWS-S3 partner profiles for a given profileId and protocol. It lists the profiles associated ProfileId and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } ] |
API Name | /pcm/si/partner/remote-as2 |
Method | PUT |
Description | This API updates an existing AS2 partner profile.It allows modifying the partner details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-as2 |
Method | POST |
Description | This API creates a new AS2 partner profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-as2 |
Method | DELETE |
Description | This API deletes an AS2 partner profile by its pkId.The deleteInSI option specifies whether to remove it from the sterling integrator, returning a status code and message. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-as2/saveAll |
Method | POST |
Description | This API creates multiple AS2 partner profiles at once. It allows bulk addition of partner’s |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-as2/migrate-to-pcm |
Method | POST |
Description | This API migrates and creates an AS2 partner profile in PCM .It allows adding the partner’s |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/partner/remote-as2/{pkId} |
Method | GET |
Description | This API retrieves an AS2 partner profile by its pkId.It allows viewing the partner details. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } |
API Name | /pcm/si/partner/remote-as2/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all AS2 partner profiles for a given profileId and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } ] |
API Name | /pcm/pooling-interval |
Method | GET |
Description | Get pollingIntervals |
Request | This API retrieves all polling intervals. |
Response | [ { “pkId”: “string”, “interval”: “string”, “seq”: 0, “description”: “string” } ] |
API Name | /pcm/pooling-interval |
Method | PUT |
Description | This API creates or updates polling intervals.It accepts a list of intervals and returns a status code with a message indicating the result. |
Request | [ { “pkId”: “string”, “interval”: “string”, “seq”: 0, “description”: “string” } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/pooling-interval/update-pollingInterval |
Method | PUT |
Description | This API updates existing polling intervals. |
Request | { “pkId”: “string”, “interval”: “string”, “seq”: 0, “description”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/pooling-interval/save-pollingInterval |
Method | POST |
Description | This API creates a new polling interval. |
Request | { “pkId”: “string”, “interval”: “string”, “seq”: 0, “description”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/pooling-interval/{pkId} |
Method | GET |
Description | This API retrieves a polling interval by its pkId.It returns the interval’s details including value, sequence, and description. |
Request | Parameter |
Response | { “pkId”: “string”, “interval”: “string”, “seq”: 0, “description”: “string” } |
API Name | /pcm/pooling-interval/{pkId} |
Method | DELETE |
Description | This API deletes a polling interval by its pkId.It returns a status code and message indicating the result of the deletion. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/pooling-interval/list |
Method | GET |
Description | This API retrieves a list of all polling intervals.It returns each interval as a key-value pair. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/pooling-interval/activity |
Method | GET |
Description | This API retrieves the history of polling intervals. It provides records of past interval changes and activities. |
Request | No Parameters |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “userId”: “string”, “activity”: “string”, “activityDt”: “2025-09-22T16:24:17.211Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/partner/filesystem |
Method | PUT |
Description | This API updates an existing FileSystem partner profile. It allows modifying the partner’s file system details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/filesystem |
Method | POST |
Description | This API creates a new FileSystem partner profile.It allows adding the partner’s file system details. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/filesystem/saveAll |
Method | POST |
Description | This API creates multiple FileSystem partner profiles at once.It allows bulk addition of file system details for partners. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/filesystem/{pkId} |
Method | GET |
Description | This API retrieves a FileSystem partner profile by its pkId.It allows viewing the partner’s file system details. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
API Name | /pcm/partner/filesystem/{pkId} |
Method | DELETE |
Description | This API deletes a FileSystem partner profile by its pkId. It returns a status code and message indicating the result of the deletion. |
Request | Paramater |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/filesystem/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | This API retrieves all FileSystem partner profiles for a given profileId and protocol. It lists the profiles associated with the specified profileId and protocol. |
Request | Parameters |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ] |
API Name | /pcm/proxy/sfgapis |
Method | GET |
Description | This API checks the availability of a routing channel template.It requires createUserId, partnerGroupKey, and templateName and returns a list of matching template names. |
Request | Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/si/application/remote-as2 |
Method | PUT |
Description | This API updates an existing AS2 application profile. It allows modifying the application’s Profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/application/remote-as2 |
Method | POST |
Description | This API creates a new AS2 application profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/application/remote-as2 |
Method | DELETE |
Description | This API deletes an AS2 application profile by its pkId. The deleteInSI option specifies whether to remove it from the system integrator, returning a status code and message. |
Request | Parameters |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/application/remote-as2/saveMultipleProfiles |
Method | POST |
Description | This API creates multiple AS2 application profiles at once. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/si/application/remote-as2/{pkId} |
Method | GET |
Description | This API retrieves an AS2 application profile by its pkId.It allows viewing the applications. |
Request | Parameters |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } |
API Name | /pcm/si/application/remote-as2/getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | This API retrieves all AS2 application profiles for a given applicationId and protocol.It lists the applications. |
Request | Parameters |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “as2Identifier”: “string”, “as2EmailAddress”: “string”, “emailHost”: “string”, “emailPort”: 0, “compressData”: “string”, “senderId”: “string”, “senderQualifier”: “string”, “endPoint”: “string”, “responseTimeout”: 0, “payloadType”: “string”, “mimeType”: “string”, “mimeSubType”: “string”, “sslType”: “string”, “cipherStrength”: “string”, “exchangeCertificate”: “string”, “signingCertification”: “string”, “keyCertification”: “string”, “systemCertificate”: “string”, “caCertificate”: “string”, “keyCertificatePassphrase”: “string”, “payloadEncryptionAlgorithm”: “string”, “encryptionAlgorithm”: “string”, “signatureAlgorithm”: “string”, “mdn”: true, “mdnType”: “string”, “mdnEncryption”: “string”, “receiptToAddress”: “string”, “socketTimeOut”: “string”, “firewallProxy”: “string”, “firewallConnectCount”: “string”, “hubInfo”: true, “httpclientAdapter”: “string”, “username”: “string”, “password”: “string”, “additionalServerCommunication”: true, “as2AdditionalServerModel”: { “endpoint”: “string”, “responseTimeout”: 0, “sslType”: “string”, “cipherStrength”: “string”, “keyCertificatePassphrase”: “string”, “keyCertId”: “string”, “caCertId”: “string” }, “receiptTimeout”: 0, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “payloadSecurity”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “isSIProfile”: true, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “identityName”: “string”, “useExistingIdentity”: “string”, “getselectNewIdentity”: true, “like”: true } ] |
API Name | /pcm/application/aws-s3 |
Method | PUT |
Description | This API updates an existing AWS-S3 application profile . It allows modifying the application’s. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/aws-s3 |
Method | POST |
Description | This API updates an existing AWS-S3 application profile . It allows modifying the application’s. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/aws-s3/saveMultipleProfiles |
Method | POST |
Description | This API creates multiple AWS-S3 application profiles at once. It allows multiple addition of partners. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/aws-s3/{pkId} |
Method | GET |
Description | This API retrieves an AWS-S3 application profile by its pkId.It allows viewing the application’s. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
API Name | /pcm/application/aws-s3/{pkId} |
Method | DELETE |
Description | This API deletes an AWS-S3 application profile by its pkId.It returns a status code and message indicating the result of the deletion. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/aws-s3/getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | This API retrieves all AWS-S3 application profiles for a given applicationId and protocol.It lists the applications associated with the ID and protocol. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } ] |
API Name | /pcm/application/ftp |
Method | PUT |
Description | This API updates an existing FTP, FTPS, or SFTP application profile. It allows modifying the application’s. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/ftp |
Method | POST |
Description | This API creates a new FTP, FTPS, or SFTP application profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/ftp/saveMultipleProfiles |
Method | POST |
Description | This API creates multiple FTP, FTPS, or SFTP application profiles at once. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/ftp/{pkId} |
Method | GET |
Description | This API retrieves an FTP, FTPS, or SFTP application profile by its pkId.It allows viewing the application’s. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
API Name | /pcm/application/ftp/{pkId} |
Method | DELETE |
Description | Delete FTP/FTPS/SFTP Application Profile |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/ftp/getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | This API retrieves all FTP, FTPS, or SFTP application profiles for a given applicationId and protocol.It lists the applications associated with the applicationId and protocol. |
Request | Parameters |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “portNumber”: “string”, “userName”: “string”, “password”: “string”, “transferType”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “certificateId”: “string”, “knownHostKey”: “string”, “hubInfo”: true, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “cwdUp”: “string”, “quote”: “string”, “site”: “string”, “connectionType”: “string”, “mbDestination”: “string”, “mbDestinationLookup”: “string”, “sslSocket”: “string”, “sslCipher”: “string”, “sshAuthentication”: “string”, “sshCipher”: “string”, “sshCompression”: “string”, “sshMac”: “string”, “sshIdentityKeyName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
API Name | /pcm/application/webservice |
Method | PUT |
Description | Update WebService Profile |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/webservice |
Method | POST |
Description | This API creates a new WebService application profile. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/webservice/saveMultipleProfiles |
Method | POST |
Description | This API creates multiple WebService application profiles at once. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/webservice/{pkId} |
Method | GET |
Description | This API retrieves a WebService application profile by its pkId.It allows viewing the application’s. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “name”: “string”, “outBoundUrl”: “string”, “inMailBox”: “string”, “certificateId”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
API Name | /pcm/application/webservice/{pkId} |
Method | DELETE |
Description | This API deletes a WebService application profile by its pkId.It returns a status code and message indicating the result of the deletion. |
Request | parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/webservice/getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | GetAll By WebService Application Profile |
Request | Parameter |
Response |
API Name | /pcm/partner/as2-relations |
Method | PUT |
Description | Updates an existing AS2 relation with the provided details. Returns the updated relation information upon successful modification |
Request | { “pkId”: “string”, “collectionFolder”: “string”, “errorLogFolder”: “string”, “extractionFolder”: “string”, “inboundErrorBusinessProcess”: “string”, “inboundSuccessBusinessProcess”: “string”, “includeFileNameInMessage”: “string”, “maxFilestoCollect”: “string”, “maxRetries”: 0, “notifyOnFinalFailure”: true, “notifyOnIntermediateFailures”: true, “retryInterval”: 0, “selectExistingParentMailbox”: “string”, “setMessageFileNameinProcessData”: true, “storeOrInvokeBP”: “string”, “useDefaultInboundOrOutboundMailbox”: true, “useMessageFileNameToSaveFile”: true, “waitForSynchronousMDNProcessToCompleteBeforeExtractingData”: true, “runServiceBasedOnTimerEvery”: { “hours”: “string”, “minutes”: “string” }, “orgProfileId”: “string”, “partnerProfileId”: “string”, “as2Organisation”: “string”, “as2TradingPartner”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/as2-relations |
Method | POST |
Description | Creates a new AS2 relation with the details provided in the request body. Returns the information of the newly created relation upon success. |
Request | { “pkId”: “string”, “collectionFolder”: “string”, “errorLogFolder”: “string”, “extractionFolder”: “string”, “inboundErrorBusinessProcess”: “string”, “inboundSuccessBusinessProcess”: “string”, “includeFileNameInMessage”: “string”, “maxFilestoCollect”: “string”, “maxRetries”: 0, “notifyOnFinalFailure”: true, “notifyOnIntermediateFailures”: true, “retryInterval”: 0, “selectExistingParentMailbox”: “string”, “setMessageFileNameinProcessData”: true, “storeOrInvokeBP”: “string”, “useDefaultInboundOrOutboundMailbox”: true, “useMessageFileNameToSaveFile”: true, “waitForSynchronousMDNProcessToCompleteBeforeExtractingData”: true, “runServiceBasedOnTimerEvery”: { “hours”: “string”, “minutes”: “string” }, “orgProfileId”: “string”, “partnerProfileId”: “string”, “as2Organisation”: “string”, “as2TradingPartner”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/as2-relations/getdetails |
Method | POST |
Description | Retrieves AS2 relation details based on partner name, organization, or both. Returns matching relation information according to the provided criteria. |
Request | Parameter Request Paylaod “pkId”: “string”, “collectionFolder”: “string”, “errorLogFolder”: “string”, “extractionFolder”: “string”, “inboundErrorBusinessProcess”: “string”, “inboundSuccessBusinessProcess”: “string”, “includeFileNameInMessage”: “string”, “maxFilestoCollect”: “string”, “maxRetries”: 0, “notifyOnFinalFailure”: true, “notifyOnIntermediateFailures”: true, “retryInterval”: 0, “selectExistingParentMailbox”: “string”, “setMessageFileNameinProcessData”: true, “storeOrInvokeBP”: “string”, “useDefaultInboundOrOutboundMailbox”: true, “useMessageFileNameToSaveFile”: true, “waitForSynchronousMDNProcessToCompleteBeforeExtractingData”: true, “runServiceBasedOnTimerEvery”: { “hours”: “string”, “minutes”: “string” }, “orgProfileId”: “string”, “partnerProfileId”: “string”, “as2Organisation”: “string”, “as2TradingPartner”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/as2-relations/connectivity |
Method | POST |
Description | Fetches the connectivity status for AS2 relations based on the provided request details. Returns a response indicating the connectivity results for the specified relations. |
Request | Parameter |
Response | { “status”: “string”, “bpId”: “string”, “statusCode”: “string” } |
API Name | /pcm/partner/as2-relations/{pkId} |
Method | GET |
Description | Retrieves the AS2 relation identified by pkId Returns detailed information about the specified relation. |
Request | Parameter |
Response | { “pkId”: “string”, “collectionFolder”: “string”, “errorLogFolder”: “string”, “extractionFolder”: “string”, “inboundErrorBusinessProcess”: “string”, “inboundSuccessBusinessProcess”: “string”, “includeFileNameInMessage”: “string”, “maxFilestoCollect”: “string”, “maxRetries”: 0, “notifyOnFinalFailure”: true, “notifyOnIntermediateFailures”: true, “retryInterval”: 0, “selectExistingParentMailbox”: “string”, “setMessageFileNameinProcessData”: true, “storeOrInvokeBP”: “string”, “useDefaultInboundOrOutboundMailbox”: true, “useMessageFileNameToSaveFile”: true, “waitForSynchronousMDNProcessToCompleteBeforeExtractingData”: true, “runServiceBasedOnTimerEvery”: { “hours”: “string”, “minutes”: “string” }, “orgProfileId”: “string”, “partnerProfileId”: “string”, “as2Organisation”: “string”, “as2TradingPartner”: “string” } |
API Name | /pcm/partner/as2-relations/{pkId} |
Method | DELETE |
Description | Deletes the AS2 relation identified by pkId. Permanently removes the relation and its associated details from the system. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mq |
Method | PUT |
Description | Updates an existing MQ application profile with the provided details. Returns the updated profile information upon successful modification. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mq |
Method | POST |
Description | Creates a new MQ application profile with the details provided in the request body. Returns the information of the newly created profile upon success. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mq/saveMultipleProfiles |
Method | POST |
Description | Creates multiple MQ application profiles in a single request. Accepts a list of profiles in the request body and returns details of the created profiles. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mq/{pkId} |
Method | GET |
Description | Retrieves the MQ application profile identified by {pkId}. Returns detailed information about the specified profile. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } |
API Name | /pcm/application/mq/{pkId} |
Method | DELETE |
Description | Deletes the MQ application profile identified by {pkId}. Permanently removes the profile and its associated details from the system. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mq/getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | Fetches all MQ application profiles associated with the specified applicationId and protocol. Returns detailed information for each matching profile. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } ] |
API Name | /pcm/application/connect-direct |
Method | PUT |
Description | Updates an existing ConnectDirect application profile with the provided details. Returns the updated profile information upon successful modification. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/connect-direct |
Method | POST |
Description | Creates a new ConnectDirect application profile with the details provided in the request body. Returns the information of the newly created profile upon success. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/connect-direct/saveMultipleProfiles |
Method | POST |
Description | Creates multiple ConnectDirect application profiles in a single request. Accepts a list of profiles in the request body and returns details of the created profiles. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/connect-direct/{pkId} |
Method | GET |
Description | Creates multiple ConnectDirect application profiles in a single request. Accepts a list of profiles in the request body and returns details of the created profiles. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } |
API Name | /pcm/application/connect-direct/{pkId} |
Method | DELETE |
Description | Deletes the ConnectDirect application profile identified by {pkId}. Permanently removes the profile and its associated details from the system. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/connect-direct/getAllApplicationId/{appliactionId}/{protocol} |
Method | GET |
Description | Fetches all ConnectDirect application profiles associated with the specified applicationId and protocol. Returns detailed information for each matching profile. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “remoteHost”: “string”, “remotePort”: “string”, “remoteUser”: “string”, “remotePassword”: “string”, “transferType”: “string”, “localNodeName”: “string”, “remoteNodeName”: “string”, “codePageFrom”: “string”, “codePageTo”: “string”, “localXLate”: “string”, “dcb”: “string”, “sysOpts”: “string”, “securityProtocol”: “string”, “securePlus”: true, “caCertificate”: [ { “caCertName”: “string” } ], “cipherSuits”: [ { “cipherSuiteName”: “string” } ], “adapterName”: “string”, “poolingInterval”: “string”, “like”: true } ] |
API Name | /pcm/application/sap |
Method | PUT |
Description | Updates an existing SAP application profile with the provided details. Returns the updated profile information upon successful modification. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/sap |
Method | POST |
Description | Creates a new SAP application profile with the details provided in the request body. Returns the information of the newly created profile upon success. |
Request | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/sap/saveMultipleProfiles |
Method | POST |
Description | Creates multiple SAP application profiles in a single request. Accepts a list of profiles in the request body and returns details of the created profiles. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/sap/{pkId} |
Method | GET |
Description | Retrieves the SAP application profile identified by pkId. Returns detailed information about the specified profile. |
Request | Parameter |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } |
API Name | /pcm/application/sap/{pkId} |
Method | DELETE |
Description | Deletes the SAP application profile identified by pkId. Permanently removes the profile and its associated details from the system. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/sap/ getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | Fetches all SAP application profiles linked to the specified applicationId and protocol. Returns detailed configuration and profile information. |
Request | Parameter |
Response | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sapRoute”: “string”, “adapterName”: “string”, “like”: true } ] |
API Name | /restapi/{apiName} |
Method | GET |
Description | Retrieves details of the API connection identified by apiName. Returns the current configuration and related information. |
Request | apiName |
Response | String |
API Name | /restapi/{apiName} |
Method | PUT |
Description | Updates an existing API connection identified by {apiName}. Accepts the updated details in the request body to modify the resource. |
Request | Parameter |
Response | String |
API Name | /restapi/{apiName} |
Method | POST |
Description | Creates or invokes a specified API via API Connect using POST. This API is used to send data or trigger operations on the API endpoint. |
Request | apiName |
Response | String |
API Name | /restapi/{apiName} |
Method | DELETE |
Description | Deletes a specified API via API Connect. This API is used to remove API configurations or endpoints from the system. |
Request | apiName |
Response | String |
API Name | /pem/workflow/base-64-xml/update-file-types |
Method | PUT |
Description | Updates file types in a workflow using Base64-encoded data. This API is used to modify workflow configurations securely by updating specific file type details. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <PemStringDataModel> <data>string</data> </PemStringDataModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityManagerResponse> <statusCode>0</statusCode> <statusMessage>string</statusMessage> </CommunityManagerResponse> |
API Name | /pem/workflow/base-64-xml/remove-file-types |
Method | POST |
Description | Removes file types from a workflow using Base64-encoded input. This API is used to update workflows by securely deleting specific file type configurations |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <PemStringDataModel> <data>string</data> </PemStringDataModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityManagerResponse> <statusCode>0</statusCode> <statusMessage>string</statusMessage> </CommunityManagerResponse> |
API Name | /pem/workflow/base-64 |
Method | POST |
Description | Creates a new workflow using Base64-encoded data. This API is used to define workflows securely by providing workflow configurations in Base64 format. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <PemStringDataModel> <data>string</data> </PemStringDataModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityManagerResponse> <statusCode>0</statusCode> <statusMessage>string</statusMessage> </CommunityManagerResponse> |
API Name | /pem/workflow/base-64-xml/add-file-types |
Method | POST |
Description | Adds file types to a workflow using Base64-encoded data. This API is used to update workflows by including additional file type configurations securely. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <PemStringDataModel> <data>string</data> </PemStringDataModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityManagerResponse> <statusCode>0</statusCode> <statusMessage>string</statusMessage> </CommunityManagerResponse> |
API Name | /pem/encode-workflow-model-xml-to-apache-base64 |
Method | POST |
Description | Encodes a workflow model XML into Apache Base64 format. This API is used to convert workflow XML data into a Base64-encoded representation for secure transmission or storage. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <PemContentWorkFlowXmlModel> <partnerProfile>string</partnerProfile> <applicationProfile>string</applicationProfile> <content> <pkId>string</pkId> <partnerProfile>string</partnerProfile> <applicationProfile>string</applicationProfile> <processDocPkId>string</processDocPkId> <seqType>string</seqType> <flow>string</flow> <fileName>string</fileName> <docType>string</docType> <transaction>string</transaction> <partnerId>string</partnerId> <receiverId>string</receiverId> <versionNo>string</versionNo> <processRulePkId>string</processRulePkId> <ruleId>string</ruleId> <ruleName>string</ruleName> <ruleValue>string</ruleValue> <businessProcessId>string</businessProcessId> <ruleProperty1>string</ruleProperty1> <ruleProperty2>string</ruleProperty2> <ruleProperty3>string</ruleProperty3> <ruleProperty4>string</ruleProperty4> <ruleProperty5>string</ruleProperty5> <ruleProperty6>string</ruleProperty6> <ruleProperty7>string</ruleProperty7> <ruleProperty8>string</ruleProperty8> <ruleProperty9>string</ruleProperty9> <ruleProperty10>string</ruleProperty10> <ruleProperty11>string</ruleProperty11> <ruleProperty12>string</ruleProperty12> <ruleProperty13>string</ruleProperty13> <ruleProperty14>string</ruleProperty14> <ruleProperty15>string</ruleProperty15> <ruleProperty16>string</ruleProperty16> <ruleProperty17>string</ruleProperty17> <ruleProperty18>string</ruleProperty18> <ruleProperty19>string</ruleProperty19> <ruleProperty20>string</ruleProperty20> <ruleProperty21>string</ruleProperty21> <ruleProperty22>string</ruleProperty22> <ruleProperty23>string</ruleProperty23> <ruleProperty24>string</ruleProperty24> <ruleProperty25>string</ruleProperty25> <rowNum>0</rowNum> <seqId>0</seqId> </content> </PemContentWorkFlowXmlModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <PemStringDataModel> <data>string</data> </PemStringDataModel> |
API Name | /pem/sql-service/config |
Method | PUT |
Description | Updates an existing database object in the system. This API is used to modify records and maintain accurate database configurations. |
Request | { “seqId”: 0, “tableName”: “string”, “distinctColumnName”: “string”, “columnName1”: “string”, “columnName2”: “string”, “columnName3”: “string”, “columnName4”: “string”, “columnName5”: “string”, “columnName6”: “string”, “columnName7”: “string”, “columnName8”: “string”, “columnName9”: “string”, “columnName10”: “string”, “columnName11”: “string”, “columnName12”: “string”, “columnName13”: “string”, “columnName14”: “string”, “columnName15”: “string”, “columnName16”: “string”, “columnName17”: “string”, “columnName18”: “string”, “columnName19”: “string”, “columnName20”: “string”, “columnName21”: “string”, “columnName22”: “string”, “columnName23”: “string”, “columnName24”: “string”, “columnName25”: “string”, “columnName26”: “string”, “columnName27”: “string”, “columnName28”: “string”, “columnName29”: “string”, “columnName30”: “string”, “columnName31”: “string”, “columnName32”: “string”, “columnName33”: “string”, “columnName34”: “string”, “columnName35”: “string”, “columnName36”: “string”, “columnName37”: “string”, “columnName38”: “string”, “columnName39”: “string”, “columnName40”: “string”, “columnName41”: “string”, “columnName42”: “string”, “columnName43”: “string”, “columnName44”: “string”, “columnName45”: “string”, “columnName46”: “string”, “columnName47”: “string”, “columnName48”: “string”, “columnName49”: “string”, “columnName50”: “string”, “columnName51”: “string”, “columnName52”: “string”, “columnName53”: “string”, “columnName54”: “string”, “columnName55”: “string”, “columnName56”: “string”, “columnName57”: “string”, “columnName58”: “string”, “columnName59”: “string”, “columnName60”: “string”, “columnName61”: “string”, “columnName62”: “string”, “columnName63”: “string”, “columnName64”: “string”, “columnName65”: “string”, “columnName66”: “string”, “columnName67”: “string”, “columnName68”: “string”, “columnName69”: “string”, “columnName70”: “string”, “columnName71”: “string”, “columnName72”: “string”, “columnName73”: “string”, “columnName74”: “string”, “columnName75”: “string”, “columnName76”: “string”, “columnName77”: “string”, “columnName78”: “string”, “columnName79”: “string”, “columnName80”: “string”, “columnName81”: “string”, “columnName82”: “string”, “columnName83”: “string”, “columnName84”: “string”, “columnName85”: “string”, “columnName86”: “string”, “columnName87”: “string”, “columnName88”: “string”, “columnName89”: “string”, “columnName90”: “string”, “columnName91”: “string”, “columnName92”: “string”, “columnName93”: “string”, “columnName94”: “string”, “columnName95”: “string”, “columnName96”: “string”, “columnName97”: “string”, “columnName98”: “string”, “columnName99”: “string”, “columnName100”: “string”, “columnName101”: “string”, “columnName102”: “string”, “columnName103”: “string”, “columnName104”: “string”, “columnName105”: “string”, “columnName106”: “string”, “columnName107”: “string”, “columnName108”: “string”, “columnName109”: “string”, “columnName110”: “string”, “columnName111”: “string”, “columnName112”: “string”, “columnName113”: “string”, “columnName114”: “string”, “columnName115”: “string”, “columnName116”: “string”, “columnName117”: “string”, “columnName118”: “string”, “columnName119”: “string”, “columnName120”: “string”, “columnName121”: “string”, “columnName122”: “string”, “columnName123”: “string”, “columnName124”: “string”, “columnName125”: “string”, “columnName126”: “string”, “columnName127”: “string”, “columnName128”: “string”, “columnName129”: “string”, “columnName130”: “string”, “columnName131”: “string”, “columnName132”: “string”, “columnName133”: “string”, “columnName134”: “string”, “columnName135”: “string”, “columnName136”: “string”, “columnName137”: “string”, “columnName138”: “string”, “columnName139”: “string”, “columnName140”: “string”, “columnName141”: “string”, “columnName142”: “string”, “columnName143”: “string”, “columnName144”: “string”, “columnName145”: “string”, “columnName146”: “string”, “columnName147”: “string”, “columnName148”: “string”, “columnName149”: “string”, “columnName150”: “string”, “whereColumnName1”: “string”, “whereColumnName2”: “string”, “whereColumnName3”: “string”, “whereColumnName4”: “string”, “whereColumnName5”: “string”, “whereColumnName6”: “string”, “whereColumnName7”: “string”, “whereColumnName8”: “string”, “whereColumnName9”: “string”, “whereColumnName10”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/sql-service/config |
Method | POST |
Description | Creates a new database object in the system. This API is used to add structured records for data storage and management. |
Request | { “seqId”: 0, “tableName”: “string”, “distinctColumnName”: “string”, “columnName1”: “string”, “columnName2”: “string”, “columnName3”: “string”, “columnName4”: “string”, “columnName5”: “string”, “columnName6”: “string”, “columnName7”: “string”, “columnName8”: “string”, “columnName9”: “string”, “columnName10”: “string”, “columnName11”: “string”, “columnName12”: “string”, “columnName13”: “string”, “columnName14”: “string”, “columnName15”: “string”, “columnName16”: “string”, “columnName17”: “string”, “columnName18”: “string”, “columnName19”: “string”, “columnName20”: “string”, “columnName21”: “string”, “columnName22”: “string”, “columnName23”: “string”, “columnName24”: “string”, “columnName25”: “string”, “columnName26”: “string”, “columnName27”: “string”, “columnName28”: “string”, “columnName29”: “string”, “columnName30”: “string”, “columnName31”: “string”, “columnName32”: “string”, “columnName33”: “string”, “columnName34”: “string”, “columnName35”: “string”, “columnName36”: “string”, “columnName37”: “string”, “columnName38”: “string”, “columnName39”: “string”, “columnName40”: “string”, “columnName41”: “string”, “columnName42”: “string”, “columnName43”: “string”, “columnName44”: “string”, “columnName45”: “string”, “columnName46”: “string”, “columnName47”: “string”, “columnName48”: “string”, “columnName49”: “string”, “columnName50”: “string”, “columnName51”: “string”, “columnName52”: “string”, “columnName53”: “string”, “columnName54”: “string”, “columnName55”: “string”, “columnName56”: “string”, “columnName57”: “string”, “columnName58”: “string”, “columnName59”: “string”, “columnName60”: “string”, “columnName61”: “string”, “columnName62”: “string”, “columnName63”: “string”, “columnName64”: “string”, “columnName65”: “string”, “columnName66”: “string”, “columnName67”: “string”, “columnName68”: “string”, “columnName69”: “string”, “columnName70”: “string”, “columnName71”: “string”, “columnName72”: “string”, “columnName73”: “string”, “columnName74”: “string”, “columnName75”: “string”, “columnName76”: “string”, “columnName77”: “string”, “columnName78”: “string”, “columnName79”: “string”, “columnName80”: “string”, “columnName81”: “string”, “columnName82”: “string”, “columnName83”: “string”, “columnName84”: “string”, “columnName85”: “string”, “columnName86”: “string”, “columnName87”: “string”, “columnName88”: “string”, “columnName89”: “string”, “columnName90”: “string”, “columnName91”: “string”, “columnName92”: “string”, “columnName93”: “string”, “columnName94”: “string”, “columnName95”: “string”, “columnName96”: “string”, “columnName97”: “string”, “columnName98”: “string”, “columnName99”: “string”, “columnName100”: “string”, “columnName101”: “string”, “columnName102”: “string”, “columnName103”: “string”, “columnName104”: “string”, “columnName105”: “string”, “columnName106”: “string”, “columnName107”: “string”, “columnName108”: “string”, “columnName109”: “string”, “columnName110”: “string”, “columnName111”: “string”, “columnName112”: “string”, “columnName113”: “string”, “columnName114”: “string”, “columnName115”: “string”, “columnName116”: “string”, “columnName117”: “string”, “columnName118”: “string”, “columnName119”: “string”, “columnName120”: “string”, “columnName121”: “string”, “columnName122”: “string”, “columnName123”: “string”, “columnName124”: “string”, “columnName125”: “string”, “columnName126”: “string”, “columnName127”: “string”, “columnName128”: “string”, “columnName129”: “string”, “columnName130”: “string”, “columnName131”: “string”, “columnName132”: “string”, “columnName133”: “string”, “columnName134”: “string”, “columnName135”: “string”, “columnName136”: “string”, “columnName137”: “string”, “columnName138”: “string”, “columnName139”: “string”, “columnName140”: “string”, “columnName141”: “string”, “columnName142”: “string”, “columnName143”: “string”, “columnName144”: “string”, “columnName145”: “string”, “columnName146”: “string”, “columnName147”: “string”, “columnName148”: “string”, “columnName149”: “string”, “columnName150”: “string”, “whereColumnName1”: “string”, “whereColumnName2”: “string”, “whereColumnName3”: “string”, “whereColumnName4”: “string”, “whereColumnName5”: “string”, “whereColumnName6”: “string”, “whereColumnName7”: “string”, “whereColumnName8”: “string”, “whereColumnName9”: “string”, “whereColumnName10”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/sql-service/config/create-object-dataypes |
Method | POST |
Description | Creates database objects with specified data types. This API is used to define and insert structured records into the database. |
Request | { “seqId”: 0, “columnName1Datatype”: “string”, “columnName2Datatype”: “string”, “columnName3Datatype”: “string”, “columnName4Datatype”: “string”, “columnName5Datatype”: “string”, “columnName6Datatype”: “string”, “columnName7Datatype”: “string”, “columnName8Datatype”: “string”, “columnName9Datatype”: “string”, “columnName10Datatype”: “string”, “columnName11Datatype”: “string”, “columnName12Datatype”: “string”, “columnName13Datatype”: “string”, “columnName14Datatype”: “string”, “columnName15Datatype”: “string”, “columnName16Datatype”: “string”, “columnName17Datatype”: “string”, “columnName18Datatype”: “string”, “columnName19Datatype”: “string”, “columnName20Datatype”: “string”, “columnName21Datatype”: “string”, “columnName22Datatype”: “string”, “columnName23Datatype”: “string”, “columnName24Datatype”: “string”, “columnName25Datatype”: “string”, “columnName26Datatype”: “string”, “columnName27Datatype”: “string”, “columnName28Datatype”: “string”, “columnName29Datatype”: “string”, “columnName30Datatype”: “string”, “columnName31Datatype”: “string”, “columnName32Datatype”: “string”, “columnName33Datatype”: “string”, “columnName34Datatype”: “string”, “columnName35Datatype”: “string”, “columnName36Datatype”: “string”, “columnName37Datatype”: “string”, “columnName38Datatype”: “string”, “columnName39Datatype”: “string”, “columnName40Datatype”: “string”, “columnName41Datatype”: “string”, “columnName42Datatype”: “string”, “columnName43Datatype”: “string”, “columnName44Datatype”: “string”, “columnName45Datatype”: “string”, “columnName46Datatype”: “string”, “columnName47Datatype”: “string”, “columnName48Datatype”: “string”, “columnName49Datatype”: “string”, “columnName50Datatype”: “string”, “columnName51Datatype”: “string”, “columnName52Datatype”: “string”, “columnName53Datatype”: “string”, “columnName54Datatype”: “string”, “columnName55Datatype”: “string”, “columnName56Datatype”: “string”, “columnName57Datatype”: “string”, “columnName58Datatype”: “string”, “columnName59Datatype”: “string”, “columnName60Datatype”: “string”, “columnName61Datatype”: “string”, “columnName62Datatype”: “string”, “columnName63Datatype”: “string”, “columnName64Datatype”: “string”, “columnName65Datatype”: “string”, “columnName66Datatype”: “string”, “columnName67Datatype”: “string”, “columnName68Datatype”: “string”, “columnName69Datatype”: “string”, “columnName70Datatype”: “string”, “columnName71Datatype”: “string”, “columnName72Datatype”: “string”, “columnName73Datatype”: “string”, “columnName74Datatype”: “string”, “columnName75Datatype”: “string”, “columnName76Datatype”: “string”, “columnName77Datatype”: “string”, “columnName78Datatype”: “string”, “columnName79Datatype”: “string”, “columnName80Datatype”: “string”, “columnName81Datatype”: “string”, “columnName82Datatype”: “string”, “columnName83Datatype”: “string”, “columnName84Datatype”: “string”, “columnName85Datatype”: “string”, “columnName86Datatype”: “string”, “columnName87Datatype”: “string”, “columnName88Datatype”: “string”, “columnName89Datatype”: “string”, “columnName90Datatype”: “string”, “columnName91Datatype”: “string”, “columnName92Datatype”: “string”, “columnName93Datatype”: “string”, “columnName94Datatype”: “string”, “columnName95Datatype”: “string”, “columnName96Datatype”: “string”, “columnName97Datatype”: “string”, “columnName98Datatype”: “string”, “columnName99Datatype”: “string”, “columnName100Datatype”: “string”, “columnName101Datatype”: “string”, “columnName102Datatype”: “string”, “columnName103Datatype”: “string”, “columnName104Datatype”: “string”, “columnName105Datatype”: “string”, “columnName106Datatype”: “string”, “columnName107Datatype”: “string”, “columnName108Datatype”: “string”, “columnName109Datatype”: “string”, “columnName110Datatype”: “string”, “columnName111Datatype”: “string”, “columnName112Datatype”: “string”, “columnName113Datatype”: “string”, “columnName114Datatype”: “string”, “columnName115Datatype”: “string”, “columnName116Datatype”: “string”, “columnName117Datatype”: “string”, “columnName118Datatype”: “string”, “columnName119Datatype”: “string”, “columnName120Datatype”: “string”, “columnName121Datatype”: “string”, “columnName122Datatype”: “string”, “columnName123Datatype”: “string”, “columnName124Datatype”: “string”, “columnName125Datatype”: “string”, “columnName126Datatype”: “string”, “columnName127Datatype”: “string”, “columnName128Datatype”: “string”, “columnName129Datatype”: “string”, “columnName130Datatype”: “string”, “columnName131Datatype”: “string”, “columnName132Datatype”: “string”, “columnName133Datatype”: “string”, “columnName134Datatype”: “string”, “columnName135Datatype”: “string”, “columnName136Datatype”: “string”, “columnName137Datatype”: “string”, “columnName138Datatype”: “string”, “columnName139Datatype”: “string”, “columnName140Datatype”: “string”, “columnName141Datatype”: “string”, “columnName142Datatype”: “string”, “columnName143Datatype”: “string”, “columnName144Datatype”: “string”, “columnName145Datatype”: “string”, “columnName146Datatype”: “string”, “columnName147Datatype”: “string”, “columnName148Datatype”: “string”, “columnName149Datatype”: “string”, “columnName150Datatype”: “string”, “whereColumnName1_datatype”: “string”, “whereColumnName2_datatype”: “string”, “whereColumnName3_datatype”: “string”, “whereColumnName4_datatype”: “string”, “whereColumnName5_datatype”: “string”, “whereColumnName6_datatype”: “string”, “whereColumnName7_datatype”: “string”, “whereColumnName8_datatype”: “string”, “whereColumnName9_datatype”: “string”, “whereColumnName10_datatype”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/sql-service/config/{seqId} |
Method | GET |
Description | Retrieves the database object identified by seqId. This API is used to view and manage specific database configurations. |
Request | Parameter |
Response | { “seqId”: 0, “tableName”: “string”, “distinctColumnName”: “string”, “columnName1”: “string”, “columnName2”: “string”, “columnName3”: “string”, “columnName4”: “string”, “columnName5”: “string”, “columnName6”: “string”, “columnName7”: “string”, “columnName8”: “string”, “columnName9”: “string”, “columnName10”: “string”, “columnName11”: “string”, “columnName12”: “string”, “columnName13”: “string”, “columnName14”: “string”, “columnName15”: “string”, “columnName16”: “string”, “columnName17”: “string”, “columnName18”: “string”, “columnName19”: “string”, “columnName20”: “string”, “columnName21”: “string”, “columnName22”: “string”, “columnName23”: “string”, “columnName24”: “string”, “columnName25”: “string”, “columnName26”: “string”, “columnName27”: “string”, “columnName28”: “string”, “columnName29”: “string”, “columnName30”: “string”, “columnName31”: “string”, “columnName32”: “string”, “columnName33”: “string”, “columnName34”: “string”, “columnName35”: “string”, “columnName36”: “string”, “columnName37”: “string”, “columnName38”: “string”, “columnName39”: “string”, “columnName40”: “string”, “columnName41”: “string”, “columnName42”: “string”, “columnName43”: “string”, “columnName44”: “string”, “columnName45”: “string”, “columnName46”: “string”, “columnName47”: “string”, “columnName48”: “string”, “columnName49”: “string”, “columnName50”: “string”, “columnName51”: “string”, “columnName52”: “string”, “columnName53”: “string”, “columnName54”: “string”, “columnName55”: “string”, “columnName56”: “string”, “columnName57”: “string”, “columnName58”: “string”, “columnName59”: “string”, “columnName60”: “string”, “columnName61”: “string”, “columnName62”: “string”, “columnName63”: “string”, “columnName64”: “string”, “columnName65”: “string”, “columnName66”: “string”, “columnName67”: “string”, “columnName68”: “string”, “columnName69”: “string”, “columnName70”: “string”, “columnName71”: “string”, “columnName72”: “string”, “columnName73”: “string”, “columnName74”: “string”, “columnName75”: “string”, “columnName76”: “string”, “columnName77”: “string”, “columnName78”: “string”, “columnName79”: “string”, “columnName80”: “string”, “columnName81”: “string”, “columnName82”: “string”, “columnName83”: “string”, “columnName84”: “string”, “columnName85”: “string”, “columnName86”: “string”, “columnName87”: “string”, “columnName88”: “string”, “columnName89”: “string”, “columnName90”: “string”, “columnName91”: “string”, “columnName92”: “string”, “columnName93”: “string”, “columnName94”: “string”, “columnName95”: “string”, “columnName96”: “string”, “columnName97”: “string”, “columnName98”: “string”, “columnName99”: “string”, “columnName100”: “string”, “columnName101”: “string”, “columnName102”: “string”, “columnName103”: “string”, “columnName104”: “string”, “columnName105”: “string”, “columnName106”: “string”, “columnName107”: “string”, “columnName108”: “string”, “columnName109”: “string”, “columnName110”: “string”, “columnName111”: “string”, “columnName112”: “string”, “columnName113”: “string”, “columnName114”: “string”, “columnName115”: “string”, “columnName116”: “string”, “columnName117”: “string”, “columnName118”: “string”, “columnName119”: “string”, “columnName120”: “string”, “columnName121”: “string”, “columnName122”: “string”, “columnName123”: “string”, “columnName124”: “string”, “columnName125”: “string”, “columnName126”: “string”, “columnName127”: “string”, “columnName128”: “string”, “columnName129”: “string”, “columnName130”: “string”, “columnName131”: “string”, “columnName132”: “string”, “columnName133”: “string”, “columnName134”: “string”, “columnName135”: “string”, “columnName136”: “string”, “columnName137”: “string”, “columnName138”: “string”, “columnName139”: “string”, “columnName140”: “string”, “columnName141”: “string”, “columnName142”: “string”, “columnName143”: “string”, “columnName144”: “string”, “columnName145”: “string”, “columnName146”: “string”, “columnName147”: “string”, “columnName148”: “string”, “columnName149”: “string”, “columnName150”: “string”, “whereColumnName1”: “string”, “whereColumnName2”: “string”, “whereColumnName3”: “string”, “whereColumnName4”: “string”, “whereColumnName5”: “string”, “whereColumnName6”: “string”, “whereColumnName7”: “string”, “whereColumnName8”: “string”, “whereColumnName9”: “string”, “whereColumnName10”: “string” } |
API Name | /pem/sql-service/config/{seqId} |
Method | DELETE |
Description | Deletes the database object identified by seqId. This API is used to remove unwanted or obsolete database configurations. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/sql-service/config/search |
Method | GET |
Description | Searches for database objects based on specified criteria. This API is used to locate and view database configurations efficiently. |
Request | No parameters |
Response | { “content”: [ “string” ] } |
API Name | /pcm/user |
Method | PUT |
Description | Updates an internal or external user’s status and details. This API is used to modify user information and account settings. |
Request | { “userId”: “string”, “userRole”: “string”, “firstName”: “string”, “lastName”: “string”, “middleName”: “string”, “salt”: “string”, “email”: “string”, “phone”: “string”, “status”: true, “b2bUser”: true, “partnersList”: [ “string” ], “groupsList”: [ “string” ], “lang”: “string”, “userType”: “string”, “externalId”: “string”, “auth”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/user |
Method | POST |
Description | Updates details of an internal or external user. This API is used to modify user information, including status and profile attributes |
Request | { “userId”: “string”, “userRole”: “string”, “firstName”: “string”, “lastName”: “string”, “middleName”: “string”, “salt”: “string”, “email”: “string”, “phone”: “string”, “status”: true, “b2bUser”: true, “partnersList”: [ “string” ], “groupsList”: [ “string” ], “lang”: “string”, “userType”: “string”, “externalId”: “string”, “auth”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/user/status |
Method | POST |
Description | Updates the status of an internal or external user. This API is used to activate, deactivate, or modify the user’s account state. |
Request | { “pkId”: “string”, “status”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/user/search |
Method | POST |
Description | Searches for internal or external users based on specified criteria. This API is used to locate and retrieve user information efficiently. |
Request | Parameter Request Paylaod “userId”: “string”, “userRole”: “string”, “firstName”: “string”, “lastName”: “string”, “middleName”: “string”, “salt”: “string”, “email”: “string”, “phone”: “string”, “status”: true, “b2bUser”: true, “partnersList”: [ “string” ], “groupsList”: [ “string” ], “lang”: “string”, “userType”: “string”, “externalId”: “string”, “auth”: true } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “userid”: “string”, “password”: “string”, “salt”: “string”, “role”: “string”, “firstName”: “string”, “middleName”: “string”, “lastName”: “string”, “email”: “string”, “phone”: “string”, “status”: “string”, “isB2bUser”: “string”, “isFaxUser”: “string”, “onboardingRef”: “string”, “partnerRef”: “string”, “activationKey”: “string”, “otp”: “string”, “createdDate”: “2025-09-23T08:54:27.973Z”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-23T08:54:27.973Z”, “groupRef”: “string”, “tpUserEntity”: { “userid”: “string”, “createdDate”: “2025-09-23T08:54:27.973Z”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-23T08:54:27.973Z”, “partnerList”: “string”, “groupList”: “string” }, “lang”: “string”, “userType”: “string”, “externalId”: “string”, “accountNonLocked”: “string”, “pwdText”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/user/lang |
Method | POST |
Description | Updates the language preference for a specified user. This API is used to set or modify language settings for internal and external users. |
Request | { “userId”: “string”, “lang”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/user/getByUserId |
Method | POST |
Description | Retrieves user details based on userId. This API is used to fetch information for both internal and external users. |
Request | { “name”: “string” } |
Response | { “userId”: “string”, “userRole”: “string”, “firstName”: “string”, “lastName”: “string”, “middleName”: “string”, “salt”: “string”, “email”: “string”, “phone”: “string”, “status”: true, “b2bUser”: true, “partnersList”: [ “string” ], “groupsList”: [ “string” ], “lang”: “string”, “userType”: “string”, “externalId”: “string”, “auth”: true } |
API Name | /pcm/user/change-password |
Method | POST |
Description | Change Internal User Password |
Request | Parameter |
Response |
API Name | /pcm/user/activity/{userId} |
Method | POST |
Description | Retrieves activity details for the specified user. This API is used to monitor and track user actions within the system. |
Request | Parameter |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “userId”: “string”, “lastUpdatedBy”: “string”, “activity”: “string”, “activityDt”: “2025-09-23T09:04:42.316Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/user/unlock-user |
Method | GET |
Description | Unlocks and activates a specified user account. This API is used to restore access for users who were locked or inactive. |
Request | Parameter |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “userId”: “string”, “lastUpdatedBy”: “string”, “activity”: “string”, “activityDt”: “2025-09-23T09:04:42.316Z” } ], “sort”: { “sorted”: true,{ “statusCode”: 0, “statusMessage”: “string” } “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/user/roles |
Method | GET |
Description | Retrieves the list of roles assigned to PCM users. This API is used to view and manage user role configurations. |
Request | No parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/user/{userId} |
Method | DELETE |
Description | Deletes the user identified by userId. This API is used to remove user accounts from the system. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/sql-service/update |
Method | PUT |
Description | Performs an SQL update operation to modify existing records. This API is used to update data in the database. |
Request | { “operator”: “string”, “rowCount”: 0, “days”: true, “seqId”: 0, “distinct”: true, “columnValue1”: “string”, “columnValue2”: “string”, “columnValue3”: “string”, “columnValue4”: “string”, “columnValue5”: “string”, “columnValue6”: “string”, “columnValue7”: “string”, “columnValue8”: “string”, “columnValue9”: “string”, “columnValue10”: “string”, “columnValue11”: “string”, “columnValue12”: “string”, “columnValue13”: “string”, “columnValue14”: “string”, “columnValue15”: “string”, “columnValue16”: “string”, “columnValue17”: “string”, “columnValue18”: “string”, “columnValue19”: “string”, “columnValue20”: “string”, “columnValue21”: “string”, “columnValue22”: “string”, “columnValue23”: “string”, “columnValue24”: “string”, “columnValue25”: “string”, “columnValue26”: “string”, “columnValue27”: “string”, “columnValue28”: “string”, “columnValue29”: “string”, “columnValue30”: “string”, “columnValue31”: “string”, “columnValue32”: “string”, “columnValue33”: “string”, “columnValue34”: “string”, “columnValue35”: “string”, “columnValue36”: “string”, “columnValue37”: “string”, “columnValue38”: “string”, “columnValue39”: “string”, “columnValue40”: “string”, “columnValue41”: “string”, “columnValue42”: “string”, “columnValue43”: “string”, “columnValue44”: “string”, “columnValue45”: “string”, “columnValue46”: “string”, “columnValue47”: “string”, “columnValue48”: “string”, “columnValue49”: “string”, “columnValue50”: “string”, “columnValue51”: “string”, “columnValue52”: “string”, “columnValue53”: “string”, “columnValue54”: “string”, “columnValue55”: “string”, “columnValue56”: “string”, “columnValue57”: “string”, “columnValue58”: “string”, “columnValue59”: “string”, “columnValue60”: “string”, “columnValue61”: “string”, “columnValue62”: “string”, “columnValue63”: “string”, “columnValue64”: “string”, “columnValue65”: “string”, “columnValue66”: “string”, “columnValue67”: “string”, “columnValue68”: “string”, “columnValue69”: “string”, “columnValue70”: “string”, “columnValue71”: “string”, “columnValue72”: “string”, “columnValue73”: “string”, “columnValue74”: “string”, “columnValue75”: “string”, “columnValue76”: “string”, “columnValue77”: “string”, “columnValue78”: “string”, “columnValue79”: “string”, “columnValue80”: “string”, “columnValue81”: “string”, “columnValue82”: “string”, “columnValue83”: “string”, “columnValue84”: “string”, “columnValue85”: “string”, “columnValue86”: “string”, “columnValue87”: “string”, “columnValue88”: “string”, “columnValue89”: “string”, “columnValue90”: “string”, “columnValue91”: “string”, “columnValue92”: “string”, “columnValue93”: “string”, “columnValue94”: “string”, “columnValue95”: “string”, “columnValue96”: “string”, “columnValue97”: “string”, “columnValue98”: “string”, “columnValue99”: “string”, “columnValue100”: “string”, “columnValue101”: “string”, “columnValue102”: “string”, “columnValue103”: “string”, “columnValue104”: “string”, “columnValue105”: “string”, “columnValue106”: “string”, “columnValue107”: “string”, “columnValue108”: “string”, “columnValue109”: “string”, “columnValue110”: “string”, “columnValue111”: “string”, “columnValue112”: “string”, “columnValue113”: “string”, “columnValue114”: “string”, “columnValue115”: “string”, “columnValue116”: “string”, “columnValue117”: “string”, “columnValue118”: “string”, “columnValue119”: “string”, “columnValue120”: “string”, “columnValue121”: “string”, “columnValue122”: “string”, “columnValue123”: “string”, “columnValue124”: “string”, “columnValue125”: “string”, “columnValue126”: “string”, “columnValue127”: “string”, “columnValue128”: “string”, “columnValue129”: “string”, “columnValue130”: “string”, “columnValue131”: “string”, “columnValue132”: “string”, “columnValue133”: “string”, “columnValue134”: “string”, “columnValue135”: “string”, “columnValue136”: “string”, “columnValue137”: “string”, “columnValue138”: “string”, “columnValue139”: “string”, “columnValue140”: “string”, “columnValue141”: “string”, “columnValue142”: “string”, “columnValue143”: “string”, “columnValue144”: “string”, “columnValue145”: “string”, “columnValue146”: “string”, “columnValue147”: “string”, “columnValue148”: “string”, “columnValue149”: “string”, “columnValue150”: “string”, “whereColumnValue1”: “string”, “whereColumnValue2”: “string”, “whereColumnValue3”: “string”, “whereColumnValue4”: “string”, “whereColumnValue5”: “string”, “whereColumnValue6”: “string”, “whereColumnValue7”: “string”, “whereColumnValue8”: “string”, “whereColumnValue9”: “string”, “whereColumnValue10”: “string”, “like”: true } |
Response | { “results”: “string” } |
API Name | /pcm/sql-service/update-dataType |
Method | PUT |
Description | Performs an SQL update operation with specified data types. This API is used to modify existing records while ensuring correct data type handling. |
Request | { “operator”: “string”, “rowCount”: 0, “days”: true, “seqId”: 0, “distinct”: true, “columnValue1”: “string”, “columnValue2”: “string”, “columnValue3”: “string”, “columnValue4”: “string”, “columnValue5”: “string”, “columnValue6”: “string”, “columnValue7”: “string”, “columnValue8”: “string”, “columnValue9”: “string”, “columnValue10”: “string”, “columnValue11”: “string”, “columnValue12”: “string”, “columnValue13”: “string”, “columnValue14”: “string”, “columnValue15”: “string”, “columnValue16”: “string”, “columnValue17”: “string”, “columnValue18”: “string”, “columnValue19”: “string”, “columnValue20”: “string”, “columnValue21”: “string”, “columnValue22”: “string”, “columnValue23”: “string”, “columnValue24”: “string”, “columnValue25”: “string”, “columnValue26”: “string”, “columnValue27”: “string”, “columnValue28”: “string”, “columnValue29”: “string”, “columnValue30”: “string”, “columnValue31”: “string”, “columnValue32”: “string”, “columnValue33”: “string”, “columnValue34”: “string”, “columnValue35”: “string”, “columnValue36”: “string”, “columnValue37”: “string”, “columnValue38”: “string”, “columnValue39”: “string”, “columnValue40”: “string”, “columnValue41”: “string”, “columnValue42”: “string”, “columnValue43”: “string”, “columnValue44”: “string”, “columnValue45”: “string”, “columnValue46”: “string”, “columnValue47”: “string”, “columnValue48”: “string”, “columnValue49”: “string”, “columnValue50”: “string”, “columnValue51”: “string”, “columnValue52”: “string”, “columnValue53”: “string”, “columnValue54”: “string”, “columnValue55”: “string”, “columnValue56”: “string”, “columnValue57”: “string”, “columnValue58”: “string”, “columnValue59”: “string”, “columnValue60”: “string”, “columnValue61”: “string”, “columnValue62”: “string”, “columnValue63”: “string”, “columnValue64”: “string”, “columnValue65”: “string”, “columnValue66”: “string”, “columnValue67”: “string”, “columnValue68”: “string”, “columnValue69”: “string”, “columnValue70”: “string”, “columnValue71”: “string”, “columnValue72”: “string”, “columnValue73”: “string”, “columnValue74”: “string”, “columnValue75”: “string”, “columnValue76”: “string”, “columnValue77”: “string”, “columnValue78”: “string”, “columnValue79”: “string”, “columnValue80”: “string”, “columnValue81”: “string”, “columnValue82”: “string”, “columnValue83”: “string”, “columnValue84”: “string”, “columnValue85”: “string”, “columnValue86”: “string”, “columnValue87”: “string”, “columnValue88”: “string”, “columnValue89”: “string”, “columnValue90”: “string”, “columnValue91”: “string”, “columnValue92”: “string”, “columnValue93”: “string”, “columnValue94”: “string”, “columnValue95”: “string”, “columnValue96”: “string”, “columnValue97”: “string”, “columnValue98”: “string”, “columnValue99”: “string”, “columnValue100”: “string”, “columnValue101”: “string”, “columnValue102”: “string”, “columnValue103”: “string”, “columnValue104”: “string”, “columnValue105”: “string”, “columnValue106”: “string”, “columnValue107”: “string”, “columnValue108”: “string”, “columnValue109”: “string”, “columnValue110”: “string”, “columnValue111”: “string”, “columnValue112”: “string”, “columnValue113”: “string”, “columnValue114”: “string”, “columnValue115”: “string”, “columnValue116”: “string”, “columnValue117”: “string”, “columnValue118”: “string”, “columnValue119”: “string”, “columnValue120”: “string”, “columnValue121”: “string”, “columnValue122”: “string”, “columnValue123”: “string”, “columnValue124”: “string”, “columnValue125”: “string”, “columnValue126”: “string”, “columnValue127”: “string”, “columnValue128”: “string”, “columnValue129”: “string”, “columnValue130”: “string”, “columnValue131”: “string”, “columnValue132”: “string”, “columnValue133”: “string”, “columnValue134”: “string”, “columnValue135”: “string”, “columnValue136”: “string”, “columnValue137”: “string”, “columnValue138”: “string”, “columnValue139”: “string”, “columnValue140”: “string”, “columnValue141”: “string”, “columnValue142”: “string”, “columnValue143”: “string”, “columnValue144”: “string”, “columnValue145”: “string”, “columnValue146”: “string”, “columnValue147”: “string”, “columnValue148”: “string”, “columnValue149”: “string”, “columnValue150”: “string”, “whereColumnValue1”: “string”, “whereColumnValue2”: “string”, “whereColumnValue3”: “string”, “whereColumnValue4”: “string”, “whereColumnValue5”: “string”, “whereColumnValue6”: “string”, “whereColumnValue7”: “string”, “whereColumnValue8”: “string”, “whereColumnValue9”: “string”, “whereColumnValue10”: “string”, “like”: true } |
Response | { “results”: “string” } |
API Name | /pcm/sql/-service//search |
Method | POST |
Description | Performs an SQL select operation to retrieve data. This API is used to query and fetch records from the database. |
Request | { “operator”: “string”, “rowCount”: 0, “days”: true, “seqId”: 0, “distinct”: true, “columnValue1”: “string”, “columnValue2”: “string”, “columnValue3”: “string”, “columnValue4”: “string”, “columnValue5”: “string”, “columnValue6”: “string”, “columnValue7”: “string”, “columnValue8”: “string”, “columnValue9”: “string”, “columnValue10”: “string”, “columnValue11”: “string”, “columnValue12”: “string”, “columnValue13”: “string”, “columnValue14”: “string”, “columnValue15”: “string”, “columnValue16”: “string”, “columnValue17”: “string”, “columnValue18”: “string”, “columnValue19”: “string”, “columnValue20”: “string”, “columnValue21”: “string”, “columnValue22”: “string”, “columnValue23”: “string”, “columnValue24”: “string”, “columnValue25”: “string”, “columnValue26”: “string”, “columnValue27”: “string”, “columnValue28”: “string”, “columnValue29”: “string”, “columnValue30”: “string”, “columnValue31”: “string”, “columnValue32”: “string”, “columnValue33”: “string”, “columnValue34”: “string”, “columnValue35”: “string”, “columnValue36”: “string”, “columnValue37”: “string”, “columnValue38”: “string”, “columnValue39”: “string”, “columnValue40”: “string”, “columnValue41”: “string”, “columnValue42”: “string”, “columnValue43”: “string”, “columnValue44”: “string”, “columnValue45”: “string”, “columnValue46”: “string”, “columnValue47”: “string”, “columnValue48”: “string”, “columnValue49”: “string”, “columnValue50”: “string”, “columnValue51”: “string”, “columnValue52”: “string”, “columnValue53”: “string”, “columnValue54”: “string”, “columnValue55”: “string”, “columnValue56”: “string”, “columnValue57”: “string”, “columnValue58”: “string”, “columnValue59”: “string”, “columnValue60”: “string”, “columnValue61”: “string”, “columnValue62”: “string”, “columnValue63”: “string”, “columnValue64”: “string”, “columnValue65”: “string”, “columnValue66”: “string”, “columnValue67”: “string”, “columnValue68”: “string”, “columnValue69”: “string”, “columnValue70”: “string”, “columnValue71”: “string”, “columnValue72”: “string”, “columnValue73”: “string”, “columnValue74”: “string”, “columnValue75”: “string”, “columnValue76”: “string”, “columnValue77”: “string”, “columnValue78”: “string”, “columnValue79”: “string”, “columnValue80”: “string”, “columnValue81”: “string”, “columnValue82”: “string”, “columnValue83”: “string”, “columnValue84”: “string”, “columnValue85”: “string”, “columnValue86”: “string”, “columnValue87”: “string”, “columnValue88”: “string”, “columnValue89”: “string”, “columnValue90”: “string”, “columnValue91”: “string”, “columnValue92”: “string”, “columnValue93”: “string”, “columnValue94”: “string”, “columnValue95”: “string”, “columnValue96”: “string”, “columnValue97”: “string”, “columnValue98”: “string”, “columnValue99”: “string”, “columnValue100”: “string”, “columnValue101”: “string”, “columnValue102”: “string”, “columnValue103”: “string”, “columnValue104”: “string”, “columnValue105”: “string”, “columnValue106”: “string”, “columnValue107”: “string”, “columnValue108”: “string”, “columnValue109”: “string”, “columnValue110”: “string”, “columnValue111”: “string”, “columnValue112”: “string”, “columnValue113”: “string”, “columnValue114”: “string”, “columnValue115”: “string”, “columnValue116”: “string”, “columnValue117”: “string”, “columnValue118”: “string”, “columnValue119”: “string”, “columnValue120”: “string”, “columnValue121”: “string”, “columnValue122”: “string”, “columnValue123”: “string”, “columnValue124”: “string”, “columnValue125”: “string”, “columnValue126”: “string”, “columnValue127”: “string”, “columnValue128”: “string”, “columnValue129”: “string”, “columnValue130”: “string”, “columnValue131”: “string”, “columnValue132”: “string”, “columnValue133”: “string”, “columnValue134”: “string”, “columnValue135”: “string”, “columnValue136”: “string”, “columnValue137”: “string”, “columnValue138”: “string”, “columnValue139”: “string”, “columnValue140”: “string”, “columnValue141”: “string”, “columnValue142”: “string”, “columnValue143”: “string”, “columnValue144”: “string”, “columnValue145”: “string”, “columnValue146”: “string”, “columnValue147”: “string”, “columnValue148”: “string”, “columnValue149”: “string”, “columnValue150”: “string”, “whereColumnValue1”: “string”, “whereColumnValue2”: “string”, “whereColumnValue3”: “string”, “whereColumnValue4”: “string”, “whereColumnValue5”: “string”, “whereColumnValue6”: “string”, “whereColumnValue7”: “string”, “whereColumnValue8”: “string”, “whereColumnValue9”: “string”, “whereColumnValue10”: “string”, “like”: true } |
Response | { “results”: “string” } |
API Name | /pcm/sql-service/create |
Method | POST |
Description | Performs an SQL insert operation to add new records. This API is used to store data into the database. |
Request | { “operator”: “string”, “rowCount”: 0, “days”: true, “seqId”: 0, “distinct”: true, “columnValue1”: “string”, “columnValue2”: “string”, “columnValue3”: “string”, “columnValue4”: “string”, “columnValue5”: “string”, “columnValue6”: “string”, “columnValue7”: “string”, “columnValue8”: “string”, “columnValue9”: “string”, “columnValue10”: “string”, “columnValue11”: “string”, “columnValue12”: “string”, “columnValue13”: “string”, “columnValue14”: “string”, “columnValue15”: “string”, “columnValue16”: “string”, “columnValue17”: “string”, “columnValue18”: “string”, “columnValue19”: “string”, “columnValue20”: “string”, “columnValue21”: “string”, “columnValue22”: “string”, “columnValue23”: “string”, “columnValue24”: “string”, “columnValue25”: “string”, “columnValue26”: “string”, “columnValue27”: “string”, “columnValue28”: “string”, “columnValue29”: “string”, “columnValue30”: “string”, “columnValue31”: “string”, “columnValue32”: “string”, “columnValue33”: “string”, “columnValue34”: “string”, “columnValue35”: “string”, “columnValue36”: “string”, “columnValue37”: “string”, “columnValue38”: “string”, “columnValue39”: “string”, “columnValue40”: “string”, “columnValue41”: “string”, “columnValue42”: “string”, “columnValue43”: “string”, “columnValue44”: “string”, “columnValue45”: “string”, “columnValue46”: “string”, “columnValue47”: “string”, “columnValue48”: “string”, “columnValue49”: “string”, “columnValue50”: “string”, “columnValue51”: “string”, “columnValue52”: “string”, “columnValue53”: “string”, “columnValue54”: “string”, “columnValue55”: “string”, “columnValue56”: “string”, “columnValue57”: “string”, “columnValue58”: “string”, “columnValue59”: “string”, “columnValue60”: “string”, “columnValue61”: “string”, “columnValue62”: “string”, “columnValue63”: “string”, “columnValue64”: “string”, “columnValue65”: “string”, “columnValue66”: “string”, “columnValue67”: “string”, “columnValue68”: “string”, “columnValue69”: “string”, “columnValue70”: “string”, “columnValue71”: “string”, “columnValue72”: “string”, “columnValue73”: “string”, “columnValue74”: “string”, “columnValue75”: “string”, “columnValue76”: “string”, “columnValue77”: “string”, “columnValue78”: “string”, “columnValue79”: “string”, “columnValue80”: “string”, “columnValue81”: “string”, “columnValue82”: “string”, “columnValue83”: “string”, “columnValue84”: “string”, “columnValue85”: “string”, “columnValue86”: “string”, “columnValue87”: “string”, “columnValue88”: “string”, “columnValue89”: “string”, “columnValue90”: “string”, “columnValue91”: “string”, “columnValue92”: “string”, “columnValue93”: “string”, “columnValue94”: “string”, “columnValue95”: “string”, “columnValue96”: “string”, “columnValue97”: “string”, “columnValue98”: “string”, “columnValue99”: “string”, “columnValue100”: “string”, “columnValue101”: “string”, “columnValue102”: “string”, “columnValue103”: “string”, “columnValue104”: “string”, “columnValue105”: “string”, “columnValue106”: “string”, “columnValue107”: “string”, “columnValue108”: “string”, “columnValue109”: “string”, “columnValue110”: “string”, “columnValue111”: “string”, “columnValue112”: “string”, “columnValue113”: “string”, “columnValue114”: “string”, “columnValue115”: “string”, “columnValue116”: “string”, “columnValue117”: “string”, “columnValue118”: “string”, “columnValue119”: “string”, “columnValue120”: “string”, “columnValue121”: “string”, “columnValue122”: “string”, “columnValue123”: “string”, “columnValue124”: “string”, “columnValue125”: “string”, “columnValue126”: “string”, “columnValue127”: “string”, “columnValue128”: “string”, “columnValue129”: “string”, “columnValue130”: “string”, “columnValue131”: “string”, “columnValue132”: “string”, “columnValue133”: “string”, “columnValue134”: “string”, “columnValue135”: “string”, “columnValue136”: “string”, “columnValue137”: “string”, “columnValue138”: “string”, “columnValue139”: “string”, “columnValue140”: “string”, “columnValue141”: “string”, “columnValue142”: “string”, “columnValue143”: “string”, “columnValue144”: “string”, “columnValue145”: “string”, “columnValue146”: “string”, “columnValue147”: “string”, “columnValue148”: “string”, “columnValue149”: “string”, “columnValue150”: “string”, “whereColumnValue1”: “string”, “whereColumnValue2”: “string”, “whereColumnValue3”: “string”, “whereColumnValue4”: “string”, “whereColumnValue5”: “string”, “whereColumnValue6”: “string”, “whereColumnValue7”: “string”, “whereColumnValue8”: “string”, “whereColumnValue9”: “string”, “whereColumnValue10”: “string”, “like”: true } |
Response | { “results”: “string” } |
API Name | /pcm/sql-service/create-datatype |
Method | POST |
Description | Performs an SQL insert operation with specified data types. This API is used to add new records to the database while ensuring correct data type handling. |
Request | { “operator”: “string”, “rowCount”: 0, “days”: true, “seqId”: 0, “distinct”: true, “columnValue1”: “string”, “columnValue2”: “string”, “columnValue3”: “string”, “columnValue4”: “string”, “columnValue5”: “string”, “columnValue6”: “string”, “columnValue7”: “string”, “columnValue8”: “string”, “columnValue9”: “string”, “columnValue10”: “string”, “columnValue11”: “string”, “columnValue12”: “string”, “columnValue13”: “string”, “columnValue14”: “string”, “columnValue15”: “string”, “columnValue16”: “string”, “columnValue17”: “string”, “columnValue18”: “string”, “columnValue19”: “string”, “columnValue20”: “string”, “columnValue21”: “string”, “columnValue22”: “string”, “columnValue23”: “string”, “columnValue24”: “string”, “columnValue25”: “string”, “columnValue26”: “string”, “columnValue27”: “string”, “columnValue28”: “string”, “columnValue29”: “string”, “columnValue30”: “string”, “columnValue31”: “string”, “columnValue32”: “string”, “columnValue33”: “string”, “columnValue34”: “string”, “columnValue35”: “string”, “columnValue36”: “string”, “columnValue37”: “string”, “columnValue38”: “string”, “columnValue39”: “string”, “columnValue40”: “string”, “columnValue41”: “string”, “columnValue42”: “string”, “columnValue43”: “string”, “columnValue44”: “string”, “columnValue45”: “string”, “columnValue46”: “string”, “columnValue47”: “string”, “columnValue48”: “string”, “columnValue49”: “string”, “columnValue50”: “string”, “columnValue51”: “string”, “columnValue52”: “string”, “columnValue53”: “string”, “columnValue54”: “string”, “columnValue55”: “string”, “columnValue56”: “string”, “columnValue57”: “string”, “columnValue58”: “string”, “columnValue59”: “string”, “columnValue60”: “string”, “columnValue61”: “string”, “columnValue62”: “string”, “columnValue63”: “string”, “columnValue64”: “string”, “columnValue65”: “string”, “columnValue66”: “string”, “columnValue67”: “string”, “columnValue68”: “string”, “columnValue69”: “string”, “columnValue70”: “string”, “columnValue71”: “string”, “columnValue72”: “string”, “columnValue73”: “string”, “columnValue74”: “string”, “columnValue75”: “string”, “columnValue76”: “string”, “columnValue77”: “string”, “columnValue78”: “string”, “columnValue79”: “string”, “columnValue80”: “string”, “columnValue81”: “string”, “columnValue82”: “string”, “columnValue83”: “string”, “columnValue84”: “string”, “columnValue85”: “string”, “columnValue86”: “string”, “columnValue87”: “string”, “columnValue88”: “string”, “columnValue89”: “string”, “columnValue90”: “string”, “columnValue91”: “string”, “columnValue92”: “string”, “columnValue93”: “string”, “columnValue94”: “string”, “columnValue95”: “string”, “columnValue96”: “string”, “columnValue97”: “string”, “columnValue98”: “string”, “columnValue99”: “string”, “columnValue100”: “string”, “columnValue101”: “string”, “columnValue102”: “string”, “columnValue103”: “string”, “columnValue104”: “string”, “columnValue105”: “string”, “columnValue106”: “string”, “columnValue107”: “string”, “columnValue108”: “string”, “columnValue109”: “string”, “columnValue110”: “string”, “columnValue111”: “string”, “columnValue112”: “string”, “columnValue113”: “string”, “columnValue114”: “string”, “columnValue115”: “string”, “columnValue116”: “string”, “columnValue117”: “string”, “columnValue118”: “string”, “columnValue119”: “string”, “columnValue120”: “string”, “columnValue121”: “string”, “columnValue122”: “string”, “columnValue123”: “string”, “columnValue124”: “string”, “columnValue125”: “string”, “columnValue126”: “string”, “columnValue127”: “string”, “columnValue128”: “string”, “columnValue129”: “string”, “columnValue130”: “string”, “columnValue131”: “string”, “columnValue132”: “string”, “columnValue133”: “string”, “columnValue134”: “string”, “columnValue135”: “string”, “columnValue136”: “string”, “columnValue137”: “string”, “columnValue138”: “string”, “columnValue139”: “string”, “columnValue140”: “string”, “columnValue141”: “string”, “columnValue142”: “string”, “columnValue143”: “string”, “columnValue144”: “string”, “columnValue145”: “string”, “columnValue146”: “string”, “columnValue147”: “string”, “columnValue148”: “string”, “columnValue149”: “string”, “columnValue150”: “string”, “whereColumnValue1”: “string”, “whereColumnValue2”: “string”, “whereColumnValue3”: “string”, “whereColumnValue4”: “string”, “whereColumnValue5”: “string”, “whereColumnValue6”: “string”, “whereColumnValue7”: “string”, “whereColumnValue8”: “string”, “whereColumnValue9”: “string”, “whereColumnValue10”: “string”, “like”: true } |
Response | { “results”: “string” } |
API Name | /pcm/sql-service/delete |
Method | DELETE |
Description | Deletes a database object from the system. This API is used to remove unwanted or obsolete database entries. |
Request | { “operator”: “string”, “rowCount”: 0, “days”: true, “seqId”: 0, “distinct”: true, “columnValue1”: “string”, “columnValue2”: “string”, “columnValue3”: “string”, “columnValue4”: “string”, “columnValue5”: “string”, “columnValue6”: “string”, “columnValue7”: “string”, “columnValue8”: “string”, “columnValue9”: “string”, “columnValue10”: “string”, “columnValue11”: “string”, “columnValue12”: “string”, “columnValue13”: “string”, “columnValue14”: “string”, “columnValue15”: “string”, “columnValue16”: “string”, “columnValue17”: “string”, “columnValue18”: “string”, “columnValue19”: “string”, “columnValue20”: “string”, “columnValue21”: “string”, “columnValue22”: “string”, “columnValue23”: “string”, “columnValue24”: “string”, “columnValue25”: “string”, “columnValue26”: “string”, “columnValue27”: “string”, “columnValue28”: “string”, “columnValue29”: “string”, “columnValue30”: “string”, “columnValue31”: “string”, “columnValue32”: “string”, “columnValue33”: “string”, “columnValue34”: “string”, “columnValue35”: “string”, “columnValue36”: “string”, “columnValue37”: “string”, “columnValue38”: “string”, “columnValue39”: “string”, “columnValue40”: “string”, “columnValue41”: “string”, “columnValue42”: “string”, “columnValue43”: “string”, “columnValue44”: “string”, “columnValue45”: “string”, “columnValue46”: “string”, “columnValue47”: “string”, “columnValue48”: “string”, “columnValue49”: “string”, “columnValue50”: “string”, “columnValue51”: “string”, “columnValue52”: “string”, “columnValue53”: “string”, “columnValue54”: “string”, “columnValue55”: “string”, “columnValue56”: “string”, “columnValue57”: “string”, “columnValue58”: “string”, “columnValue59”: “string”, “columnValue60”: “string”, “columnValue61”: “string”, “columnValue62”: “string”, “columnValue63”: “string”, “columnValue64”: “string”, “columnValue65”: “string”, “columnValue66”: “string”, “columnValue67”: “string”, “columnValue68”: “string”, “columnValue69”: “string”, “columnValue70”: “string”, “columnValue71”: “string”, “columnValue72”: “string”, “columnValue73”: “string”, “columnValue74”: “string”, “columnValue75”: “string”, “columnValue76”: “string”, “columnValue77”: “string”, “columnValue78”: “string”, “columnValue79”: “string”, “columnValue80”: “string”, “columnValue81”: “string”, “columnValue82”: “string”, “columnValue83”: “string”, “columnValue84”: “string”, “columnValue85”: “string”, “columnValue86”: “string”, “columnValue87”: “string”, “columnValue88”: “string”, “columnValue89”: “string”, “columnValue90”: “string”, “columnValue91”: “string”, “columnValue92”: “string”, “columnValue93”: “string”, “columnValue94”: “string”, “columnValue95”: “string”, “columnValue96”: “string”, “columnValue97”: “string”, “columnValue98”: “string”, “columnValue99”: “string”, “columnValue100”: “string”, “columnValue101”: “string”, “columnValue102”: “string”, “columnValue103”: “string”, “columnValue104”: “string”, “columnValue105”: “string”, “columnValue106”: “string”, “columnValue107”: “string”, “columnValue108”: “string”, “columnValue109”: “string”, “columnValue110”: “string”, “columnValue111”: “string”, “columnValue112”: “string”, “columnValue113”: “string”, “columnValue114”: “string”, “columnValue115”: “string”, “columnValue116”: “string”, “columnValue117”: “string”, “columnValue118”: “string”, “columnValue119”: “string”, “columnValue120”: “string”, “columnValue121”: “string”, “columnValue122”: “string”, “columnValue123”: “string”, “columnValue124”: “string”, “columnValue125”: “string”, “columnValue126”: “string”, “columnValue127”: “string”, “columnValue128”: “string”, “columnValue129”: “string”, “columnValue130”: “string”, “columnValue131”: “string”, “columnValue132”: “string”, “columnValue133”: “string”, “columnValue134”: “string”, “columnValue135”: “string”, “columnValue136”: “string”, “columnValue137”: “string”, “columnValue138”: “string”, “columnValue139”: “string”, “columnValue140”: “string”, “columnValue141”: “string”, “columnValue142”: “string”, “columnValue143”: “string”, “columnValue144”: “string”, “columnValue145”: “string”, “columnValue146”: “string”, “columnValue147”: “string”, “columnValue148”: “string”, “columnValue149”: “string”, “columnValue150”: “string”, “whereColumnValue1”: “string”, “whereColumnValue2”: “string”, “whereColumnValue3”: “string”, “whereColumnValue4”: “string”, “whereColumnValue5”: “string”, “whereColumnValue6”: “string”, “whereColumnValue7”: “string”, “whereColumnValue8”: “string”, “whereColumnValue9”: “string”, “whereColumnValue10”: “string”, “like”: true } |
Response | { “results”: “string” } |
API Name | /pcm/sfg/rct |
Method | PUT |
Description | Updates an existing routing channel template. This API is used to modify configurations for routing channel operations. |
Request | { “pkId”: “string”, “templateName”: “string”, “consumerIdentification”: “string”, “bpName”: “string”, “processDataElementName”: “string”, “specialCharacterHandling”: “string”, “producerMailboxPath”: “string”, “groupPermissions”: { “producerGroupNameList”: [ { “groupName”: “string” } ], “consumerGroupNameList”: [ { “groupName”: “string” } ] }, “provisioningFactList”: [ { “factName”: “string”, “displayLabel”: “string”, “description”: “string” } ], “producerFileStructureList”: [ { “producerFileStructureLayerList”: [ { “producerLayerName”: “string”, “fileNamePattern”: “string”, “fileNamePatternGroupFactNames”: “string” } ] } ], “deliveryChannelTemplateList”: [ { “consumerMailboxPath”: “string”, “createMailboxAtRuntime”: true, “mailboxOrProtocol”: true, “consumerFileStructureModelList”: [ { “consumerLayerName”: “string”, “fileNameFormat”: “string”, “encryptionRequired”: true, “signatureRequired”: true } ] } ] } |
Response | { “errorCode”: 0, “errorDescription”: “string” } |
API Name | /pcm/sfg/rct |
Method | POST |
Description | Creates a new routing channel template. This API is used to define and configure templates for routing channel operations. |
Request | { “pkId”: “string”, “templateName”: “string”, “consumerIdentification”: “string”, “bpName”: “string”, “processDataElementName”: “string”, “specialCharacterHandling”: “string”, “producerMailboxPath”: “string”, “groupPermissions”: { “producerGroupNameList”: [ { “groupName”: “string” } ], “consumerGroupNameList”: [ { “groupName”: “string” } ] }, “provisioningFactList”: [ { “factName”: “string”, “displayLabel”: “string”, “description”: “string” } ], “producerFileStructureList”: [ { “producerFileStructureLayerList”: [ { “producerLayerName”: “string”, “fileNamePattern”: “string”, “fileNamePatternGroupFactNames”: “string” } ] } ], “deliveryChannelTemplateList”: [ { “consumerMailboxPath”: “string”, “createMailboxAtRuntime”: true, “mailboxOrProtocol”: true, “consumerFileStructureModelList”: [ { “consumerLayerName”: “string”, “fileNameFormat”: “string”, “encryptionRequired”: true, “signatureRequired”: true } ] } ] } |
Response | { “errorCode”: 0, “errorDescription”: “string” } |
API Name | /pcm/sfg/rct/{templateName} |
Method | GET |
Description | Retrieves the routing channel template for the specified templateName. This API is used to view configurations of routing channel templates. |
Request | Parameter |
Response | { “pkId”: “string”, “templateName”: “string”, “consumerIdentification”: “string”, “bpName”: “string”, “processDataElementName”: “string”, “specialCharacterHandling”: “string”, “producerMailboxPath”: “string”, “groupPermissions”: { “producerGroupNameList”: [ { “groupName”: “string” } ], “consumerGroupNameList”: [ { “groupName”: “string” } ] }, “provisioningFactList”: [ { “factName”: “string”, “displayLabel”: “string”, “description”: “string” } ], “producerFileStructureList”: [ { “producerFileStructureLayerList”: [ { “producerLayerName”: “string”, “fileNamePattern”: “string”, “fileNamePatternGroupFactNames”: “string” } ] } ], “deliveryChannelTemplateList”: [ { “consumerMailboxPath”: “string”, “createMailboxAtRuntime”: true, “mailboxOrProtocol”: true, “consumerFileStructureModelList”: [ { “consumerLayerName”: “string”, “fileNameFormat”: “string”, “encryptionRequired”: true, “signatureRequired”: true } ] } ] } |
API Name | /pcm/sfg/rct/{templateName} |
Method | DELETE |
Description | Deletes the routing channel template identified by templateName. This API is used to remove template configurations for routing channels. |
Request | Parameter |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/rule |
Method | GET |
Description | Retrieves the list of all rules in the system. This API is used to view and manage existing rule configurations. |
Request | No Parameters |
Response | [ { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName_1”: “string”, “propertyName_2”: “string”, “propertyName_3”: “string”, “propertyName_4”: “string”, “propertyName_5”: “string”, “propertyName_6”: “string”, “propertyName_7”: “string”, “propertyName_8”: “string”, “propertyName_9”: “string”, “propertyName_10”: “string”, “propertyName_11”: “string”, “propertyName_12”: “string”, “propertyName_13”: “string”, “propertyName_14”: “string”, “propertyName_15”: “string”, “propertyName_16”: “string”, “propertyName_17”: “string”, “propertyName_18”: “string”, “propertyName_19”: “string”, “propertyName_20”: “string”, “propertyName_21”: “string”, “propertyName_22”: “string”, “propertyName_23”: “string”, “propertyName_24”: “string”, “propertyName_25”: “string” } ] |
API Name | /pcm/rule |
Method | PUT |
Description | Updates an existing rule in the system. This API is used to modify rule configurations for processing or validation purposes. |
Request | No parameters Request Body { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName1”: “string”, “propertyName2”: “string”, “propertyName3”: “string”, “propertyName4”: “string”, “propertyName5”: “string”, “propertyName6”: “string”, “propertyName7”: “string”, “propertyName8”: “string”, “propertyName9”: “string”, “propertyName10”: “string”, “propertyName11”: “string”, “propertyName12”: “string”, “propertyName13”: “string”, “propertyName14”: “string”, “propertyName15”: “string”, “propertyName16”: “string”, “propertyName17”: “string”, “propertyName18”: “string”, “propertyName19”: “string”, “propertyName20”: “string”, “propertyName21”: “string”, “propertyName22”: “string”, “propertyName23”: “string”, “propertyName24”: “string”, “propertyName25”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/rule |
Method | POST |
Description | Creates a new rule in the system. This API is used to define and configure rules for processing or validation purposes. |
Request | No Parameters Request Body { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName1”: “string”, “propertyName2”: “string”, “propertyName3”: “string”, “propertyName4”: “string”, “propertyName5”: “string”, “propertyName6”: “string”, “propertyName7”: “string”, “propertyName8”: “string”, “propertyName9”: “string”, “propertyName10”: “string”, “propertyName11”: “string”, “propertyName12”: “string”, “propertyName13”: “string”, “propertyName14”: “string”, “propertyName15”: “string”, “propertyName16”: “string”, “propertyName17”: “string”, “propertyName18”: “string”, “propertyName19”: “string”, “propertyName20”: “string”, “propertyName21”: “string”, “propertyName22”: “string”, “propertyName23”: “string”, “propertyName24”: “string”, “propertyName25”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/rule/search |
Method | POST |
Description | Searches for rules based on specified criteria. This API is used to locate and manage rules within the system. |
Request | Parameters { “pageable”: { “page”: 0, “size”: 1, “sort”: [ “string” ] } } Request Body { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName1”: “string”, “propertyName2”: “string”, “propertyName3”: “string”, “propertyName4”: “string”, “propertyName5”: “string”, “propertyName6”: “string”, “propertyName7”: “string”, “propertyName8”: “string”, “propertyName9”: “string”, “propertyName10”: “string”, “propertyName11”: “string”, “propertyName12”: “string”, “propertyName13”: “string”, “propertyName14”: “string”, “propertyName15”: “string”, “propertyName16”: “string”, “propertyName17”: “string”, “propertyName18”: “string”, “propertyName19”: “string”, “propertyName20”: “string”, “propertyName21”: “string”, “propertyName22”: “string”, “propertyName23”: “string”, “propertyName24”: “string”, “propertyName25”: “string” } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName_1”: “string”, “propertyName_2”: “string”, “propertyName_3”: “string”, “propertyName_4”: “string”, “propertyName_5”: “string”, “propertyName_6”: “string”, “propertyName_7”: “string”, “propertyName_8”: “string”, “propertyName_9”: “string”, “propertyName_10”: “string”, “propertyName_11”: “string”, “propertyName_12”: “string”, “propertyName_13”: “string”, “propertyName_14”: “string”, “propertyName_15”: “string”, “propertyName_16”: “string”, “propertyName_17”: “string”, “propertyName_18”: “string”, “propertyName_19”: “string”, “propertyName_20”: “string”, “propertyName_21”: “string”, “propertyName_22”: “string”, “propertyName_23”: “string”, “propertyName_24”: “string”, “propertyName_25”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/rule/rules-models |
Method | POST |
Description | Get Rules (Models) |
Request | No Parameters |
Response | [ { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName1”: “string”, “propertyName2”: “string”, “propertyName3”: “string”, “propertyName4”: “string”, “propertyName5”: “string”, “propertyName6”: “string”, “propertyName7”: “string”, “propertyName8”: “string”, “propertyName9”: “string”, “propertyName10”: “string”, “propertyName11”: “string”, “propertyName12”: “string”, “propertyName13”: “string”, “propertyName14”: “string”, “propertyName15”: “string”, “propertyName16”: “string”, “propertyName17”: “string”, “propertyName18”: “string”, “propertyName19”: “string”, “propertyName20”: “string”, “propertyName21”: “string”, “propertyName22”: “string”, “propertyName23”: “string”, “propertyName24”: “string”, “propertyName25”: “string” } ] |
API Name | /pcm/rule/{ruleId} |
Method | POST |
Description | Get Rules Activity |
Request | Parameters { “ruleId”: “string”, “pageable”: { “page”: 0, “size”: 1, “sort”: [ “string” ] } } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “ruleRefId”: “string”, “ruleName”: “string”, “userId”: “string”, “activity”: “string”, “activityDt”: “2025-09-22T17:23:12.755Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } , “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/rule/{ruleId} |
Method | GET |
Description | Get Rule |
Request | Parameters { “ruleId”: “string” } |
Response | { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName1”: “string”, “propertyName2”: “string”, “propertyName3”: “string”, “propertyName4”: “string”, “propertyName5”: “string”, “propertyName6”: “string”, “propertyName7”: “string”, “propertyName8”: “string”, “propertyName9”: “string”, “propertyName10”: “string”, “propertyName11”: “string”, “propertyName12”: “string”, “propertyName13”: “string”, “propertyName14”: “string”, “propertyName15”: “string”, “propertyName16”: “string”, “propertyName17”: “string”, “propertyName18”: “string”, “propertyName19”: “string”, “propertyName20”: “string”, “propertyName21”: “string”, “propertyName22”: “string”, “propertyName23”: “string”, “propertyName24”: “string”, “propertyName25”: “string” } |
API Name | /pcm/rule/{ruleId} |
Method | DELETE |
Description | Delete Rule |
Request | Parameters { “ruleId”:”string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/reprocess |
Method | PUT |
Description | Reprocesses a specified file in the system. This API is used to retry or correct file processing operations. |
Request | Parameters { “seqId”: Integer, “coreBpId”: Integer, “isArchive”:boolean } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/pickup-now |
Method | PUT |
Description | Immediately picks up a specified file for processing. This API is used to trigger instant file retrieval and handling. |
Request | Parameters { “seqId”: Integer, “pickupBpId”: Integer, } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/drop-again |
Method | PUT |
Description | Re-initiates the drop of a specified file. This API is used to retry file transfer or submission operations. |
Request | Parameters { “seqId”: Integer, “DeliveryBpId”: Integer, } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reprocess/archive-reprocess |
Method | PUT |
Description | Reprocesses archived files in the system. This API is used to retry processing of files that have been previously archived. |
Request | Parameters { “seqId”: Integer, “coreBpId”: Integer, } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/upload-file |
Method | POST |
Description | Uploads a file to the system. This API is used to add new files for processing or storage. |
Request | Parameters { “seqId”: Integer, “type”: “string”, } Request Body : Multipart/form-data |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/search |
Method | POST |
Description | Searches file transfer records based on specified criteria. This API is used to locate and review file transfer activities in the system. |
Request | Parameters { “pageable”: { “page”: 0, “size”: 1, “sort”: [ “string” ] } } Request Body { “dateRangeStart”: “string”, “dateRangeEnd”: “string”, “flowInOut”: “string”, “typeOfTransfer”: “string”, “doctype”: “string”, “status”: “string”, “srcProtocol”: “string”, “destProtocol”: “string”, “partner”: “string”, “application”: “string”, “senderId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “errorStatus”: “string”, “srcFileName”: “string”, “destFileName”: “string”, “coreBpId”: “string”, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string”, “correlationValue26”: “string”, “correlationValue27”: “string”, “correlationValue28”: “string”, “correlationValue29”: “string”, “correlationValue30”: “string”, “correlationValue31”: “string”, “correlationValue32”: “string”, “correlationValue33”: “string”, “correlationValue34”: “string”, “correlationValue35”: “string”, “correlationValue36”: “string”, “correlationValue37”: “string”, “correlationValue38”: “string”, “correlationValue39”: “string”, “correlationValue40”: “string”, “correlationValue41”: “string”, “correlationValue42”: “string”, “correlationValue43”: “string”, “correlationValue44”: “string”, “correlationValue45”: “string”, “correlationValue46”: “string”, “correlationValue47”: “string”, “correlationValue48”: “string”, “correlationValue49”: “string”, “correlationValue50”: “string”, “fileNameRegExpression”: “string”, “mailbox”: “string”, “processData”: “string”, “staging”: true } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “seqid”: 0, “filearrived”: “2025-09-22T16:52:15.502Z”, “flowinout”: “string”, “typeoftransfer”: “string”, “senderid”: “string”, “reciverid”: “string”, “application”: “string”, “appintstatus”: “string”, “partnerackstatus”: “string”, “srcprotocol”: “string”, “srcfilename”: “string”, “srcarcfileloc”: “string”, “destfilename”: “string”, “destarcfileloc”: “string”, “destprotocol”: “string”, “doctype”: “string”, “pickbpid”: “string”, “corebpid”: “string”, “deliverybpid”: “string”, “status”: “string”, “errorstatus”: “string”, “adverrorstatus”: “string”, “partner”: “string”, “doctrans”: “string”, “encType”: “string”, “srcFileSize”: 0, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string”, “correlationValue26”: “string”, “correlationValue27”: “string”, “correlationValue28”: “string”, “correlationValue29”: “string”, “correlationValue30”: “string”, “correlationValue31”: “string”, “correlationValue32”: “string”, “correlationValue33”: “string”, “correlationValue34”: “string”, “correlationValue35”: “string”, “correlationValue36”: “string”, “correlationValue37”: “string”, “correlationValue38”: “string”, “correlationValue39”: “string”, “correlationValue40”: “string”, “correlationValue41”: “string”, “correlationValue42”: “string”, “correlationValue43”: “string”, “correlationValue44”: “string”, “correlationValue45”: “string”, “correlationValue46”: “string”, “correlationValue47”: “string”, “correlationValue48”: “string”, “correlationValue49”: “string”, “correlationValue50”: “string”, “transfile”: “string”, “statusComments”: “string”, “isEncrypted”: “string”, “xrefName”: “string”, “processData”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/reports/overdue |
Method | POST |
Description | Retrieves reports of overdue files or transactions. This API is used to monitor and track items that have missed their expected processing timelines. |
Request | Parameters { “pageable”: { “page”: 0, “size”: 1, “sort”: [ “string” ] } } Request Body { “dateRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “docTrans”: “string”, “destFileName”: “string”, “status”: “string”, “senderId”: “string”, “receiverId”: “string”, “groupCount”: “string” } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “rowNum”: 0, “value”: “string”, “fileArrived”: “string”, “destFileName”: “string”, “partner”: “string”, “docTrans”: “string”, “senderId”: “string”, “receiverId”: “string”, “wfId”: “string”, “groupCount”: “string”, “overdue”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/reports/multi-reprocess |
Method | POST |
Description | Reprocesses multiple files in a single request. This API is used to retry or correct file processing for bulk operations. |
Request | No Parameters Request Body { “content”: [ { “key”: “string”, “value”: “string” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/file/status-change |
Method | POST |
Description | Updates the status of a specified file. This API is used to modify file states for processing or tracking purposes. |
Request | No Parameters Request Body { “seqId”: “string”, “coreBpId”: “string”, “oldStatus”: “string”, “newStatus”: “string”, “customMessage”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/data-insertion-without-correlation |
Method | POST |
Description | Inserts data into the system without correlation information. This API is used to add independent data entries without linking them to other records. |
Request | Parameters { “dataSize”: Integer } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/data-insertion-with-correlation |
Method | POST |
Description | Inserts data into the system with correlation information. This API is used to maintain relationships between related data entries during insertion. |
Request | Parameters { “dataSize” : Integer } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/view-file |
Method | GET |
Description | Loads a transfer file and returns its content as a string. This API is used to view file contents without downloading the file. |
Request | Parameters { “seqId”: Integer, “type”: “string”, } |
Response | string |
API Name | /pcm/reports/transaction-volume |
Method | GET |
Description | Retrieves report data based on transaction volumes. This API is used to analyze and monitor the number of transactions processed in the system. |
Request | { “start”: “string”, “end”: “string”, } |
Response | { “docTransVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “statusVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “flowInOutVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “docTypeVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “partnerVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 } } |
API Name | /pcm/reports/stream/download |
Method | GET |
Description | Downloads files as a data stream from the system. This API is used to retrieve large or continuous file data efficiently. |
Request | { “seqId”: Integer, “type”: “string”, } |
Response | unAuthorized Request |
API Name | /pcm/reports/search/transaction/workflow-d |
Method | GET |
Description | Searches transactions based on a specific workflow ID. This API is used to track and monitor transactions associated with a given workflow. |
Request | Parameters { “workflowId”: “string” } |
Response | { “seqid”: 0, “filearrived”: “2025-09-22T17:04:46.533Z”, “flowinout”: “string”, “typeoftransfer”: “string”, “senderid”: “string”, “reciverid”: “string”, “application”: “string”, “appintstatus”: “string”, “partnerackstatus”: “string”, “srcprotocol”: “string”, “srcfilename”: “string”, “srcarcfileloc”: “string”, “destfilename”: “string”, “destarcfileloc”: “string”, “destprotocol”: “string”, “doctype”: “string”, “pickbpid”: “string”, “corebpid”: “string”, “deliverybpid”: “string”, “status”: “string”, “errorstatus”: “string”, “adverrorstatus”: “string”, “partner”: “string”, “doctrans”: “string”, “encType”: “string”, “srcFileSize”: 0, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string”, “correlationValue26”: “string”, “correlationValue27”: “string”, “correlationValue28”: “string”, “correlationValue29”: “string”, “correlationValue30”: “string”, “correlationValue31”: “string”, “correlationValue32”: “string”, “correlationValue33”: “string”, “correlationValue34”: “string”, “correlationValue35”: “string”, “correlationValue36”: “string”, “correlationValue37”: “string”, “correlationValue38”: “string”, “correlationValue39”: “string”, “correlationValue40”: “string”, “correlationValue41”: “string”, “correlationValue42”: “string”, “correlationValue43”: “string”, “correlationValue44”: “string”, “correlationValue45”: “string”, “correlationValue46”: “string”, “correlationValue47”: “string”, “correlationValue48”: “string”, “correlationValue49”: “string”, “correlationValue50”: “string”, “transfile”: “string”, “statusComments”: “string”, “isEncrypted”: “string”, “xrefName”: “string”, “processData”: “string” } |
API Name | /pcm/reports/partner-volume |
Method | GET |
Description | Retrieves report data showing file volume per partner. This API is used to analyze and monitor partner-specific file transfer activity. |
Request | Parameters { “start”: “string”, “end”: “string”, } |
Response | { “docTransVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “statusVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “flowInOutVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “docTypeVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “partnerVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 } } |
API Name | /pcm/reports/download-file |
Method | GET |
Description | Downloads files from transfer operations. This API is used to retrieve transferred files for review or processing. |
Request | Parameters { “seqId”: Integer, “type”: “string”, } |
Response | Media type: application/octet-stream string |
API Name | /pcm/reports/doctype-volume |
Method | GET |
Description | Retrieves report data based on document type volumes. This API is used to analyze and monitor the volume of files processed per document type. |
Request | Parameters { “start”: “string”, “end”: “string”, } |
Response | { “docTransVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “statusVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “flowInOutVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “docTypeVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 }, “partnerVolume”: { “additionalProp1”: 0, “additionalProp2”: 0, “additionalProp3”: 0 } } |
API Name | /pcm/reports/activity |
Method | GET |
Description | Retrieves transfer file activity details. This API is used to monitor and track file transfer operations in the system. |
Request | Parameters { “seqId”: Integer, “bpId”: “string”, } |
Response | [ { “pkId”: 0, “bpid”: “string”, “bpname”: “string”, “rulename”: “string”, “details”: “string”, “sequence”: 0, “activityDt”: “2025-09-22T17:11:21.744Z”, “activityBy”: “string”, “actName”: “string” } ] |
API Name | /pcm/reports/activity/download-file |
Method | Transaction Activity Report Error File Download |
Description | Downloads error files from the Transaction Activity Report. This API is used to retrieve and review failed transaction details for analysis. |
Request | Parameters { “filePath”: “string” } |
Response | Unauthorized request Media type: application/octet-stream string |
API Name | /pcm/partner/mq |
Method | PUT |
Description | Updates an existing MQ partner profile. This API is used to modify message queue configurations for partners. |
Request | No Parameters Request Body { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mq |
Method | POST |
Description | Create MQ Profile |
Request | No Parameters Request Body { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mq/saveAll |
Method | POST |
Description | Creates one or more MQ partner profiles in a single request. This API is used to onboard partners with message queue configurations efficiently. |
Request | No Parameters Request Body [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mq/{pkId} |
Method | GET |
Description | Retrieves the MQ partner profile for the specified pkId. This API is used to view message queue configurations for partners. |
Request | Parameters { “pkId”: “string” } |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } |
API Name | /pcm/partner/mq/{pkId} |
Method | DELETE |
Description | Deletes the MQ partner profile identified by pkId. This API is used to remove message queue configurations for partners. |
Request | Parameters { “pkId”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/mq/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | Retrieves MQ partner profiles based on profileId and protocol. This API is used to view and manage message queue configurations for partners. |
Request | Parameters { “profileId”: “string”, “protocol”: “string” } |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hostName”: “string”, “port”: “string”, “fileType”: “string”, “queueManager”: “string”, “queueName”: “string”, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “userId”: “string”, “password”: “string”, “channelName”: “string”, “like”: true } ] |
API Name | /pcm/partner/customprotocol |
Method | PUT |
Description | Updates an existing custom protocol partner profile. This API is used to modify partner configurations that use custom protocols. |
Request | Parameters Request Body { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “appendSuffixToUsername”: true, “asciiArmor”: true, “authenticationHost”: “string”, “authenticationType”: “string”, “authorizedUserKeyName”: “string”, “city”: “string”, “code”: “string”, “community”: “string”, “consumerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “remoteDisposition”: “string”, “remoteFileName”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “consumerFtpConfiguration”: { “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “username”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificates”: “string”, “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “consumerSshConfiguration”: { “remoteProfile”: “string” }, “consumerWsConfiguration”: { “destinationAgentName”: “string”, “destinationAgentQueueManager”: “string”, “destinationChecksumMethod”: “string”, “destinationDirSetOrSpace”: “string”, “destinationFileAlreadyExists”: “string”, “destinationType”: “string”, “jobName”: “string”, “metadata”: “string”, “postAntProperties”: “string”, “postAntTargets”: “string”, “postCommand”: “string”, “postCommandType”: “string”, “postExecArgs”: “string”, “postRetryCount”: 0, “postRetryWait”: 0, “postReturnCode”: “string”, “preAntProperties”: “string”, “preAntTargets”: “string”, “preCommand”: “string”, “preCommandType”: “string”, “preExecArgs”: “string”, “preRetryCount”: 0, “preRetryWait”: 0, “preReturnCode”: “string”, “priority”: 0, “queueManager”: “string”, “replyQueue”: “string”, “sourceAgentAdapter”: “string”, “transferMode”: “string” }, “countryOrRegion”: “string”, “customProtocolExtensions”: “string”, “customProtocolName”: “string”, “doesRequireCompressedData”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “doesUseSSH”: true, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “keyEnabled”: true, “mailbox”: “string”, “password”: “string”, “passwordPolicy”: “string”, “pollingInterval”: 0, “postalCode”: “string”, “producerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “operatingSystem”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “directory”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “username”: “string” }, “producerFtpsConfiguration”: { “caCertificates”: “string”, “connectionType”: “string”, “directory”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “producerSshConfiguration”: { “remoteProfile”: “string” }, “publicKeyID”: “string”, “remoteFilePattern”: “string”, “sessionTimeout”: 0, “stateOrProvince”: “string”, “surname”: “string”, “textMode”: true, “timeZone”: “string”, “useGlobalMailbox”: true, “username”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/customprotocol |
Method | POST |
Description | Creates a new custom protocol partner profile. This API is used to onboard partners with specific custom protocol configurations. |
Request | Parameters Request Body { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “appendSuffixToUsername”: true, “asciiArmor”: true, “authenticationHost”: “string”, “authenticationType”: “string”, “authorizedUserKeyName”: “string”, “city”: “string”, “code”: “string”, “community”: “string”, “consumerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “remoteDisposition”: “string”, “remoteFileName”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “consumerFtpConfiguration”: { “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “username”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificates”: “string”, “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “consumerSshConfiguration”: { “remoteProfile”: “string” }, “consumerWsConfiguration”: { “destinationAgentName”: “string”, “destinationAgentQueueManager”: “string”, “destinationChecksumMethod”: “string”, “destinationDirSetOrSpace”: “string”, “destinationFileAlreadyExists”: “string”, “destinationType”: “string”, “jobName”: “string”, “metadata”: “string”, “postAntProperties”: “string”, “postAntTargets”: “string”, “postCommand”: “string”, “postCommandType”: “string”, “postExecArgs”: “string”, “postRetryCount”: 0, “postRetryWait”: 0, “postReturnCode”: “string”, “preAntProperties”: “string”, “preAntTargets”: “string”, “preCommand”: “string”, “preCommandType”: “string”, “preExecArgs”: “string”, “preRetryCount”: 0, “preRetryWait”: 0, “preReturnCode”: “string”, “priority”: 0, “queueManager”: “string”, “replyQueue”: “string”, “sourceAgentAdapter”: “string”, “transferMode”: “string” }, “countryOrRegion”: “string”, “customProtocolExtensions”: “string”, “customProtocolName”: “string”, “doesRequireCompressedData”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “doesUseSSH”: true, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “keyEnabled”: true, “mailbox”: “string”, “password”: “string”, “passwordPolicy”: “string”, “pollingInterval”: 0, “postalCode”: “string”, “producerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “operatingSystem”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “directory”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “username”: “string” }, “producerFtpsConfiguration”: { “caCertificates”: “string”, “connectionType”: “string”, “directory”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “producerSshConfiguration”: { “remoteProfile”: “string” }, “publicKeyID”: “string”, “remoteFilePattern”: “string”, “sessionTimeout”: 0, “stateOrProvince”: “string”, “surname”: “string”, “textMode”: true, “timeZone”: “string”, “useGlobalMailbox”: true, “username”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/customprotocol/saveAll |
Method | POST |
Description | Creates one or more custom protocol partner profiles in a single request. This API is used to onboard partners with custom protocol configurations efficiently. |
Request | Parameters Request Body [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “appendSuffixToUsername”: true, “asciiArmor”: true, “authenticationHost”: “string”, “authenticationType”: “string”, “authorizedUserKeyName”: “string”, “city”: “string”, “code”: “string”, “community”: “string”, “consumerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “remoteDisposition”: “string”, “remoteFileName”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “consumerFtpConfiguration”: { “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “username”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificates”: “string”, “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “consumerSshConfiguration”: { “remoteProfile”: “string” }, “consumerWsConfiguration”: { “destinationAgentName”: “string”, “destinationAgentQueueManager”: “string”, “destinationChecksumMethod”: “string”, “destinationDirSetOrSpace”: “string”, “destinationFileAlreadyExists”: “string”, “destinationType”: “string”, “jobName”: “string”, “metadata”: “string”, “postAntProperties”: “string”, “postAntTargets”: “string”, “postCommand”: “string”, “postCommandType”: “string”, “postExecArgs”: “string”, “postRetryCount”: 0, “postRetryWait”: 0, “postReturnCode”: “string”, “preAntProperties”: “string”, “preAntTargets”: “string”, “preCommand”: “string”, “preCommandType”: “string”, “preExecArgs”: “string”, “preRetryCount”: 0, “preRetryWait”: 0, “preReturnCode”: “string”, “priority”: 0, “queueManager”: “string”, “replyQueue”: “string”, “sourceAgentAdapter”: “string”, “transferMode”: “string” }, “countryOrRegion”: “string”, “customProtocolExtensions”: “string”, “customProtocolName”: “string”, “doesRequireCompressedData”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “doesUseSSH”: true, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “keyEnabled”: true, “mailbox”: “string”, “password”: “string”, “passwordPolicy”: “string”, “pollingInterval”: 0, “postalCode”: “string”, “producerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “operatingSystem”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “directory”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “username”: “string” }, “producerFtpsConfiguration”: { “caCertificates”: “string”, “connectionType”: “string”, “directory”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “producerSshConfiguration”: { “remoteProfile”: “string” }, “publicKeyID”: “string”, “remoteFilePattern”: “string”, “sessionTimeout”: 0, “stateOrProvince”: “string”, “surname”: “string”, “textMode”: true, “timeZone”: “string”, “useGlobalMailbox”: true, “username”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/customprotocol/{pkId} |
Method | GET |
Description | Retrieves the custom protocol partner profile for the specified pkId. This API is used to view partner configurations using custom protocols. |
Request | Parameters { “pkId”: “string” } |
Response | { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “appendSuffixToUsername”: true, “asciiArmor”: true, “authenticationHost”: “string”, “authenticationType”: “string”, “authorizedUserKeyName”: “string”, “city”: “string”, “code”: “string”, “community”: “string”, “consumerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “remoteDisposition”: “string”, “remoteFileName”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “consumerFtpConfiguration”: { “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “username”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificates”: “string”, “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “consumerSshConfiguration”: { “remoteProfile”: “string” }, “consumerWsConfiguration”: { “destinationAgentName”: “string”, “destinationAgentQueueManager”: “string”, “destinationChecksumMethod”: “string”, “destinationDirSetOrSpace”: “string”, “destinationFileAlreadyExists”: “string”, “destinationType”: “string”, “jobName”: “string”, “metadata”: “string”, “postAntProperties”: “string”, “postAntTargets”: “string”, “postCommand”: “string”, “postCommandType”: “string”, “postExecArgs”: “string”, “postRetryCount”: 0, “postRetryWait”: 0, “postReturnCode”: “string”, “preAntProperties”: “string”, “preAntTargets”: “string”, “preCommand”: “string”, “preCommandType”: “string”, “preExecArgs”: “string”, “preRetryCount”: 0, “preRetryWait”: 0, “preReturnCode”: “string”, “priority”: 0, “queueManager”: “string”, “replyQueue”: “string”, “sourceAgentAdapter”: “string”, “transferMode”: “string” }, “countryOrRegion”: “string”, “customProtocolExtensions”: “string”, “customProtocolName”: “string”, “doesRequireCompressedData”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “doesUseSSH”: true, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “keyEnabled”: true, “mailbox”: “string”, “password”: “string”, “passwordPolicy”: “string”, “pollingInterval”: 0, “postalCode”: “string”, “producerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “operatingSystem”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “directory”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “username”: “string” }, “producerFtpsConfiguration”: { “caCertificates”: “string”, “connectionType”: “string”, “directory”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “producerSshConfiguration”: { “remoteProfile”: “string” }, “publicKeyID”: “string”, “remoteFilePattern”: “string”, “sessionTimeout”: 0, “stateOrProvince”: “string”, “surname”: “string”, “textMode”: true, “timeZone”: “string”, “useGlobalMailbox”: true, “username”: “string”, “like”: true } |
API Name | /pcm/partner/customprotocol/{pkId} |
Method | DELETE |
Description | Deletes the custom protocol partner profile identified by pkId. This API is used to remove partner configurations that use custom protocols. |
Request | Parameters { “pkId” : “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/customprotocol/getAllByProfileId |
Method | GET |
Description | Retrieves custom protocol partner profiles based on profileId. This API is used to view and manage partner configurations using custom protocols. |
Request | Parameters { “profileId”: “string”, “protocol”: “string” } |
Response | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “appendSuffixToUsername”: true, “asciiArmor”: true, “authenticationHost”: “string”, “authenticationType”: “string”, “authorizedUserKeyName”: “string”, “city”: “string”, “code”: “string”, “community”: “string”, “consumerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “remoteDisposition”: “string”, “remoteFileName”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “consumerFtpConfiguration”: { “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “username”: “string” }, “consumerFtpsConfiguration”: { “assignedCaCertificates”: “string”, “baseDirectory”: “string”, “connectionType”: “string”, “controlPortRange”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “localPortRange”: “string”, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “uploadFileUnderTemporaryNameFirst”: true, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “consumerSshConfiguration”: { “remoteProfile”: “string” }, “consumerWsConfiguration”: { “destinationAgentName”: “string”, “destinationAgentQueueManager”: “string”, “destinationChecksumMethod”: “string”, “destinationDirSetOrSpace”: “string”, “destinationFileAlreadyExists”: “string”, “destinationType”: “string”, “jobName”: “string”, “metadata”: “string”, “postAntProperties”: “string”, “postAntTargets”: “string”, “postCommand”: “string”, “postCommandType”: “string”, “postExecArgs”: “string”, “postRetryCount”: 0, “postRetryWait”: 0, “postReturnCode”: “string”, “preAntProperties”: “string”, “preAntTargets”: “string”, “preCommand”: “string”, “preCommandType”: “string”, “preExecArgs”: “string”, “preRetryCount”: 0, “preRetryWait”: 0, “preReturnCode”: “string”, “priority”: 0, “queueManager”: “string”, “replyQueue”: “string”, “sourceAgentAdapter”: “string”, “transferMode”: “string” }, “countryOrRegion”: “string”, “customProtocolExtensions”: “string”, “customProtocolName”: “string”, “doesRequireCompressedData”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “doesUseSSH”: true, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “keyEnabled”: true, “mailbox”: “string”, “password”: “string”, “passwordPolicy”: “string”, “pollingInterval”: 0, “postalCode”: “string”, “producerCdConfiguration”: { “checkpointInterval”: “string”, “localNodeName”: “string”, “localUserId”: “string”, “operatingSystem”: “string”, “remoteNodeName”: “string”, “remotePassword”: “string”, “remoteSysopts”: “string”, “remoteUserId”: “string” }, “producerFtpConfiguration”: { “connectionType”: “string”, “directory”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “username”: “string” }, “producerFtpsConfiguration”: { “caCertificates”: “string”, “connectionType”: “string”, “directory”: “string”, “encryptionStrength”: “string”, “hostname”: “string”, “listenPort”: 0, “numberOfRetries”: 0, “password”: “string”, “retryInterval”: 0, “siteCommand”: “string”, “useCcc”: true, “useImplicitSsl”: true, “username”: “string” }, “producerSshConfiguration”: { “remoteProfile”: “string” }, “publicKeyID”: “string”, “remoteFilePattern”: “string”, “sessionTimeout”: 0, “stateOrProvince”: “string”, “surname”: “string”, “textMode”: true, “timeZone”: “string”, “useGlobalMailbox”: true, “username”: “string”, “like”: true } ] |
API Name | /pcm/group |
Method | GET |
Description | Retrieves the list of group names in the system. This API is used to view and manage existing groups efficiently. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/group |
Method | PUT |
Description | Updates the details of an existing group. This API is used to modify group configurations and associated settings. |
Request | No Parameters Request Body { “pkId”: “string”, “groupName”: “string”, “partnerList”: [ “string” ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/group |
Method | POST |
Description | Creates a new group with the details provided in the request body. Returns the information of the newly created group upon success |
Request | No Parameters Request Body { “pkId”: “string”, “groupName”: “string”, “partnerList”: [ “string” ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/group/search |
Method | POST |
Description | Allows searching for groups based on given criteria. Accepts filters in the request body to return matching group details. |
Request | Parameters Pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] } Request Body { “pkId”: “string”, “groupName”: “string”, “partnerList”: [ “string” ] } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “partnerList”: “string”, “createdDate”: “2025-09-22T16:05:19.535Z”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-22T16:05:19.535Z”, “pk_Id”: “string”, “groupname”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/group/activity/{groupId} |
Method | POST |
Description | Retrieves the activity details of the specified group. This API is used to monitor and review group actions and events. |
Request | Get Group Parameters { “pkId”: “string” } |
Response | { “pkId”: “string”, “groupName”: “string”, “partnerList”: [ “string” ] } |
API Name | /pcm/group/{pkId} |
Method | DELETE |
Description | Deletes the group identified by pkId. This API is used to remove group configurations from the system. |
Request | Parameters Parameters { “pkId”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/ssp/ssp-trust-keystore-update |
Method | PUT |
Description | Updates a key definition in an SSP keystore. This API is used to modify existing cryptographic keys within the keystore. |
Request | Parameter <?xml version=”1.0″ encoding=”UTF-8″?> <elements> <keyDef> <description>string</description> <enabled>string</enabled> <keyData>string</keyData> <keyType>string</keyType> <name>string</name> <forceToUnlock>string</forceToUnlock> <formatVersion>string</formatVersion> <keyDataFormat>string</keyDataFormat> <keyInHSM>string</keyInHSM> <password>string</password> <serialNum>string</serialNum> <validFrom>string</validFrom> <validTo>string</validTo> <verStamp>string</verStamp> <versionNum>string</versionNum> </keyDef> </elements> |
Response |
<?xml version=”1.0″ encoding=”UTF-8″?> <elements> <keyDef> <description>string</description> <enabled>string</enabled> <keyData>string</keyData> <keyType>string</keyType> <name>string</name> <forceToUnlock>string</forceToUnlock> <formatVersion>string</formatVersion> <keyDataFormat>string</keyDataFormat> <keyInHSM>string</keyInHSM> <password>string</password> <serialNum>string</serialNum> <validFrom>string</validFrom> <validTo>string</validTo> <verStamp>string</verStamp> <versionNum>string</versionNum> </keyDef> </elements> |
API Name | /pem/ssp/ssp-node-update |
Method | PUT |
Description | Updates an existing SSP node for FTP, SFTP, HTTP, or CD protocols. This API is used to modify node configurations for data transfer and communication. |
Request | Parameter |
Response |
<?xml version=”1.0″ encoding=”UTF-8″?> <elements> <keyDef> <description>string</description> <enabled>string</enabled> <keyData>string</keyData> <keyType>string</keyType> <name>string</name> <forceToUnlock>string</forceToUnlock> <formatVersion>string</formatVersion> <keyDataFormat>string</keyDataFormat> <keyInHSM>string</keyInHSM> <password>string</password> <serialNum>string</serialNum> <validFrom>string</validFrom> <validTo>string</validTo> <verStamp>string</verStamp> <versionNum>string</versionNum> </keyDef> </elements> |
API Name | /pem/ssp/ssp-trust-keystore |
Method | POST |
Description | Adds a key definition to an SSP keystore. This API is used to manage and update cryptographic keys within the keystore. |
Request | Parameter Request <elements> <keyDef> <description>string</description> <enabled>string</enabled> <keyData>string</keyData> <keyType>string</keyType> <name>string</name> <forceToUnlock>string</forceToUnlock> <formatVersion>string</formatVersion> <keyDataFormat>string</keyDataFormat> <keyInHSM>string</keyInHSM> <password>string</password> <serialNum>string</serialNum> <validFrom>string</validFrom> <validTo>string</validTo> <verStamp>string</verStamp> <versionNum>string</versionNum> </keyDef> </elements> |
Response | XML Response |
API Name | /pem/ssp/ssp-node |
Method | POST |
Description | Creates an SSP node for FTP, SFTP, HTTP, or CD protocols. This API is used to configure and manage nodes for data transfer and communication. |
Request | Parameter NetMapName <?xml version=”1.0″ encoding=”UTF-8″?> <inboundNodes> <inboundNodeDef> <addresses> <address> <host>string</host> <port>0</port> <nodeName>string</nodeName> </address> </addresses> <compression>string</compression> <description>string</description> <destinationServiceName>string</destinationServiceName> <forceToUnlock>string</forceToUnlock> <formatVersion>string</formatVersion> <knownHostKey>string</knownHostKey> <knownHostKeyStore>string</knownHostKeyStore> <logLevel>string</logLevel> <name>string</name> <outboundACLNodes> <outboundACLNode>string</outboundACLNode> </outboundACLNodes> <password>string</password> <preferredCipher>string</preferredCipher> <preferredKeyExchange>string</preferredKeyExchange> <preferredMAC>string</preferredMAC> <peerAddressPattern>string</peerAddressPattern> <remoteClientKey>string</remoteClientKey> <remoteClientKeyStore>string</remoteClientKeyStore> <policyId>string</policyId> <routingName>string</routingName> <routingNode>string</routingNode> <port>0</port> <secureConnection>string</secureConnection> <userId>string</userId> <validDestination>string</validDestination> <validDestinationPort>string</validDestinationPort> <sslInfo> <ccc>string</ccc> <cipherSuites> <cipherSuite>string</cipherSuite> </cipherSuites> <clientAuthentication>string</clientAuthentication> <keyCertName>string</keyCertName> <keyStoreName>string</keyStoreName> <protocol>string</protocol> <trustStoreName>string</trustStoreName> <trustedCertNames> <trustedCertName>string</trustedCertName> </trustedCertNames> <verifyCommonName>string</verifyCommonName> <clientAuthenticationCD>string</clientAuthenticationCD> </sslInfo> <serverAddress>string</serverAddress> <stepInjection>string</stepInjection> <tcpTimeout>0</tcpTimeout> <verStamp>string</verStamp> <sshConfigName>string</sshConfigName> </inboundNodeDef> </inboundNodes> |
Response | XML Response |
API Name | /pem/ssp/ssp-encode-base64 |
Method | POST |
Description | Encodes data into Base64 format in the SSP system. This API is used to securely convert information into an encoded representation. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <input> <pattern>string</pattern> <data> <value>string</value> </data> </input> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <input> <pattern>string</pattern> <data> <value>string</value> </data> </input> |
API Name | /pem/ssp/ssp-decode-base64 |
Method | POST |
Description | Decodes Base64-encoded data to its original format in the SSP system. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <input> <pattern>string</pattern> <data> <value>string</value> </data> </input> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <input> <pattern>string</pattern> <data> <value>string</value> </data> </input> |
API Name | /pem/ssp/ssp-check-node-availability |
Method | POST |
Description | Checks the availability of an SSP node. This API is used to verify if a specific node is active and reachable for operations. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <XmlRequest> <netMap>string</netMap> <nodeName>string</nodeName> </XmlRequest> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityManagerNameModel> <name>string</name> </CommunityManagerNameModel> |
API Name | /pem/ssp/ssp-check-keystore |
Method | POST |
Description | Checks the validity and configuration of a specified SSP keystore. This API is used to verify keystore integrity and accessibility. |
Request | <?xml version=”1.0″ encoding=”UTF-8″?> <XmlRequest> <certificateStore>string</certificateStore> <certName>string</certName> </XmlRequest> |
Response | XML Response |
API Name | /pem/ssp/get-ssp-expiry-cert-info |
Method | POST |
Description | Retrieves the expiry information of SSP certificates. This API is used to monitor and manage certificate validity and renewals. |
Request | Parameter Request <SspExpiryCertInfoModel> <scriptInput>string</scriptInput> </SspExpiryCertInfoModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityMangerModelPemAccountExpiryModel> <content> <userName>string</userName> <certName>string</certName> <profileName>string</profileName> <profileId>string</profileId> <emailId>string</emailId> <pemIdentifier>string</pemIdentifier> <certType>string</certType> <pass>string</pass> <pwdLastUpdatedDate>2025-09-23T11:06:09.170Z</pwdLastUpdatedDate> <protocol>string</protocol> <notAfter>2025-09-23T11:06:09.170Z</notAfter> <notBefore>2025-09-23T11:06:09.170Z</notBefore> <expiresOn>string</expiresOn> <keyName>string</keyName> <createDate>2025-09-23T11:06:09.170Z</createDate> </content> </CommunityMangerModelPemAccountExpiryModel> |
API Name | /pem/ssp/ssp-get-netmap |
Method | GET |
Description | Retrieves details of a specific network map (NetMap) in the SSP system. This API is used to view and manage individual network mapping configurations. |
Request | Parameter |
Response | XML Response |
API Name | /pem/ssp/ssp-get-keystore |
Method | GET |
Description | Retrieves details of a specific keystore in the SSP system. This API is used to view and manage individual keystore configurations. |
Request | Parameter |
Response | XML Response |
API Name | /pem/ssp/ssp-get-all-policies |
Method | GET |
Description | Retrieves all policies in the SSP system. This API is used to view and manage policy configurations. |
Request | No parameters |
Response | XML Response |
API Name | /pem/ssp/ssp-get-all-netmaps |
Method | GET |
Description | Retrieves all network maps (NetMaps) in the SSP system. This API is used to view and manage network mapping configurations. |
Request | No parameter |
Response | XML Response |
API Name | /pem/ssp/ssp-get-all-keystores |
Method | GET |
Description | Retrieves all keystores available in the SSP system. This API is used to view and manage cryptographic keystore information. |
Request | No parameters |
Response | XML Response |
API Name | /pcm/file/scheduler/config |
Method | GET |
Description | Retrieves the File Transfer Scheduler configuration. It provides the current scheduler settings. |
Request | No Parameters |
Response | { “pkId”: “string”, “fileAge”: “string”, “active”: true, “cloudName”: “string”, “s3SchedulerConfig”: { “accessKeyId”: “string”, “secretKeyId”: “string”, “region”: “string”, “bucketName”: “string”, “filesPathDetails”: [ { “sourcePath”: “string”, “destPath”: “string”, “containerName”: “string” } ] }, “azureSchedulerConfig”: { “connectionString”: “string”, “containerName”: “string”, “filesPathDetails”: [ { “sourcePath”: “string”, “destPath”: “string”, “containerName”: “string” } ] } } |
API Name | /pcm/file/scheduler/config |
Method | PUT |
Description | Updates the File Transfer Scheduler configuration. It modifies the scheduler settings. |
Request | No Parameters RequestBody: { “pkId”: “string”, “fileAge”: “string”, “active”: true, “cloudName”: “string”, “s3SchedulerConfig”: { “accessKeyId”: “string”, “secretKeyId”: “string”, “region”: “string”, “bucketName”: “string”, “filesPathDetails”: [ { “sourcePath”: “string”, “destPath”: “string”, “containerName”: “string” } ] }, “azureSchedulerConfig”: { “connectionString”: “string”, “containerName”: “string”, “filesPathDetails”: [ { “sourcePath”: “string”, “destPath”: “string”, “containerName”: “string” } ] } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/file/scheduler/config |
Method | POST |
Description | API creates a new File Transfer Scheduler configuration. It adds scheduler settings for file transfers. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “fileAge”: “string”, “active”: true, “cloudName”: “string”, “s3SchedulerConfig”: { “accessKeyId”: “string”, “secretKeyId”: “string”, “region”: “string”, “bucketName”: “string”, “filesPathDetails”: [ { “sourcePath”: “string”, “destPath”: “string”, “containerName”: “string” } ] }, “azureSchedulerConfig”: { “connectionString”: “string”, “containerName”: “string”, “filesPathDetails”: [ { “sourcePath”: “string”, “destPath”: “string”, “containerName”: “string” } ] } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/envelope |
Method | PUT |
Description | API updates an Envelope resource. It modifies the details of an existing envelope. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “ediProperties”: { “partnerPkId”: “string”, “partnerName”: “string”, “direction”: “string”, “validateInput”: “string”, “validateOutput”: “string”, “useIndicator”: “string” }, “isaSegment”: { “isaSenderIdQal”: “string”, “isaReceiverIdQal”: “string”, “isaSenderId”: “string”, “isaReceiverId”: “string”, “interVersion”: “string”, “globalContNo”: “string”, “invokeBPForIsa”: “string”, “businessProcess”: “string”, “perContNumCheck”: “string”, “perDupNumCheck”: “string”, “isaAcceptLookAlias”: “string” }, “gsSegment”: { “gsSenderId”: “string”, “gsReceiverId”: “string”, “functionalIdCode”: “string”, “respAgencyCode”: “string”, “groupVersion”: “string” }, “inBound”: { “complianceCheck”: “string”, “complianceCheckMap”: “string”, “retainEnv”: “string”, “genInboundAck”: “string”, “ackDetailLevel”: “string” }, “stSegment”: { “stSenderId”: “string”, “stReceiverId”: “string”, “trnSetIdCode”: “string”, “acceptLookAlias”: “string” }, “outBound”: { “segTerm”: “string”, “eleTerm”: “string”, “subEleTerm”: “string”, “releaseCharacter”: “string”, “useCorrelation”: “string”, “dataExtraction”: “string”, “extractionMailBox”: “string”, “extractionMailBoxBp”: “string”, “expectAck”: “string”, “intAckReq”: “string”, “ackOverDueHr”: “string”, “ackOverDueMin”: “string” } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/envelope |
Method | POST |
Description | API creates a new Envelope. It adds a new envelope resource. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “ediProperties”: { “partnerPkId”: “string”, “partnerName”: “string”, “direction”: “string”, “validateInput”: “string”, “validateOutput”: “string”, “useIndicator”: “string” }, “isaSegment”: { “isaSenderIdQal”: “string”, “isaReceiverIdQal”: “string”, “isaSenderId”: “string”, “isaReceiverId”: “string”, “interVersion”: “string”, “globalContNo”: “string”, “invokeBPForIsa”: “string”, “businessProcess”: “string”, “perContNumCheck”: “string”, “perDupNumCheck”: “string”, “isaAcceptLookAlias”: “string” }, “gsSegment”: { “gsSenderId”: “string”, “gsReceiverId”: “string”, “functionalIdCode”: “string”, “respAgencyCode”: “string”, “groupVersion”: “string” }, “inBound”: { “complianceCheck”: “string”, “complianceCheckMap”: “string”, “retainEnv”: “string”, “genInboundAck”: “string”, “ackDetailLevel”: “string” }, “stSegment”: { “stSenderId”: “string”, “stReceiverId”: “string”, “trnSetIdCode”: “string”, “acceptLookAlias”: “string” }, “outBound”: { “segTerm”: “string”, “eleTerm”: “string”, “subEleTerm”: “string”, “releaseCharacter”: “string”, “useCorrelation”: “string”, “dataExtraction”: “string”, “extractionMailBox”: “string”, “extractionMailBoxBp”: “string”, “expectAck”: “string”, “intAckReq”: “string”, “ackOverDueHr”: “string”, “ackOverDueMin”: “string” } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/envelope/search |
Method | POST |
Description | searches for envelope profiles. It returns envelope profiles matching the search criteria. |
Request | Parameters: Pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: { “pkId”: “string”, “ediProperties”: { “partnerPkId”: “string”, “partnerName”: “string”, “direction”: “string”, “validateInput”: “string”, “validateOutput”: “string”, “useIndicator”: “string” }, “isaSegment”: { “isaSenderIdQal”: “string”, “isaReceiverIdQal”: “string”, “isaSenderId”: “string”, “isaReceiverId”: “string”, “interVersion”: “string”, “globalContNo”: “string”, “invokeBPForIsa”: “string”, “businessProcess”: “string”, “perContNumCheck”: “string”, “perDupNumCheck”: “string”, “isaAcceptLookAlias”: “string” }, “gsSegment”: { “gsSenderId”: “string”, “gsReceiverId”: “string”, “functionalIdCode”: “string”, “respAgencyCode”: “string”, “groupVersion”: “string” }, “inBound”: { “complianceCheck”: “string”, “complianceCheckMap”: “string”, “retainEnv”: “string”, “genInboundAck”: “string”, “ackDetailLevel”: “string” }, “stSegment”: { “stSenderId”: “string”, “stReceiverId”: “string”, “trnSetIdCode”: “string”, “acceptLookAlias”: “string” }, “outBound”: { “segTerm”: “string”, “eleTerm”: “string”, “subEleTerm”: “string”, “releaseCharacter”: “string”, “useCorrelation”: “string”, “dataExtraction”: “string”, “extractionMailBox”: “string”, “extractionMailBoxBp”: “string”, “expectAck”: “string”, “intAckReq”: “string”, “ackOverDueHr”: “string”, “ackOverDueMin”: “string” } } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “partnerid”: “string”, “partnername”: “string”, “direction”: “string”, “validateinput”: “string”, “validateoutput”: “string”, “isasenderidqal”: “string”, “isasenderid”: “string”, “isareceiveridqal”: “string”, “isareceiverid”: “string”, “isacontstd”: “string”, “isaauthinfo”: “string”, “isaauthinfoqual”: “string”, “isaauthsecinfo”: “string”, “isaauthsecqual”: “string”, “interversion”: “string”, “useindicator”: “string”, “segterm”: “string”, “subeleterm”: “string”, “eleterm”: “string”, “releasechar”: “string”, “retainenv”: “string”, “limitintersize”: “string”, “gssenderid”: “string”, “gsreceiverid”: “string”, “funcationalidcode”: “string”, “respagencycode”: “string”, “groupversion”: “string”, “stsenderid”: “string”, “streceiverid”: “string”, “geninack”: “string”, “ackdetlevel”: “string”, “trnsetidcode”: “string”, “encodedoc”: “string”, “streamseg”: “string”, “dataextraction”: “string”, “extractionmailbox”: “string”, “batchtransaction”: “string”, “complcheck”: “string”, “complcheckmap”: “string”, “hippacompliance”: “string”, “hippavallevel”: “string”, “businessprocess”: “string”, “invokebpforisa”: “string”, “bpinvokesetinpd”: “string”, “extractionmailboxbp”: “string”, “expectack”: “string”, “intackreq”: “string”, “usecorrelation”: “string”, “acceptlookalias”: “string”, “isaacceptlookalias”: “string”, “errorbp”: “string”, “acceptnoninter”: “string”, “spoutboundencode”: “string”, “ta1alaform”: “string”, “ala999form”: “string”, “globalcontno”: “string”, “accnongroup”: “string”, “ackdetails”: “string”, “edipostmode”: “string”, “errorbpmode”: “string”, “percontnumcheck”: “string”, “perdupnumcheck”: “string”, “invokebpmode”: “string”, “ackoverduehr”: “string”, “ackoverduemin”: “string”, “isaenvelopeid”: “string”, “isaenvelopename”: “string”, “gsenvelopeid”: “string”, “gsenvelopename”: “string”, “stenvelopeid”: “string”, “stenvelopename”: “string”, “lastupdatedby”: “string”, “updatedon”: “2025-09-22T14:46:03.213Z”, “pk_Id”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/envelope/activity/{ediRefId} |
Method | POST |
Description | Retrieves envelope activity. It fetches activity details using the ediRefId path parameter. |
Request | Parameters: { “ediRefId “: “string”, Pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “ediRefId”: “string”, “userName”: “string”, “userId”: “string”, “activity”: “string”, “activityDt”: “2025-09-22T14:48:50.477Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/envelope/{pkId} |
Method | GET |
Description | Retrieves an envelope profile. It fetches profile details using the pkId path parameter. |
Request | Parameters: { “pkId”: “string” } |
Response | { “pkId”: “string”, “ediProperties”: { “partnerPkId”: “string”, “partnerName”: “string”, “direction”: “string”, “validateInput”: “string”, “validateOutput”: “string”, “useIndicator”: “string” }, “isaSegment”: { “isaSenderIdQal”: “string”, “isaReceiverIdQal”: “string”, “isaSenderId”: “string”, “isaReceiverId”: “string”, “interVersion”: “string”, “globalContNo”: “string”, “invokeBPForIsa”: “string”, “businessProcess”: “string”, “perContNumCheck”: “string”, “perDupNumCheck”: “string”, “isaAcceptLookAlias”: “string” }, “gsSegment”: { “gsSenderId”: “string”, “gsReceiverId”: “string”, “functionalIdCode”: “string”, “respAgencyCode”: “string”, “groupVersion”: “string” }, “inBound”: { “complianceCheck”: “string”, “complianceCheckMap”: “string”, “retainEnv”: “string”, “genInboundAck”: “string”, “ackDetailLevel”: “string” }, “stSegment”: { “stSenderId”: “string”, “stReceiverId”: “string”, “trnSetIdCode”: “string”, “acceptLookAlias”: “string” }, “outBound”: { “segTerm”: “string”, “eleTerm”: “string”, “subEleTerm”: “string”, “releaseCharacter”: “string”, “useCorrelation”: “string”, “dataExtraction”: “string”, “extractionMailBox”: “string”, “extractionMailBoxBp”: “string”, “expectAck”: “string”, “intAckReq”: “string”, “ackOverDueHr”: “string”, “ackOverDueMin”: “string” } |
API Name | /pcm/envelope/{pkId} |
Method | DELETE |
Description | Deletes an envelope profile. It removes the profile identified by the pkId path parameter. |
Request | Parameters: { “pkId”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/correlation |
Method | GET |
Description | Retrieves correlations. It returns a list of correlation records. |
Request | No Parameters |
Response | { “pkId”: “string”, “correlationName1”: “string”, “correlationName2”: “string”, “correlationName3”: “string”, “correlationName4”: “string”, “correlationName5”: “string”, “correlationName6”: “string”, “correlationName7”: “string”, “correlationName8”: “string”, “correlationName9”: “string”, “correlationName10”: “string”, “correlationName11”: “string”, “correlationName12”: “string”, “correlationName13”: “string”, “correlationName14”: “string”, “correlationName15”: “string”, “correlationName16”: “string”, “correlationName17”: “string”, “correlationName18”: “string”, “correlationName19”: “string”, “correlationName20”: “string”, “correlationName21”: “string”, “correlationName22”: “string”, “correlationName23”: “string”, “correlationName24”: “string”, “correlationName25”: “string”, “correlationName26”: “string”, “correlationName27”: “string”, “correlationName28”: “string”, “correlationName29”: “string”, “correlationName30”: “string”, “correlationName31”: “string”, “correlationName32”: “string”, “correlationName33”: “string”, “correlationName34”: “string”, “correlationName35”: “string”, “correlationName36”: “string”, “correlationName37”: “string”, “correlationName38”: “string”, “correlationName39”: “string”, “correlationName40”: “string”, “correlationName41”: “string”, “correlationName42”: “string”, “correlationName43”: “string”, “correlationName44”: “string”, “correlationName45”: “string”, “correlationName46”: “string”, “correlationName47”: “string”, “correlationName48”: “string”, “correlationName49”: “string”, “correlationName50”: “string” } |
API Name | /pcm/correlation |
Method | PUT |
Description | Updates or creates correlations. It modifies existing or adds new correlation records. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “correlationName1”: “string”, “correlationName2”: “string”, “correlationName3”: “string”, “correlationName4”: “string”, “correlationName5”: “string”, “correlationName6”: “string”, “correlationName7”: “string”, “correlationName8”: “string”, “correlationName9”: “string”, “correlationName10”: “string”, “correlationName11”: “string”, “correlationName12”: “string”, “correlationName13”: “string”, “correlationName14”: “string”, “correlationName15”: “string”, “correlationName16”: “string”, “correlationName17”: “string”, “correlationName18”: “string”, “correlationName19”: “string”, “correlationName20”: “string”, “correlationName21”: “string”, “correlationName22”: “string”, “correlationName23”: “string”, “correlationName24”: “string”, “correlationName25”: “string”, “correlationName26”: “string”, “correlationName27”: “string”, “correlationName28”: “string”, “correlationName29”: “string”, “correlationName30”: “string”, “correlationName31”: “string”, “correlationName32”: “string”, “correlationName33”: “string”, “correlationName34”: “string”, “correlationName35”: “string”, “correlationName36”: “string”, “correlationName37”: “string”, “correlationName38”: “string”, “correlationName39”: “string”, “correlationName40”: “string”, “correlationName41”: “string”, “correlationName42”: “string”, “correlationName43”: “string”, “correlationName44”: “string”, “correlationName45”: “string”, “correlationName46”: “string”, “correlationName47”: “string”, “correlationName48”: “string”, “correlationName49”: “string”, “correlationName50”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/chargeback/update-chargeback |
Method | PUT |
Description | Updates the chargeback details. It modifies existing chargeback information. |
Request | No Parameters
RequestBody: { “slabId”: 0, “minCharge”: 0.1, “flat1”: 0.1, “rate110”: 0.1, “flat10”: 0.1, “rate1025”: 0.1, “flat25”: 0.1, “rateAbove25”: 0.1, “flatOther”: 0.1, “active”: 0.1 } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/chargeback/chargeback-data |
Method | GET |
Description | Retrieves chargeback data. It provides details related to chargebacks. |
Request | No Parameters
|
Response | { “slabId”: 0, “minCharge”: 0.1, “flat1”: 0.1, “rate110”: 0.1, “flat10”: 0.1, “rate1025”: 0.1, “flat25”: 0.1, “rateAbove25”: 0.1, “flatOther”: 0.1, “active”: 0.1, “createDate”: “2025-09-22T15:06:32.504Z”, “lastupdateDate”: “2025-09-22T15:06:32.504Z” } |
API Name | /pcm/application/mailbox |
Method | PUT |
Description | Updates a Mailbox Profile. It modifies the configuration of an existing mailbox profile. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mailbox |
Method | POST |
Description | Saves a Mailbox Profile. It creates and stores a new mailbox profile configuration. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mailbox |
Method | DELETE |
Description | Deletes a Mailbox Profile. It removes the configuration of an existing mailbox profile |
Request | Parameters: { “pkId “: “string” “deleteUser”: boolean, “deleteMailboxes”: boolean } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mailbox/saveMultipleProfiles |
Method | POST |
Description | Creates multiple Mailbox Profiles. It saves the configurations of multiple mailbox profiles in a single request. |
Request | No Parameters
RequestBody: [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } ]
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/mailbox/{pkId} |
Method | GET |
Description | Retrieves a Mailbox Profile. It fetches the configuration of a mailbox profile by its ID. |
Request | Parameters: { “pkId”: “string”, } |
Response | “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true }
|
API Name | /pcm/application/mailbox/getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | Retrieves all Mailbox Profiles. It fetches mailbox profiles by application ID and protocol. |
Request | Parameters: { “applicationId”: “string”, “protocol”: “string” } |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “inMailBox”: “string”, “outMailBox”: “string”, “filter”: “string”, “poolingInterval”: “string”, “hubInfo”: true, “deleteAfterCollection”: true, “userName”: “string”, “password”: “string”, “getvirtualRoot”: “string”, “mergeUser”: true, “groups”: [ “string” ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “createMailBoxInSI”: true, “routingRuleName”: “string”, “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “like”: true } ]
|
API Name | /pcm/application/filesystem |
Method | PUT |
Description | Updates a File System Profile. It modifies the configuration of an existing file system profile. |
Request | No Parameters
RequestBody { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/filesystem |
Method | POST |
Description | Creates a File System Profile. It saves the configuration of a new file system profile. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/filesystem/saveMultipleProfiles |
Method | POST |
Description | Creates multiple File System Profiles. It saves the configurations of multiple file system profiles in a single request. |
Request | No Parameter
RequestBody: [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/filesystem/{pkId} |
Method | GET |
Description | Retrieves a File System Profile. It fetches the configuration of a file system profile by its ID |
Request | Parameters: { “pkId “: “string” } |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true }
|
API Name | /pcm/application/filesystem/{pkId} |
Method | DELETE |
Description | Deletes a File System Profile. It removes the configuration of an existing file system profile. |
Request | Parameters: { “pkId “: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/application/filesystem/getAllByApplicationId/{applicationId}/{protocol} |
Method | GET |
Description | Retrieves all File System Profiles. It fetches file system profiles by application ID and protocol. |
Request | Parameters: { “applicationId “: “string” “protocol “: “string”, } |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “userName”: “string”, “password”: “string”, “fileType”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “routingRuleName”: “string”, “like”: true } ]
|
API Name | /pcm/api/proxy-endpoint |
Method | PUT |
Description | Updates a Proxy Endpoint. It modifies the configuration of an existing proxy endpoint. |
Request | No Parameters
RequestBody { “pkId”: “string”, “apiName”: “string”, “proxyUrl”: “string”, “proxyWebMethod”: “string”, “poolingInterval”: “string”, “proxyApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “serverUrl”: “string”, “serverWebMethod”: “string”, “serverApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “apiHeaderDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “apiParamDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “body”: “string”, “apiType”: “string” }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/api/proxy-endpoint |
Method | POST |
Description | Creates a Proxy Endpoint. It saves the configuration of a new proxy endpoint. |
Request | No Parameters
RequestBody: { “pkId”: “string”, “apiName”: “string”, “proxyUrl”: “string”, “proxyWebMethod”: “string”, “poolingInterval”: “string”, “proxyApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “serverUrl”: “string”, “serverWebMethod”: “string”, “serverApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “apiHeaderDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “apiParamDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “body”: “string”, “apiType”: “string” }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/api/proxy-endpoint/search |
Method | POST |
Description | Searches Proxy Endpoints. |
Request | Parameters: Pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: { “pkId”: “string”, “apiName”: “string”, “proxyUrl”: “string”, “proxyWebMethod”: “string”, “poolingInterval”: “string”, “proxyApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “serverUrl”: “string”, “serverWebMethod”: “string”, “serverApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “apiHeaderDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “apiParamDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “body”: “string”, “apiType”: “string” } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “createdBy”: “string”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-22T15:39:06.676Z”, “pkId”: “string”, “apiName”: “string”, “methodName”: “string”, “proxyUrl”: “string”, “serverUrl”: “string”, “reqPayloadSpa”: “string”, “apiType”: “string”, “poolingIntervalMins”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true }
|
API Name | /pcm/api/proxy-endpoint/{pkId} |
Method | GET |
Description | Retrieves a Proxy Endpoint. |
Request | Parameters: { “pkId “: “string” } |
Response | { “pkId”: “string”, “apiName”: “string”, “proxyUrl”: “string”, “proxyWebMethod”: “string”, “poolingInterval”: “string”, “proxyApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “serverUrl”: “string”, “serverWebMethod”: “string”, “serverApiAuthData”: { “authType”: “string”, “basicAuth”: { “username”: “string”, “password”: “string” }, “tokenAuth”: { “username”: “string”, “password”: “string”, “tokenApiUrl”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” }, “getoAuth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “apiHeaderDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “apiParamDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “body”: “string”, “apiType”: “string” }
|
API Name | /pcm/api/proxy-endpoint/{pkId} |
Method | DELETE |
Description | Deletes a Proxy Endpoint. |
Request | Parameters: { “pkId “: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/api/proxy-endpoint/get-oauth2-details |
Method | GET |
Description | Retrieves OAuth 2.0 details. |
Request | No Parameters |
Response | { “tokenUrl”: “string”, “grantType”: “string”, “clientId”: “string”, “clientSecret”: “string”, “scope”: “string”, “resource”: “string”, “username”: “string”, “cmks”: “string”, “token”: { “responseParser”: “string”, “prefix”: “string”, “header”: “string” } }
|
API Name | /pcm/api/proxy-endpoint/get-methods-by-apiName/{apiName} |
Method | GET |
Description | Retrieves method details of an API. |
Request | Parameters: { “apiName “: “string” } |
Response | [ { “name”: “string” } ]
|
API Name | /pcm/api/proxy-endpoint/endpoints |
Method | GET |
Description | Retrieves the Endpoints Map. |
Request | No Parameters
|
Response | [ { “name”: “string” } ]
|
API Name | /pcm/admin/workflow |
Method | PUT |
Description | To update the relations between the workflow entities. this is onetime run when we migrate from 6.1 below version to any higher version of PCM |
Request | No Parameters
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/admin/purge/transactions |
Method | GET |
Description | To delete the Transaction from both TransferInfo and TransInfoD(Transaction Activities) |
Request | Parameters: { “days “: integer } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/ws/roll-out |
Method | POST |
Description | Performs PEM Webservice rollout. |
Request | No Parameters
RequestBody: { “rollOutInternally”: true, “activityDefinition”: “string”, “alertInterval”: 0, “alertStartDate”: “string”, “contextData”: “string”, “description”: “string”, “dueDate”: “string”, “name”: “string”, “expiryList”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T15:57:28.098Z”, “protocol”: “string”, “notAfter”: “2025-09-22T15:57:28.098Z”, “notBefore”: “2025-09-22T15:57:28.098Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T15:57:28.098Z” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/ws/roll-out-profile |
Method | POST |
Description | Performs PEM Webservice rollout with a profile. |
Request | No Parameters
RequestBody: { “rollOutInternally”: true, “activityDefinition”: “string”, “alertInterval”: 0, “alertStartDate”: “string”, “contextData”: “string”, “description”: “string”, “dueDate”: “string”, “name”: “string”, “expiryList”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-22T16:00:02.800Z”, “protocol”: “string”, “notAfter”: “2025-09-22T16:00:02.800Z”, “notBefore”: “2025-09-22T16:00:02.800Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-22T16:00:02.800Z” } ] }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/ws/roll-out-profile-xml |
Method | POST |
Description | Performs PEM Webservice rollout with a profile XML.It triggers the deployment process using the provided XML profile configuration. |
Request | No Parameters
RequestBody: <?xml version=”1.0″ encoding=”UTF-8″?> <PemRollOutModelXml> <rollOutInternally>true</rollOutInternally> <activityDefinition>string</activityDefinition> <alertInterval>0</alertInterval> <alertStartDate>string</alertStartDate> <contextData>string</contextData> <description>string</description> <dueDate>string</dueDate> <name>string</name> <contextDataNodes> <contextDataNode> <nodeRef>string</nodeRef> <nodeValue>string</nodeValue> </contextDataNode> </contextDataNodes> <expiryList> <expiryAccount> <userName>string</userName> <certName>string</certName> <profileName>string</profileName> <profileId>string</profileId> <emailId>string</emailId> <pemIdentifier>string</pemIdentifier> <certType>string</certType> <pass>string</pass> <pwdLastUpdatedDate>string</pwdLastUpdatedDate> <protocol>string</protocol> <notAfter>2025-09-22T16:02:00.752Z</notAfter> <notBefore>2025-09-22T16:02:00.752Z</notBefore> <expiresOn>string</expiresOn> <nonProd>string</nonProd> <prod>string</prod> </expiryAccount> </expiryList> </PemRollOutModelXml> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityManagerResponse> <statusCode>0</statusCode> <statusMessage>string</statusMessage> </CommunityManagerResponse>
|
API Name | /pem/utility/xml/encode-with-apache |
Method | POST |
Description | Encodes XML using Apache utilities. |
Request | No Parameters
RequestBody: <?xml version=”1.0″ encoding=”UTF-8″?> <!– XML example cannot be generated; root element name is undefined –>
|
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <DataModel> <data>string</data> </DataModel> |
API Name | /pem/utility/xml/decode-with-apache |
Method | POST |
Description | Decodes XML using Apache utilities. |
Request | No Parameters
RequestBody: <?xml version=”1.0″ encoding=”UTF-8″?> <DataModel> <data>string</data> </DataModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <!– XML example cannot be generated; root element name is und |
API Name | /pem/utility/string-to-list |
Method | POST |
Description | Converts a string into a list. |
Request | Parameters { “content”: “string”, “separator “: “string”
} |
Response | { “content”: [ { “name”: “string” } ] }
|
API Name | /pem/utility/string-replacer |
Method | POST |
Description | Replaces values in a string. |
Request | Parameters: { “content”: “string”, “regex “: “string”, “replacement “: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/string-replacer-dup |
Method | POST |
Description | Replaces values in a string. |
Request | No Parameters
RequestBody: { “content”: “string”, “regex”: “string”, “replacement”: “string” }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/string-remove-special-characters |
Method | POST |
Description | Removes special characters from a string. |
Request | Parameters: { “content”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/remote-server/script-run |
Method | POST |
Description | Executes a script on a remote server. |
Request | No Parameters
RequestBody: { “host”: “string”, “port”: 0, “userName”: “string”, “command”: “string”, “inputParam1”: “string”, “inputParam2”: “string”, “inputParam3”: “string”, “inputParam4”: “string”, “inputParam5”: “string”, “isPemKey”: true, “password”: “string”, “localFile”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/regex-finder |
Method | POST |
Description | Matches data using a regular expression. |
Request | No Parameters
RequestBody: <?xml version=”1.0″ encoding=”UTF-8″?> <input> <pattern>string</pattern> <data> <value>string</value> </data> </input>
|
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <PemRegexOutPutModel> <validation>string</validation> <data> <value>string</value> </data> </PemRegexOutPutModel> |
API Name | /pem/utility/partner/save-codes |
Method | POST |
Description | Saves a list of codes. |
Request | No Parameters
RequestBody: { “content”: [ { “key”: “string”, “value”: “string” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/list-to-String |
Method | POST |
Description | Converts a list into a string. |
Request | Parameters { “delimiter “: “string” }
RequestBody: { “content”: [ { “name”: “string” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/get-values-from-csv |
Method | POST |
Description | Retrieves values from a CSV file. |
Request | No Parameters
RequestBody: { “base64OfCSV”: “string”, “row”: 0 } |
Response | { “content”: [ { “name”: “string” } ] }
|
API Name | /pem/utility/get-sub-string |
Method | POST |
Description | Extracts a substring from a string. |
Request | Parameters: { “content”: “string”, “isStart “: boolean, “position”: integer } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/get-first-value |
Method | POST |
Description | Retrieves the first value from a dataset or string.It returns the initial element based on the provided input. |
Request | No Parameters
RequestBody: { “string1”: “string”, “string2”: “string”, “string3”: “string”, “string4”: “string”, “string5”: “string”, “string6”: “string”, “string7”: “string”, “string8”: “string”, “string9”: “string”, “string10”: “string”, “string11”: “string”, “string12”: “string”, “string13”: “string”, “string14”: “string”, “string15”: “string”, “string16”: “string”, “string17”: “string”, “string18”: “string”, “string19”: “string”, “string20”: “string” }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/generate-random-password |
Method | POST |
Description | Generates a random password. |
Request | Parameters: { “upperCaseLettersCnt “: integer “lowerCaseLettersCnt “: integer “numberCnt “: integer “specialCharCnt “: integer } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/find-null |
Method | GET |
Description | Checks if the given data is null. |
Request | No Parameters { “data”: “string” } |
Response | { “value”: true } |
API Name | /pem/utility/find-null |
Method | POST |
Description | Checks if the given string is null. |
Request | No Parameters
RequestBody: { “data”: “string” } |
Response | { “value”: “true” } |
API Name | /pem/utility/file-drop |
Method | POST |
Description | Drops a static file to a specified location. |
Request | No Parameters
RequestBody:
{ “fileName”: “string”, “filePath”: “string”, “operation”: “string”, “content”: “string”, “host”: “string”, “port”: 0, “userName”: “string”, “password”: “string”, “isPemKey”: true, “localDirectory”: true }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/encode-workflow-model-to-apache-base64 |
Method | POST |
Description | Encodes a workflow model using Apache Base64.It converts the workflow model into a Base64-encoded string. |
Request | No Parameters
RequestBody: { “partnerProfile”: “string”, “applicationProfile”: “string”, “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] } |
Response | { “data”: “string” } |
API Name | /pem/utility/custom-protocol-var-names |
Method | POST |
Description | Retrieves custom protocol variable names. |
Request | Parameters: { “filePath “: “string”, “customProtocolName “: “string” } |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CustomProtocolResponseModel> <data> <value>string</value> </data> <bp>string</bp> <customProtocol>string</customProtocol> </CustomProtocolResponseModel>
|
API Name | /pem/utility/custom-protocol-list |
Method | POST |
Description | Retrieves the list of custom protocols. |
Request | Parameters: { “ filePath “: “string” } |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CustomProtocolResponseModel> <data> <value>string</value> </data> <bp>string</bp> <customProtocol>string</customProtocol> </CustomProtocolResponseModel> |
API Name | /pem/utility/convert-hex-to-ascii |
Method | POST |
Description | Converts hexadecimal values to ASCII. |
Request | No Parameters
RequestBody: { “data”: “string” } |
Response | { “name”: “string” } |
API Name | /pem/utility/convert-compliance-report-base64-to-xml |
Method | POST |
Description | Converts a Base64-encoded compliance report to XML.It decodes the encoded data and returns it in XML format |
Request | No Parameters
RequestBody: { “url”: “string”, “method”: “string”, “username”: “string”, “password”: “string”, “input”: “string” } |
Response | “string” |
API Name | /pem/utility/convert-base64-string-java |
Method | POST |
Description | Encodes a string using Java libraries. |
Request | No Parameters
RequestBody: { “data”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/convert-base64-string-apache |
Method | POST |
Description | Encodes a string using Apache Base64. |
Request | No Parameters
RequestBody: { “data”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/convert-asciiToHex |
Method | POST |
Description | Converts a string from ASCII to hexadecimal. |
Request | Parameters { “ ascii “: “string” } |
Response | { “name”: “string” } |
API Name | /pem/utility/convert-ascii-to-hex-hh |
Method | POST |
Description | Converts a string from ASCII to hexadecimal. |
Request | No Parameters
RequestBody: { “data”: “string” } |
Response | { “name”: “string” } |
API Name | /pem/utility/si/template-names |
Method | GET |
Description | Retrieves routing channel template names. |
Request | No Parameters |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pem/utility/partner/get-code/{partnerName} |
Method | GET |
Description | Retrieves code list by partner name. |
Request | Parameters: { “partnerName “: “string” } |
Response | { “key”: “string”, “value”: “string” } |
API Name | /pem/utility/get-expiry-users |
Method | GET |
Description | Lists users with upcoming expiry. |
Request | Parameters: { “remainDaya”: integer } |
Response | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-23T08:59:50.756Z”, “protocol”: “string”, “notAfter”: “2025-09-23T08:59:50.756Z”, “notBefore”: “2025-09-23T08:59:50.756Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-23T08:59:50.756Z” } ] } |
API Name | /pem/utility/get-expiry-users-xml |
Method | GET |
Description | Lists users with upcoming expiry in XML format.It returns users whose accounts will expire within the specified number of days as XML output. |
Request | Parameters: { “remainDays “: integer } |
Response | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-23T09:01:15.660Z”, “protocol”: “string”, “notAfter”: “2025-09-23T09:01:15.660Z”, “notBefore”: “2025-09-23T09:01:15.660Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-23T09:01:15.660Z” } ] }
|
API Name | /pem/utility/get-expiry-users-by-updated-time |
Method | GET |
Description | Lists users with upcoming expiry filtered by update time. |
Request | Parameters: { “dayBefore”: “string” } |
Response | { “content”: [ { “userName”: “string”, “certName”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “pemIdentifier”: “string”, “certType”: “string”, “pass”: “string”, “pwdLastUpdatedDate”: “2025-09-23T09:02:29.098Z”, “protocol”: “string”, “notAfter”: “2025-09-23T09:02:29.098Z”, “notBefore”: “2025-09-23T09:02:29.098Z”, “expiresOn”: “string”, “keyName”: “string”, “createDate”: “2025-09-23T09:02:29.098Z” } ] }
|
API Name | /pem/utility/get-expiry-user-identity-keys |
Method | GET |
Description | Lists partners using UIDD keys older than a specified number of days.It returns partner details whose UIDD keys exceed the given age threshold. |
Request | Parameters: { “noOfDays “: integer, “uidKeyName “: “string”, “isAuthKey “: boolean } |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityMangerModelPemAccountExpiryModel> <content> <userName>string</userName> <certName>string</certName> <profileName>string</profileName> <profileId>string</profileId> <emailId>string</emailId> <pemIdentifier>string</pemIdentifier> <certType>string</certType> <pass>string</pass> <pwdLastUpdatedDate>2025-09-23T09:03:39.240Z</pwdLastUpdatedDate> <protocol>string</protocol> <notAfter>2025-09-23T09:03:39.240Z</notAfter> <notBefore>2025-09-23T09:03:39.240Z</notBefore> <expiresOn>string</expiresOn> <keyName>string</keyName> <createDate>2025-09-23T09:03:39.240Z</createDate> </content> </CommunityMangerModelPemAccountExpiryModel> |
API Name | /pem/utility/get-current-date |
Method | GET |
Description | Retrieves the current date. |
Request | No Parameters
RequestBody: { “Format”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/generate-password |
Method | GET |
Description | Generates a password string. |
Request | Parameters: { “length”: integer } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/find-index-value |
Method | GET |
Description | Finds the index of a value. |
Request | Parameters: { “content “: “string”, “pattern””: “string”, “index””: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/utility/partner/delete-codes |
Method | DELETE |
Description | Deletes a list of codes. |
Request | No Parameters
RequestBody: { “content”: [ { “key”: “string”, “value”: “string” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/framework-integration |
Method | POST |
Description | Performs framework integration operations.It supports create, read, update, and delete (CRUD) actions within the framework. |
Request | No Parameters
RequestBody: { “content”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/certificate/upload-trusted-cert |
Method | POST |
Description | Uploads a trusted certificate. |
Request | No Parameters
RequestBody: { “certOrKeyName”: “string”, “certOrKeyData”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/certificate/upload-ssh-known-host-key |
Method | POST |
Description | Uploads an SSH Known Host Key certificate. |
Request | No Parameters
RequestBody: { “certOrKeyName”: “string”, “certOrKeyData”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/certificate/upload-pgp-publickey |
Method | POST |
Description | ploads a PGP public key. |
Request | No Parameters
RequestBody: { “keyString”: “string”, “name”: “string”, “verifyOnUse”: true } |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityManagerResponse> <statusCode>0</statusCode> <statusMessage>string</statusMessage> </CommunityManagerResponse>
|
API Name | /pem/certificate/upload-ca-cert |
Method | POST |
Description | Uploads a CA certificate. |
Request | No Parameters
RequestBody: { “certOrKeyName”: “string”, “certOrKeyData”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/certificate/upload-SSH-authorized-user-key |
Method | POST |
Description | Uploads an SSH authorized user key. |
Request | No Parameters
RequestBody: { “certOrKeyName”: “string”, “certOrKeyData”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/certificate/upload-SSH-UID-key |
Method | POST |
Description | Uploads an SSH UID key certificate. |
Request | No Parameters
RequestBody: { “certOrKeyName”: “string”, “certOrKeyData”: “string” }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/certificate/get-pgp-publickey-local |
Method | GET |
Description | Retrieves the PGP public keys from the local database.It returns all stored PGP public keys available in the system. |
Request | Parameters: { “certName “: “string “ } |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <!– XML example cannot be generated; root element name is undefined –>
|
API Name | /pem/certificate/delete-pgp-publickey |
Method | DELETE |
Description | Deletes a PGP public key. |
Request | Parameters: { “certName “: “string “ } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/update-workflow |
Method | POST |
Description | Updates a workflow. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId “: “string”
}
RequestBody: { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/update-workflow-save-version |
Method | POST |
Description | Updates a workflow and saves a new version.It modifies the workflow and retains the previous version for record-keeping or rollback. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId “: “string”, “isSaveVersion “: “string”, “Description”: “string” }
RequestBody: { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/update-flow |
Method | POST |
Description | Updates a workflow flow. |
Request | Parameters: { “isUpdate “: “string” }
RequestBody: { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/search |
Method | POST |
Description | Searches workflow flows for reporting. |
Request | Parameters: Pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: { “partnerName”: “string”, “applicationName”: “string”, “seqType”: “string”, “flow”: “string”, “fileType”: “string”, “docType”: “string”, “transaction”: “string”, “senderId”: “string”, “receiverId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “partnerPkId”: “string”, “applicationPkId”: “string”, “ruleModel”: { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName1”: “string”, “propertyName2”: “string”, “propertyName3”: “string”, “propertyName4”: “string”, “propertyName5”: “string”, “propertyName6”: “string”, “propertyName7”: “string”, “propertyName8”: “string”, “propertyName9”: “string”, “propertyName10”: “string”, “propertyName11”: “string”, “propertyName12”: “string”, “propertyName13”: “string”, “propertyName14”: “string”, “propertyName15”: “string”, “propertyName16”: “string”, “propertyName17”: “string”, “propertyName18”: “string”, “propertyName19”: “string”, “propertyName20”: “string”, “propertyName21”: “string”, “propertyName22”: “string”, “propertyName23”: “string”, “propertyName24”: “string”, “propertyName25”: “string” }, “seqId”: 0 } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true }
|
API Name | /pcm/workflow/search-transactions |
Method | POST |
Description | Searches workflows with transactions. |
Request | Parameters: Pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: { “partnerName”: “string”, “applicationName”: “string”, “seqType”: “string”, “flow”: “string”, “fileType”: “string”, “docType”: “string”, “transaction”: “string”, “senderId”: “string”, “receiverId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “partnerPkId”: “string”, “applicationPkId”: “string”, “ruleModel”: { “ruleId”: “string”, “ruleName”: “string”, “businessProcessId”: “string”, “propertyName1”: “string”, “propertyName2”: “string”, “propertyName3”: “string”, “propertyName4”: “string”, “propertyName5”: “string”, “propertyName6”: “string”, “propertyName7”: “string”, “propertyName8”: “string”, “propertyName9”: “string”, “propertyName10”: “string”, “propertyName11”: “string”, “propertyName12”: “string”, “propertyName13”: “string”, “propertyName14”: “string”, “propertyName15”: “string”, “propertyName16”: “string”, “propertyName17”: “string”, “propertyName18”: “string”, “propertyName19”: “string”, “propertyName20”: “string”, “propertyName21”: “string”, “propertyName22”: “string”, “propertyName23”: “string”, “propertyName24”: “string”, “propertyName25”: “string” }, “seqId”: 0 }
|
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/workflow/search-applied-rules |
Method | POST |
Description | Searches applied workflow rules. |
Request | No Parameters
RequestBody: { “content”: [ “string” ] } |
Response | { “content”: [ { “key”: “string”, “list”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ] } ] }
|
API Name | /pcm/workflow/save-workflow-version |
Method | POST |
Description | Saves a workflow version. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, “description”: “string”, } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/reorder-workflow-version |
Method | POST |
Description | Reorders workflow versions. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, “version”: “string”, } RequestBody: { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/import |
Method | POST |
Description | Imports a workflow. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, }
RequestBody: MultipartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/import-with-profile |
Method | POST |
Description | Imports workflows along with their profiles. |
Request | RequestBody: MultiPartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/delete-all-by-partner-ids |
Method | POST |
Description | Deletes all workflows for specified partner IDs.It removes every workflow associated with the given partners from the system. |
Request | No Parameters
RequestBody: { “content”: [ { “name”: “string” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/delete-all-by-application-ids |
Method | POST |
Description | Deletes all workflows for specified application IDs. |
Request | No Parameters
RequestBody: { “content”: [ { “name”: “string” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/delete-all-by-application-ids |
Method | POST |
Description | Deletes all workflows for the specified application IDs. |
Request | No Parameters
RequestBody: { “content”: [ { “name”: “string” } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/create |
Method | POST |
Description | Creates a new workflow. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, }
RequestBody: { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/change-workflow-version |
Method | POST |
Description | Updates the version of a specified workflow. Allows switching to a different workflow version. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, “version”: “string”, “description”: “string” }
RequestBody: { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow |
Method | GET |
Description | Retrieves details of a specified workflow. Provides information about the workflow configuration. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, }
|
Response | { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } }
|
API Name | /pcm/workflow |
Method | DELETE |
Description | Deletes a specified workflow. Permanently removes the workflow from the system. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/get-workflow-version |
Method | GET |
Description | Retrieves the version details of a specified workflow. Provides information about available workflow versions. |
Request | Parameters: { “pkId “: “string”, } |
Response | { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } }
|
API Name | /pcm/workflow/get-workflow-history |
Method | GET |
Description | Retrieves the version history of a specified workflow. Provides a list of all previous workflow versions. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, } |
Response | [ { “pkId”: “string”, “partnerId”: “string”, “applicationId”: “string”, “version”: 0, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-22T14:17:39.502Z”, “description”: “string” } ] |
API Name | /pcm/workflow/get-workflow-by-names |
Method | GET |
Description | Retrieves workflows by their names. Used to import specified workflows based on name. |
Request | Parameters: { “partnerName “: “string”, “applicationName”: “string”, } |
Response | { “inboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } }, “outboundFlow”: { “mfts”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] }, “docHandlings”: { “processDocModels”: [ { “pkId”: “string”, “processRef”: “string”, “fileNamePattern”: “string”, “docType”: “string”, “versionNo”: “string”, “partnerId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “processRuleSeq”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ], “index”: 0 } ] } } } |
API Name | /pcm/workflow/get-file-name-availability |
Method | GET |
Description | Checks availability of a file name pattern. Ensures the file name does not conflict with existing ones. |
Request | Parameters: { “filenamePattern “: “string”, } |
Response | true |
API Name | /pcm/workflow/export |
Method | GET |
Description | Exports specified workflows as XML. Generates XML representation for selected workflows. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/export-with-profile |
Method | GET |
Description | Exports specified workflows along with their profiles. Generates an XML including workflow and profile data. |
Request | Parameters: { “partnerPkId “: “string”, “applicationPkId”: “string”, } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/export-all |
Method | GET |
Description | Exports all workflows in CSV format. Provides a complete list of workflows as a CSV file. |
Request | No Parameters |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/activity/{processRefId} |
Method | GET |
Description | Retrieves activity history for a specified workflow. Provides details of past actions for the given processRefId. |
Request | Parameters: { “processRefId “: “string”, “pageable”: { “page”: 0, “size”: 1, “sort”: [ “string” ] } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “processRefId”: “string”, “userName”: “string”, “userId”: “string”, “activity”: “string”, “activityDt”: “2025-09-22T14:25:10.327Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/workflow/delete-workflow-version/{pkId} |
Method | DELETE |
Description | Deletes a specified workflow version. Removes the selected version from the system. |
Request | Parameters: { “pkId “: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/delete-By-Flow |
Method | DELETE |
Description | Deletes a specific workflow. Removes the workflow identified by the given parameters. |
Request | Parameters: { “pkId “: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/delete-By-Flow-and-save-version |
Method | DELETE |
Description | Deletes a specific workflow and saves its version. Removes the workflow while preserving the version data. |
Request | Parameters: { “pkId “: “string”, “isSaveVersion “: boolean, “profileId “: “string”, “applicationId “: “string”, “description “: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/watsonX/search |
Method | POST |
Description | Searches Watson X files using error details. Retrieves relevant files based on the provided error information. |
Request | Parameters: pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: { “dateRangeStart”: “string”, “dateRangeEnd”: “string”, “flowInOut”: “string”, “typeOfTransfer”: “string”, “doctype”: “string”, “status”: “string”, “srcProtocol”: “string”, “destProtocol”: “string”, “partner”: “string”, “application”: “string”, “senderId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “errorStatus”: “string”, “srcFileName”: “string”, “destFileName”: “string”, “coreBpId”: “string”, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string”, “correlationValue26”: “string”, “correlationValue27”: “string”, “correlationValue28”: “string”, “correlationValue29”: “string”, “correlationValue30”: “string”, “correlationValue31”: “string”, “correlationValue32”: “string”, “correlationValue33”: “string”, “correlationValue34”: “string”, “correlationValue35”: “string”, “correlationValue36”: “string”, “correlationValue37”: “string”, “correlationValue38”: “string”, “correlationValue39”: “string”, “correlationValue40”: “string”, “correlationValue41”: “string”, “correlationValue42”: “string”, “correlationValue43”: “string”, “correlationValue44”: “string”, “correlationValue45”: “string”, “correlationValue46”: “string”, “correlationValue47”: “string”, “correlationValue48”: “string”, “correlationValue49”: “string”, “correlationValue50”: “string”, “fileNameRegExpression”: “string”, “mailbox”: “string”, “processData”: “string”, “staging”: true } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “seqid”: 0, “filearrived”: “2025-09-22T13:28:14.711Z”, “flowinout”: “string”, “typeoftransfer”: “string”, “senderid”: “string”, “reciverid”: “string”, “application”: “string”, “appintstatus”: “string”, “partnerackstatus”: “string”, “srcprotocol”: “string”, “srcfilename”: “string”, “srcarcfileloc”: “string”, “destfilename”: “string”, “destarcfileloc”: “string”, “destprotocol”: “string”, “doctype”: “string”, “pickbpid”: “string”, “corebpid”: “string”, “deliverybpid”: “string”, “status”: “string”, “errorstatus”: “string”, “adverrorstatus”: “string”, “partner”: “string”, “doctrans”: “string”, “encType”: “string”, “srcFileSize”: 0, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string”, “correlationValue26”: “string”, “correlationValue27”: “string”, “correlationValue28”: “string”, “correlationValue29”: “string”, “correlationValue30”: “string”, “correlationValue31”: “string”, “correlationValue32”: “string”, “correlationValue33”: “string”, “correlationValue34”: “string”, “correlationValue35”: “string”, “correlationValue36”: “string”, “correlationValue37”: “string”, “correlationValue38”: “string”, “correlationValue39”: “string”, “correlationValue40”: “string”, “correlationValue41”: “string”, “correlationValue42”: “string”, “correlationValue43”: “string”, “correlationValue44”: “string”, “correlationValue45”: “string”, “correlationValue46”: “string”, “correlationValue47”: “string”, “correlationValue48”: “string”, “correlationValue49”: “string”, “correlationValue50”: “string”, “transfile”: “string”, “statusComments”: “string”, “isEncrypted”: “string”, “xrefName”: “string”, “processData”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true }
|
API Name | /pcm/watsonX/invoke |
Method | POST |
Description | Invokes the Watson X B2B API. Executes business-to-business operations using Watson X. |
Request | No Parameters
RequestBody: { “username”: “string”, “password”: “string”, “path”: “string”, “method”: “string”, “headers”: [ “string” ], “conversionEnabled”: true, “request”: “string” } |
Response | “string” |
API Name | /pcm/watsonX/encode-workflow-model-to-apache-base64 |
Method | POST |
Description | Encodes a workflow model to Apache Base64 format. Returns the encoded model as a string. |
Request | Parameters: { “partnerProfile”: “string”, “applicationProfile”: “string” }
RequestBody: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] |
Response | { “data”: “string” } |
API Name | /pcm/watsonX/getPartnerDetails |
Method | GET |
Description | Retrieves partner details via Watson X Partner Protocol API. Provides information about partners connected to Watson X. |
Request | Parameters: { “tpName “: “string”, } |
Response | { “protocol”: “string”, “pkId”: “string” } |
API Name | /pcm/watsonX/getFormattedDateTime |
Method | GET |
Description | Returns formatted date and time via Watson X API. Provides date and time in a specified format. |
Request | Parameters: { “DateTime “: “string”, “CurrentFormat “: “string”, “Required Format “: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/watsonX/getAccounts |
Method | GET |
Description | Retrieves account details using Watson X API. Provides a list of accounts associated with Watson X. |
Request | Parameters: { “PartnerName”: “string” } |
Response | { “accounts”: [ “string” ] } |
API Name | /pcm/watsonX/example |
Method | GET |
Description | Retrieves example data via Watson X Partner Protocol API. Provides sample information for partner integration. |
Request | No Parameters |
Response | { “content”: { “createdBy”: [ “string” ], “pkId”: [ “string” ] } } |
API Name | /pcm/utility/is-valid |
Method | POST |
Description | Validates user activities. Checks if user actions meet specified criteria. |
Request | No Parameters
RequestBody: { “userName”: “string”, “password”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/utility/trusted-cert-map |
Method | GET |
Description | Looks like you just repeated the description I gave. Need me to tweak it or write a new version? |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/utility/trusted-cert-list |
Method | GET |
Description | Retrieves a list of trusted certificates. Provides all trusted certificates available in the system. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/utility/timezone |
Method | GET |
Description | Retrieves a list of PCM time zones. Provides available time zone information for PCM. |
Request | No Parameters |
Response | { “serverTimezone”: “string”, “serverTime”: “string” } |
API Name | /pcm/utility/system-cert-map |
Method | GET |
Description | Retrieves the system certificate map. Provides details of system certificates in use. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/utility/ssh-khost-key-cert-list |
Method | GET |
Description | Retrieves the list of known host keys. Provides details of SSH known host key certificates. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/utility/ssh-key-pair |
Method | GET |
Description | Retrieves the list of SSH key pairs. Provides details of available SSH key pairs. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/utility/si-map-list |
Method | GET |
Description | Retrieves the list of SI maps. Provides details of all available SI maps. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/utility/si-bp-list |
Method | GET |
Description | Retrieves the list of SI BPs. Provides details of all available SI BPs. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/utility/search-date-range |
Method | GET |
Description | Retrieves the valid date range for searches. Provides date range used in the transferInfo search screen. |
Request | No Parameters |
Response | 0 |
API Name | /pcm/utility/restricted-special-char |
Method | GET |
Description | Retrieves the list of restricted special characters. Provides characters that are not allowed in inputs. |
Request | No Parameters |
Response | [ “string” ] |
API Name | /pcm/utility/protocols-map |
Method | GET |
Description | Retrieves the map of protocols. Provides details of supported protocols in the system. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/utility/protocols-list |
Method | GET |
Description | Retrieves the list of protocols. Provides all supported protocols available in the system. |
Request | No Parameters |
Response | [ “string” ] |
API Name | /pcm/utility/is-mft-duplicate |
Method | GET |
Description | Checks if MFT duplicates are allowed. Returns true or false based on the setting. |
Request | No Parameters |
Response | true or false |
API Name | /pcm/utility/is-b2b-active |
Method | GET |
Description | Checks if B2B is active. Returns the current B2B activation status. |
Request | No Parameters |
Response | true or false |
API Name | /pcm/utility/get-virtual-root |
Method | GET |
Description | Retrieves the virtual root directory. Provides the path of the virtual root used in the system. |
Request | Parameters { “userName”:”string” } |
Response | { “virtualRoot”: “string” } |
API Name | /pcm/utility/get-trusted-cert-id |
Method | GET |
Description | Retrieves the trusted certificate ID using its name. Provides the ID associated with a given trusted cert name. |
Request | Parameters { “certName”:”string” } |
Response | { “name”: “string” } |
API Name | /pcm/utility/get-system-cert-id |
Method | GET |
Description | Retrieves the system certificate ID using its name. Provides the ID associated with a given system certificate name. |
Request | Parameters { “certName”:”string” } |
Response | { “name”: “string” } |
API Name | /pcm/utility/get-ssh-user-key |
Method | GET |
Description | Retrieves SSH user key using the specified name. Provides details of the SSH user key |
Request | Parameters { “certName “:”string” } |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pcm/utility/get-ssh-user-key-list |
Method | GET |
Description | Retrieves the list of SSH user keys. Provides details of all available SSH user keys. |
Request | No Parameters |
Response | { “content”: [ { “name”: “string” } ] } |
API Name | /pcm/utility/get-logo |
Method | GET |
Description | Retrieves logo data. Provides the current logo used in the system. |
Request | No Parameters |
Response | { “logoData”: “string” } |
API Name | /pcm/utility/get-cloud-list |
Method | GET |
Description | Retrieves the list of supported cloud services. Provides available cloud options like (AWS-S3,….) |
Request | No Parameters |
Response | { “content”: [ { “key”: “string”, “value”: “string” } ] } |
API Name | /pcm/utility/get-cloud-aws-regions |
Method | GET |
Description | Retrieves the list of AWS regions. Provides available AWS region options for configuration. |
Request | No Parameters |
Response | { “content”: [ { “key”: “string”, “value”: “string” } ] } |
API Name | /pcm/utility/envelop-terminators-map-list |
Method | GET |
Description | Retrieves the map of envelope terminators. Provides details of configured envelope terminator mappings. |
Request | No Parameters |
Response | { “content”: [ { “key”: “string”, “value”: “string” } ] } |
API Name | /pcm/utility/cd/get-cipher-suites |
Method | GET |
Description | Retrieves the list of CD cipher suites. Provides details of supported cipher suites for CD. |
Request | No Parameters |
Response | { “content”: [ { “key”: “string”, “value”: “string” } ] } |
API Name | /pcm/utility/ca-cert-map |
Method | GET |
Description | Retrieves the map of CA certificates. Provides details of certificate authority certificates in the system. |
Request | No Parameters |
Response | { “content”: [ { “key”: “string”, “value”: “string” } ] } |
API Name | /pcm/utility/ca-cert-list |
Method | GET |
Description | Retrieves the list of CA certificates. Provides all certificate authority certificates available. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/utility/auth-xref-ssh-list |
Method | GET |
Description | Retrieves the list of SSH authentication cross-references. Provides details of SSH auth mappings. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/utility/adapter-names |
Method | GET |
Description | Retrieves the list of adapters. Provides available adapters in the system. |
Request | No Parameters |
Response | { “ftpServerAdapterName”: “string”, “ftpClientAdapterName”: “string”, “ftpsServerAdapterName”: “string”, “ftpsClientAdapterName”: “string”, “sftpServerAdapterName”: “string”, “sftpClientAdapterName”: “string”, “as2ServerAdapterName”: “string”, “as2ClientAdapterName”: “string”, “as2HttpClientAdapter”: “string”, “cdClientAdapterName”: “string”, “httpServerAdapterName”: “string”, “httpsServerAdapterName”: “string”, “mqAdapterName”: “string”, “wsServerAdapterName”: “string”, “fsAdapter”: “string”, “sfgSftpClientAdapterName”: “string”, “sfgSftpServerAdapterName”: “string”, “sfgFtpClientAdapterName”: “string”, “sfgFtpServerAdapterName”: “string”, “sfgFtpsClientAdapterName”: “string”, “sfgFtpsServerAdapterName”: “string” } |
API Name | /pcm/utility/active-profile |
Method | GET |
Description | Retrieves the active profile details. Provides information about the currently active profile. |
Request | No Parameters |
Response | { “smLogin”: true, “activeProfile”: “string”, “samlSSOUrl”: “string”, “samlSloUrl”: “string”, “smlogin”: true } |
API Name | /pcm/user-activity/restrictUserActivity |
Method | POST |
Description | Locks the Partner, Application, or Dataflow page. Restricts user activity on the specified page. |
Request | RequestBody: [ { “id”: 0, “principle”: “string”, “eventType”: “string”, “eventData”: “string”, “eventDate”: “2025-09-22T12:23:08.922Z”, “like”: true } ] |
Response | [ { “id”: 0, “principle”: “string”, “eventType”: “string”, “eventData”: “string”, “eventDate”: “2025-09-22T12:23:09.119Z”, “like”: true } ] |
API Name | /pcm/user-activity/get-userActivityDetails |
Method | POST |
Description | Retrieves details of locked profiles. Provides information on profiles with restricted access. |
Request | Parameters: Pageable: { “page”: 0, “size”: 1, “sort”: [ “string” ] } RequestBody: [ { “id”: 0, “principle”: “string”, “eventType”: “string”, “eventData”: “string”, “eventDate”: “2025-09-22T12:23:08.922Z”, “like”: true } ] |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “id”: 0, “principle”: “string”, “eventType”: “string”, “eventData”: “string”, “eventDate”: “2025-09-22T12:24:24.470Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true }
|
API Name | /pcm/user-activity/deleteActivity |
Method | DELETE |
Description | Unlocks the Partner, Application, or Dataflow page. Removes restrictions on user activity for the specified page. |
Request | No Parameters
RequestBody: [ { “id”: 0, “principle”: “string”, “eventType”: “string”, “eventData”: “string”, “eventDate”: “2025-09-22T12:27:00.028Z”, “like”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/reports/files-size-processed/by-month/last-36-months |
Method | POST |
Description | Retrieves the number of files processed over the last 36 months. Provides monthly file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-size-processed/by-hour/last-30-days |
Method | POST |
Description | Retrieves the number of files processed over the last 30 days by hour. Provides hourly file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-size-processed/by-day/last-12-months |
Method | POST |
Description | Retrieves the number of files processed over the last 12 months by day. Provides daily file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/this-week |
Method | POST |
Description | Retrieves the number of files processed during the current week. Provides weekly file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/this-month |
Method | POST |
Description | Retrieves the number of files processed during the current month. Provides monthly file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/this-hour |
Method | POST |
Description | Retrieves the number of files processed during the current hour. Provides hourly file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/this-day |
Method | POST |
Description | Retrieves the number of files processed during the current day. Provides daily file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/peak-hours/last-31-days |
Method | POST |
Description | Identifies peak file processing hours over the last 31 days. Provides hourly data highlighting busiest processing times. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/by-month/last-36-months |
Method | POST |
Description | Retrieves file processing data for the last 36 months by month. Provides monthly file processing statistics. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/by-hour/last-30-days |
Method | POST |
Description | Retrieves the number of files processed by hour over the last 30 days. Provides hourly file processing statistics for the period. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/by-day/last-12-months |
Method | POST |
Description | Retrieves the number of files processed by day over the last 12 months. Provides daily file processing statistics for the period. |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/files-processed/by-day-week/avg-last-4-weeks-by-day |
Method | POST |
Description | Number of files processed by Day in a week, Average of last 4 weeks by day |
Request | RequestBody: { “dataRangeStart”: “string”, “dateRangeEnd”: “string”, “partner”: “string”, “status”: “string”, “direction”: “string”, “transferType”: “string”, “transaction”: “string”, “docType”: “string” } |
Response | [ { “name”: “string”, “count”: 0, “avg”: 0 } ] |
API Name | /pcm/reports/inactive-partners/last-n-days |
Method | GET |
Description | Retrieves partners inactive without file transfers for the past year. Provides a list of inactive partners over the specified period. |
Request | Parameters: { “days “: integer } |
Response | [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ]
|
API Name | /pcm/mailbox/file-drop |
Method | POST |
Description | Uploads a file to the mailbox. Allows file transfer into the mailbox system. |
Request | Parameters: { partnerPkId : “string”, files: “array<string>” }
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/google/google-drive/upload-file/{pkId} |
Method | POST |
Description | Uploads a file into a specified folder. Saves the file under the given folder ID. |
Request | Parameters: { folderId : “string”, pkId: “string” } RequestBody : MultipartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/google/google-drive/create-folder/{folderName}/{pkId} |
Method | POST |
Description | Creates a folder in Google Drive. Adds a new folder with the specified name under the given ID. |
Request | Parameters: { folderName : “string”, pkId: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/google/google-drive/get-folders-and-files-list/{pkId} |
Method | GET |
Description | Retrieves the list of folders and files. Provides folder and file details under the specified ID. |
Request | Parameters: { pkId: “string” } |
Response | [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “appProperties”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “capabilities”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “canAcceptOwnership”: true, “canAddChildren”: true, “canAddFolderFromAnotherDrive”: true, “canAddMyDriveParent”: true, “canChangeCopyRequiresWriterPermission”: true, “canChangeSecurityUpdateEnabled”: true, “canChangeViewersCanCopyContent”: true, “canComment”: true, “canCopy”: true, “canDelete”: true, “canDeleteChildren”: true, “canDownload”: true, “canEdit”: true, “canListChildren”: true, “canModifyContent”: true, “canModifyContentRestriction”: true, “canMoveChildrenOutOfDrive”: true, “canMoveChildrenOutOfTeamDrive”: true, “canMoveChildrenWithinDrive”: true, “canMoveChildrenWithinTeamDrive”: true, “canMoveItemIntoTeamDrive”: true, “canMoveItemOutOfDrive”: true, “canMoveItemOutOfTeamDrive”: true, “canMoveItemWithinDrive”: true, “canMoveItemWithinTeamDrive”: true, “canMoveTeamDriveItem”: true, “canReadDrive”: true, “canReadRevisions”: true, “canReadTeamDrive”: true, “canRemoveChildren”: true, “canRemoveMyDriveParent”: true, “canRename”: true, “canShare”: true, “canTrash”: true, “canTrashChildren”: true, “canUntrash”: true, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “contentHints”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “indexableText”: “string”, “thumbnail”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “image”: “string”, “mimeType”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “contentRestrictions”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “readOnly”: true, “reason”: “string”, “restrictingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “restrictionTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “type”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “copyRequiresWriterPermission”: true, “createdTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “description”: “string”, “driveId”: “string”, “explicitlyTrashed”: true, “exportLinks”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “fileExtension”: “string”, “folderColorRgb”: “string”, “fullFileExtension”: “string”, “hasAugmentedPermissions”: true, “hasThumbnail”: true, “headRevisionId”: “string”, “iconLink”: “string”, “id”: “string”, “imageMediaMetadata”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “aperture”: 0.1, “cameraMake”: “string”, “cameraModel”: “string”, “colorSpace”: “string”, “exposureBias”: 0.1, “exposureMode”: “string”, “exposureTime”: 0.1, “flashUsed”: true, “focalLength”: 0.1, “height”: 0, “isoSpeed”: 0, “lens”: “string”, “location”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “altitude”: 0.1, “latitude”: 0.1, “longitude”: 0.1, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “maxApertureValue”: 0.1, “meteringMode”: “string”, “rotation”: 0, “sensor”: “string”, “subjectDistance”: 0, “time”: “string”, “whiteBalance”: “string”, “width”: 0, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “isAppAuthorized”: true, “kind”: “string”, “lastModifyingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “linkShareMetadata”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “securityUpdateEligible”: true, “securityUpdateEnabled”: true, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “md5Checksum”: “string”, “mimeType”: “string”, “modifiedByMe”: true, “modifiedByMeTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “modifiedTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “name”: “string”, “originalFilename”: “string”, “ownedByMe”: true, “owners”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “parents”: [ “string” ], “permissionIds”: [ “string” ], “permissions”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “allowFileDiscovery”: true, “deleted”: true, “displayName”: “string”, “domain”: “string”, “emailAddress”: “string”, “expirationTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “id”: “string”, “kind”: “string”, “pendingOwner”: true, “permissionDetails”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “inherited”: true, “inheritedFrom”: “string”, “permissionType”: “string”, “role”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “photoLink”: “string”, “role”: “string”, “teamDrivePermissionDetails”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “inherited”: true, “inheritedFrom”: “string”, “role”: “string”, “teamDrivePermissionType”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “type”: “string”, “view”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “properties”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “quotaBytesUsed”: 0, “resourceKey”: “string”, “shared”: true, “sharedWithMeTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “sharingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “shortcutDetails”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “targetId”: “string”, “targetMimeType”: “string”, “targetResourceKey”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “size”: 0, “spaces”: [ “string” ], “starred”: true, “teamDriveId”: “string”, “thumbnailLink”: “string”, “thumbnailVersion”: 0, “trashed”: true, “trashedTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “trashingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “version”: 0, “videoMediaMetadata”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “durationMillis”: 0, “height”: 0, “width”: 0, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “viewedByMe”: true, “viewedByMeTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “viewersCanCopyContent”: true, “webContentLink”: “string”, “webViewLink”: “string”, “writersCanShare”: true, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ]
|
API Name | /pcm/google/google-drive/get-files-list/{parentId}/{pkId} |
Method | GET |
Description | Retrieves the list of files from a specified folder. Provides file details under the given parent folder ID. |
Request | Parameters: { parentId : “string”, pkId: “string” } |
Response | [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “appProperties”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “capabilities”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “canAcceptOwnership”: true, “canAddChildren”: true, “canAddFolderFromAnotherDrive”: true, “canAddMyDriveParent”: true, “canChangeCopyRequiresWriterPermission”: true, “canChangeSecurityUpdateEnabled”: true, “canChangeViewersCanCopyContent”: true, “canComment”: true, “canCopy”: true, “canDelete”: true, “canDeleteChildren”: true, “canDownload”: true, “canEdit”: true, “canListChildren”: true, “canModifyContent”: true, “canModifyContentRestriction”: true, “canMoveChildrenOutOfDrive”: true, “canMoveChildrenOutOfTeamDrive”: true, “canMoveChildrenWithinDrive”: true, “canMoveChildrenWithinTeamDrive”: true, “canMoveItemIntoTeamDrive”: true, “canMoveItemOutOfDrive”: true, “canMoveItemOutOfTeamDrive”: true, “canMoveItemWithinDrive”: true, “canMoveItemWithinTeamDrive”: true, “canMoveTeamDriveItem”: true, “canReadDrive”: true, “canReadRevisions”: true, “canReadTeamDrive”: true, “canRemoveChildren”: true, “canRemoveMyDriveParent”: true, “canRename”: true, “canShare”: true, “canTrash”: true, “canTrashChildren”: true, “canUntrash”: true, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “contentHints”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “indexableText”: “string”, “thumbnail”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “image”: “string”, “mimeType”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “contentRestrictions”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “readOnly”: true, “reason”: “string”, “restrictingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “restrictionTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “type”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “copyRequiresWriterPermission”: true, “createdTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “description”: “string”, “driveId”: “string”, “explicitlyTrashed”: true, “exportLinks”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “fileExtension”: “string”, “folderColorRgb”: “string”, “fullFileExtension”: “string”, “hasAugmentedPermissions”: true, “hasThumbnail”: true, “headRevisionId”: “string”, “iconLink”: “string”, “id”: “string”, “imageMediaMetadata”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “aperture”: 0.1, “cameraMake”: “string”, “cameraModel”: “string”, “colorSpace”: “string”, “exposureBias”: 0.1, “exposureMode”: “string”, “exposureTime”: 0.1, “flashUsed”: true, “focalLength”: 0.1, “height”: 0, “isoSpeed”: 0, “lens”: “string”, “location”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “altitude”: 0.1, “latitude”: 0.1, “longitude”: 0.1, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “maxApertureValue”: 0.1, “meteringMode”: “string”, “rotation”: 0, “sensor”: “string”, “subjectDistance”: 0, “time”: “string”, “whiteBalance”: “string”, “width”: 0, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “isAppAuthorized”: true, “kind”: “string”, “lastModifyingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “linkShareMetadata”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “securityUpdateEligible”: true, “securityUpdateEnabled”: true, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “md5Checksum”: “string”, “mimeType”: “string”, “modifiedByMe”: true, “modifiedByMeTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “modifiedTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “name”: “string”, “originalFilename”: “string”, “ownedByMe”: true, “owners”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “parents”: [ “string” ], “permissionIds”: [ “string” ], “permissions”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “allowFileDiscovery”: true, “deleted”: true, “displayName”: “string”, “domain”: “string”, “emailAddress”: “string”, “expirationTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “id”: “string”, “kind”: “string”, “pendingOwner”: true, “permissionDetails”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “inherited”: true, “inheritedFrom”: “string”, “permissionType”: “string”, “role”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “photoLink”: “string”, “role”: “string”, “teamDrivePermissionDetails”: [ { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “inherited”: true, “inheritedFrom”: “string”, “role”: “string”, “teamDrivePermissionType”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “type”: “string”, “view”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ], “properties”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “quotaBytesUsed”: 0, “resourceKey”: “string”, “shared”: true, “sharedWithMeTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “sharingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “shortcutDetails”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “targetId”: “string”, “targetMimeType”: “string”, “targetResourceKey”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “size”: 0, “spaces”: [ “string” ], “starred”: true, “teamDriveId”: “string”, “thumbnailLink”: “string”, “thumbnailVersion”: 0, “trashed”: true, “trashedTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “trashingUser”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “displayName”: “string”, “emailAddress”: “string”, “kind”: “string”, “me”: true, “permissionId”: “string”, “photoLink”: “string”, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “version”: 0, “videoMediaMetadata”: { “classInfo”: { “ignoreCase”: true, “names”: [ “string” ], “enum”: true, “fieldInfos”: [ { “field”: { “name”: “string”, “modifiers”: 0, “enumConstant”: true, “synthetic”: true, “genericType”: { “typeName”: “string” }, “declaredAnnotations”: [ “string” ], “annotatedType”: { “type”: { “typeName”: “string” }, “annotations”: [ “string” ], “declaredAnnotations”: [ “string” ] }, “annotations”: [ “string” ] }, “name”: “string”, “genericType”: { “typeName”: “string” }, “final”: true, “primitive”: true, “classInfo”: “string” } ] }, “durationMillis”: 0, “height”: 0, “width”: 0, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “viewedByMe”: true, “viewedByMeTime”: { “value”: 0, “dateOnly”: true, “timeZoneShift”: 0 }, “viewersCanCopyContent”: true, “webContentLink”: “string”, “webViewLink”: “string”, “writersCanShare”: true, “factory”: “string”, “unknownKeys”: { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” }, “empty”: true, “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } ]
|
API Name | /pcm/google/google-drive/download/{id}/{pkId} |
Method | GET |
Description | Retrieves the list of files from a specified folder. Provides file details under the given parent folder ID. |
Request | Parameters: { Id: “string”, pkId: “string” } |
Response | string
|
API Name | /pcm/google/google-drive/delete/{id}/{pkId} |
Method | GET |
Description | Deletes a folder from Google Drive. Removes the folder identified by the specified ID. |
Request | Parameters: { Id: “string”, pkId: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/generate-token |
Method | POST |
Description | Refresh JWT token – to access all REST resourcesInvalidate JWT token |
Request | RequestBody : { “userName”: “string”, “password”: “string” } |
Response | { “userId”: “string”, “token”: “string”, “email”: “string”, “userRole”: “string”, “userName”: “string”, “b2bUser”: true, “faxUser”: true, “siUser”: true, “faxQueue”: “string”, “faxQueueAccess”: “string”, “faxQueueName”: “string”, “lang”: “string”, “color”: “string”, “appVersion”: “string”, “appCustomName”: “string”, “dbInfo”: “string”, “sfgEnabled”: true, “errorInfo”: “string”, “apiConnect”: true, “sfgPcDReports”: true, “editAndUpload”: true, “partnerList”: [ { “key”: “string”, “value”: “string” } ], “cmDeployment”: true }
|
API Name | /pcm/refresh-token |
Method | GET |
Description | Refresh JWT token – to access all REST resourcesInvalidate JWT token |
Request | No Parameters |
Response | { “userId”: “string”, “token”: “string”, “email”: “string”, “userRole”: “string”, “userName”: “string”, “b2bUser”: true, “faxUser”: true, “siUser”: true, “faxQueue”: “string”, “faxQueueAccess”: “string”, “faxQueueName”: “string”, “lang”: “string”, “color”: “string”, “appVersion”: “string”, “appCustomName”: “string”, “dbInfo”: “string”, “sfgEnabled”: true, “errorInfo”: “string”, “apiConnect”: true, “sfgPcDReports”: true, “editAndUpload”: true, “partnerList”: [ { “key”: “string”, “value”: “string” } ], “cmDeployment”: true }
|
API Name | /pcm/logout |
Method | GET |
Description | Invalidates the JWT token. Logs the user out by revoking authentication. |
Request | No Parameters
|
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/file/upload/file |
Method | POST |
Description | Uploads a file to the system. Allows users to submit files for processing or storage. |
Request | { mailbox: “string” } RequestBody : MultipartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/file/upload/chunk |
Method | POST |
Description | Uploads a file chunk. Supports uploading large files in smaller parts. |
Request | { tmpDirectoryName : “string” , fileIndex: integer } RequestBody : MultipartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/file/upload/stop-process |
Method | GET |
Description | Cancels the ongoing chunk upload process. Stops uploading file parts immediately. |
Request | { tmpDirectoryName : “string” } RequestBody : MultipartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/file/upload/start |
Method | GET |
Description | Starts the process for uploading files in chunks. Initializes the chunked file upload. |
Request | No Parameters |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/file/upload/end-mailbox |
Method | GET |
Description | Merges uploaded chunks into a single file and sends it to the mailbox. Completes the chunked upload process. |
Request | { tmpDirectoryName : “string” , fileName : “string” , mailbox: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/file/activity/{activityName} |
Method | GET |
Description | Retrieves user file activity by activity name. Provides details of file actions performed by the user. |
Request | { activityName: “string” , mailbox: “string” } |
Response | [ { “pkId”: 0, “bpid”: “string”, “bpname”: “string”, “rulename”: “string”, “details”: “string”, “sequence”: 0, “activityDt”: “2025-0922T10:22:48.795Z”, “activityBy”: “string”, “actName”: “string” } ]
|
API Name | /pcm/certificate/upload-trusted-cert |
Method | POST |
Description | Uploads a trusted certificate. Adds a new trusted certificate to the system. |
Request | Parameters: { certName: string }
RequestBody : MultipartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/certificate/upload-system-cert |
Method | POST |
Description | Uploads a system certificate. Adds a new system certificate to the system. |
Request | Parameters: { “ certName “: “string”, “ certType “: “string”, “ privateKeyPassword “: “string”, “ keyStorePassword “: “string”
}
RequestBody: MultipartFile |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/certificate/upload-ssh-known-host-key |
Method | POST |
Description | Uploads an SSH KnownHostKey. Adds a new SSH known host key to the system. |
Request | Parameters: { “ keyName “: “string”
} RequestBody: MultipartFile |
Response | { statuscode:200, statusmessage: “SSH key uploaded successfully.” } |
API Name | /pcm/certificate/upload-pgp-publickey |
Method | POST |
Description | Uploads a PGP public key. Adds a new PGP public key to the system. |
Request | Parameters: { “ objectName “: “string”, “ partnerName “: “string”, “ applicationName “: “string” }
RequestBody: MultipartFile |
Response | { statuscode:200, statusmessage: “PGP key uploaded successfully!!” } |
API Name | /pcm/certificate/upload-ca-cert |
Method | POST |
Description | Uploads a CA certificate. Adds a new certificate authority certificate to the system. |
Request | Parameters: { “ certName “: “string” }
RequestBody: MultipartFile |
Response | { statuscode:200, statusmessage: “CA Certificate uploaded successfully!!” } |
API Name | /pcm/certificate/upload-SSH-authorized-user-key |
Method | POST |
Description | Uploads an SSH authorized user key. Adds a new authorized SSH key for user access. |
Request | Parameters: { “ keyName“: “string”, }
RequestBody: MultipartFile |
Response | { statuscode:200, statusmessage: “SSH Authorized User key uploaded successfully.” } |
API Name | /pcm/certificate/upload-SSH-UID-key |
Method | POST |
Description | Uploads an SSH User Identity Key. Adds a new SSH UID key for user authentication. |
Request | Parameters: { “ keyName “: “string”, “ passphrase “: “string”, }
RequestBody: MultipartFile |
Response | { statuscode:200, statusmessage: “SSH UID key uploaded successfully.” } |
API Name | /pcm/certificate/pgp-details |
Method | POST |
Description | Retrieves PGP key details. Provides information about the specified PGP key. |
Request | Parameters: pageable “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: “objectId”: “string”, “objectName”: “string”, “keyId”: “string”, “masterKey”: “string”, “expiryDate”: “string”, “tpAppPkid”: “string”, “subscriberType”: “string”, “tpAppName”: “string”, “like”: true } |
Response | { “content”: [ { “id”: 2, “keyId”: “67890XYZ”, “objectName”: “Partner_Key_B”, “tpAppName”: “PartnerTwo”, “expiryDate”: “2026-01-15T00:00:00”, “createdBy”: “system”, “createdDate”: “2024-02-05T08:00:00”, “lastModifiedBy”: “system”, “lastModifiedDate”: “2024-06-01T10:00:00” } ], “pageable”: { “sort”: { “sorted”: true, “unsorted”: false, “empty”: false }, “pageNumber”: 0, “pageSize”: 10, “offset”: 0, “paged”: true, “unpaged”: false }, “totalPages”: 5, “totalElements”: 42, “last”: false, “size”: 10, “number”: 0, “sort”: { “sorted”: true, “unsorted”: false, “empty”: false }, “first”: true, “numberOfElements”: 10, “empty”: false } |
API Name | /pcm/certificate/fetch-ssh-key |
Method | POST |
Description | Retrieves the SSH known host key. Provides details of the specified SSH host key. |
Request | Parameters: { “remoteHost”: “string”, “remotePort”: “string”, “keyName”: “string” } |
Response | { { “statuscode”: 200, “message”: “ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7…== user@host” } } |
API Name | /pcm/certificate/get-pgp-publickey |
Method | GET |
Description | Retrieves a PGP public key. Provides the requested PGP public key data. |
Request | Parameters: { “objectName”: “string” } |
Response | application/xml
<PGPKey> <Name>Partner_Key_A</Name> <KeyId>12345ABC</KeyId> <Created>2024-05-12T12:00:00</Created> <Expires>2026-05-12T12:00:00</Expires> <PublicKey> —–BEGIN PGP PUBLIC KEY BLOCK—– mQENBFuX… —–END PGP PUBLIC KEY BLOCK—– </PublicKey> </PGPKey> application/json
{ “Name”: “Partner_Key_A”, “KeyId”: “12345ABC”, “Created”: “2024-05-12T12:00:00”, “Expires”: “2026-05-12T12:00:00”, “PublicKey”: “—–BEGIN PGP PUBLIC KEY BLOCK—–\n…\n—–END PGP PUBLIC KEY BLOCK—–“ }
|
API Name | /pcm/certificate/get-pgp-publickeyId |
Method | GET |
Description | Retrieves a PGP public key by its ID. Provides the PGP public key associated with the given ID. |
Request | Parameters: { “keyId”: “string” } |
Response | HTTP/1.1 200 OK Content-Disposition: attachment; filename=”pgp_public_key.asc” Content-Type: application/xml |
API Name | /pcm/certificate/delete-pgp-publickey |
Method | DELETE |
Description | Deletes a specified PGP public key. Removes the PGP key from the system. |
Request | Parameters: { “objectId”: “string” } |
Response | { “statusCode”: 200, “statusMessage”: “PGP PublicKey Deleted successfully!!” }
|
API Name | /pcm/application/status |
Method | POST |
Description | Updates the status of a profile. Changes the current state of the specified profile. |
Request | Parameterss: { pkId: “string”, status: boolean } |
Response | { “statuscode”: 200, “statusmessage”: “Status Updated Successfully.” } |
API Name | /pcm/application/search |
Method | POST |
Description | Retrieves application profiles based on search criteria. Provides a list of matching application profiles. |
Request | Parameters: “page”: 0, “size”: 1, “sort”: [ “string” ] } RequestBody: { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true }
|
Response | { “content”: [ { “applicationId”: “APP001”, “applicationName”: “MyApplication”, “appIntegrationProtocol”: “HTTP”, “appIsActive”: “true”, “createdBy”: “admin”, “createdDate”: “2024-01-15T12:00:00”, “lastModifiedBy”: “admin”, “lastModifiedDate”: “2024-06-01T09:30:00” }, { “applicationId”: “APP002”, “applicationName”: “AnotherApplication”, “appIntegrationProtocol”: “HTTPS”, “appIsActive”: “true”, “createdBy”: “system”, “createdDate”: “2024-02-10T08:45:00”, “lastModifiedBy”: “system”, “lastModifiedDate”: “2024-05-20T11:15:00” } ], “pageable”: { “sort”: { “sorted”: true, “unsorted”: false, “empty”: false }, “pageNumber”: 0, “pageSize”: 10, “offset”: 0, “paged”: true, “unpaged”: false }, “totalPages”: 3, “totalElements”: 25, “last”: false, “size”: 10, “number”: 0, “sort”: { “sorted”: true, “unsorted”: false, “empty”: false }, “first”: true, “numberOfElements”: 10, “empty”: false } |
API Name | /pcm/application/search-xml |
Method | POST |
Description | Retrieves application profiles in XML format. Provides matching profiles as an XML response. |
Request | Parameters: “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: <?xml version=”1.0″ encoding=”UTF-8″?> <ProfileModel> <pkId>string</pkId> <profileName>string</profileName> <customProfileName>string</customProfileName> <pgpInfo>string</pgpInfo> <ipWhiteList>string</ipWhiteList> <profileId>string</profileId> <emailId>string</emailId> <phone>string</phone> <protocol>string</protocol> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <status>true</status> <hubInfo>true</hubInfo> <onlyPCM>true</onlyPCM> <pemIdentifier>string</pemIdentifier> <partnerPriority>true</partnerPriority> <like>true</like> </ProfileModel>
|
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <PageApplicationEntity> <totalPages>0</totalPages> <totalElements>0</totalElements> <number>0</number> <size>0</size> <numberOfElements>0</numberOfElements> <content> <createdBy>string</createdBy> <lastUpdatedBy>string</lastUpdatedBy> <lastUpdatedDt>2025-09-22T09:48:23.648Z</lastUpdatedDt> <pkId>string</pkId> <applicationName>string</applicationName> <applicationId>string</applicationId> <emailId>string</emailId> <phone>string</phone> <appIntegrationProtocol>string</appIntegrationProtocol> <appPickupFiles>string</appPickupFiles> <appDropFiles>string</appDropFiles> <appProtocolRef>string</appProtocolRef> <appIsActive>string</appIsActive> <pemIdentifier>string</pemIdentifier> <pgpInfo>string</pgpInfo> <ipWhitelist>string</ipWhitelist> <fileAppServer>string</fileAppServer> </content> <sort> <sorted>true</sorted> <empty>true</empty> <unsorted>true</unsorted> </sort> <first>true</first> <last>true</last> <pageable> <paged>true</paged> <unpaged>true</unpaged> <pageNumber>0</pageNumber> <pageSize>0</pageSize> <offset>0</offset> <sort> <sorted>true</sorted> <empty>true</empty> <unsorted>true</unsorted> </sort> </pageable> <empty>true</empty> </PageApplicationEntity>
|
API Name | /pcm/application/connectivity |
Method | POST |
Description | Retrieves the connectivity status of an application. Provides response details about the application’s connectivity. |
Request | Parameters: applicationName : “string”, } |
Response | { “status”: “string”, “bpId”: “string”, “statusCode”: “string” }
|
API Name | /pcm/application/applicationsListByApplicationId |
Method | POST |
Description | Retrieves application profiles using the application ID. Provides profile details for the specified application. |
Request | Parameters: ApplicationId : “string” } |
Response | { “count”: 0, “applicationId”: “string”, “applicationNames”: [ “string” ]}
|
API Name | /pcm/application/applications-by-protocol |
Method | POST |
Description | Retrieves application profiles based on protocol. Provides profiles matching the specified protocol. |
Request | Parameters: protocol : “string” } |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/application/applicationIdDupCheck |
Method | POST |
Description | Checks for duplicate application IDs. Validates if the application ID already exists. |
Request | Parameters: { ApplicationId : “string” } |
Response | true or false
|
API Name | /pcm/application/advanced-search |
Method | POST |
Description | Retrieves partner profiles using advanced search by protocol. Provides partner profiles matching the specified protocol criteria. |
Request | Parameters: pageable{ “page”: 0, “size”: 1, “sort”: [ “string” ] }
RequestBody: { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “connectionType”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “adapterName”: “string”, “poolingInterval”: “string”, “encryptionStrength”: “string”, “fileType”: “string”, “preferredAuthenticationType”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “protocolType”: “string”, “as2Identifier”: “string”, “as2ProfileName”: “string”, “senderId”: “string”, “exchangeCertificateName”: “string”, “signingCertificateName”: “string”, “bucketName”: “string”, “accessKey”: “string”, “endPointUrl”: “string”, “localNodeName”: “string”, “nodeName”: “string”, “getsNodeId”: “string”, “operatingSystem”: “string”, “securityProtocol”: “string”, “isSSP”: “string”, “ecProtocol”: “string”, “ecProtocolReference”: “string”, “certificate”: “string”, “filter”: “string”, “channelName”: “string”, “queueManager”: “string”, “queueName”: “string”, “sapRoute”: “string”, “name”: “string”, “customProtocolName”: “string”, “customProtocolExtensions”: “string”, “ssp”: true, “outBoundUrl”: “string”, “like”: true } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “createdBy”: “string”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-22T10:02:37.443Z”, “pkId”: “string”, “applicationName”: “string”, “applicationId”: “string”, “emailId”: “string”, “phone”: “string”, “appIntegrationProtocol”: “string”, “appPickupFiles”: “string”, “appDropFiles”: “string”, “appProtocolRef”: “string”, “appIsActive”: “string”, “pemIdentifier”: “string”, “pgpInfo”: “string”, “ipWhitelist”: “string”, “fileAppServer”: “string” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true }
|
API Name | /pcm/application/activity/{pkId} |
Method | POST |
Description | Retrieves the activity history of an application. Provides past actions and events for the specified application ID. |
Request | Parameters: { pkid: “string”, pageable: “page”: 0, “size”: 1, “sort”: [ “string” ] } } |
Response | { “totalPages”: 0, “totalElements”: 0, “number”: 0, “size”: 0, “numberOfElements”: 0, “content”: [ { “pkId”: “string”, “appRefId”: “string”, “userName”: “string”, “userId”: “string”, “activity”: “string”, “activityDt”: “2025-09-22T10:04:45.902Z” } ], “sort”: { “sorted”: true, “empty”: true, “unsorted”: true }, “first”: true, “last”: true, “pageable”: { “paged”: true, “unpaged”: true, “pageNumber”: 0, “pageSize”: 0, “offset”: 0, “sort”: { “sorted”: true, “empty”: true, “unsorted”: true } }, “empty”: true } |
API Name | /pcm/application/hasMultipleApplicationsForUserId/{userId} |
Method | GET |
Description | Checks if a user has multiple applications. Returns whether multiple applications exist for the given user ID. |
Request | Parameters: { userId : “string” } |
Response | true or false |
API Name | /pcm/application/application-map |
Method | GET |
Description | Retrieves applications as a map. Provides application details organized in a key-value format. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/application/application-list |
Method | GET |
Description | Retrieves applications as a list. Provides application details in a list format. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pcm/file-operator/reports/search |
Method | POST |
Description | Searches file operator transfer records. Provides transfer details based on search criteria. |
Request | Parameters: pageable { “page”: 0, “size”: 1, “sort”: [ “string” ] }
Request Body: { “dateRangeStart”: “string”, “dateRangeEnd”: “string”, “flowInOut”: “string”, “typeOfTransfer”: “string”, “doctype”: “string”, “status”: “string”, “srcProtocol”: “string”, “destProtocol”: “string”, “partner”: “string”, “application”: “string”, “senderId”: “string”, “receiverId”: “string”, “docTrans”: “string”, “errorStatus”: “string”, “srcFileName”: “string”, “destFileName”: “string”, “coreBpId”: “string”, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string”, “correlationValue26”: “string”, “correlationValue27”: “string”, “correlationValue28”: “string”, “correlationValue29”: “string”, “correlationValue30”: “string”, “correlationValue31”: “string”, “correlationValue32”: “string”, “correlationValue33”: “string”, “correlationValue34”: “string”, “correlationValue35”: “string”, “correlationValue36”: “string”, “correlationValue37”: “string”, “correlationValue38”: “string”, “correlationValue39”: “string”, “correlationValue40”: “string”, “correlationValue41”: “string”, “correlationValue42”: “string”, “correlationValue43”: “string”, “correlationValue44”: “string”, “correlationValue45”: “string”, “correlationValue46”: “string”, “correlationValue47”: “string”, “correlationValue48”: “string”, “correlationValue49”: “string”, “correlationValue50”: “string”, “fileNameRegExpression”: “string”, “mailbox”: “string”, “processData”: “string”, “staging”: true } |
Response | { “content”: [ { “id”: “123”, “filearrived”: “2025-09-19T10:15:30”, “flowInOut”: “UPLOAD”, “typeOfTransfer”: “SFTP”, “xrefName”: “DOC_TYPE_1”, “status”: “SUCCESS”, “srcprotocol”: “FTP”, “destprotocol”: “MAILBOX”, “partner”: “PartnerA”, “srcFileName”: “invoice_001.txt” // … other fields from TransferInfoEntity }, { “id”: “124”, “filearrived”: “2025-09-19T11:20:15”, “flowInOut”: “DOWNLOAD”, “typeOfTransfer”: “AS2”, “xrefName”: “DOC_TYPE_2”, “status”: “No Action Required”, “srcprotocol”: “MAILBOX”, “destprotocol”: “AS2”, “partner”: “PartnerB”, “srcFileName”: “po_2025.pdf” } ], “pageable”: { “sort”: { “empty”: false, “unsorted”: false, “sorted”: true }, “pageNumber”: 0, “pageSize”: 10, “offset”: 0, “unpaged”: false, “paged”: true }, “totalPages”: 5, “totalElements”: 45, “last”: false, “size”: 10, “number”: 0, “sort”: { “empty”: false, “unsorted”: false, “sorted”: true }, “first”: true, “numberOfElements”: 10, “empty”: false } |
API Name | /pcm/file-operator/reports/activity/{activityType} |
Method | GET |
Description | Number of files upload/Download This Hour, This Day, This Week, and This Month |
Request | Parameters: { ” activityType ”: “string”, } |
Response | { “thisHourCount”: <number>, “thisDayCount”: <number>, “thisWeekCount”: <number>, “thisMonthCount”: <number> } |
API Name | /pcm/api/workflow |
Method | POST |
Description | Shuts down a specified resource. Initiates the shutdown process via the API. |
Request | Parameters: { ” shutdownUser “: “string”, ” keyPhrase “: “string” } |
Response | HTTP/1.1 200 OK Content-Type: application/json Content-Length: 0 |
API Name | /pcm/api/workflow/create |
Method | POST |
Description | Creates or updates a workflow. Saves new workflow data or modifies existing workflows. |
Request | No Parameters
RequestBody { “apiName”: “string”, “seqId”: “string”, “processDocApiModel”: [ { “pkId”: “string”, “index”: 0, “methodName”: “string”, “filter”: “string”, “description”: “string”, “processRulesList”: [ { “ruleId”: “string”, “ruleName”: “string”, “propertyValue1”: “string”, “propertyValue2”: “string”, “propertyValue3”: “string”, “propertyValue4”: “string”, “propertyValue5”: “string”, “propertyValue6”: “string”, “propertyValue7”: “string”, “propertyValue8”: “string”, “propertyValue9”: “string”, “propertyValue10”: “string”, “propertyValue11”: “string”, “propertyValue12”: “string”, “propertyValue13”: “string”, “propertyValue14”: “string”, “propertyValue15”: “string”, “propertyValue16”: “string”, “propertyValue17”: “string”, “propertyValue18”: “string”, “propertyValue19”: “string”, “propertyValue20”: “string”, “propertyValue21”: “string”, “propertyValue22”: “string”, “propertyValue23”: “string”, “propertyValue24”: “string”, “propertyValue25”: “string”, “seqId”: 0, “index”: 0 } ] } ] } |
Response | { “statusCode”: 200, “statusMessage”: “Workflow created successfully “ } |
API Name | /pcm/api/workflow |
Method | GET |
Description | Retrieves workflow details. Provides information about the specified workflow. |
Request | Parameters: { ” profileId”: “string” } |
Response | { “seqId”: “SEQ001”, “apiName”: “WF123”, “processDocApiModel”: [ { “pkId”: “DOC001”, “methodName”: “POST”, “description”: “Create order”, “filter”: “*”, “index”: 1, “processRulesList”: [ { “ruleId”: “R1”, “ruleName”: “Check Customer”, “propertyValue1”: “123”, “propertyValue2”: null, “propertyValue3”: null // … up to propertyValue25 }, { “ruleId”: “R2”, “ruleName”: “Validate Amount”, “propertyValue1”: “1000”, “propertyValue2”: “USD” } ] } ] } |
API Name | /pcm/api/workflow |
Method | DELETE |
Description | Deletes a specified workflow. Removes the workflow from the system. |
Request | Parameters: { ” seqId”: “string” } |
Response | { “statusCode”: 200, “statusMessage”: “Workflow deleted successfully” } |
API Name | /pcm/api/workflow/activity/{processRefId} |
Method | GET |
Description | Retrieves workflow activity history. |
Request | Parameters { processRefId: “page”: , pageable { “page”: 0, “size”: 1, “sort”: [ “string” ] } |
Response | { “content”: [ { “id”: “ACT1001”, “processRefId”: “PR123”, “activityName”: “Order Created”, “status”: “SUCCESS”, “activityDt”: “2025-09-19T14:22:00” }, { “id”: “ACT1000”, “processRefId”: “PR123”, “activityName”: “Workflow Started”, “status”: “INITIATED”, “activityDt”: “2025-09-19T14:20:00” } ], “pageable”: { “sort”: { “empty”: false, “unsorted”: false, “sorted”: true }, “pageNumber”: 0, “pageSize”: 10, “offset”: 0, “paged”: true, “unpaged”: false }, “totalPages”: 1, “totalElements”: 2, “last”: true, “size”: 10, “number”: 0, “sort”: { “empty”: false, “unsorted”: false, “sorted”: true }, “first”: true, “numberOfElements”: 2, “empty”: false } |
API Name | /outlook-apis/sendMailOutlookApi |
Method | POST |
Description | Sends an email via Outlook API. |
Request | No Parameters
RequestBody: { “subject”: “string”, “contentType”: “string”, “content”: “string”, “outLookApiModel”: { “actualApi”: “string”, “actualApiWebMethod”: “string”, “apiHeaderDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “apiParamDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “oauth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } }, “toMails”: [ { “name”: “string” } ] } |
Response | “Mail Sent Successfully..!” |
API Name | /outlook-apis/getOutlookApi |
Method | POST |
Description | Retrieves undelivered emails from Outlook. |
Request | No Parameters RequestBody: “actualApi”: “string”, “actualApiWebMethod”: “string”, “apiHeaderDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “apiParamDataList”: [ { “key”: “string”, “value”: “string”, “description”: “string”, “required”: true, “dynamicValue”: true } ], “oauth2Auth”: { “tokenApiUrl”: “string”, “clientID”: “string”, “clientSecret”: “string”, “username”: “string”, “password”: “string”, “scope”: “string”, “grantType”: “string”, “resource”: “string”, “tokenKey”: “string”, “tokenPrefix”: “string”, “tokenHeader”: “string” } } |
Response | { “emails”: [ { “name”: “test1”, “address”: “john@example.com”, “subject”: “Meeting Tomorrow” }, { “name”: ” test2″, “address”: “jane@example.com”, “subject”: “Meeting Tomorrow” }, { “name”: ” test3″, “address”: “alice@example.com”, “subject”: “Project Update” } ] } |
API Name | /customer/{customerName} |
Method | POST |
Description | Creates or updates customer data. |
Request | Parameters: { “ customerName“: “string”, } |
Response | ” request processed successfully!” |
API Name | /customer/acme |
Method | POST |
Description | Sends data to the ACME partner endpoint. |
Request | ” string” |
Response | can’t parse JSON. Raw result: request processed successfully! |
API Name | /customer/abc-corp |
Method | POST |
Description | Sends data to the ABC Corp partner endpoint. |
Request | ” String” |
Response | can’t parse JSON. Raw result: request processed successfully! |
API Name | /pcm/dashboard/priorityErrorFiles |
Method | GET |
Description | Retrieves priority error files. |
Request | No parameters |
Response | [ “/DeleteDir”, “/DeleteDir/in”, “/DeleteDir/out”, “/deleteA”, “/deleteA/in”, “/deleteA/out” ] |
API Name | /pcm/partner-mailbox/getFilesFromMailboxes |
Method | GET |
Description | Retrieves available files from mailboxes. |
Request | Parameters: { “ MailboxPath “: “string”, } |
Response | [ { “messageName”: “order_12345.xml”, “messageSize”: “2048” }, { “messageName”: “invoice_56789.xml”, “messageSize”: “1024” } ] |
API Name | /pcm/partner-mailbox/downloadFile |
Method | GET |
Description | Downloads a file from a mailbox. |
Request | Parameters: { “ MailboxPath “: “string”, “ FileName “: “string” } |
Response | HTTP/1.1 200 OK Content-Disposition: attachment; filename=order_12345.xml Content-Type: application/octet-stream Content-Length: 2048 |
API Name | /pcm/dashboard/priorityErrorFiles |
Method | GET |
Description | Retrieves priority error files for the dashboard. |
Request | No parameters |
Response | [] |
API Name | /pcm/dashboard/partnersCount |
Method | GET |
Description | Retrieves the total number of partners. |
Request | No parameters |
Response | [ { “protocol”: “AS2”, “count”: 60 }, { “protocol”: “AWS_S3”, “count”: 34 }, { “protocol”: “CUSTOM_PROTOCOL”, “count”: 8 }, { “protocol”: “ExistingConnection”, “count”: 34 }, { “protocol”: “FileSystem”, “count”: 15 }, { “protocol”: “HTTP”, “count”: 10 }, { “protocol”: “HTTPS”, “count”: 10 }, { “protocol”: “MQ”, “count”: 9 }, { “protocol”: “Mailbox”, “count”: 25 }, { “protocol”: “SAP”, “count”: 10 }, { “protocol”: “SFGFTP”, “count”: 53 }, { “protocol”: “SFGFTPS”, “count”: 25 }, { “protocol”: “SFGSFTP”, “count”: 40 }, { “protocol”: “SFG_CONNECT_DIRECT”, “count”: 19 } ] |
API Name | /pcm/dashboard/flowOutCount |
Method | GET |
Description | Retrieves the count of outgoing workflow flows. |
Request | No parameters |
Response | { “dateRangeStart”: null, “dateRangeEnd”: null, “inbound”: “41”, “outbound”: “15” } |
API Name | /pcm/dashboard/flowInCount |
Method | GET |
Description | Retrieves the count of incoming workflow flows. |
Request | No parameters |
Response | { “dateRangeStart”: null, “dateRangeEnd”: null, “inbound”: “7”, “outbound”: “4” } |
API Name | /pcm/dashboard/filesOutCount |
Method | GET |
Description | Retrieves the count of outgoing files. |
Request | No parameters |
Response | cache-control: no-cache,no-store,max-age=0,must-revalidate connection: keep-alive content-length: 0 date: Fri,19 Sep 2025 15:56:05 GMT expires: 0 feature-policy: geolocation ‘self’; vibrate ‘none’ keep-alive: timeout=8 pragma: no-cache profilenames: cm referrer-policy: same-origin server: IBM Partner Engagement Manager Community Manager strict-transport-security: max-age=31536000 ; includeSubDomains vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers x-content-type-options: nosniff x-frame-options: DENY x-xss-protection: 0 |
API Name | /pcm/dashboard/filesInCount |
Method | GET |
Description | Retrieves the count of incoming files. |
Request | No parameters |
Response | cache-control: no-cache,no-store,max-age=0,must-revalidate connection: keep-alive content-length: 0 date: Fri,19 Sep 2025 15:57:11 GMT expires: 0 feature-policy: geolocation ‘self’; vibrate ‘none’ keep-alive: timeout=8 pragma: no-cache profilenames: cm referrer-policy: same-origin server: IBM Partner Engagement Manager Community Manager strict-transport-security: max-age=31536000 ; includeSubDomains vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers x-content-type-options: nosniff x-frame-options: DENY x-xss-protection: 0
|
API Name | /pcm/dashboard/counts |
Method | GET |
Description | Retrieves dashboard counts. |
Request | No parameters |
Response | { “dateRangeStart”: null, “dateRangeEnd”: null, “partnerCount”: “352”, “applicationCount”: “157”, “dataflowCount”: “67”, “filesCount”: null, “oneHourFailedFiles”: null, “oneDayFailedFiles”: null } |
API Name | /pcm/dashboard/applicationCount |
Method | GET |
Description | API provides the total number of applications in the dashboard. It is typically used to retrieve the current count of all submitted or active applications for monitoring or reporting purposes. |
Request | No parameters |
Response | [ { “protocol”: “AS2”, “count”: 19 }, { “protocol”: “AWS_S3”, “count”: 18 }, { “protocol”: “FileSystem”, “count”: 6 }, { “protocol”: “HTTP”, “count”: 6 }, { “protocol”: “HTTPS”, “count”: 6 }, { “protocol”: “MQ”, “count”: 4 }, { “protocol”: “Mailbox”, “count”: 18 }, { “protocol”: “SAP”, “count”: 4 }, { “protocol”: “SFGFTP”, “count”: 30 }, { “protocol”: “SFGFTPS”, “count”: 17 }, { “protocol”: “SFGSFTP”, “count”: 23 }, { “protocol”: “SFG_CONNECT_DIRECT”, “count”: 6 } ] |
API Name | /pcm/bulk-remote-profiles-active |
Method | GET |
Description | On-boarding Bulk Profiles: On-boarding the Profiles into both PCM and SI using the profiles data in staging tables
|
Request | No parameters |
Response | { “statusCode”: 200, “statusMessage”: “Bulk Profiles import to SI, successfully completed” } |
Api Name | /pcm/si/user |
Method | GET |
Description | Retrieves user details associated with a given organization. |
Request | Parameter |
Response | [ { “lockid”: 0, “createts”: “2025-09-23T09:03:03.167Z”, “modifyts”: “2025-09-23T09:03:03.167Z”, “createuserid”: “string”, “modifyuserid”: “string”, “createprogid”: “string”, “modifyprogid”: “string”, “userKey”: “string”, “loginid”: “string”, “password”: “string”, “isPasswordEncrypted”: “string”, “username”: “string”, “businessKey”: “string”, “usergroupKey”: “string”, “contactaddressKey”: “string”, “billingaddressKey”: “string”, “imagefile”: “string”, “usertype”: “string”, “noteKey”: “string”, “preferenceKey”: “string”, “pwdlastchangedon”: “2025-09-23T09:03:03.167Z”, “activateflag”: “string”, “longdesc”: “string”, “localecode”: “string”, “organizationKey”: “string”, “parentUserKey”: “string”, “menuId”: “string”, “theme”: “string”, “creatorOrganizationKey”: “string”, “systemname”: “string”, “dataSecurityGroupId”: “string”, “departmentKey”: “string”, “passwordPolicyId”: “string”, “sessionTimeout”: 0, “superUser”: “string”, “confirmValue”: “string”, “changePassNext”: 0, “salt”: “string”, “pwdPolicyKey”: “string” } ] |
API Name | /pcm/si/user |
Method | POST |
Description | Creates a new user account in IBM Sterling B2B Integrator. Used for onboarding users and enabling them for authentication and integration processes. |
Request | { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true } |
Response | { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true } |
API Name | /pcm/si/user/get-Ysf-User |
Method | POST |
Description | Retrieves YSF user details from IBM Sterling B2B Integrator based on the provided name. |
Request | { “name”: “string” } |
Response |
{ “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true } |
API Name | /pcm/si/user/assign-gp-user |
Method | POST |
Description | Assigns groups and permissions to a specified user in IBM Sterling B2B Integrator. This API is used to manage user roles and access rights. |
Request | { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true } |
Response |
{ “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true } |
API Name | /pcm/si/user/get-identities-list |
Method | GET |
Description | Retrieves the list of identities from IBM Sterling B2B Integrator. This API is used to view and manage available user identities in the system. |
Request | No parameters |
Response | [ “string” ] |
API Name | /pcm/si/user/get-gp-per |
Method | GET |
Description | Retrieves the groups and permissions assigned to a user in IBM Sterling B2B Integrator. |
Request | Parameters userName |
Response |
{ “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true } |
API Name | /pcm/si/user/get-Policy-list |
Method | GET |
Description | Fetches the list of policies from IBM Sterling B2B Integrator. This API is used to view and manage available system policies. |
Request | No Parameters |
Response | [ “string” ] |
API Name | /pcm/si/user/get-Manager-list |
Method | GET |
Description | Retrieves the list of manager IDs from IBM Sterling B2B Integrator. This API is used to identify and manage user-manager relationships. |
Request | No Parameters |
Response | [ “string” ] |
API Name | /pcm/si/user/get-Auth-Host-list |
Method | GET |
Description | Fetches the list of authentication hosts from IBM Sterling B2B Integrator. This API is used to manage and configure authorized host details. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pcm/partner/aws-s3 |
Method | PUT |
Description | Updates the AWS-S3 partner profile with the provided configuration details. This API is used to modify and maintain partner integration settings. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3 |
Method | POST |
Description | Creates a new AWS-S3 partner profile with the given configuration details. This API is used to onboard and enable partner integration. |
Request | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3/saveAll |
Method | POST |
Description | Creates multiple AWS-S3 partner profiles in a single request. This API is used for bulk onboarding and configuration of partner integrations. |
Request | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } ] |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3/{pkId} |
Method | GET |
Description | Retrieves the AWS-S3 partner profile for the specified pkId. This API is used to view partner configuration and integration details. |
Request | Parameters pkId , isSIProfile |
Response | { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } |
API Name | /pcm/partner/aws-s3/{pkId} |
Method | DELETE |
Description | Deletes the AWS-S3 partner profile identified by pkId. This API is used to remove partner integration configurations from the system. |
Request | Parameters pkId , isDeleteInSI |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/partner/aws-s3/getAllByProfileId/{profileId}/{protocol} |
Method | GET |
Description | Retrieves AWS-S3 partner profiles based on profileId and protocol. This API is used to fetch specific partner configuration details for integration purposes. |
Request | Parameters ProfileId , protocol , isSIProfile |
Response | [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “accessKey”: “string”, “secretKey”: “string”, “endpoint”: “string”, “region”: “string”, “isActive”: “string”, “inMailbox”: “string”, “hubInfo”: true, “poolingInterval”: “string”, “outboundConnectionType”: true, “inboundConnectionType”: true, “adapterName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “sourcePath”: “string”, “fileType”: “string”, “bucketName”: “string”, “fileName”: “string”, “isHubInfo”: “string”, “endPointUrl”: “string”, “folderName”: “string”, “queueName”: “string”, “authenticationType”: “string”, “authenticationHost”: “string”, “profileUserName”: “string”, “profileUserPassword”: “string”, “doesUseSSH”: true, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “producerS3Configuration”: { “credentialsRequired”: true, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “proxyuserName”: “string”, “ConnectionRetries”: 0, “ConnectionTimeout”: 0, “EndPointUrl”: “string”, “AccessKey”: “string”, “SecretKey”: “string”, “ProxyServer”: true, “QueueName”: “string”, “Region”: “string” }, “consumerS3Configuration”: { “bucketName”: “string”, “connectionTimeOut”: 0, “credentialsRequired”: true, “directory”: “string”, “endpoint”: “string”, “endpointPort”: 0, “maxErrorRetryCount”: 0, “obscuredaccesskey”: “string”, “obscuredsecretkey”: “string”, “password”: “string”, “proxyHost”: “string”, “proxyPort”: 0, “region”: “string”, “requiredProxy”: true, “userName”: “string” }, “deleteAfterCollection”: true, “endPointPort”: “string”, “connectionRetries”: “string”, “connectionReadTimeout”: “string”, “credentialsRequired”: true, “proxyPort”: “string”, “proxyHost”: “string”, “proxyUsername”: “string”, “proxyPassword”: “string”, “definitionName”: “string”, “description”: “string”, “serviceGroupName”: “string”, “serviceName”: “string”, “targetEnv”: “string”, “directory”: “string”, “serviceId”: “string”, “proxyServer”: true, “sqsstring”: “string”, “initiatingConsumer”: true, “initiatingProducer”: true, “listeningConsumer”: true, “listeningProducer”: true, “siprofile”: true, “proxyBasicAuthentication”: true, “like”: true, “requiredProxy”: true } ] |
API Name | /pem/workflow/update-file-types |
Method | PUT |
Description | Updates the file types configuration in a workflow. This API is used to modify and manage workflow file type settings. |
Request | { “partnerProfile”: “string”, “applicationProfile”: “string”, “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/base-64/update-file-types |
Method | PUT |
Description | Updates workflow file types using Base64-encoded data. This API is used to modify and manage file type configurations securely. |
Request | { “data”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/routing-rules |
Method | PUT |
Description | Updates an existing routing rule in the system. This API is used to modify routing logic and configuration for workflow processing. |
Request | Parameters name , mailBox |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/remove-fileTypes |
Method | POST |
Description | Removes a specified file type from the workflow configuration. This API is used to manage and update workflow file type settings. |
Request | { “partnerProfile”: “string”, “applicationProfile”: “string”, “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/import-with-profiles |
Method | POST |
Description | Imports a workflow along with its associated profile settings. This API is used to onboard workflows with predefined configurations efficiently. |
Request | { “content”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pcm/workflow/flows-list |
Method | POST |
Description | Retrieves a list of template workflow flow types. This API is used to view available workflow templates for configuration or processing. |
Request | Parameters IsPartnerID ,
{ “pkId”: “string”, “partner”: “string”, “application”: “string”, “flowType”: “string”, “senderId”: “string”, “receiverId”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “status”: “string”, “errorInfo”: “string”, “operation”: “string”, “regexFind”: true } |
Response | { “content”: [ { “pkId”: “string”, “partner”: “string”, “application”: “string”, “flowType”: “string”, “senderId”: “string”, “receiverId”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “status”: “string”, “errorInfo”: “string”, “operation”: “string”, “regexFind”: true } ] } |
API Name | /pem/workflow-edit-flows |
Method | POST |
Description | Retrieves workflow details including profiles, flows, and rules along with any updates. This API is used to view and manage the complete workflow configuration. |
Request | { “partnerProfile”: “string”, “applicationProfile”: “string”, “partnerProtocol”: “string”, “content”: [ { “pkId”: “string”, “partner”: “string”, “application”: “string”, “flowType”: “string”, “senderId”: “string”, “receiverId”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “status”: “string”, “errorInfo”: “string”, “operation”: “string”, “regexFind”: true } ] } |
Response | { “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] } |
API Name | /pem/workflow/edit-flows2 |
Method | POST |
Description | Edits existing workflows by updating their flows, profiles, and rules. This API is used to modify workflow configurations efficiently. |
Request | [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] |
Response |
{ “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] } |
API Name | /pem/workflow/create |
Method | POST |
Description | Creates a new workflow with the specified flows, profiles, and rules. This API is used to onboard and configure workflows in the system. |
Request | { “partnerProfile”: “string”, “applicationProfile”: “string”, “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/base-64/remove-fileTypes |
Method | POST |
Description | Removes a workflow file type using Base64-encoded data. This API is used to manage and update workflow file type configurations securely. |
Request | { “data”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/base-64/create |
Method | POST |
Description | Creates a new workflow using Base64-encoded data. This API is used to securely onboard workflows with their configurations. |
Request | { “data”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/base-64/add-file-types |
Method | POST |
Description | Adds file types to a workflow using Base64-encoded data. This API is used to update workflow configurations securely with new file types. |
Request | { “data”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/add-file-types |
Method | POST |
Description | Adds new file types to an existing workflow. This API is used to update and manage workflow file type configurations. |
Request | { “partnerProfile”: “string”, “applicationProfile”: “string”, “content”: [ { “pkId”: “string”, “partnerProfile”: “string”, “applicationProfile”: “string”, “processDocPkId”: “string”, “seqType”: “string”, “flow”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “partnerId”: “string”, “receiverId”: “string”, “versionNo”: “string”, “processRulePkId”: “string”, “ruleId”: “string”, “ruleName”: “string”, “ruleValue”: “string”, “businessProcessId”: “string”, “ruleProperty1”: “string”, “ruleProperty2”: “string”, “ruleProperty3”: “string”, “ruleProperty4”: “string”, “ruleProperty5”: “string”, “ruleProperty6”: “string”, “ruleProperty7”: “string”, “ruleProperty8”: “string”, “ruleProperty9”: “string”, “ruleProperty10”: “string”, “ruleProperty11”: “string”, “ruleProperty12”: “string”, “ruleProperty13”: “string”, “ruleProperty14”: “string”, “ruleProperty15”: “string”, “ruleProperty16”: “string”, “ruleProperty17”: “string”, “ruleProperty18”: “string”, “ruleProperty19”: “string”, “ruleProperty20”: “string”, “ruleProperty21”: “string”, “ruleProperty22”: “string”, “ruleProperty23”: “string”, “ruleProperty24”: “string”, “ruleProperty25”: “string”, “rowNum”: 0, “seqId”: 0 } ] } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/string-lower-upper |
Method | POST |
Description | Converts a given string to either lowercase or uppercase. This API is used for standardizing or formatting string data. |
Request | { “data”: “string”, “ignoreSpace”: true, “ignoreLowerUpper”: true, “removeSpace”: true, “toLower”: true, “toUpper”: true } |
Response | { “data”: “string”, “ignoreSpace”: true, “ignoreLowerUpper”: true, “removeSpace”: true, “toLower”: true, “toUpper”: true } |
API Name | /pem/string-length |
Method | POST |
Description | Calculates the length of a given string. This API is used to determine the number of characters in the input string. |
Request | { “key”: “string”, “value”: “string” } |
Response | { “key”: “string”, “value”: “string” } |
API Name | /pem/string-concatenation |
Method | POST |
Description | Concatenates a list of strings into a single string. This API is used to combine multiple string values efficiently. |
Request | { “string1”: “string”, “string2”: “string”, “string3”: “string”, “string4”: “string”, “string5”: “string”, “string6”: “string”, “string7”: “string”, “string8”: “string”, “string9”: “string”, “string10”: “string”, “string11”: “string”, “string12”: “string”, “string13”: “string”, “string14”: “string”, “string15”: “string”, “string16”: “string”, “string17”: “string”, “string18”: “string”, “string19”: “string”, “string20”: “string” } |
Response | { “key”: “string”, “value”: “string” } |
API Name | /pem/send-email |
Method | POST |
Description | Sends an email to the specified recipients. This API is used for notifications, alerts, or communication purposes. |
Request | { “host”: “string”, “port”: “string”, “desc”: “string”, “subject”: “string”, “userName”: “string”, “password”: “string”, “note”: “string”, “attachmentContentBase64”: “string”, “attachmentName”: “string”, “attachmentExtension”: “string”, “toMails”: [ { “name”: “string” } ], “bccMails”: [ { “name”: “string” } ], “ccMails”: [ { “name”: “string” } ], “normalToMails”: “string”, “normalBccMails”: “string”, “normalCcMails”: “string”, “normalMail”: true, “withAttachment”: true } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/routing-channels |
Method | POST |
Description | Retrieves a list of routing channel codes. This API is used to view and manage available routing channels in the system. |
Request | { “templateName”: “string”, “producerName”: “string”, “consumerName”: “string” } |
Response | { “content”: [ { “routingChannelKey”: “string”, “templateName”: “string”, “producer”: “string”, “consumer”: “string”, “producerMailboxPath”: “string” } ] } |
API Name | /pem/reports/search-by-pattern |
Method | POST |
Description | Retrieves file types along with their current status based on a search pattern. This API is used to filter and view file type information efficiently. |
Request | { “pkId”: “string”, “partner”: “string”, “application”: “string”, “flowType”: “string”, “senderId”: “string”, “receiverId”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “status”: “string”, “errorInfo”: “string”, “operation”: “string”, “regexFind”: true } |
Response | { “content”: [ { “pkId”: “string”, “partner”: “string”, “application”: “string”, “flowType”: “string”, “senderId”: “string”, “receiverId”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “status”: “string”, “errorInfo”: “string”, “operation”: “string”, “regexFind”: true } ] } |
API Name | /pem/profiles/search-remote-profiles-by-auth-hub |
Method | POST |
Description | Retrieves all profiles based on isHubInfo and PrfAuthType criteria. This API is used to filter and fetch profiles according to authentication and hub configurations. |
Request | Parameters IsHubInfo , prfAuthType |
Response | { “content”: [ { “pkId”: “string”, “profileName”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “preferredAuthenticationType”: “string”, “preferredCipher”: “string”, “characterEncoding”: “string”, “compression”: “string”, “preferredMacAlgorithm”: “string”, “localPortRange”: “string”, “userIdentityKey”: “string”, “knownHostKey”: “string”, “connectionRetryCount”: “string”, “retryDelay”: “string”, “responseTimeOut”: “string”, “encryptionStrength”: “string”, “useCCC”: true, “useImplicitSSL”: true, “certificateId”: “string”, “remoteHost”: “string”, “remotePort”: “string”, “userName”: “string”, “password”: “string”, “inDirectory”: “string”, “outDirectory”: “string”, “fileType”: “string”, “transferType”: “string”, “connectionType”: “string”, “noOfRetries”: “string”, “retryInterval”: “string”, “createUserInSI”: true, “createDirectoryInSI”: true, “deleteAfterCollection”: true, “poolingInterval”: “string”, “adapterName”: “string”, “hubInfo”: true, “userIdentity”: “string”, “groups”: [ { “name”: “string” } ], “authorizedUserKeys”: [ { “name”: “string” } ], “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “isSIProfile”: true, “profileUserName”: “string”, “profileUserPassword”: “string”, “pwdPolicy”: “string”, “sessionTimeout”: “string”, “surname”: “string”, “givenName”: “string”, “isInitiatingConsumer”: true, “isInitiatingProducer”: true, “isListeningConsumer”: true, “isListeningProducer”: true, “doesUseSSH”: true, “siteCommand”: “string”, “mergeUser”: true, “secondaryMail”: “string”, “resetPermissions”: true, “city”: “string”, “state”: “string”, “zipCode”: “string”, “country”: “string”, “caCertificateNames”: [ { “name”: “string” } ], “keyCertificateNames”: [ { “name”: “string” } ], “knownHostKeyNames”: [ { “name”: “string” } ], “createSfgProfile”: true, “createProducerProfile”: true, “useBaseDirectoryForVirtualRoot”: true, “authenticationType”: “string”, “authenticationHost”: “string”, “virtualRoot”: “string”, “routingRuleName”: “string”, “asciiArmor”: true, “doesRequireEncryptedData”: true, “doesRequireSignedData”: true, “textMode”: true, “permissions”: [ { “name”: “string” } ], “userDetails”: { “userName”: “string”, “password”: “string”, “userType”: “string”, “surname”: “string”, “givenName”: “string”, “parentUserKey”: “string”, “sessionTimeOut”: 0, “pwdPolicyId”: “string”, “emailId”: “string”, “mergeUser”: true, “userIdentity”: “string”, “groups”: [ “string” ], “permissions”: [ “string” ], “authorizedUserKeys”: [ “string” ], “policy”: “string”, “resetPermissions”: true, “authenticationHost”: “string”, “pager”: “string”, “preferredLanguage”: “string”, “managerId”: “string”, “identity”: “string”, “pcmUserLogin”: true }, “patch”: true, “like”: true } ] } |
API Name | /pem/profiles/search-remote-profiles-by-auth-hub-xml |
Method | POST |
Description | Retrieves all profiles in XML format based on isHubInfo and PrfAuthType. This API is used to fetch and filter profiles according to hub and authentication settings. |
Request | Parameters IsHubInfo , prfAuthType |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityMangerModelRemoteProfileModel> <content> <pkId>string</pkId> <profileName>string</profileName> <profileId>string</profileId> <emailId>string</emailId> <phone>string</phone> <protocol>string</protocol> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <status>true</status> <preferredAuthenticationType>string</preferredAuthenticationType> <preferredCipher>string</preferredCipher> <characterEncoding>string</characterEncoding> <compression>string</compression> <preferredMacAlgorithm>string</preferredMacAlgorithm> <localPortRange>string</localPortRange> <userIdentityKey>string</userIdentityKey> <knownHostKey>string</knownHostKey> <connectionRetryCount>string</connectionRetryCount> <retryDelay>string</retryDelay> <responseTimeOut>string</responseTimeOut> <encryptionStrength>string</encryptionStrength> <useCCC>true</useCCC> <useImplicitSSL>true</useImplicitSSL> <certificateId>string</certificateId> <remoteHost>string</remoteHost> <remotePort>string</remotePort> <userName>string</userName> <password>string</password> <inDirectory>string</inDirectory> <outDirectory>string</outDirectory> <fileType>string</fileType> <transferType>string</transferType> <connectionType>string</connectionType> <noOfRetries>string</noOfRetries> <retryInterval>string</retryInterval> <createUserInSI>true</createUserInSI> <createDirectoryInSI>true</createDirectoryInSI> <deleteAfterCollection>true</deleteAfterCollection> <poolingInterval>string</poolingInterval> <adapterName>string</adapterName> <hubInfo>true</hubInfo> <userIdentity>string</userIdentity> <groups> <name>string</name> </groups> <authorizedUserKeys> <name>string</name> </authorizedUserKeys> <customProfileName>string</customProfileName> <pgpInfo>string</pgpInfo> <ipWhiteList>string</ipWhiteList> <onlyPCM>true</onlyPCM> <pemIdentifier>string</pemIdentifier> <partnerPriority>true</partnerPriority> <isSIProfile>true</isSIProfile> <profileUserName>string</profileUserName> <profileUserPassword>string</profileUserPassword> <pwdPolicy>string</pwdPolicy> <sessionTimeout>string</sessionTimeout> <surname>string</surname> <givenName>string</givenName> <isInitiatingConsumer>true</isInitiatingConsumer> <isInitiatingProducer>true</isInitiatingProducer> <isListeningConsumer>true</isListeningConsumer> <isListeningProducer>true</isListeningProducer> <doesUseSSH>true</doesUseSSH> <siteCommand>string</siteCommand> <mergeUser>true</mergeUser> <secondaryMail>string</secondaryMail> <resetPermissions>true</resetPermissions> <city>string</city> <state>string</state> <zipCode>string</zipCode> <country>string</country> <caCertificateNames> <name>string</name> </caCertificateNames> <keyCertificateNames> <name>string</name> </keyCertificateNames> <knownHostKeyNames> <name>string</name> </knownHostKeyNames> <createSfgProfile>true</createSfgProfile> <createProducerProfile>true</createProducerProfile> <useBaseDirectoryForVirtualRoot>true</useBaseDirectoryForVirtualRoot> <authenticationType>string</authenticationType> <authenticationHost>string</authenticationHost> <virtualRoot>string</virtualRoot> <routingRuleName>string</routingRuleName> <asciiArmor>true</asciiArmor> <doesRequireEncryptedData>true</doesRequireEncryptedData> <doesRequireSignedData>true</doesRequireSignedData> <textMode>true</textMode> <permissions> <name>string</name> </permissions> <userDetails> <userName>string</userName> <password>string</password> <userType>string</userType> <surname>string</surname> <givenName>string</givenName> <parentUserKey>string</parentUserKey> <sessionTimeOut>0</sessionTimeOut> <pwdPolicyId>string</pwdPolicyId> <emailId>string</emailId> <mergeUser>true</mergeUser> <userIdentity>string</userIdentity> <groups>string</groups> <permissions>string</permissions> <authorizedUserKeys>string</authorizedUserKeys> <policy>string</policy> <resetPermissions>true</resetPermissions> <authenticationHost>string</authenticationHost> <pager>string</pager> <preferredLanguage>string</preferredLanguage> <managerId>string</managerId> <identity>string</identity> <pcmUserLogin>true</pcmUserLogin> </userDetails> <patch>true</patch> <like>true</like> </content> </CommunityMangerModelRemoteProfileModel> |
API Name | /pem/profiles-search-all-contacts |
Method | POST |
Description | Retrieves all partner contact details. This API is used to view and manage contact information for partners. |
Request | Parameters IsOr , fileTpServer
{ “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } |
Response | { “content”: [ { “pkId”: “string”, “profileName”: “string”, “customProfileName”: “string”, “pgpInfo”: “string”, “ipWhiteList”: “string”, “profileId”: “string”, “emailId”: “string”, “phone”: “string”, “protocol”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “status”: true, “hubInfo”: true, “onlyPCM”: true, “pemIdentifier”: “string”, “partnerPriority”: true, “like”: true } ] } |
API Name | /pem/profiles/search-all-contacts/xml |
Method | POST |
Description | Retrieves all partner contact details in XML format. This API is used to view and manage partner contacts in a structured XML format. |
Request | Parameters IsOr , file TpServer
<?xml version=”1.0″ encoding=”UTF-8″?> <ProfileModel> <pkId>string</pkId> <profileName>string</profileName> <customProfileName>string</customProfileName> <pgpInfo>string</pgpInfo> <ipWhiteList>string</ipWhiteList> <profileId>string</profileId> <emailId>string</emailId> <phone>string</phone> <protocol>string</protocol> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <status>true</status> <hubInfo>true</hubInfo> <onlyPCM>true</onlyPCM> <pemIdentifier>string</pemIdentifier> <partnerPriority>true</partnerPriority> <like>true</like> </ProfileModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityMangerModelProfileModel> <content> <pkId>string</pkId> <profileName>string</profileName> <customProfileName>string</customProfileName> <pgpInfo>string</pgpInfo> <ipWhiteList>string</ipWhiteList> <profileId>string</profileId> <emailId>string</emailId> <phone>string</phone> <protocol>string</protocol> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <status>true</status> <hubInfo>true</hubInfo> <onlyPCM>true</onlyPCM> <pemIdentifier>string</pemIdentifier> <partnerPriority>true</partnerPriority> <like>true</like> </content> </CommunityMangerModelProfileModel> |
API Name | /pem/partner/status |
Method | POST |
Description | Updates the status of a partner profile. This API is used to activate, deactivate, or modify the status of partner integrations. |
Request | Parameters partnerName , status |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/partner/search |
Method | POST |
Description | Searches for partner profiles based on provided criteria. This API is used to retrieve partner profile details using template-based filtering. |
Request | { “pkId”: “string”, “partner”: “string”, “application”: “string”, “flowType”: “string”, “senderId”: “string”, “receiverId”: “string”, “fileName”: “string”, “docType”: “string”, “transaction”: “string”, “status”: “string”, “errorInfo”: “string”, “operation”: “string”, “regexFind”: true } |
Response | { “content”: [ { “createdBy”: “string”, “lastUpdatedBy”: “string”, “lastUpdatedDt”: “2025-09-23T11:23:38.839Z”, “tpName”: “string”, “customTpName”: “string”, “pgpInfo”: “string”, “ipWhitelist”: “string”, “tpId”: “string”, “addressLine1”: “string”, “addressLine2”: “string”, “email”: “string”, “phone”: “string”, “tpProtocol”: “string”, “tpPickupFiles”: “string”, “fileTpServer”: “string”, “partnerProtocolRef”: “string”, “status”: “string”, “isProtocolHubInfo”: “string”, “isOnlyPcm”: “string”, “pemIdentifier”: “string”, “getpartnerPriority”: “string”, “pkId”: “string” } ] } |
API Name | /pem/mathematicalCalculator |
Method | POST |
Description | Performs mathematical calculations based on the provided input. This API is used to execute arithmetic or logical operations programmatically. |
Request | { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } |
Response | { “key”: “string”, “value”: “string” } |
API Name | /pem/import-as-string |
Method | POST |
Description | Imports a workflow using input data provided as a string. This API is used to onboard workflows from raw string data efficiently. |
Request | { “partnerName”: “string”, “applicationName”: “string”, “data”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/dataStorageForPem |
Method | POST |
Description | Stores and reflects the provided data exactly as received. This API is used to save or retrieve raw data without any modifications. |
Request | { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } |
Response | { “additionalProp1”: “string”, “additionalProp2”: “string”, “additionalProp3”: “string” } |
API Name | /pem/code-list-profile |
Method | POST |
Description | Creates a new code list profile. This API is used to define and manage a set of codes for workflow or system configurations. |
Request | { “pkId”: “string”, “profileName”: “string”, “protocol”: “string”, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string” } |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/application/status |
Method | POST |
Description | Updates the status of an application profile. This API is used to activate, deactivate, or modify the state of application configurations. |
Request | Parameters applicationName, status |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/app-profiles/search-all-contacts/xml |
Method | POST |
Description | Retrieves all application contact details in XML format. This API is used to view and manage application contacts in a structured XML format. |
Request | Parameters IsOr , fileAppServer
<?xml version=”1.0″ encoding=”UTF-8″?> <ProfileModel> <pkId>string</pkId> <profileName>string</profileName> <customProfileName>string</customProfileName> <pgpInfo>string</pgpInfo> <ipWhiteList>string</ipWhiteList> <profileId>string</profileId> <emailId>string</emailId> <phone>string</phone> <protocol>string</protocol> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <status>true</status> <hubInfo>true</hubInfo> <onlyPCM>true</onlyPCM> <pemIdentifier>string</pemIdentifier> <partnerPriority>true</partnerPriority> <like>true</like> </ProfileModel> |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <CommunityMangerModelProfileModel> <content> <pkId>string</pkId> <profileName>string</profileName> <customProfileName>string</customProfileName> <pgpInfo>string</pgpInfo> <ipWhiteList>string</ipWhiteList> <profileId>string</profileId> <emailId>string</emailId> <phone>string</phone> <protocol>string</protocol> <addressLine1>string</addressLine1> <addressLine2>string</addressLine2> <status>true</status> <hubInfo>true</hubInfo> <onlyPCM>true</onlyPCM> <pemIdentifier>string</pemIdentifier> <partnerPriority>true</partnerPriority> <like>true</like> </content> </CommunityMangerModelProfileModel> |
API Name | /pem/workflow/export-with-profile |
Method | GET |
Description | Exports a workflow along with its associated profile. This API is used to download workflow configurations for backup or migration purposes. |
Request | Parameters PartnerName , applicationName |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/workflow/export-enc |
Method | GET |
Description | Exports the workflow without profile information. This API is used to download workflow configurations independently for backup or migration. |
Request | Parameters partnerPkId , applicationPkId |
Response | { “statusCode”: 0, “statusMessage”: “string” }
|
API Name | /pem/routing-channels/{templateName} |
Method | GET |
Description | Retrieves the code list for the specified routing channel template. This API is used to view and manage routing channel configurations based on template names. |
Request | Parameters templateName |
Response | { “content”: [ { “routingChannelKey”: “string”, “templateName”: “string”, “producer”: “string”, “consumer”: “string”, “producerMailboxPath”: “string” } ] } |
API Name | /pem/pooling/{pInterval} |
Method | GET |
Description | Retrieves pooling intervals based on the specified pInterval. This API is used to manage and monitor system or workflow polling configurations. |
Request | Parameters pInterval |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pem/pem-adapter-names |
Method | GET |
Description | Retrieves the list of PEM adapter names. This API is used to view and manage available adapters for integration and workflow processing. |
Request | No Parameters |
Response | [ { “key”: “string”, “value”: “string” } ] |
API Name | /pem/partner/search-code-list |
Method | GET |
Description | Retrieves PEM code list profiles based on search criteria. This API is used to view and manage code lists for partner configurations. |
Request | No Parameters |
Response | { “content”: [ { “pkId”: “string”, “profileName”: “string”, “protocol”: “string”, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string” } ] } |
API Name | /pem/partner/getnameslist |
Method | GET |
Description | Retrieves a list of partner names based on the template. This API is used to view and manage partner information efficiently. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pem/partner-groups |
Method | GET |
Description | Retrieves details of partner groups. This API is used to view and manage the grouping of partners for workflow and integration purposes. |
Request | No Parameters |
Response | <?xml version=”1.0″ encoding=”UTF-8″?> <!– XML example cannot be generated; root element name is undefined –> |
API Name | /pem/generate-unique-key |
Method | GET |
Description | Generates a unique key for identification or tracking purposes. This API is used to create unique identifiers for workflows, profiles, or transactions. |
Request | No Parameters |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/code-list/{pkId} |
Method | GET |
Description | Retrieves the code list corresponding to the specified pkId. This API is used to view and manage code list details for system or workflow configurations. |
Request | Parameters pkId |
Response | { “pkId”: “string”, “profileName”: “string”, “protocol”: “string”, “correlationValue1”: “string”, “correlationValue2”: “string”, “correlationValue3”: “string”, “correlationValue4”: “string”, “correlationValue5”: “string”, “correlationValue6”: “string”, “correlationValue7”: “string”, “correlationValue8”: “string”, “correlationValue9”: “string”, “correlationValue10”: “string”, “correlationValue11”: “string”, “correlationValue12”: “string”, “correlationValue13”: “string”, “correlationValue14”: “string”, “correlationValue15”: “string”, “correlationValue16”: “string”, “correlationValue17”: “string”, “correlationValue18”: “string”, “correlationValue19”: “string”, “correlationValue20”: “string”, “correlationValue21”: “string”, “correlationValue22”: “string”, “correlationValue23”: “string”, “correlationValue24”: “string”, “correlationValue25”: “string” } |
API Name | /pem/code-list/{pkId} |
Method | DELETE |
Description | Deletes the code list profile identified by pkId. This API is used to remove unwanted or obsolete code list configurations from the system. |
Request | pkId |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/application/getnameslist |
Method | GET |
Description | Retrieves a list of application names based on the template. This API is used to view and manage application information efficiently. |
Request | No Parameters |
Response | [ { “name”: “string” } ] |
API Name | /pem/partner/{partnerName} |
Method | DELETE |
Description | Deletes the partner profile identified by partnerName. This API is used to remove partner integration configurations from the system. |
Request | Parameters partnerName |
Response | { “statusCode”: 0, “statusMessage”: “string” } |
API Name | /pem/application/{applicationName} |
Method | DELETE |
Description | Deletes the application profile identified by applicationName. This API is used to remove application configurations from the system. |
Request | Parameters applicationName |
Response | { “statusCode”: 0, “statusMessage”: “string” } |