IBM Cloud API Docs

Introduction

Last updated: 2022-11-01

IBM Knowledge Catalog provides the capabilities for you to track data science models across the organization. View at a glance which models are in production and which need development or validation. Use the governance features to establish best practices to manage the communication flow from data scientists to ModelOps administrators.

Endpoint URLs

API Endpoint

https://{cpd_cluster_host}

Authentication

A bearer token from IBM Cloud Pak for Data is required to use any of the Watson Data APIs.

Visit the authorization section on Cloud Pak for Data for more information.

Curl command with API key to retrieve token

curl -k -X POST https://{cpd_cluster_host}/icp4d-api/v1/authorize     -H 'cache-control: no-cache'     -H 'content-type: application/json'     -d '{"username":"admin","password":"password"}'

Response

{
  "_messageCode_": "200",
  "message": "Success",
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...."
}
  1. Use the value of the token property for your Factsheet API calls. Set the token value as the authorization header parameter for requests to the Watson Data APIs. The format is Authorization: Bearer <token_value_here>. For example: Authorization: Bearer eyJraWQiOiIyMDE3MDgwOS0wMDowMDowMCIsImFsZyI6IlJTMjU2In0...

Security scheme

Authentication to this API's methods uses one of the following security schemes.

BearerToken

Attribute

Value
  • Type
    HTTP
  • Scheme
    Bearer
  • Bearer format
    JWT

BasicAuth

Attribute

Value
  • Type
    HTTP
  • Scheme
    Basic

Versioning

Factsheet API has a major, minor, and patch version, following industry conventions on semantic versioning: Using the version number format MAJOR.MINOR.PATCH, the MAJOR version is incremented when incompatible API changes are made, the MINOR version is incremented when functionality is added in a backwards-compatible manner, and the PATCH version is incremented when backwards-compatible bug fixes are made. The service major version is represented in the URL path.

Error Handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP Error Code Description Recovery
200 Success The request was successful.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized to access '{namespace}'.
404 Not Found The requested resource could not be found.
500 Internal Server Error Service is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

Model Inventory

A model inventory tracks Watson Machine Learning and external models that you add to model entries. This allows you to control which models to track for an organization without all of the overhead of tracking samples and other models that are not significant to the organization.

The model inventory is a repository in IBM Knowledge Catalog where you can request a new model, then track it through its lifecycle. A typical flow might go as follows:

  • A business user identifies a need for a machine learning model and creates a model entry to request a new model. The business owner assigns a potential name and states the basic parameters for the requested model.
  • When the request is saved, a model entry is created in the inventory and the tracking begins. Initially, the entry will be in the Awaiting development state as there are no assets to accompany the request.
  • When a data scientist creates a model for this business case, the data scientist chooses to track the model from the model details page of the project or deployment space, and associates it with the model entry.
  • The model entry in the inventory can now be moved to an In progress state and stakeholders can review the assets for the entry, which now include the model.
  • As the model advances in the lifecycle, the model entry will reflect all updates, including deployments and input data assets.
  • If the data scientist chooses, challenger models can be added to the entry to compare performance.
  • Validators and other stakeholders can review this and other model entries to ensure compliance with corporate protocols and to view and certify model progress from development to production.

External Models

You can add a model entry for a model that you trained outside of Watson Studio to the model inventory so that you can track the lifecycle details for the model.

The process to track external models is as follows:

  • A user with Admin access to the IBM Knowledge Catalog must first set up a Platform Assets Catalog for registering external models, then enable tracking for external models in the model inventory.
  • In the model notebook, use the API to define an external model asset to the Platform assets catalog.
  • Associate the external model asset with a model entry in the model inventory to start preserving the facts.

Related API

Collect model training metrics automatically during model development in Notebooks. Using the AI Gov Facts Client Library, a model developer can enable collection of a rich set of model metrics, parameters and tags during training.

Report Template API

Generate a printer-friendly document that contains all the information about a model that can be exported to PDF via browser print.

Methods

Delete Collaborators from an Inventory

Delete Collaborators from an Inventory

DELETE /v1/aigov/inventories/{inventory_id}/collaborators/{collaborator_id}

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Path Parameters

  • inventory_id
    Required*
    string

    inventory_id

  • collaborator_id
    Required*
    string

    collaborator_id

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update Role of the Collaborator

Update Role of the Collaborator

PATCH /v1/aigov/inventories/{inventory_id}/collaborators/{collaborator_id}

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Path Parameters

  • inventory_id
    Required*
    string

    inventory_id

  • collaborator_id
    Required*
    string

    collaborator_id

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
application/json-patch+jsonstring

Patch JsonArray payload

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

No Sample Response

This method does not specify any sample responses.

List all Collaborators of an Inventory

List all Collaborators of an Inventory

GET /v1/aigov/inventories/{inventory_id}/collaborators

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Path Parameters

  • inventory_id
    Required*
    string

    inventory_id

Query Parameters

  • collaborator_type
    string

    collaborator_type

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Add Collaborators to an Inventory

Add Collaborators to an Inventory

POST /v1/aigov/inventories/{inventory_id}/collaborators

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Custom Headers

  • Authorization
    Required*
    string

    IAM Bearer access token

Path Parameters

  • inventory_id
    Required*
    string

    inventory_id

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
CollaboratorsSchema

Patch json object payload

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

No Sample Response

This method does not specify any sample responses.

Add/Remove/Update Collaborator for an Asset

Add/Remove/Update Collaborator for an Asset

PATCH /v1/aigov/inventories/{inventory_id}/assets/{asset_id}/collaborators

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Path Parameters

  • asset_id
    Required*
    string

    asset_id

  • inventory_id
    Required*
    string

    inventory_id

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
application/json-patch+jsonstring

Patch JsonArray payload

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

No Sample Response

This method does not specify any sample responses.

Gets an AI Governance Configuration Setting

Gets an AI Governance Configuration Setting

GET /v1/aigov/factsheet/settings/{setting}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • setting
    Required*
    string

    Name of setting

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Updates AI Governance Configuration Settings

Updates AI Governance Configuration Settings

PUT /v1/aigov/factsheet/settings/{setting}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • setting
    Required*
    string

    Name of setting

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
AddSetting

Setting value

Response

Status Code

  • 200

    OK

  • 201

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Deletes an AI Governance Configuration Setting

Deletes an AI Governance Configuration Setting

DELETE /v1/aigov/factsheet/settings/{setting}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • setting
    Required*
    string

    Name of setting

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Gets all AI Governance Inventories Details

Gets all AI Governance Inventories Details

GET /v1/aigov/inventories

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Query Parameters

  • bss_account_id
    string

    Limited to use by accredited services. Must be supplied when caller is an accredited service. Used for listing catalogs, projects, or spaces for the account or for retrieving the number of public catalogs for the account.

  • limit
    int32

    limit

  • bookmark
    string

    bookmark

  • skip
    int32

    skip

  • orderby
    string[]

    orderby

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Create a Factsheet Inventory

Create a Factsheet Inventory

POST /v1/aigov/inventories

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
InventorySchema

Patch json object payload

Response

Status Code

  • 201

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

No Sample Response

This method does not specify any sample responses.

Gets an AI Governance Inventory Details

Gets an AI Governance Inventory Details

GET /v1/aigov/inventories/{inventory_id}

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Path Parameters

  • inventory_id
    Required*
    string

    inventory_id

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Deletes an AI Governance Inventory

Deletes an AI Governance Inventory

DELETE /v1/aigov/inventories/{inventory_id}

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Path Parameters

  • inventory_id
    Required*
    string

    inventory_id

Query Parameters

  • delete_bucket
    Required*
    boolean

    delete_bucket

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update an AI Governance Inventory properties

Update an AI Governance Inventory properties

PATCH /v1/aigov/inventories/{inventory_id}

Authentication

This method uses the BearerToken security scheme for authentication.

Request

Path Parameters

  • inventory_id
    Required*
    string

    inventory_id

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
application/json-patch+jsonstring

Patch JsonArray payload

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

No Sample Response

This method does not specify any sample responses.

Gets all AI Governance Configuration Settings

Gets all AI Governance Configuration Settings

GET /v1/aigov/factsheet/settings

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get all deployments of external model

API supports only external models

GET /v1/aigov/model_inventory/models/{model_asset_id}/deployments

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_asset_id
    Required*
    string

    model_asset_id

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Add a deployment to external model

Add a deployment to external model

PUT /v1/aigov/model_inventory/models/{model_asset_id}/deployments

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_asset_id
    Required*
    string

    model_asset_id

Query Parameters

  • catalog_id
    Required*
    string

    catalog_id

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
DeploymentDetail

Deployment detail payload

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get All Model use case assets

Returns all Model use case assets

GET /v1/aigov/model_inventory/model_entries

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • bss_account_id
    string

    Limited to use by accredited services. Must be supplied when caller is an accredited service. Used for listing catalogs, projects, or spaces for the account or for retrieving the number of public catalogs for the account.

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Get All Model use case assets

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Create a Model use case asset for given catalog

Creates an asset of Type Model use case

POST /v1/aigov/model_inventory/model_entries

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
ModelEntryAttribute

ModelEntry attributes

Response

Status Code

  • 201

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

No Sample Response

This method does not specify any sample responses.

Create model use case approach

Create model use case approach

POST /v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approach

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_usecase_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
Approach

Approach json object

Response

Status Code

  • 201

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Delete external model deployment

This api supports only external models

DELETE /v1/aigov/model_inventory/models/{model_asset_id}/deployments/{deployment_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_asset_id
    Required*
    string

    model_asset_id

  • deployment_id
    Required*
    string

    deployment_id

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Fetch Model use case Asset for given assetId

Returns Model use case Asset for given assetId

GET /v1/aigov/model_inventory/model_entries/{model_entry_asset_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_entry_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Delete Model use case

Use this API to delete an existing Model use case and remove Model use case information.

DELETE /v1/aigov/model_inventory/model_entries/{model_entry_asset_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_entry_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update Status and/or Risk Level of ModelEntry

Update Status and/or Risk Level of ModelEntry

PATCH /v1/aigov/model_inventory/model_entries/{model_entry_asset_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_entry_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
ModelEntryStatus

ModelEntry Status

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

No Sample Response

This method does not specify any sample responses.

Delete Model use case approach

Use this API to delete an existing Model use case approach if it's not being used by a model.

DELETE /v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approach/{approach_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • approach_id
    Required*
    string

    approach_id

  • model_usecase_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update Model use case approach

Use this API to update an existing Model use case approach if it's not being used by a model.

PATCH /v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approach/{approach_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • approach_id
    Required*
    string

    approach_id

  • model_usecase_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
application/json-patch+jsonstring

Patch JsonArray payload

Response

Status Code

  • 200

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Fetch all Model use case assets for the catalog

Returns all Model use case assets for a catalog

GET /v1/aigov/model_inventory/{catalog_id}/model_entries

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch all Model use case assets for the catalog

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Fetch System facts of the Model

Returns System Facts of the Model

GET /v1/aigov/model_inventory/models/{asset_id}/system_facts

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • asset_id
    Required*
    string

    Asset GUID

Query Parameters

  • catalog_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • project_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • space_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • deployment_id
    string

    Deployment GUID

  • exclude_basic_facts
    boolean

    exclude_basicFacts

  • exclude_additional_facts
    boolean

    exclude_additionalFacts

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch System facts of the Model

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update SystemFacts with openscale data

Model SystemFacts is updated with data from Openscale, Note: Only OpenScale MRM Service with a valid token is authorized to execute this endpoint

POST /v1/aigov/model_inventory/models/{asset_id}/system_facts

Authentication

This method uses the BasicAuth security scheme for authentication.

Request

Path Parameters

  • asset_id
    Required*
    string

    Asset GUID

Query Parameters

  • deployment_id
    Required*
    string

    Deployment GUID

  • space_id
    string

    Space GUID

  • project_id
    string

    Project GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
OpenscaleSchema

Openscale Facts

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Fetch Model use case Asset for given assetId

Returns Model use case Asset for given assetId

GET /v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/tracked_model_versions

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_usecase_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Gets the version details of a model

Gets the version details of a model

GET /v1/aigov/model_inventory/models/{model_asset_id}/version_details

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_asset_id
    Required*
    string

    model_asset_id

Query Parameters

  • catalog_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • project_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • space_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Fetch all Physical Models for a logical Model

Returns all Physical Models for a logical Model

GET /v1/aigov/model_inventory/model_entries/{model_entry_asset_id}/models

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_entry_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch all Physical Models for a logical Model

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Link Model to Model use case

Link Model to Model use case

POST /v1/aigov/model_inventory/models/{asset_id}/model_entry

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • asset_id
    Required*
    string

    Model GUID

Query Parameters

  • catalog_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • project_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • space_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
ModelEntryDetails

ModelEntry Details

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Move deployment from source to target environment

Move deployment from source to target environment

PUT /v1/aigov/model_inventory/models/{model_asset_id}/deployments/{deployment_id}/environment

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_asset_id
    Required*
    string

    Asset GUID

  • deployment_id
    Required*
    string

    Deployment GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
string

Patch json object payload

Response

Status Code

  • 200

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Move model from source to target environment

Move model from source to target environment

PUT /v1/aigov/model_inventory/models/{model_asset_id}/environment

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_asset_id
    Required*
    string

    model_asset_id

Query Parameters

  • catalog_id
    Required*
    string

    catalog_id

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
string

Patch json object payload

Response

Status Code

  • 200

    OK

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Save External Model

Creates an asset of type Model Stub

PUT /v1/aigov/model_inventory/model_stub

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • experiment_name
    string

    experiment_name

  • catalog_id
    string

    catalog_id

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
ModelStub

ModelStub metadata

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update master_id for a model

Updates master_id of model

PATCH /v1/aigov/model_inventory/model_entries/{model_entry_asset_id}/relatemodels

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_entry_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
RelateModel

Model information to relate master_ids

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update Model use case approach

Use this API to update an existing Model use case approach if it's not being used by a model.

PUT /v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approach/{approach_id}/versions/{version_number}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • approach_id
    Required*
    string

    approach_id

  • version_number
    Required*
    string

    version_number

  • model_usecase_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
string

Patch json object payload

Response

Status Code

  • 200

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get attachment facts for given type either model_usecase or model

Get attachment facts for given type either model_usecase or model

GET /v1/aigov/factsheet/attachment_fact_definitions/{type_name}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • type_name
    Required*
    string

    Attachment fact type, allowed values are model_usecase or model

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Create attachment group deifinition

Create attachment group deifinition

POST /v1/aigov/factsheet/attachment_fact_definitions/{type_name}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • type_name
    Required*
    string

    Attachment fact type, allowed values are model_usecase or model

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
AttachmentDefinition

Attachment definition attributes

Response

Status Code

  • 201

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns the Report Attachment Contents.

Returns the Report Attachment Contents.

GET /v1/aigov/factsheet/report_logo

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Uploads the Report Logo as an Attachment to the AIGOV Config Asset

Uploads the Report Logo as an Attachment to the AIGOV Config Asset

PUT /v1/aigov/factsheet/report_logo

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • file_name
    Required*
    string

    Name

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    Updated

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Deletes the Existing Report Logo Attachment from AIGOV Config Asset

Deletes the Existing Report Logo Attachment from AIGOV Config Asset

DELETE /v1/aigov/factsheet/report_logo

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns the Report Attachment Contents.

Returns the Report Attachment Contents.

GET /v1/aigov/factsheet/report_stylesheet

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Uploads the Report StyleSheet as an Attachment to the AIGOV Config Asset

Uploads the Report StyleSheet as an Attachment to the AIGOV Config Asset

PUT /v1/aigov/factsheet/report_stylesheet

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • file_name
    string

    Name

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    Updated

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Deletes the Existing Report StyleSheet Attachment from AIGOV Config Asset

Deletes the Existing Report StyleSheet Attachment from AIGOV Config Asset

DELETE /v1/aigov/factsheet/report_stylesheet

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get all Attachment facts

Get all Attachment facts

GET /v1/aigov/factsheet/attachment_fact_definitions

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get Attachmet details for the given attachment ID

Get Attachmet details for the given attachment ID

GET /v1/aigov/model_inventory/model_usecases/{asset_id}/facts

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • asset_id
    Required*
    string

    Asset GUID

Query Parameters

  • catalog_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns the Report Attachment Logo or Stylesheet file name.

Returns the Report Attachment Logo or Stylesheet file name.

GET /v1/aigov/factsheet/report_logo_stylesheet/file_name

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • attachment_type
    Required*
    string

    IAM Bearer access token

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

PUT /v1/aigov/factsheet/models/attachment/{asset_id}/content

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • asset_id
    Required*
    string

    asset_id

Query Parameters

  • fact_id
    Required*
    string

    Fact ID of Attachment

  • project_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • space_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • catalog_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • name
    string

    Name

  • description
    string

    description

  • mime
    string

    mime

  • html_rendering_hint
    string

    HTML rendering hint of Attachment

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

PUT /v1/aigov/factsheet/model_entries/attachment/{model_entry_asset_id}/content

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_entry_asset_id
    Required*
    string

    asset_id

Query Parameters

  • fact_id
    Required*
    string

    Fact ID of Attachment

  • catalog_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • name
    string

    Name

  • description
    string

    description

  • mime
    string

    mime

  • html_rendering_hint
    string

    HTML rendering hint of Attachment

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

GET /v1/aigov/report_templates

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • scope
    Required*
    string

    Template Scope

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Create report template

Create report template with ftl file to be used for report generation

POST /v1/aigov/report_templates

Authentication

This method uses the following security schemes for authentication.

Request

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
ReportTemplate

Custom Report Template Creation Data

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

GET /v1/aigov/report_templates/{template_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • template_id
    Required*
    string

    Template Asset GUID

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Delete Report User Report Template Asset

Delete Report User Report Template Asset

DELETE /v1/aigov/report_templates/{template_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • template_id
    Required*
    string

    Template Asset GUID

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update report template

Update report template with ftl file to be used for report generation

PATCH /v1/aigov/report_templates/{template_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • template_id
    Required*
    string

    Template Asset GUID

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Request Body

Required*
ReportTemplate

Custom Report Template Creation Data

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

API to delete the System Report Template

API to delete the System Report Template

DELETE /v1/aigov/report_templates/system/{template_id}

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • template_id
    Required*
    string

    Template Asset GUID

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Download Model use case Asset for given assetId, format type and template type

Returns Model use case Asset data file for given assetId, format type and template type

GET /v1/aigov/model_inventory/model_entries/{model_entry_asset_id}/report

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • model_entry_asset_id
    Required*
    string

    ModelEntry Asset GUID

Query Parameters

  • catalog_id
    Required*
    string

    Catalog GUID

  • template_id
    Required*
    string

    Template Asset GUID

  • format
    string

    Format Type

  • strict
    boolean

    Ignore Template Errors

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Fetch Model use case Asset for given assetId

  • 400

    Bad Request

  • 401

    Unauthorized

  • 404

    Requested data are not available, try again later.

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Download Model Asset for given assetId, format type and template type

Returns Model Asset data file for given assetId, format type and template type

GET /v1/aigov/model_inventory/models/{asset_id}/report

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • asset_id
    Required*
    string

    Model GUID

Query Parameters

  • template_id
    Required*
    string

    Template Asset GUID

  • catalog_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • project_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • space_id
    string

    You must provide either a catalog id, a project id, or a space id, but not more than one

  • format
    string

    Format Type

  • strict
    boolean

    Ignore Template Errors

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

Returns templates metadata, if scope is provided then it would provide only those scope specific template metadata

GET /v1/aigov/report_templates/{template_id}/content

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • template_id
    Required*
    string

    Template Asset GUID

Query Parameters

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Update specific report template content

Updates specified template id with template file name and content

POST /v1/aigov/report_templates/{template_id}/content

Authentication

This method uses the following security schemes for authentication.

Request

Path Parameters

  • template_id
    Required*
    string

    Template Asset GUID

Query Parameters

  • template_name
    Required*
    string

    Template file name which is an ftl file

  • call_ref
    string

    call_ref optional for caller reference

Response

Status Code

  • 200

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    AI Factsheets Service is not available now please try after some time

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

id=curlclassName=tab-item-selected