20 About API Integration

If you are responsible for integration and endpoint management, you'll find details in this chapter. Links include task-based instructions for monitoring API messages on the Event Messages page and for configuring endpoints with common authentication methods (e.g., Standard, OAuth, etc.).

• Access API documentation
  API documentation provides the message detail your organization will need for data integration with Oracle Site Activate.
• View event messages
  Evaluate API message activity in the Event Messages area to see individual message detail and actions.
• Retry a single failed event message
  Filter the event message list to quickly locate a single failed event message so that you can retry sending it.
• Retry failed event messages in bulk
  Learn how to efficiently manage failed event message retries by filtering the message list and initiating the retry in bulk.
• Retry successful event message
  Under certain circumstances, you may want to retry an event message that was originally successful. This procedure describes how you can optionally filter the event messages list to find the successful message.
• Download event messages to CSV
  When you want to view event messages outside of the application, you can export the list to a comma separated values (.csv) format spreadsheet.
• Create publishing endpoint with standard authentication
  When you create an endpoint with standard authentication type, it displays on the left side of the Publishing to an Outside API page, and the endpoint and "view" pop-in details are also available for selection on the Edit Study page.
• Create publishing endpoint with basic authentication
  Using the steps in this procedure, you can quickly create a publishing endpoint with username and password authentication type.
• Create publishing endpoint with OAuth 2.0 authentication
  Learn the steps required to create a publishing endpoint that uses the industry-standard OAuth 2.0 authentication method.
• Edit an existing endpoint
  If you need to update attributes for an existing endpoint, use this procedure. When you finish making your updates, the endpoint details will be updated on the Edit Study page as well.
• Delete an endpoint
  Sometimes you'll need to delete an endpoint so that it isn't available for selection. Use this procedure to ensure that messages stop flowing to the endpoint.
• Configure custom eTMF attributes
  Create up to 10 custom fields to capture document data and send that data in an eTMF publish message.
• Review files in IRB documents queue
  If you have a role that allows you to access the IRB approval documents queue, you can quickly evaluate files received via API from IRB integration partners.
• Match an IRB file or add new item
  If you have a role that allows you to access the IRB approval documents queue, you can attempt to match a file in the queue to an existing placeholder item or add a new item if no match is found.