Accessing other API operations

If you can’t find an operation you need in our primary reference documents, check our legacy API documents. The legacy documents contain information on all the services, but it is presented differently, and with a bit less detail.

Refer to the sections below for information on using the legacy documents.

Viewing the available services and operations

To find out what services and operations are available, as well as the parameters they support:

  1. Log in to your Replicon instance, or sandbox instance.
  2. In the browser address bar, remove everything after .com and replace it with /services/help/all. For example, if your URL is:

https://sb1.replicon.com/yourcompany/projects

Change it to:

https://sb1.replicon.com/services/help/all

You will see a list of available services.

Certain services substitute security or billing for services in the URL outlined above (e.g. https://sb1.replicon.com/security/help/all).

  1. Click on a service name to see a list of operations for that service, and the format and parameters required for each operation.

Each service includes several operations.

  1. To view the parameters supported by an operation, click on the operation name. The parameters display on the Fields tab. You may need to click the + icon to display any child parameters.

Testing your service calls

While building your application, you may want to test that you have formatted the field values and the JSON data correctly.

When using the test interface, keep in mind you are editing your organization’s live data. If you’d like to set up a sandbox instance for testing, please contact Replicon Support.

Confirming field formatting

To confirm that you’re using valid data and have identified all the required fields:

  1. Click the Fields tab for the operation.

This tab shows all the supported fields for the operation, and their types.

  1. Enter values in the fields.
  2. You may need to click the + icon next to the field name to show sub-fields.
  3. Click Submit to execute the operation.

The results display below the tabs. If the fields are correct, you will see a Success message.

You can also populate the Fields tab using JSON data you’ve entered on the Raw tab, by clicking To Fields, located in the lower, right-hand corner of the Raw tab.

Testing the JSON data

To test the JSON data:

  1. Click the Raw tab for the operation.
  2. Enter the JSON data in the text area.
  3. Click Submit to execute the operation.

The result displays below the tabs.

Viewing the format of the JSON data

If you are unsure how to format the JSON data, you can automatically create JSON data based on the values entered in the Fields tab.

To automatically generate JSON data:

  1. Set the field values in the Fields tab.
  2. In the Raw tab, click the From Fields button in the bottom, right hand corner of the tab.

The text area will be automatically populated with the JSON data for the field values.

  1. Edit the JSON data as necessary.

To set the Fields tab based on the JSON data you’ve entered in the Raw tab, click the To Fields button.

Obtaining the URI for an item

URIs (Uniform Resource Identifiers) are labels used in Replicon operations to identify specific resources of various types (e.g. projects, users, etc). Two types of URIs exist in Replicon:

Static

These URIs are pre-defined by Replicon, and are unchanging. They are used to identify set resources in Replicon, such as cost types. Static URIs use the namespace Urn:replicon and take this format:

Urn:replicon:<object type>:<pre-defined option name>

For example:

Urn:replicon:cost-type:capital

Tenant-scoped

These URIs identify resources defined by the customer, like project names. Tenant-scoped URIs use the namespace Urn:replicon-tenant, and match this pattern:

Urn:replicon-tenant:<company ID>:<object type>:<object ID>

For example:

Urn:replicon-tenant:e72345c76bd14ee1aacf610ee76bf2c9:currency:6

Or, for older URIs, the company ID could be based on the company’s name.

For example:

Urn:replicon-tenant:yourcompanyinc:currency:6

If you need to reference a URI programmatically for a single item, use the Create operation for that item, which will return the URI for the new item.

To obtain the URI for multiple items, use the GetAll operation for that type of data. This will return a list of all items of that type and their URIs.

If you don’t need to obtain the URI programmatically, you can use the Fields tab to find the URI:

  1. Open the Fields tab for the operation.
  2. Click the  icon to the right of the field.

All of the items of that type are listed in a drop-down, with their display name.

  1. Select the name of the item.

 

The URI for the selected item displays.