getIdByOriginalId

Purpose

Given the original ID and an entity type, returns the entity's ID.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getIdByOriginalId

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

entityType

The type of entity. Can be one of object, field, relationship, webpage, view, template, report, chart, gauge, trigger, process, status, action, button, or datamap.

origId

The original ID of the entity.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

The user must have the Administrator role.

Response

If successful, the ID of the specified entity. If an entity of the specified type with the specified original ID does not exist, returns an error message in the specified output format (XML or JSON).

Example

The following example retrieves the ID for an object with the original ID 7550.

https://app.infiniteblue.com/rest/api/getIdByOriginalId?
sessionId=e7bf663caa844ac89dce1c36c17c9300@46216462&entityType=object&origId=7550

The output in XML format:

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="ok">
    <id>46219927</id>
</resp>

If the specified entity does not exist, returns an error message as shown below (in XML format):

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="fail">
    <err>No object exists with original ID - 7550</err>
</resp>