Table of Contents

• Title and Copyright Information
• 1 Revision History
• 2 Get Help
  • 2.1 Access Help Content
    • 2.1.1 Watch Video
    • 2.1.2 Additional Resources
  • 2.2 Learn About Accessibility
  • 2.3 Get Support
  • 2.4 Get Training
  • 2.5 Join Our Community
  • 2.6 Share Your Feedback
• 3 About the REST APIs
• 4 Getting Started
  • 4.1 Prerequisites
    • 4.1.1 Obtain Account Information
  • 4.2 Authentication
    • 4.2.1 Download the Application Certificate
    • 4.2.2 Get the OAuth Client ID and Client Secret
    • 4.2.3 Generate the Access Token
    • 4.2.4 Generate the Refresh Token
    • 4.2.5 Invoke the API using the Access Token
    • 4.2.6 Activate New User Accounts for API Invocation
  • 4.3 Supported Methods
    • 4.3.1 Media Types
  • 4.4 Supported Headers
  • 4.5 Status Code
• 5 Mandatory Authentication to be perfomed before calling any API
• 6 Generating PAR URL for File Operations
  • 6.1 Generating PAR URL for File Upload
    • 6.1.1 End Point Details
      • 6.1.1.1 Request JSON Parameters
      • 6.1.1.2 Response JSON Parameters
  • 6.2 Generating PAR URL For File Download
    • 6.2.1 End Point Details
      • 6.2.1.1 Request JSON Parameters
      • 6.2.1.2 Response JSON Parameters
• 7 Initiating a PMF Process
  • 7.1 End Point Details
    • 7.1.1 Request JSON Parameters
    • 7.1.2 Response JSON Parameters
• 8 Initiating a PMF Process Using Object ID
  • 8.1 End Point Details
    • 8.1.1 Request JSON Parameters
    • 8.1.2 Response JSON Parameters
• 9 Viewing Ingested Data
  • 9.1 Prerequisites
  • 9.2 Get Metadata Keys
    • 9.2.1 End Point Details
      • 9.2.1.1 Request JSON Parameters
      • 9.2.1.2 Response JSON Parameters
  • 9.3 Retrieve Data Using the Metadata Keys
    • 9.3.1 End Point Details
      • 9.3.1.1 Request JSON Parameters
      • 9.3.1.2 Response JSON Parameters
• 10 Abort PMF Execution Process
  • 10.1 End Point Details
    • 10.1.1 Request JSON Parameters
    • 10.1.2 Response JSON Parameters
• 11 Abort PMF Execution Process Using Object ID
  • 11.1 End Point Details
    • 11.1.1 Request JSON Parameters
    • 11.1.2 Response JSON Parameters
• 12 Resume PMF Execution Process
  • 12.1 End Point Details
    • 12.1.1 Request JSON Parameters
    • 12.1.2 Response JSON Parameters
• 13 Resume PMF Execution Process Using Object ID
  • 13.1 End Point Details
    • 13.1.1 Request JSON Parameters
    • 13.1.2 Response JSON Parameters
• 14 Rerun PMF Execution Process
  • 14.1 End Point Details
    • 14.1.1 Request JSON Parameters
    • 14.1.2 Response JSON Parameters
• 15 Rerun PMF Execution Process Using Object ID
  • 15.1 End Point Details
    • 15.1.1 Request JSON Parameters
    • 15.1.2 Response JSON Parameters
• 16 Fetching the PMF Execution status
  • 16.1 End Point Details
    • 16.1.1 Request JSON Parameters
    • 16.1.2 Response JSON Parameters
• 17 Fetching the PMF Execution Status Using Object ID
  • 17.1 End Point Details
    • 17.1.1 Request JSON Parameters
    • 17.1.2 Response JSON Parameters
• 18 Searching a File
  • 18.1 End Point Details
    • 18.1.1 Request JSON Parameters
    • 18.1.2 Response JSON Parameters
• 19 Fetching Running Instances for a PMF Process
  • 19.1 End Point Details
    • 19.1.1 Request JSON Parameters
    • 19.1.2 Response JSON Parameters
• 20 Fetching the Process Execution Details
  • 20.1 End Point Details
    • 20.1.1 Request JSON Parameters
    • 20.1.2 Response JSON Parameters
• 21 Fetching the Process Execution Details Using Object ID
  • 21.1 End Point Details
    • 21.1.1 Request JSON Parameters
    • 21.1.2 Response JSON Parameters
• 22 Fetching the PMF Dashboard Process Status
  • 22.1 End Point Details
    • 22.1.1 Request JSON Parameters
    • 22.1.2 Response JSON Parameters
• 23 Fetching the PMF Dashboard Process Status Using Object ID
  • 23.1 End Point Details
    • 23.1.1 Request JSON Parameters
    • 23.1.2 Response JSON Parameters
• 24 Fetching the PMF Dashboard Activities
  • 24.1 End Point Details
    • 24.1.1 Request JSON Parameters
    • 24.1.2 Response JSON Parameters
• 25 Fetching the PMF Dashboard Activities Using Object ID
  • 25.1 End Point Details
    • 25.1.1 Request JSON Parameters
    • 25.1.2 Response JSON Parameters
• 26 Fetching all the Events of an Activity
  • 26.1 End Point Details
    • 26.1.1 Request JSON Parameters
    • 26.1.2 Response JSON Parameters
• 27 Fetching all the Events of an Activity Using Object ID
  • 27.1 End Point Details
    • 27.1.1 Request JSON Parameters
    • 27.1.2 Response JSON Parameters
• 28 Fetching all the PMF Dashboard Events
  • 28.1 End Point Details
    • 28.1.1 Request JSON Parameters
    • 28.1.2 Response JSON Parameters
• 29 Fetching all the PMF Dashboard Events Using Object ID
  • 29.1 End Point Details
    • 29.1.1 Request JSON Parameters
    • 29.1.2 Response JSON Parameters
• 30 Run Purpose Post API to Insert a New Run Purpose
  • 30.1 End Point Details
    • 30.1.1 Request JSON Parameters
    • 30.1.2 Response JSON Parameters
• 31 Run Purpose Get API to Get Run Purpose Details
  • 31.1 End Point details
    • 31.1.1 Response JSON Parameters
• 32 Fetching details of Data Quality that are breaching the Threshold Limit
  • 32.1 End Point Details
    • 32.1.1 Response JSON Parameters
• 33 Object Migration APIs
  • 33.1 Create Export Definition
    • 33.1.1 End Point Details
      • 33.1.1.1 Request JSON Parameters
      • 33.1.1.2 Response JSON Parameters
  • 33.2 Invoke Export
    • 33.2.1 End Point Details
      • 33.2.1.1 Response JSON Parameters
  • 33.3 Get Status for Export
    • 33.3.1 End Point Details
      • 33.3.1.1 Response JSON Parameters
  • 33.4 Copy Export Definition
    • 33.4.1 End Point Details
      • 33.4.1.1 Request JSON Parameters
      • 33.4.1.2 Response JSON Parameters
  • 33.5 Get Download URL for DMP file
    • 33.5.1 End Point Details
      • 33.5.1.1 Response JSON Parameters
  • 33.6 Create Import Definition
    • 33.6.1 End Point Details
      • 33.6.1.1 Request JSON Parameters
      • 33.6.1.2 Response JSON Parameters
  • 33.7 Invoke Import
    • 33.7.1 End Point Details
      • 33.7.1.1 Response JSON Parameters
  • 33.8 Update Existing Import Outline Definition
    • 33.8.1 End Point Details
      • 33.8.1.1 Request JSON Parameters
      • 33.8.1.2 Response JSON Parameters
  • 33.9 Get Status for Import
    • 33.9.1 End Point Details
      • 33.9.1.1 Response JSON Parameters
  • 33.10 Copy Import Definition
    • 33.10.1 End Point Details
      • 33.10.1.1 Request JSON Parameters
      • 33.10.1.2 Response JSON Parameters
• 34 Email Notification APIs
  • 34.1 Register Email Notification for a Process
    • 34.1.1 End Point Details
      • 34.1.1.1 Request JSON Parameters
      • 34.1.1.2 Response JSON Parameters
  • 34.2 Register Email Notification for a Package
    • 34.2.1 End Point Details
      • 34.2.1.1 Request JSON Parameters
      • 34.2.1.2 Response JSON Parameters
  • 34.3 Get the List of Email Registrations
    • 34.3.1 End Point Details
      • 34.3.1.1 Response JSON Parameters
  • 34.4 Enable/Disable the Notification Emails
    • 34.4.1 End Point Details
      • 34.4.1.1 Request JSON Parameters
      • 34.4.1.2 Response JSON Parameters
• 35 Retrieving ERP ESS Job Details
  • 35.1 End Point Details
    • 35.1.1 Calling the API to fetch the Process Status
      • 35.1.1.1 Response JSON Parameters
• 36 Token Based Authentication of ERP
  • 36.1 End Point Details
    • 36.1.1 Request JSON Parameters
    • 36.1.2 Response JSON Parameters