Looking up URIs
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:
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>
These URIs identify resources defined by the customer, like projects or users. Tenant-scoped URIs use the namespace Urn:replicon-tenant, and match this pattern:
Urn:replicon-tenant:<company ID>:<object type>:<object ID>
Or, for older URIs, the company ID could be based on the company’s name.
For a full list of the static URIs you might need, including their options, see Static URI formats and options.
You can look up tenant-scoped URIs using the operations listed at the bottom of each reference page, under Tenant-scoped URI lookup operations. On each page, a lookup operation is listed for each URI you might need to carry out an operation.
Imagine you're working with an operation on the Projects reference page, and you need the URI for a project that includes the term website. To look up the URI:
- Scroll down the page and find the Project URI lookup operation (POST /ProjectListService1.svc/GetData) service.
- Expand the operation, and click Try it out. The sample code that displays will become editable.
- Replace SEARCH TEXT with the keyword you’re looking for – in this case website.
When you call this operation, we recommend setting the page value to 1 initially, and the pagesize value to between 50 and 100. Then, carry out multiple calls, each incrementing the page value, until you find the URI you’re looking for.
- Click Execute.
The response will look like this:
You can see the URI for the Website Redesign project in red.
In some cases, no SEARCH TEXT option is given, and clicking Execute gives the full list of URIs of that type. If you want a full list of URIs for an operation that includes SEARCH TEXT, omit the filterExpression parameter. Or, if no such parameter exists in the operation, omit the search text (i.e. include empty quotation marks: "").