PEM Partner Repository REST APIs

REST APIs are used to complete certain tasks in PEM Partner Repository. Each REST resource contains information such as URIs, descriptions, and sample input and output data.

The URL to access PEM Partner Repository REST APIs is based on the deployment options. Only one of the following URL is available to access the application.

https://<ip:port>/mdrws/sponsors/<sponsorContext>/<entityName>

https://<ip:port>/mdrws/sponsors/<sponsorContext>/sponsor/<entityName>

When a sponsor user makes an API call for an activity and views the executed API, if the nodes and elements in the request or response are named as password, the password is masked.

For example, original password is displayed as:

{"ftpUsername":"admin",
 "password":"password1213"}

After masking, it is displayed as:

{"ftpUsername":"admin",
 "password":"*****"}

To access the API documentation, see Accessing the REST APIs and documentation.

The following table lists the PEM Partner Repository REST APIs with a brief description:

Partner Repository REST APIs	Description
Activity Services	Services to read the details of an activity instance that has been rolled out to internal or external partners.
Activity Definition Services	Services to read the details of an activity definition and roll out activities to internal or external partners.
API Configuration Services	Services to read, create, and update API configurations. This service also provides APIs that allows a System Administrator to assign or unassign API configurations to sponsors.
API Configuration Sponsor Services	Service to read sponsors that are assigned to an API Configuration.
Application Services	Services to automatically read, list, create, update, and delete applications after a sponsor is on boarded. These applications are used to create and manage activities in the PEM Portal and topologies in the PEM Partner Provisioner
AS2 Configuration Services	Services to create, read, update, and delete AS2 configuration services.
AS2 Inbound Configuration Services	Services to create, read, and update, AS2 inbound configuration services. Service to mark the configuration as pending for review. Service to mark the configuration as complete.
AS2 Inbound Configuration Type Services	Services to create, read, and update, AS2 inbound configuration type services.
AS2 Inbound Extension Services	Services to create, read, and update, AS2 inbound configuration type extensions.
AS2 Outbound Configuration Services	Services to create, read, and update, AS2 outbound configuration services for a partner organization. Service to mark the configuration as pending for review. Service to mark the configuration as complete.
AS2 Outbound Configuration Type Services	Services to create, read, and update, AS2 outbound configuration type services.
AS2 Outbound Extension Services	Services to create, read, and update, AS2 outbound configuration type extensions.
Attribute Type Services	Services to read, create, update, and delete attribute types.
Attribute Value Services	Services to read, create, and delete attribute values.
CDSA Configuration Services	Services to create, read, update, and delete CDSA configuration services for a partner organization.
CDSA Inbound Pull Services	Services to create, read, and update CDSA inbound pull configurations.
CDSA Inbound Pull Configuration Type Services	Services to create, read, and update CDSA inbound pull configuration types.
CDSA Inbound Pull Extension Services	Services to create, read, update, and delete CDSA inbound pull extensions.
CDSA Inbound Push Services	Services to create, read, and update CDSA inbound push configurations.
CDSA Inbound Push Configuration Type Services	Services to create, read, and update CDSA inbound push configuration types.
CDSA Inbound Push Extension Services	Services to create, read, update, and delete CDSA inbound push extensions.
CDSA Outbound Pull Services	Services to create, read, and update CDSA outbound pull configurations.
CDSA Outbound Pull Configuration Type Services	Services to create, read, and update CDSA outbound pull configuration types.
CDSA Outbound Pull Extension Services	Services to create, read, update, and delete CDSA outbound pull extensions.
CDSA Outbound Push Services	Services to create, read, and update CDSA outbound push configurations.
CDSA Outbound Push Configuration Type Services	Services to create, read, and update CDSA outbound push configuration types.
CDSA Outbound Push Extension Services	Services to create, read, update, and delete CDSA outbound push extensions.
CDSAS Configuration Services	Services to create, read, update, and delete CDSAS configuration services for a partner organization.
Certificate Services	Services to read the configurations that uses the certificates.
Certificate Configuration Services	Services to read the configurations for which the SSL certificates are expired.
Code Services	Services to create, read, update, and delete codes.
CodeList Services	Services to create, read, update, and delete Trading Partner code lists stored in the PEM Partner Repository database.
Configuration Services	Services to create, read, update, and delete configuration data.
Configuration Meta Data Services	Services to create, read, update, and delete configuration meta data.
Contact Services	Services to create, read, update, and delete contact services for a partner organization.
Configuration Type Services	Services to read, create, and update configuration type services for a partner organization.
Custom Field Services	Services to create, read, update, activate, and deactivate custom fields for a division.
Custom Protocol Services	Services to create, read, and update custom protocols. Services to trigger a test or production provisioning event to the PEM Partner Provisioner. Services to mark the configuration as pending for review or mark as complete. Services to move the configuration to the Delete status.
Custom Protocol Configuration Type Services	Services to create, read, and update custom protocol types.
Custom Protocol Type Extension Services	Services to create, read, update, and delete custom protocol type extensions.
Custom Protocol Type Field Services	Services to read and delete custom protocol type fields.
Division Services	Services for the following tasks: Create, read, and update divisions. Trigger a provisioning event to the PEM Partner Provisioner after a division is created. Assign or unassign partners to and from the divisions. Assign or unassign LOB users to and from the divisions. Assign or unassign primary contacts to and from the divisions. Service to also manually trigger an event to the PEM Partner Provisioner.
Division Custom Field Services	Services to read, create, update, and delete division custom field services for a partner organization.
Division LOB Services	Service to read LOB users that are associated with a division.
Division Partner Services	Service to read partners that are associated with a division.
Document Services	Services to read documents for uploading logos, emails templates, activities, or licence notices.
Email Services	Services to create, read, update, and delete division contact email services for a partner organization.
Extension Services	Services to read, created, update, and delete PGP outbound type extension for a partner organization.
FTP Configuration Services	Services to create, read, update, and delete FTP configuration services for a partner organization.
FTP Inbound Pull Services	Services to create, read, and update FTP inbound pull configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTP Inbound Pull Configuration Type Services	Services to create, read, and update FTP inbound pull configuration types.
FTP Inbound Pull Extension Services	Services to create, read, update, and delete FTP inbound pull extensions.
FTP Inbound Push Services	Services to create, read, and update FTP inbound push configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTP Inbound Push Configuration Type Services	Services to create, read, and update FTP inbound push configuration types.
FTP Inbound Push Extension Services	Services to create, read, update, and delete FTP inbound push extensions.
FTP Outbound Pull Services	Services to create, read, and update FTP outbound pull configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTP Outbound Pull Configuration Type Services	Services to create, read, and update FTP outbound pull configuration types.
FTP Outbound Pull Extension Services	Services to create, read, update, and delete FTP outbound pull extensions.
FTP Outbound Push Services	Services to create, read, and update FTP outbound push configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTP Outbound Push Configuration Type Services	Services to create, read, and update FTP outbound push configuration types.
FTP Outbound Push Extension Services	Services to create, read, update, and delete FTP outbound push extensions.
FTPS Configuration Services	Services to create, read, update, and delete FTPS configuration services for a partner organization.
FTPS Inbound Pull Services	Services to create, read, and update FTPS inbound pull configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTPS Inbound Pull Configuration Type Services	Services to create, read, and update FTPS inbound pull configuration types.
FTPS Inbound Pull Extension Services	Services to create, read, update, and delete FTPS inbound pull extensions.
FTPS Inbound Push Services	Services to create, read, and update FTPS inbound push configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTPS Inbound Push Configuration Type Services	Services to create, read, and update FTPS inbound push configuration types.
FTPS Inbound Push Extension Services	Services to create, read, update, and delete FTPS inbound push extensions.
FTPS Outbound Pull Services	Services to create, read, and update FTPS outbound pull configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTPS Outbound Pull Configuration Type Services	Services to create, read, and update FTPS outbound pull configuration types.
FTPS Outbound Pull Extension Services	Services to create, read, update, and delete FTPS outbound pull extensions.
FTPS Outbound Push Services	Services to create, read, and update FTPS outbound push configurations. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
FTPS Outbound Push Configuration Type Services	Services to create, read, and update FTPS outbound push configuration types.
FTPS Outbound Push Extension Services	Services to create, read, update, and delete FTPS outbound push extensions.
HTTP Services	Services to create, read, update, and delete HTTP resources. Service to mark the configuration as complete and trigger an event to the PEM Partner Provisioner.
HTTP Type Services	Services to create, read, and update HTTP configuration types.
HTTP Type Extension Services	Services to create, read, update, and delete HTTP type extensions.
Identifier Services	Services to create, read, update, and delete division identifier services for a partner organization.
Keystore Entry Services	Services to read, create, and update certificates.
LOB Services	Service to read LOB users.
LOB Division Services	Service to read divisions that are associated with LOB users.
Managed Certificate Services	Services to read, create, and update certificates. Services to perform the following actions for provisioning certificates: Complete provisioning production configuration Complete provisioning test configuration Complete testing test configuration Delete configuration Fail provision production configuration Fail provision test configuration Fail testing test configuration Mark pending review production configuration Mark pending review test configuration Start provisioning production configuration Start provisioning test configuration Start testing test configuration
Managed Certificate Type Services	Services to read, create, and update certificate types.
Managed Certificate Type Extension Services	Services to read, create, update, and delete certificate type extensions.
Managed PGP Key Services	Services to read, create, update, and delete the PGP key services for a partner organization. Also, used to move configurations to the appropriate status.
Managed SSH Key Services	Services to read, create, update, and delete the SSH key services for a partner organization. Also, used to move configurations to the appropriate status.
Managed User Credential Services	Services to read, create, update, and delete user credentials. The profile configuration of the user credentials are used for authentication of protocols such as SFTP, FTP, or CDSA by providing user credentials or authenticating by using the key.
Managed User Credential SSH Key Services	Services to read managed user credentials SSH key. It is used for authentication in the SFTP profile by providing the profile configuration details of the user credentials.
Managed User Credential Type Services	Services to read, create, and update user credentials types.
Managed User Credential Type Extension Services	Services to read, create, update and delete user credentials types extensions.
Participant Activity Services	Services to read and launch participant activities, reopen the participant activity task, or retrieve the ID of the next participant activity task that is accessible by the logged-in user.
Participant Activity Task Services	Services to read, launch, and finish participant tasks, assign owners for tasks, and update participant custom tasks.
Partner Services	Services to create, read, and update the profile of a partner, approve or reject a partner, and trigger a provisioning event to the PEM Partner Provisioner after a partner is created or updated. Service to also manually trigger an event to the PEM Partner Provisioner. Services to register a partner.
Partner Division Services	Service to read divisions that are associated to a partner organization.
PGP Configuration Services	Services to create, read, update, and delete PGP configuration services for a partner organization.
PGP Key Services	Services to read, create, and update PGP keys.
Primary Contact Services	Services to read primary contacts.
Profile Configuration Services	Services to read, create, update, and delete profile configurations for a partner organization. Services to read protocols that are associated to user credentials and vice versa. Services to assign and unassign one or more protocols from the user credentials and vice versa. Services to assign and unassign multiple locations to protocols. Services to assign and unassgin primary contacts to the profile configuration.
Types of Profile configuration Services	Sponsor Gateway Server (SG): A server to which either a Partner or Sponsor connects to send or receive files residing in Sterling File Gateway. Division Level Gateway Server (DG): A server to which either a Partner or Sponsor connects to send or receive files residing in Sterling File Gateway. This allows divisions to override attributes of the SG server, such as; credentials, locations, etc. Sponsor Remote Server (SR): A server where a Sponsor requires Sterling File Gateway to connect to pick up or deliver files, residing behind a sponsor firewall. Partner Remote Server (PR): A server where Trading Partner requires Sterling File Gateway to connect to pick up or deliver files, residing behinds partners firewall.
Profile Location Services	Services to read, create, update, and soft delete profile location. When a Line of Business user or a Partner user transfers a file, they must select the from and to location of the profile for the file transfer. Note: Soft delete indicates that a record in the database is marked for deletion.
Rule Services	Services to read, create, update, and delete rules, read rule activities and attributes, and assign or unassign activities to the rules.
Send Email Services	Services to enable sponsor administrators and sponsor LOB users to send emails to other users such as sponsors or trading partners.
SFTP Configuration Services	Services to create, read, update, and delete SFTP configuration services for a partner organization.
Sponsor Customization Services	Services to read, create, update, and delete sponsor customizations.
Sponsor Services	Services to read, create, and update sponsors, and approve or reject a sponsor.
SSH Key Services	Services to read, create, and update SSH keys.
System Services	Services to read, create, and update system services.
System Profile Reference Services	Services to read, create, update, and delete system profile reference services.
System Type Services	Services to read, create, and update system type services.
System Type Extension Services	Services to read, create, update, and delete system type extension services.
Topology Services	Services to read, create, update, and delete topologies.
Topology Sponsor Services	Service to read sponsors that are assigned to a topology.
User Services	Services to read, create, and update partner or sponsor users, activate or deactivate sponsor or partner users, and approve or reject sponsor or partner users. Also used to reset password for users and update user account.
User Credential Services	Services to read, create, and update user credentials.