AI Factsheets API

Introduction 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 The Factsheet API uses the following global endpoint URL. When you call the API, add the path for each method to form the complete API endpoint for your requests. https://api.dataplatform.cloud.ibm.com Authentication Before you can call a Watson Data API you must first create an IAMhttps://cloud.ibm.com/docs/account?topic=account-iamtokenfromapikey bearer token. Each token is valid only for one hour, and after a token expires you must create a new one if you want to continue using the API. The recommended method to retrieve a token programmatically is to create an API key for your IBM Cloud identity and then use the IAM token API to exchange that key for a token. You can create a token in IBM Cloud or by using the IBM Cloud command line interface CLI. To create a token in the IBM Cloud: 1. Log in to IBM Cloudhttps://cloud.ibm.com and select Manage Security Platform API Keys. 2. Create an API key for your own personal identity, copy the key value, and save it in a secure place. After you leave the page, you will no longer be able to access this value. 3. With your API key, set up Postman or another REST API tool and run the following command to the right Curl command with API key to retrieve token curl "https://iam.cloud.ibm.com/identity/token" \ -d "apikey=YOURAPIKEYHERE&granttype=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey" \ -H "Content-Type: application/x-www-form-urlencoded" \ -H "Authorization: Basic Yng6Yng=" Response json { "accesstoken": "eyJraWQiOiIyMDE3MDgwOS0wMDowMDowMCIsImFsZyI6...", "refreshtoken": "zmRTQFKhASUdF76Av6IUzi9dtB7ip8F2XV5fNgoRQ0mbQgD5XCeWkQhjlJ1dZi8K...", "tokentype": "Bearer", "expiresin": 3600, "expiration": 1505865282 } 4. Use the value of the accesstoken property for your Factsheet API calls. Set the accesstoken value as the authorization header parameter for requests to the Watson Data APIs. The format is Authorization: Bearer

MethodPathSummary
GET/v1/aigov/factsheet/settingsGet all Factsheet service configuration settings
GET/v1/aigov/factsheet/settings/{setting}Get Factsheet service configuration setting
DELETE/v1/aigov/factsheet/settings/{setting}Delete the Factsheet service configuration setting
PUT/v1/aigov/factsheet/settings/{setting}Add or Update the Factsheet service configuration setting
GET/v1/aigov/model_inventory/model_entriesGet All WKC Model Entry assets
POST/v1/aigov/model_inventory/model_entriesCreate a WKC Model Entry asset for given catalog
GET/v1/aigov/model_inventory/model_entries/{model_entry_asset_id}Fetch WKC Model Entry Asset for given assetId
DELETE/v1/aigov/model_inventory/model_entries/{model_entry_asset_id}Delete Model Entry
PATCH/v1/aigov/model_inventory/model_entries/{model_entry_asset_id}Update Status value of ModelEntry
GET/v1/aigov/model_inventory/model_entries/{model_entry_asset_id}/modelsFetch all Physical Models for a logical Model
GET/v1/aigov/model_inventory/model_entries/{model_entry_asset_id}/alertsFetch Alerts for given Model Entry Asset
PATCH/v1/aigov/model_inventory/model_entries/{model_entry_asset_id}/relatemodelsUpdate master_id for a model
PUT/v1/aigov/model_inventory/model_stubSave External Model
POST/v1/aigov/model_inventory/models/{asset_id}/model_entryLink Model to Model Entry
DELETE/v1/aigov/model_inventory/models/{asset_id}/model_entryUnlink Model to Model Entry
GET/v1/aigov/model_inventory/models/{asset_id}/system_factsFetch System facts of the Model
GET/v1/aigov/model_inventory/models/{model_asset_id}/version_detailsGets the version details of a model
POST/v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approachCreate approach for model use case
DELETE/v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approach/{approach_id}Delete approach from model use case
PATCH/v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approach/{approach_id}Update model use case approach
GET/v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/tracked_model_versionsGet approaches and versions of all tracked models of a model use case
GET/v1/aigov/model_inventory/models/{model_asset_id}/deploymentsList all deployments of external model
PUT/v1/aigov/model_inventory/models/{model_asset_id}/deploymentsAdd a deployment to External Model
DELETE/v1/aigov/model_inventory/models/{model_asset_id}/deployments/{deployment_id}Delete deployment of an external model.
PUT/v1/aigov/model_inventory/models/{model_asset_id}/deployments/{deployment_id}/environmentMove deployment from source to target environment
PUT/v1/aigov/model_inventory/models/{model_asset_id}/environmentMove model from source to target environment
PUT/v1/aigov/model_inventory/model_usecases/{model_usecase_asset_id}/version_approach/{approach_id}/versions/{version_number}Modify the approach or version or both of all tracked models that belong to the given version number and approach
GET/v1/aigov/model_inventory/model_entries/{model_entry_asset_id}/reportDownload Model Entry report
GET/v1/aigov/model_inventory/models/{asset_id}/reportDownload model report
GET/v1/aigov/report_templatesGet report templates detail
POST/v1/aigov/report_templatesCreate report template
GET/v1/aigov/report_templates/{template_id}Get specific report template detail
PATCH/v1/aigov/report_templates/{template_id}Update report template
DELETE/v1/aigov/report_templates/{template_id}Delete Custom Report Template
GET/v1/aigov/report_templates/{template_id}/contentGet specific report template content
POST/v1/aigov/report_templates/{template_id}/contentUpdate specific report template file content
PATCH/v1/aigov/model_inventory/grc/configResets OpenPages Integration'