Breadcrumbs

Cortex Service Public API – Overview & Setup

This page explains how to:

  • Access the Public API Documentation

  • Configure authorization for users

  • Set up ID mapping between Cortex Service and external systems

1. Public API Documentation Page 📘

  • You can access the Public API Documentation directly from your Cortex Service workspace:

    • Go to Settings

    • Select Public API Documentation

image-20260129-125958.png


  • On this documentation page, you’ll find a comprehensive list of all available request types that can be used with the API.

image-20260129-131319.png


  • For each request, the documentation provides:

    • An example request body (JSON format)

    • The required schema for making the call

Note: The example data shown is not real data. You can, however, test the requests using your own actual values.

image-20260129-131608.png
image-20260129-131614.png


  • To try out any of the requests, you must first add an Authorization header using your Cortex Service credentials.

For more details on credentials and permissions, see Section 2 – Authorization.

image-20260129-131625.png


  • You can:

    • Experiment with different payload structures and parameters

    • Send test requests directly from the documentation page

    • View the various responses returned by the API in real time

17231d1e-7752-4360-9df7-5db252898620.png
image-20260129-132056.png
image-20260129-132206.png


2. Authorization 🔐

To allow a user to access the Public API with their own credentials, the following steps are required.

Assigning the Required Permission

  • Ensure the user has the correct permission assigned to their account:

    • Open the Manage Users page

    • Go to View/Edit User

    • Check the Effective Permissions tab

    • Verify that the required permission for Public API access is assigned

image-20260129-132224.png
If you cannot see the Manage Users feature, please contact your maintenance manager.
image-20260129-132237.png
image-20260129-132242.png

If the permission is not present, please contact your maintenance manager so they can add the necessary permission for you.

Setting User Credentials

  • On the same Manage Users page:

    • Open the Credentials tab

    • Set the user’s password

image-20260129-132302.png

This enables Basic Authentication with a username and password for the API.

3. Mapping IDs from Cortex Service 🔗

Cortex Service provides a built-in Mapping Table that allows a mappiing of asset IDs and work order IDs to IDs from other systems.

Initial ID Mapping (One-Time Setup)

  • For the initial mapping, please complete the following Excel templates provided by the CORTEX Service team:

    • CORTEX Service Asset Overview

    • CORTEX Service WorkOrder List Summary

  • In each Excel sheet:

    • Enter the name of your system in the foreignSystem column

    • Enter the corresponding asset or work order ID from your system in the foreignId column

    • Ensure these map correctly to the assets and work orders that already exist in Cortex Service

image-20260129-132409.png

 

  • Once the Excel sheets are completed, send them to us.

We will upload the data into the Mapping Table, after which you can begin integration testing and development.


Note: Any assets and work orders added directly through the REST API will be automatically mapped in the table.

image-20260129-132425.png

Therefore, the Excel-based mapping is required only once for the initial setup. ✅ 

4. Support & Contact ☎️

If you have any questions or need assistance with:

  • API documentation

  • Authorization and permissions

  • Mapping configuration or data upload

please contact us through our Jira Service Management portal:

https://adbsafegate.atlassian.net/servicedesk/customer/portal/11