Monitoring external objects

The Monitoring Dashboard in Corridor enables admins and supervisors to track information across objects on the Platform in a single place. Sometimes, objects are not registered in the platform but it is still useful to track information about the external as well as internal objects in Corridor's Monitoring Dashboard centrally.

The information about the external objects should come from an external database which the platform can fetch information from. To transfer information about external objects to Corridor, use the following API: - API URL: /api/v1/{object_type}/external/object - API Method: POST - Payload: {"objectFields": {...}, "externalId": ...}

Where object_type can be: data_tables, quality_profiles, data_elements, features, datasets, experiments, algorithms, models, features, frameworks, global_functions, global_variables, runtime_parameters, policies, product_types, products, reason_codes, reports, dashboard_views, .

Here is an example payload which provides information to the system about a model which has a unique ID "123".

# POST /api/v1/models/external/object
{
    "objectFields": {
        "created_date": "2020-01-01T00:00:00",
        "risk_level': "L1"
    },
    "externalId": "123"
}

The fields provided in the payload need to be Custom Fields defined in the platform's Settings > Fields. Only Custom Fields can be tracked for external objects in Monitoring Dashboard.

To update an external object, the same API can be used - by providing the same unique ID (externalId). In this example, The platform will update information about the model 123 if it is called a second time with new information. For example - the below payload:

# POST /api/v1/models/external/object
{"objectFields": {"risk_level": "L2"}, "externalId": "123"}

will update the field risk_level from L1 -> L2.