API concepts

The Replicon API uses certain common API terminology in a proprietary way. Refer to the descriptions below for more information.

Batch

Example: POST /ProjectService1.svc/CreateProjectCopyBatch2

Creates a job that runs in the background, and therefore avoids timeouts. You can poll the status, to see when it’s done.

Bulk

Example: POST /ProjectService1.svc/BulkDelete

Executes multiple operations in a single request. More sensitive to timeouts than batch operations.

List

Example: POST /ProjectListService1.svc/GetData

Retrieves paginated data with customizable columns, filtering, and sorting.

parameterCorrelationID

You can create these IDs for certain parameters to help you identify the relationship between each new resource you create and its properties. These IDs are typically used when creating multiple resources of a certain type.

Put

Example: POST ProjectService1.svc/PutExpenseCodesAllowingExpenseEntry

Adds an item with a single call. All of the required data must be specified when you call a Put operation.

Target parameters

Target parameters identify the resource (e.g. project, user) you’ll be updating. For example, the POST /ProjectService1.svc/CreateProjectOrApplyModifications operation includes a target parameter:

 

     "project": {

         "target": {

           "uri": null,

           "name": null,

           "parameterCorrelationId": null

         }

     }

In these types of parameters, either the URI or the name of the target resource must be included, not both. We typically recommend using the resource’s URI rather than its name, since URIs are immutable, but names can change.

unitOfWorkId

When using this parameter to track iterations of your work, you must use a unique string for each new call. The API will always return the same result the ID was originally associated with. So, if you don't update the ID, each new call will return the same result.