Oomnitza REST API examples

The Oomnitza API v3 is a RESTful interface that enables interaction with resources in Oomnitza. This interface follows REST best practices, to help ensure that creating and updating objects in Oomnitza is as intuitive as possible.

The API supports both HTTP basic and token-based authentication, as well as session-based authentication. All data in transit is securely encrypted via SSL/TLS. The request and response Content-Type values are “application/json”.

The following are some examples of how to use the various API calls in Oomnitza:

Activities API

Assets API

Connector API

Workflows API

Using the Oomnitza API

To get started with the API, complete the following steps:

1. In Oomnitza, navigate to Configuration>Integrations>Rest APIs (Swagger Docs).
2. Select your API from the list.
3. Select the lock icon and enter your Basic Auth credentials in the form of an Oomnitza username and password. Alternatively, enter your Oomnitza API key. For information on how to generate an API in Oomnitza see Creating an API token.
4. Optional: Enter a filter, or specify an order of results. For further information on filters, refer to Filtering data using the Oomnitza REST API.
5. Click Try it Out and then click Execute.
6. You will be provided with a request URL or a CURL URL that you can use.
7. Copy and paste the URL directly into Postman and replace any {} placeholders with the correct identifier.
8. If you are using Basic Authentication, enter your username and password Postman.
9. Send the API in Postman. Your response should be similar to the response documented in the Swagger Responses section.

Using the Activities API

The Activities API provides an overview of user activities in Oomnitza. You can run this API query directly in Swagger by clicking Execute.

Using the Assets API

The Assets API provides an overview of assets as well as details of an asset record in Oomnitza.

Use the equipment id returned in the Get Asset API response to get the details of an asset record. You need to replace {ident} with your equipment id in the following query​/api​/v3​/assets​/{ident} to get the details of an asset record.

Using the Connector API

The Connector Run Logs API returns the run logs for a particular connector or integration. You can find the id of your connector by selecting the integration in Configuration> Integrations>Overview. The connector id is displayed on the Info page. It is also displayed in the URL  https://demo.oomnitza.com/settings/connectors?id=4

Tip 
You can use the portion_id returned in the response to use the Get Connector Portion id API, and get a more detailed view of each connector run, including specific details on each error.

Using the Workflows API

You can use the Workflows API to get an overview of workflow runs, including workflow errors. You can enter the following Get request in Postman: https://demo.oomnitza.com/api/v3/users/workflows/{workflow_external_id}/processes

To find your {workflow_external_id}, navigate to your workflow in Oomnitza and copy the id in the workflow URL  https://demo.oomnitza.com/people/workflow/view_workflow?id=*****************

The following is an example of the Workflows API response:

      {
        "run_id": 1234567,
        "wf_id": 123,
        "wf_external_id": "**************",
        "object_id": "qa3-OM",
        "object_type": "USERS",
        "status": 5,
        "start_date": 1653397450,
        "end_date": 1653397520,
        "initiator": "Nobody",
        "nodes_runs_logs_count": 0,
        "nodes_runs_logs": {},
        "version": 4
    },