<aside> <img src="/icons/warning_red.svg" alt="/icons/warning_red.svg" width="40px" />

This article describes an older version of Prodly API. View Latest

This original Prodly application programming interface (API) is officially deprecated as of January 2022 and will be removed from service on January 15, 2023. Prodly strongly recommends changing over to the new API well before the deadline.

</aside>

[Deprecated] Overview

This topic describes the original Prodly application programming interface (API). The API helps integrate continuous delivery and release management systems to automatically perform deployments. For example, use API requests to deploy a data set or deployment plan.

The Prodly API is a RESTful API that allows you to integrate deployments into a larger continuous integration process. Prodly API requests use the Force.com REST API to invoke actions. It also supports global Apex services for internal Salesforce automation.

These API requests are available:

• Deployment Web Service
• Deployment Apex Service

Deployment Web Service

Deployment Web Service is REST web service specific to Prodly that provides the ability for consumers and integrated systems outside of Salesforce to invoke deployments and perform other actions through REST-based API requests exposed by the Salesforce package in your Prodly control org.

Usage

The Deployment Web Service allows you to deploy deployment plans and data sets from applications external to the Salesforce, such as a continuous delivery or release management system. For example:

• You are running CircleCI and after deploying updated code to a QA sandbox, you need to automatically deploy the updated data to the sandbox for end to end testing.
• You have a custom built solution coordinating CPQ deployments that performs automated steps to promote product catalog changes between development, QA, and UAT sandboxes.

Namespace

PDRI

The REST Endpoint

The endpoint takes these parameters:

• The destination org is the value of the targetConnectionId required parameter.
• The source org is one of these choices:
  • The org in which you invoke the endpoint.
  • The value of the sourceConnectionId, if you supply the optional parameter.
• For data sets only, you can optionally pass a query filter in for the data set’s root deployment object.