{ "openapi": "3.0.0", "info": { "description": "## Introduction\n\n**IMPORTANT**:\nWatson Data API documentation is deprecated and might be out of date.\nThe relevant functionality is now described in the following documents:\n\n1. [Common core functionality APIs for Data and AI SaaS products](https://cloud.ibm.com/apidocs/data-ai-common-core)\n2. [IBM Knowledge Catalog as a Service APIs](https://cloud.ibm.com/apidocs/knowledge-catalog)\n3. [IBM watsonx.ai as a Service APIs](https://cloud.ibm.com/apidocs/watsonx-ai)\n\nYou can use a collection of Watson Data REST APIs associated with Watson Studio and Watson Knowledge Catalog to manage data-related assets and the people who need to use these assets.\n\n**Refine data**\nUse the sampling APIs to create representative subsets of the data on which to test and refine your data cleansing and shaping operations. To better understand the contents of your data, you can create profiles of your data assets that include a classification of the data and additional distribution information which assists in determining the data quality.\n\n**Catalog data**\nUse the catalog APIs to create catalogs to administer your assets, associate properties with those assets, and organize the users who use the assets. Assets can be notebooks or connections to files, database sources, or data assets from a connection.\n\n**Data policies**\nUse the data policy APIs to implement data policies and a business glossary that fits to your organization to control user access rights to assets and to make it easier to find data.\n\n**Ingest streaming data**\nUse the streams flow APIs to hook up continuous, unidirectional flows of massive volumes of moving data that you can analyze in real time.\n\n**API Endpoint**\n\n```\nhttps://api.dataplatform.cloud.ibm.com\n\n```\n\n## Creating an IAM bearer token\n\nBefore you can call a Watson Data API you must first create an [IAM](https://cloud.ibm.com/docs/account?topic=account-iamoverview) 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.\n\nYou can create a token in IBM Cloud or by using the IBM Cloud command line interface (CLI).\n\nTo create a token in the IBM Cloud:\n\n1. Log in to [IBM Cloud](https://cloud.ibm.com/) and select **Manage > Access (IAM) > API keys**.\n2. 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.\n3. With your API key, set up Postman or another REST API tool and run the following command to the right\n\nYou can read more about managing API keys at [Understanding API keys](https://cloud.ibm.com/docs/account?topic=account-manapikey) documentation page.\n\n**Curl command with API key to retrieve token**\n```\ncurl -X POST 'https://iam.cloud.ibm.com/identity/token' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=MY_APIKEY'\n```\n\n**Response**\n```json\n{\n\"access_token\": \"eyJhbGciOiJIUz......sgrKIi8hdFs\",\n\"refresh_token\": \"SPrXw5tBE3......KBQ+luWQVY=\",\n\"token_type\": \"Bearer\",\n\"expires_in\": 3600,\n\"expiration\": 1473188353\n}\n```\n\n4. Use the value of the `access_token` property for your Watson Data API calls. Set the `access_token` value as the authorization header parameter for requests to the Watson Data APIs. The format is `Authorization: Bearer `. For example:\n `Authorization: Bearer eyJhbGciOiJIUz......sgrKIi8hdFs`\n\nTo create a token by using the IBM Cloud CLI:\n\n1. Follow the steps to install the CLI, log in to IBM Cloud, and get the token described [here](https://cloud.ibm.com/docs/monitoring?topic=monitoring-api_token#api_iam_token_get).\n\n Remove `Bearer` from the returned IAM token value in your API calls.\n\n## Versioning\n\nWatson Data 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.\n\n## Sorting\n\nSome of the Watson Data API collections provide custom sorting support. Custom sorting is implemented using the `sort` query parameter. Service collections can also support single-field or multi-field sorting. The `sort` parameter in collections that support single-field sorting can contain any one of the valid sort fields.\n\nFor example, the following expression would sort accounts on company name (ascending):`GET /v2/accounts?sort=company_name`.\n\nYou can also add a + or - character, indicating “ascending” or “descending,” respectively.\n\nFor example, the expression below would sort on the last name of the account owner, in descending order:`GET /v2/accounts?sort=-owner.last_name`.\n\nThe `sort` parameter in collections that support sorting on multiple fields can contain a comma-separated sequence of fields (each, optionally, with a + or -) in the same format as the single-field sorting. Sorts are applied to the data set in the order that they are provided. For example, the expression below would sort accounts first on company name (ascending) and second on owner last name (descending): `GET /v2/accounts?sort=company_name,-owner.last_name`\n\n## Filtering\n\nSome of the Watson Data API collections provide filtering support. You can specify one or more filters where each supported field is required to match a specific value for basic filtering. The query parameter names for a basic filter must exactly match the name of a primitive field on a resource in the collection or a nested primitive field where the '.' character is the hierarchical separator. The only exception to this rule is for primitive arrays. In primitive arrays, such as tags, a singular form of the field is supported as a filter that matches the resource if the array contains the supplied value. Some of the Watson Data API collections can also support extended filtering comparisons for the following field types: Integer and float, date and date/time, identifier and enumeration, and string.\n\n## Rate Limiting\n\nThe following rate limiting headers are supported by some of the Watson Data service APIs: 1. X-RateLimit-Limit: If rate limiting is active, this header indicates the number of requests permitted per hour; 2. X-RateLimit-Remaining: If rate limiting is active, this header indicates the number of requests remaining in the current rate limit window; 3. X-RateLimit-Reset: If rate limiting is active, this header indicates the time at which the current rate limit window resets, as a UNIX timestamp.\n\n## Error Handling\n\nResponses with 400-series or 500-series status codes are returned when a request cannot be completed. The body of these responses follows the error model, which contains a code field to identify the problem and a message field to explain how to solve the problem. Each individual endpoint has specific error messages. All responses with 500 or 503 status codes are logged and treated as a critical failure requiring an emergency fix.\n\n## Connections\n\nA connection is the information necessary to create a connection to a data source or a repository. You create a connection asset by providing the connection information.\n\n#### List data source types\n\nData sources are where data can be written or read and might include relational database systems, file systems, object storage systems and others.\n\nTo list supported data source types, call the following GET method:\n\n```\nGET /v2/datasource_types\n```\n\nThe response to the GET method includes information about each of the sources and targets that are currently supported. The response includes a unique ID property value `metadata.asset_id`, name, and a label. The `metadata.asset_id` property value should be used for the data source in other APIs that reference a data source type. Additional useful information such as whether that data source can be used as a source or target (or both) is also included.\n\nYou can also view a table of the individual data source properties obtained by this GET method at https://dataplatform.cloud.ibm.com/connections/docs.\n\nUse the `connection_properties=true` query parameter to return a set of properties for each data source type that is used to define a connection to it. Use the `interaction_properties=true` query parameter to return a set of properties for each data source type that is used to interact with a created connection. Interaction properties for a relational database might include the table name and schema from which to retrieve data.\n\nUse the `_sort` query parameter to order the list of data source type returned in the response.\n\nA default maximum of 100 data source type entries are returned per page of results. Use the `_limit` query parameter with an integer value to specify a lower limit.\n\nMore data source types than those on the first page of results might be available. Additional properties generated from the page size initially specified with `_limit` are returned in the response. Call a GET method using the value of the `next.href` property to retrieve the next page of results. Call a GET method using the value in the `prev.href` property to retrieve the previous page of results. Call a GET method using the value in the `last.href` property to retrieve the last page of results.\n\nThese URIs use the `_offset` and `_limit` query parameters to retrieve a specific block of data source types from the full list. Alternatively, you can use a combination of the `_offset` and `_limit` query parameters to retrieve a custom block of results.\n\n#### Create a connection\n\nConnections to any of the supported data source types returned by the previous method can be created and persisted in a catalog or project.\n\nTo create a connection, call the following POST method:\n\n```\nPOST /v2/connections\n```\n\nA new connection can be created in a catalog or project. Use the `catalog_id` **or** `project_id` query parameter to specify where to create the connection asset. Either `catalog_id` or `project_id` is required.\n\nThe request body for the method is a UTF-8 encoded JSON document and includes the data source type ID (obtained in the `List data source types` section), its unique name in the catalog or project space, and a set of connection properties specific to the data source. Some connection properties are required.\n\nThe following example shows the request body used for creating a connection to IBM dashDB:\n\n```json\n{\n \"datasource_type\": \"cfdcb449-1204-44ba-baa6-9a8a878e6aa7\",\n\t \"name\":\"My-DashDB-Connection\",\n \"properties\": {\n\t \"host\":\"dashDBhost.com\",\n\t \"port\":\"50001\",\n\t \"database\":\"MYDASHDB\",\n \"password\": \"mypassword\",\n \"username\": \"myusername\"\n }\n}\n```\n\nBy default, the physical connection to the data source is tested when the connection is created. Use the `test=false` query parameter to disable the connection test.\n\nA response payload containing a connection ID and other metadata is returned when a connection is successfully created. Use the connection ID as path parameter in other REST APIs when a connection resource must be referenced.\n\n#### Discover connection assets\n\nData sources contain data and metadata describing the data they contain.\n\nTo discover or browse the data or metadata in a data source, call the following GET method:\n\n```\nGET /v2/connections/{connection_id}/assets?path=\n```\n\nUse the `catalog_id` **or** `project_id` query parameter to specify where the connection asset was created. Either `catalog_id` or `project_id` is required.\n\n`connection_id` is the ID of the connection asset returned from the `POST https://{service_URL}/v2/connections` method, which created the connection asset.\n\nThe `path` query parameter is required and is used to specify the hierarchical path of the asset within the data source to be browsed. In a relational database, for example, the path might represent a schema and table. For a file object, the path might represent a folder hierarchy.\n\nEach asset in the assets array returned by this method includes a property containing its path in the hierarchy to facilitate the next call to drill down deeper in the hierarchy.\n\nFor example, starting at the root path in an RDBMS will return a list of schemas:\n\n```json\n{\n \"path\": \"/\",\n \"asset_types\": [\n {\n \"type\": \"schema\",\n \"dataset\": false,\n \"dataset_container\": true\n }\n ],\n \"assets\": [\n {\n \"id\": \"GOSALES\",\n \"type\": \"schema\",\n \"name\": \"GOSALES\",\n \"path\": \"/GOSALES\"\n },\n ],\n \"fields\": [],\n \"first\": {\n \"href\": \"https://wdp-dataconnect-ys1dev.stage1.mybluemix.net/v2/connections/4b28b5c1-d818-4ad2-bcf9-7de08e776fde/assets?catalog_id=75a3062b-e40f-4bc4-9519-308ee1b5b251&_offset=0&_limit=100\"\n },\n \"prev\": {\n \"href\": \"https://wdp-dataconnect-ys1dev.stage1.mybluemix.net/v2/connections/4b28b5c1-d818-4ad2-bcf9-7de08e776fde/assets?catalog_id=75a3062b-e40f-4bc4-9519-308ee1b5b251&_offset=0&_limit=100\"\n },\n \"next\": {\n \"href\": \"https://wdp-dataconnect-ys1dev.stage1.mybluemix.net/v2/connections/4b28b5c1-d818-4ad2-bcf9-7de08e776fde/assets?catalog_id=75a3062b-e40f-4bc4-9519-308ee1b5b251&_offset=100&_limit=100\"\n }\n}\n```\n\nDrill down into the GOSALES schema using the `path` property for the GOSALES schema asset to discover the list of table assets in the schema.\n\n```\nGET /v2/connections/{connection_id}/assets?catalog_id={catalog_id}&path=/GOSALES\n```\n\nThe list of table type assets is returned in the response.\n\n```json\n{\n \"path\": \"/GOSALES\",\n \"asset_types\": [\n {\n \"type\": \"table\",\n \"dataset\": true,\n \"dataset_container\": false\n }\n ],\n \"assets\": [\n {\n \"id\": \"BRANCH\",\n \"type\": \"table\",\n \"name\": \"BRANCH\",\n \"description\": \"BRANCH contains address information for corporate offices and distribution centers.\",\n \"path\": \"/GOSALES/BRANCH\"\n },\n {\n \"id\": \"CONVERSION_RATE\",\n \"type\": \"table\",\n \"name\": \"CONVERSION_RATE\",\n \"description\": \"CONVERSION_RATE contains currency exchange values.\",\n \"path\": \"/GOSALES/CONVERSION_RATE\"\n }\n ],\n \"fields\": [],\n \"first\": {\n \"href\": \"https://wdp-dataconnect-ys1dev.stage1.mybluemix.net/v2/connections/4b28b5c1-d818-4ad2-bcf9-7de08e776fde/assets?catalog_id=75a3062b-e40f-4bc4-9519-308ee1b5b251&_offset=0&_limit=100\"\n },\n \"prev\": {\n \"href\": \"https://wdp-dataconnect-ys1dev.stage1.mybluemix.net/v2/connections/4b28b5c1-d818-4ad2-bcf9-7de08e776fde/assets?catalog_id=75a3062b-e40f-4bc4-9519-308ee1b5b251&_offset=0&_limit=100\"\n },\n \"next\": {\n \"href\": \"https://wdp-dataconnect-ys1dev.stage1.mybluemix.net/v2/connections/4b28b5c1-d818-4ad2-bcf9-7de08e776fde/assets?catalog_id=75a3062b-e40f-4bc4-9519-308ee1b5b251&_offset=100&_limit=100\"\n }\n}\n```\n\nUse the `fetch` query parameter with a value of either `data`, `metadata`, or both. Data can only be fetched for *data set* assets. In the response above, note the `asset_type` has the property `type` value of **table**. Its `dataset` property value is **true**. This means that data can be fetched from table type assets. However, if you fetched assets from the connection root, the response would contain schema asset types, which are not data sets and thus fetching this data is not relevant.\n\nA default maximum of 100 metadata assets are returned per page of results. Use the `_limit` query parameter with an integer value to specify a lower limit. More assets than those on the first page of results might be available.\n\nAdditional properties generated from the page size initially specified with `_limit` are returned in the response. Call a GET method using the value of the `next.href` property to retrieve the next page of results. Call a GET method using the value in the `prev.href` property to retrieve the previous page of results. Call a GET method using the value in the `last.href` property to retrieve the last page of results.\n\nThese URIs use the `_offset` and `_limit` query parameters to retrieve a specific block of assets from the full list. Alternatively, use a combination of the `_offset` and `_limit` query parameters to retrieve a custom block of results.\n\n#### Specify properties for reading delimited files\n\nWhen reading a delimited file using this method, specify property values to correctly parse the file based on its format. These properties are passed to the method as a JSON object using the `properties` query parameter. The default file format (property `file_format`) is a CSV file. If the file is a CSV, the following property values are set by default:\n\nProperty Name | Property Description | Default Value | Value Description\n--- | --- | --- | ---\n`quote_character` | quote character | `double_quote` | double quotation mark\n`field_delimiter` | field delimiter | `comma` | comma\n`row_delimiter` | row delimiter | `carriage_return_linefeed` | carriage return followed by line feed\n`escape_character` | escape character | `double_quote` | double quotation mark\n
\n\nFor CSV file formats, these property values can not be overwritten. If it is necessary to modify these properties to properly read a delimited file, set the `file_format` property to `delimited`. For generic delimited files, these properties have the following values:\n\nProperty Name | Property Description | Default Value | Value Description\n--- | --- | --- | ---\n`quote_character` | quote character | `none` | no character is used for a quote\n`field_delimiter` | field delimiter | _null_ | no field delimiter value is set by default\n`row_delimiter` | row delimiter | `new_line` | Any new line representation\n`escape_character` | escape character | `none` | no character is used for an escape\n
\n\nThis example sets file format properties for a generic delimited file:\n\n```\nGET https://{service_URL}/v2/connections/{connection_id}/assets?catalog_id={catalog_id}&path=/myFolder/myFile.txt&fetch=data&properties={\"file_format\":\"delimited\", \"quote_character\":\"single_quote\",\"field_delimiter\":\"colon\",\"escape_character\":\"backslash\"}\n```\n\nFor more information about this method see the [REST API Reference](https://console.ng.bluemix.net/apidocs/681?&language=node#introduction).\n\n#### Discover assets using a transient connection\n\nA data source's assets can be discovered without creating a persistent connection.\n\nTo browse assets without first creating a persistent connection, call the following POST method:\n\n```\nPOST https://{service_URL}/v2/connections/assets?path=\n```\n\nThis method is identical in behavior to the GET method in the `Discover connection assets`section except for two differences:\n\n1. You define the connection properties in the request body of the REST API. You do not reference the connection ID of a persistent connection with a query parameter. The same JSON object used to create a persistent connection is used in the request body.\n1. You do not specify a catalog or project ID with a query parameter.\n\nSee the previous section to learn how to set properties used to read delimited files.\n\nFor more information about this method see the [REST API Reference](https://console.ng.bluemix.net/apidocs/681?&language=node#introduction).\n\n#### Update a connection\n\nTo modify the properties of a connection, call the following PATCH method:\n\n```\nPATCH /v2/connections/{connection_id}\n```\n\n`connection_id` is the ID of the connection asset returned from the `POST https://{service_URL}/v2/connections` method, which created the connection asset.\n\nUse the `catalog_id` **or** `project_id` query parameter to specify where the connection asset was created. Either `catalog_id` or `project_id` is required.\n\nSet the `Content-Type` header to `application/json-patch+json`. The request body contains the connection properties to update using a JSON object in [JSON Patch format](http://jsonpatch.com).\n\nChange the port number of the connection and add a description using this JSON Patch:\n\n```json\n[\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/description\",\n\t\t\"value\": \"My new PATCHed description\"\n\t},\n\t{\n\t\t\"op\":\"replace\",\n\t\t\"path\":\"/properties/port\",\n\t\t\"value\":\"40001\"\n\t}\n]\n```\n\nBy default, the physical connection to the data source is tested when the connection is modified. Use the `test=false` query parameter to disable the connection test.\n\nFor more information about this method see the [REST API Reference](https://console.ng.bluemix.net/apidocs/681?&language=node#introduction).\n\n#### Delete a connection\n\nTo delete a persistent connection, call the following DELETE method:\n\n```\nDELETE /v2/connections/{connection_id}\n```\n\n`connection_id` is the ID of the connection asset returned from the `POST https://{service_URL}/v2/connections` method, which created the connection asset.\n\nUse the `catalog_id` **or** `project_id` query parameter to specify where the connection asset was created. Either `catalog_id` or `project_id` is required.\n\n## Schedules\n\n#### Introduction\n\nSchedules allow you to run a data flow, a notebook, a data profile, or any other given source more than once. It supports various repeat types namely hour, day, week, month, and year with 2 repeat end options namely, end date and the maximum number of runs.\n\n#### Create a schedule\n\nTo create a schedule in a specified catalog or project, call the following POST method:\n\n```\n HTTP Method : POST\n URI : /v2/schedules\n```\n\nBefore you create a schedule, you must consider the following points:\n\n1. You must have a valid IAM token to make REST API calls and a project or catalog ID.\n\n2. You must be authorized (be assigned the correct role) to create schedules in the catalog or project.\n\n3. The start and end dates must be in the following format: `YYYY-MM-DDTHH:mm:ssZ` or `YYYY-MM-DDTHH:mm:ss.sssZ` (specified in RFC 3339).\n\n4. The supported repeat types are `hour`, `day`, `week`, `month`, and `year`.\n\n5. There are 2 repeat end options, namely `max_invocations` and `end_date`.\n\n6. The supported repeat interval is 1.\n\n7. There are 3 statuses for schedules, namely `enabled`, `disabled`, and `finished`. To create a schedule, the status must be `enabled`. The scheduling service updates the status to `finished` once it has finished running. You can stop or pause the scheduling service by updating the status to `disabled`.\n\n8. You can update the endpoint URI in the target HREF. Supported target methods are POST, PUT, PATCH, DELETE, and GET.\n\n9. Set `generate_iam_token=true`. When this option is set to true, the scheduling service generates an IAM token and passes it to the target URL at runtime. This IAM token is required to run schedules automatically at the scheduled intervals. This token is not to be confused with the IAM token required to make Watson Data API REST calls.\n\nThis POST method creates a schedule in a catalog with a defined start and a given end date:\n\n```json\n {\n \"catalog_id\": \"aeiou\",\n \"description\": \"aeiou\",\n \"name\": \"aeiou\",\n \"tags\": [\"aeiou\"],\n \"start_date\": \"2017-08-22T01:02:14.859Z\",\n \"status\": \"enabled\",\n \"repeat\": {\n \"repeat_interval\": 1,\n \"repeat_type\": \"hour\"\n },\n \"repeat_end\": {\n \"end_date\": \"2017-08-24T01:02:14.859Z\"\n },\n \"target\": {\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/data_profiles?start=false\",\n \"generate_iam_token\": true,\n \"method\": \"POST\",\n \"payload\": \"aeiou\",\n \"headers\": [\n {\n \"name\": \"content-type\",\n \"value\": \"application/json\",\n \"sensitive\": false\n }\n ]\n }\n }\n```\n\n#### Get multiple schedules in a catalog or project\n\nTo get all schedules in the specified catalog or project, call the following GET method:\n\n HTTP Method: GET\n URI :/v2/schedules\n\nYou need the following information to get multiple schedules:\n\n1. A valid IAM token, schedule ID, and the catalog or project ID.\n\n2. You must be authorized to get schedules in the catalog or project.\n\nYou can filter the returned results by using the options `entity.schedule.name` and `entity.schedule.status` and can filter matching types by using `StartsWith(starts:)` and `Equals(e:)`.\n\nYou can sort the returned results either in ascending or descending order by using one or more of the following options: `entity.schedule.name`, `metadata.create_time`, and `entity.schedule.status`.\n\n#### Get a schedule\n\nTo get a schedule in the specified catalog or project, call the following GET method:\n\n```\n HTTP Method: GET\n URI :/v2/schedules/{schedule_id}\n```\n\nYou need the following information to get a schedule:\n\n1. A valid IAM token, schedule ID, and the catalog or project ID.\n\n2. You must be authorized to get a schedule in the catalog or project.\n\n#### Update a schedule\n\nTo update a schedule in the specified catalog or project, call the following PATCH method:\n\n HTTP Method: PATCH\n URI :/v2/schedules/{schedule_id}\n\nYou need the following information to update a schedule:\n\n1. A valid IAM token, schedule ID, and the catalog or project ID.\n\n2. You must be authorized to update a schedule in the catalog or project.\n\nYou can update all the attributes under entity but can't update the attributes under meta-data.\n\nPatch supports the `replace`, `add`, and `remove` operations. The `replace` operation can be used with all the attributes under entity. The `add` and `remove` operations can only be used with the repeat end options, namely `max_invocations` and `end_date`.\n\nThe start and end dates must be in the following format: `YYYY-MM-DDTHH:mm:ssZ` or `YYYY-MM-DDTHH:mm:ss.sssZ` (specified in RFC 3339).\n\nThis PATCH method replaces the repeat type, removes the max invocations and adds an end date:\n\n```json\n [\n {\n \"op\": \"remove\",\n \"path\": \"/entity/schedule/repeat_end/max_invocations\",\n \"value\": 20\n },\n {\n \"op\": \"add\",\n \"path\": \"/entity/schedule/repeat_end/end_date\",\n \"value\": \"date\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/entity/schedule/repeat/repeat_type\",\n \"value\": \"week\"\n }\n ]\n```\n\n#### Delete a schedule\n\nTo delete a schedule in the specified catalog or project, call the following DELETE method:\n\n```\n HTTP Method : DELETE\n URI :{GATEWAY_URL}/v2/schedules/{schedule_id}\n```\n\n\":guid\" represents the schedule_id of the deleted schedule.\n\nYou need the following information to delete a schedule:\n\n1. A valid IAM token, schedule ID, and the catalog or project ID.\n\n2. You must be authorized to delete a schedule in the catalog or project.\n\n#### Delete multiple schedules\n\nTo delete multiple schedules in the specified catalog or project, call the following DELETE method:\n\n HTTP Method: DELETE\n URI :{GATEWAY_URL}/v2/schedules\n\n\":guid\" represents the schedule_id of the deleted schedule.\n\nYou need the following information to delete multiple schedules:\n\n1. A valid IAM token, schedule ID, and the catalog or project ID.\n\n2. You must be authorized to delete schedules in the catalog or project.\n\n3. A comma-separated list of the schedule IDs. If schedule IDs are not listed in the parameter `schedule_ids`, the scheduling service will delete all the schedules in the catalog or project.\n\n\n## Catalogs #\n\n[Catalog Overview](#Section_Catalog__Overview)\n\n[Catalog APIs](#Section_Catalog__APIs)\n\n - [Get a Catalog](#Section_Catalog__GET_CATALOG)\n - [Get Catalogs](#Section_Catalog__GET_CATALOGS)\n\n\n\nIBM Knowledge Catalog helps you easily organize, find and share data assets, analytical assets, etc. for many data science projects and for the users who need to use those assets.\n\nYou can use the Catalog API to create catalogs which are rich metadata repositories for organizing and exploring metadata.\n\n\n\nThere are two phrases that will be used repeatedly throughout this (and the [\"Assets\"](#Section_Assets__start) and [\"Asset Types\"](#Section_Asset_Types__start)) documentation:\n\n - `asset resource`: The primary content of the asset. Many assets have a resource that is stored in an external repository: a data file, connected data set, notebook file, dashboard definition, or model definition.\n\n - `asset metadata`: The information about the asset resource. Each asset has a primary metadata document in a project or catalog and might have additional metadata documents.\n\nSee the [Asset Terminology](#Section_Asset__Terminology_Overview) section for more information about those two phrases.\n\n\nThere is one special user-provided storage that must be specified by the creator of a catalog at the time the catalog is created: a Cloud Object Storage bucket for public cloud deployment and a file system for hybrid cloud deployment. We'll informally call that the **\"catalog's bucket\"**. The creator of the catalog owns that bucket, but by providing that bucket's identification info during catalog creation, the catalog creator is allowing the IBM Knowledge Catalog graphical User Interface to store asset resources in that bucket and is allowing other IBM Knowledge Catalog APIs to stored (extended) asset metadata in that bucket.\n\nIf a user wants to store and retrieve asset resources (like spreadsheets, images, etc.) in the catalog's bucket, then that user can use the [Assets API](#Section_Assets__start) API to assist in that process.\n\nIn some cases, one of the other IBM Knowledge Catalog APIs (for example, the \"Profiling\" API) will store (extended) asset metadata documents in the catalog's bucket.\n\n\n\nThis section describes some of the individual Catalog APIs.\n\n\n\n### Get a Catalog ###\n\nYou can get metadata about a catalog using the get Catalog API. (Note: you aren't retrieving the actual **data** catalog with the GET Catalog API - you're just retrieving **metadata** that _describes_ the catalog.)\n\n\n\n#### Get Catalog - Request URL: ####\n\n```\nGET {service_URL}/v2/catalogs/{catalog_id}\n```\n\n#### Get Catalog - Response Body: ####\n\n```json\n{\n\t\"metadata\": {\n\t\t\"guid\": \"c6f3cbd8-2b7f-42fb-aa60-___\",\n\t\t\"url\": \"https://api.dataplatform.cloud.ibm.com/v2/catalogs/c6f3cbd8-2b7f-42fb-aa60-___\",\n\t\t\"creator_id\": \"IBMid-___\",\n\t\t\"create_time\": \"2018-11-06T17:40:32Z\"\n\t},\n\t\"entity\": {\n\t\t\"name\": \"CatalogForGettingStartedDoc\",\n\t\t\"description\": \"Catalog created for Getting Started doc\",\n\t\t\"generator\": \"Your catalog generator\",\n\t\t\"bss_account_id\": \"12345___\",\n\t\t\"capacity_limit\": 0,\n\t\t\"is_governed\": false,\n\t\t\"saml_instance_name\": \"IBM w3id\"\n\t},\n\t\"href\": \"https://api.dataplatform.cloud.ibm.com/v2/catalogs/c6f3cbd8-2b7f-42fb-aa60-___\"\n}\n```\n\nIn this case, the response for the Get Catalog request is identical to the response for the Create Catalog request. If more activity had occurred with the catalog between the Create Catalog and the Get Catalog requests then there might have been some differences between the two responses.\n\n\n\n### Get Catalogs ###\n\nTo obtain the metadata for all the catalogs that you have access to (ie, are a collaborator of), you can call the GET Catalogs API.\n\n#### Get Catalogs - Request URL: ####\n\n```\nGET {service_URL}/v2/catalogs\n```\n\nNote: the above URL is the simplest URL for getting catalogs because it doesn't contain any parameters. There are a number of optional parameters (`limit`, `bookmark`, `skip`, `include`, `bss_account_id`) to the above URL that you can make use of to limit the number of catalogs for which metadata is returned.\n\n#### Get Catalogs - Response Body: ####\n\n```json\n{\n \"catalogs\": [\n {\n \"metadata\": {\n \"guid\": \"c6f3cbd8-2b7f-42fb-aa60-___\",\n \"url\": \"https://api.dataplatform.cloud.ibm.com/v2/catalogs/c6f3cbd8-2b7f-42fb-aa60-___\",\n \"creator_id\": \"IBMid-___\",\n \"create_time\": \"2018-11-06T17:40:32Z\"\n },\n \"entity\": {\n \"name\": \"CatalogForGettingStartedDoc\",\n \"description\": \"Catalog created for Getting Started doc\",\n \"generator\": \"Your catalog generator\",\n \"bss_account_id\": \"12345___\",\n \"capacity_limit\": 0,\n \"is_governed\": false,\n \"saml_instance_name\": \"IBM w3id\"\n },\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/catalogs/c6f3cbd8-2b7f-42fb-aa60-___\"\n }\n ],\n \"nextBookmark\": \"g1AAAAFCeJzLYWBgYMlgTmHQSklKzi9KdUhJMjT___\",\n \"nextSkip\": 0\n}\n```\n\nIn the above example, metadata for only one catalog is returned - the catalog created above. An advantage of calling the GET Catalogs API is you don't have to remember the ID of any particular catalog in order to get the metadata for that catalog.\n\n\n## Assets #\n\n * [Asset Terminology](#Section_Asset__Terminology_Overview)\n\n * [Assets API Overview](#Section_Asset__API_Overview)\n\n - [Asset's Primary Metadata Document (or Card)](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview)\n + [Parts of a Primary Metadata Document Figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure)\n + [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group)\n + [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group)\n * [Attributes](#Section_Assets__Overview_and_Terminology__Attributes)\n + [\"attachments\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group)\n * [Asset Resource Attachment](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group__Asset)\n * [Extended Metadata Document Attachment(s)](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata)\n - [Other Assets API objects](#Section_Assets__Overview_and_Terminology__Asset__Other_Parts)\n\n * [Assets API Examples](#Section_Asset__API_Examples)\n\n - [Get Asset](#Section_Assets__Get_Asset)\n * [Get Asset - for a Connection](#Section_Assets__Get_Asset__WDP_Connection)\n + [Get Asset - Connection - Response Body](#Section_Assets__Get_Asset__WDP_Connection__Response)\n * [Get Asset - for a CSV File](#Section_Assets__Get_Asset__CSV_File)\n + [Get Asset - CSV File - Response Body - _Before_ Profiling](#Section_Assets__GET_ASSET__CSV_File__before_profiling)\n + [Get Asset - CSV File - Response Body - _After_ Profiling](#Section_Assets__GET_ASSET__CSV_File__after_profiling)\n * [Get Attachment - Extended Metadata Document](#Section_Assets__Request__GET_Extended_Metadata_document)\n * [Get Attachment - Asset Resource](#Section_Assets__Request__GET_ASSET_RESOURCE)\n - [Create Asset: book](#Section_Assets__Create_Asset_book)\n - [Associate a Term with an Asset](#Section_Assets__Associate_Term_with_Asset)\n - [Associate a Classification with an Asset](#Section_Assets__Associate_Classification_with_Asset)\n\n * [Processing Duplicate Asset](#Section_Assets__DUPLICATE_ASSET)\n\n - [Overview](#Section_Assets__DUPLICATE_ASSET__Overview)\n - [What is a duplicate](#Section_Assets__DUPLICATE_ASSET__What_Is_A_Duplicate)\n - [What to do with a duplicate](#Section_Assets__DUPLICATE_ASSET__What_To_Do_With_A_Duplicate)\n - [Duplicate Detection Strategy](#Section_Assets__DUPLICATE_ASSET__Duplicate_Detection_Strategy)\n - [Multiple duplicates](#Section_Assets__DUPLICATE_ASSET__Multiple_Duplicates)\n - [How the duplicate asset is updated or overwritten](#Section_Assets__DUPLICATE_ASSET__How_The_Duplicate_Asset_Is_Updated_Or_Overwritten)\n - [Backup revision](#Section_Assets__DUPLICATE_ASSET__Backup_Revision)\n - [Check duplicates before creating an asset](#Section_Assets__DUPLICATE_ASSET__Check_Duplicates_Before_Creating_An_Asset)\n - [Lineage and Activity event messages change](#Section_Assets__DUPLICATE_ASSET__Event_Messages)\n - [Known issues/limitations](#Section_Assets__DUPLICATE_ASSET__Known_issues_limitations)\n - [Troubleshooting](#Section_Assets__DUPLICATE_ASSET__Troubleshooting)\n\n\n\nFrom a high level, an asset is an item of data or data analysis in a project or catalog. Most of these assets consist of two parts:\n\n - **Asset resource**: The primary content of the asset. Many assets have a resource that is stored in an external repository: a data file (eg. text file, image, video, etc.), connected data set (eg. database table), notebook file, dashboard definition, or model definition. The Assets API does not affect this part of the asset. Think of this as the object that's _being described_ by [asset metadata](#Section_Assets__Terminology_Overview__definition__Asset_Metadata) (ie, an asset resource is a \"decribee\").\n\n - **Asset metadata**: The information about the asset resource. Each asset has a primary metadata document in a project or catalog and might have additional metadata documents. This is the part of the asset that you can get, create, or operate on with the Assets API. Think of this as the object that's _doing the describing_ of an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) (ie, asset metadata is a \"describer\").\n\nA library is a useful analogy for understanding the scope of the Assets API. A library contains a set of books and an index. The index, or card catalog, contains a card about each book. A card has information about the book, including the location of the book. A Watson project or catalog contains only the card catalog part of the library. The books, or asset resources, are elsewhere. Consequently, the Assets API can return the location of an asset resource, but not affect the asset resource in any way.\n\nThe term **asset** encapsulates the following:\n\n - **\\[1\\] [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource)**: the primary / initial resource that a user wants described by a primary metadata document.\n - **\\[2\\] [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview)**: a document added to a catalog to describe an asset resource.\n - **\\[3\\] [attributes](#Section_Assets__Overview_and_Terminology__Attributes)**: chunks of data inside a primary metadata document that describe either the asset resource or a secondary / extended metadata document.\n - **\\[4\\] [secondary / extended metadata documents](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata)**: additional documents containing information related to the asset resource. Attached to the primary metadata document. Can be generated by catalog processes, such as profiling.\n - **\\[5\\] a combination of all of the above**: the IBM Knowledge Catalog UI presents information from each of the above on a single page and calls all that information an \"asset\".\n\nFor example, when you call the Get Assets API, you receive asset metadata (in a primary metadata document). The asset metadata might point to the location of the asset resource, but the Get Assets API does not return the asset resource. Similarly, when you run the Create Assets API, you create a primary metadata document that can, eventually, include the location of an existing asset resource.\n\n\n\nThis overview section provides a [picture](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure) of the parts of a [\"primary metadata document\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) and then explains the parts of that picture. The picture provides a kind of \"map\" of a primary metadata document, so it's recommended to spend a few minutes studying it. Readers who prefer API examples can skip over the explanation of that picture that follows, and go straight to the [Assets API Examples](#Section_Asset__API_Examples) section. However, the Assets API Examples section will often refer back to the terms and explanations discussed in this Assets API Overview section.\n\nNote: when calling any of the endpoints in the Assets API you must specify either a catalog ID or a project ID to indicate whether the metadata for an asset is (to be) in a catalog or a project. Because the Assets API endpoints can be applied to either a catalog or a project, rather than repeating the phrase \"either a catalog or a project\" over and over throughout the rest of this documentation, only the term \"catalog\" will be used. The possibility of instead using a \"project\" will be implied.\n\n\n### Asset Primary Metadata Document (or Card) ###\n\n\nA **primary metadata document** is a document that contains the primary metadata for an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource). Once a primary metadata document has been created and stored in the catalog, it's often _informally_ said that that asset resource has been \"**cataloged**\", or \"**added** to the catalog\". Note: being cataloged, or added to the catalog, does _not_ mean the asset resource has been moved or copied and is now physically stored inside the catalog - it just means a primary metadata document has been created _for_ that asset resource, and that primary metadata document is now stored in the catalog.\n\nAlmost every Assets API endpoint revolves around creating, reading, modifying or deleting a primary metadata document. JSON is natively used to store primary metadata documents in a catalog, and to transfer those documents in Assets API REST calls. So, JSON examples of primary metadata documents will be used throughout this documentation.\n\n\nIn this documentation, the term **card** (as in, an index **card** in a library's catalog) will often be used as a short _nickname_ for the phrase **\"primary metadata document\"**. In this documentation, \"card\" and \"primary metadata document\" mean exactly the same thing. The term \"card\" just saves us from reading and writing the lengthier phrase \"primary metadata document\" over and over.\n\n\nA primary metadata document (ie, card) is a JSON object that's composed of up to three top-level fields, named as follows:\n\n 1. [**metadata**](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group): a JSON object containing metadata _common to all_ [asset types](#Section_Assets__Overview_and_Terminology__Asset_Type)\n 2. [**entity**](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group): a JSON object containing [attributes](#Section_Assets__Overview_and_Terminology__Attributes), each containing metadata _specific to one_ asset type\n 3. [**attachments**](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group): an optional JSON array, each item of which is a JSON object containing _metadata for_ an attached (ie, externally stored) [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) or [extended metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata)\n\nFor a pictorial representation of a primary metadata document (ie, card) and its associated asset resource and extended metadata documents, see the [Parts of a Primary Metadata Document figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure) below:\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Green rectangles and arrows illustrate the role that thename of the primary asset type plays in connecting parts to each other.Underlines highlight the role that the name of a secondary asset type plays in connecting other parts to each other.\n \n \n \n \n \n { "metadata": { ... "asset\\_type": "data\\_asset", "asset\\_attributes": [ "data\\_asset", "data\\_profile", ... ], ... } "entity": { "data\\_asset": { ...metadata related to data\\_asset... }, "data\\_profile": { ...metadata related to data\\_profile... }, ... more attributes } "attachments": [ { "asset\\_type": "data\\_asset", "connection\\_id": "070e9b...", "connection\\_path": ".../Sample.csv", ... }, { asset\\_type": "data\\_profile", "handle": { "bucket": "...", ... } ... more attachment items } ]}\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Sample.csv file\n \n \n \n \n \n Asset Resource:\n \n \n \n \n \n An Asset's Primary Metadata Document, or Card:\n \n \n \n \n \n \n \n \n \n \n \n CATALOG DATABASE:\n \n \n \n \n \n ...many more CARDS...\n \n \n \n \n \n \n \n \n \n \n \n User-provided Storage Repository A: (one of possibly many)\n \n \n \n \n \n ...many more Asset Resources...\n \n \n \n \n \n \n \n \n \n \n \n JSON document containing moremetadata aboutthe Asset Resource\n \n \n \n \n \n \n \n \n \n \n \n The one and only CATALOG'S BUCKET(which is provided by user):\n \n \n \n \n \n ...many more Extended Metadata documents and/or Asset Resources...\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Figure: The Parts of a Primary Metadata Document, or Card\n \n \n \n \n \n Extended Metadata Document:\n \n \n \n \n \n \n \n \n \n \n \n EXTERNAL STORAGE REPOSITORIES provided by the User\n \n \n \n \n \n INTERNAL STORAGEprovided by the Catalog\n \n \n \n \n \n Two Attributes.- each Attribute is an instance of a different Asset Type.- name of Attribute matchesname of Asset Type.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Primary Attribute\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Extended (or Secondary) Attribute\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Metadata for an attachedAsset Resource\n \n \n \n \n \n Metadata for an attachedExtended Metadata Document\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Red rectangles indicate the 3 main sections of a card.\n \n \n \n \n \n { "metadata": { ... "asset\\_type": "data\\_asset", "asset\\_attributes": [ "data\\_asset", "data\\_profile", ... ], ... } "entity": { "data\\_asset": { ...metadata related to data\\_asset... }, "data\\_profile": { ...metadata related to data\\_profile... }, ... more attributes } "attachments": [ { "asset\\_type": "data\\_asset", "connection\\_id": "070e9b...", "connection\\_path": ".../Sample.csv", ... }, { asset\\_type": "data\\_profile", "handle": { "bucket": "...", ... } ... more attachment items } ]}\n \n \n \n \n \n \n \n\n\nIn particular, note that:\n\n - red rectangles are used in the figure to highlight the [three top-level fields of a card](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__three_top_level_fields_of_a_card).\n - the green rectangles illustrate how important the _name_ of the [primary asset type](#Section_Assets__Overview_and_Terminology__Asset_Type__Primary_Asset_Type_definition) is in relating various parts of the card, and the attached [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource), to each other. In the example figure, the value of `\"metadata.asset_type\"` is \"data\\_asset\". The value you'll see in your card depends on the \"asset_type\" you've specified for your asset.\n\n\n\n#### \"metadata\" field of a Primary Metadata Document ####\n\nThe **\"metadata\"** field of a primary metadata document (ie, of a card) is a JSON object that contains metadata fields that are common across _all_ [types of assets](#Section_Assets__Overview_and_Terminology__Asset_Type). (See the top red rectangle in the [parts figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure).) The Assets API specifies the names of the fields that go into the \"metadata\" part of the card. The user must supply values for _some_ of the fields in \"metadata\"; the values of other fields in \"metadata\" will be filled in by the Assets API during the life of the card. Here's a list of some of the fields inside \"metadata\" (see example cards in the [Get Asset](#Section_Assets__Get_Asset) section for more extensive lists):\n\n - **\"asset_id\"**:\n + The ID of the _card_ (ie, primary metadata document) rather than of the _asset resource_ described by the card.\n + Created _internally_ by the Assets API at the time the card is created. That is, you do *not* supply this value.\n - **\"asset\\_type\"**:\n + You must supply this value.\n + Declares the [primary asset type](#Section_Assets__Overview_and_Terminology__Asset_Type__Primary_Asset_Type_definition) of this card.\n + Describes the type of the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) attached (if any) to this card.\n + Specifies the name of the [primary attribute](#Section_Assets__primary_attribute__definition) in this card.\n + See [Asset Types](#Section_Assets__Overview_and_Terminology__Asset_Type) for more details on asset types.\n - **\"asset\\_attributes\"**:\n + You must _not_ supply any value for this field when creating a primary metadata document. The Assets APIs maintain the contents of this field.\n + An array of [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute) names (only the _names_, not the actual _attributes_).\n + Each attribute / asset type name listed in this array will have a correspondingly named attribute in the [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) field of the card.\n + The name of each _attribute_ must match the name of an existing [asset _type_](#Section_Assets__Overview_and_Terminology__Asset_Type), so this is also an array of the names of the [primary](#Section_Assets__Overview_and_Terminology__Asset_Type__Primary_Asset_Type_definition) and [secondary / extended](#Section_Assets__Overview_and_Terminology__Asset_Type__Secondary_Extended_Asset_Type_definition) asset types used by this card.\n - **\"name\"**: the name of the asset resource this card describes\n - **\"description\"**: a description of the asset resource\n - **\"origin_country\"**: the originating country for the asset resource\n - **\"tags\"**: an array of terms that users want to associate with the asset resource\n - **\"rov\"**: Rules Of Visibility.\n + **\"mode\"**: -1 - this is the default, which corresponds to \"mode\" : 0, public (see below)\n + **\"mode\"**: 0 - indicates **public** visibility, in which everybody can view and search the values of the asset's primary metadata document (card), and preview the asset's data. Note: access can still be denied based on actionable governance policy rules.\n\n```\n\t\"rov\": {\n\t\t\"mode\": 0,\n\t\t\"collaborator_ids\": []\n\t}\n```\n\n -\n + **\"mode\"**: 8 - indicates **private** visibility, which allows users listed as members of the asset (as denoted by `collaborator_ids` list) to view and search all fields (including `metadata`, `entity`, and `attachments`) of the asset's primary metadata document (card), and preview the asset's data. Non-members are allowed to only view and search the `metadata` field, and cannot preview the asset's data. This mode is only available through the API, and is not exposed in the IKC UI. Note: access can still be denied based on actionable governance policy rules.\n\n```\n\t\"rov\": {\n\t\"mode\": 8,\n\t\"collaborator_ids\": [\n\t\t{\n\t\t\t\"IBMid-06___\": {\n\t\t\t\t\"user_iam_id\": \"IBMid-06___\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"IBMid-27___\": {\n\t\t\t\t\"user_iam_id\": \"IBMid-27___\"\n\t\t\t}\n\t\t}\n\t]\n}\n```\n -\n + **\"mode\"**: 16 - indicates **hidden** visibility, in which _only_ users listed as members of the asset (as denoted by `collaborator_ids` list) have any access to fields in the asset, and non-members have no access to the asset. Note: access can still be denied based on actionable governance policy rules.\n\n```\n\t\"rov\": {\n\t\"mode\": 16,\n\t\"collaborator_ids\": [\n\t\t{\n\t\t\t\"IBMid-06___\": {\n\t\t\t\t\"user_iam_id\": \"IBMid-06___\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"IBMid-27___\": {\n\t\t\t\t\"user_iam_id\": \"IBMid-27___\"\n\t\t\t}\n\t\t}\n\t]\n}\n```\n\n\n\n#### \"entity\" field of a Primary Metadata Document ####\n\nThe **\"entity\"** field of a card (ie, primary metadata document) is a JSON object that contains additional JSON objects called [attributes](#Section_Assets__Overview_and_Terminology__Attributes), each of which contains metadata fields that are _specific_ to _one_ [asset type](#Section_Assets__Overview_and_Terminology__Asset_Type). (See the middle red rectangle in the [parts figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure).) The _only_ contents of the \"entity\" field are attributes, which are discussed in the next section.\n\nNote: the fact that the \"entity\" section contains attributes for more than one asset type does not mean that a single card contains metadata for more than one [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource). A card always contains metadata for exactly one asset resource, and that asset resource will have exactly one attribute associated with it (see [primary attribute](#Section_Assets__primary_attribute__definition) below). All the other attributes in the \"entity\" field contain _extended_ metadata describing the single asset resource that the card was created for. Really, [asset types](#Section_Assets__Overview_and_Terminology__Asset_Type) ought to be thought of as _attribute_ types because asset types literally define (some of) the fields that will appear in _attributes_.\n\n\n##### Attributes #####\n\nIn the Assets API, an **attribute** is a collection of metadata that:\n\n - is contained directly inside the [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) field of the [primary metadata document](#Section_Assets__Overview_and_Terminology__definition__primary_metadata_document).\n - is identically named with, and has fields that are partially defined by, an [Asset Type](#Section_Assets__Overview_and_Terminology__Asset_Type)\n - describes an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) or something related to that asset resource, such as an [extended metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata)\n\nThere is one attribute in the [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) field for each attribute _name_ that appears in the [\"metadata.asset\\_attributes\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__attributes) array. So, for example, if the `\"metadata.asset_attributes\"` array contains these two attribute _names_:\n\n```\n \"metadata\": {\n ...\n \"asset_attributes\": [\n \"data_asset\",\n \"data_profile\"\n ],\n }\n```\n\nthen the \"entity\" field will contain these two correspondingly named attributes:\n\n```\n \"entity\": {\n \"data_asset\": { // attribute name matches \"data_asset\" in \"metadata.asset_attributes\"\n ...attribute contents...\n },\n \"data_profile\": { // attribute name matches \"data_profile\" in \"metadata.asset_attributes\"\n ...attribute contents...\n }\n }\n```\n\nThe name of each attribute in \"entity\" must also match the name of an existing [asset _type_](#Section_Assets__Overview_and_Terminology__Asset_Type). That is, an _attribute_ named \"X\" will contain metadata related to an asset _type_ also named \"X\". So, an attribute's _name_ can be thought of as _simultaneously_ telling us that attribute's \"type\". For example, in [this asset metadata document example](#Section_Assets__GET_ASSET__CSV_File__after_profiling), both the attribute names \"data\\_asset\" and \"data\\_profile\" refer to [asset types](#Section_Assets__Overview_and_Terminology__Asset_Type) with those same names.\n\n\nThere is one special attribute that will be referred to as the **primary attribute**. The primary attribute is the main attribute used to describe an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource). Every primary metadata document will have exactly one primary attribute. The _name_ of the primary attribute is the same as the name that appears in the [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) field.\n\n\nAny attribute other than the primary attribute is a **\"secondary\" / \"extended\" attribute** whose name must match the name of a [secondary / extended asset type](#Section_Assets__Overview_and_Terminology__Asset_Type__Secondary_Extended_Asset_Type_definition). A common example of an attribute for extended metadata is named \"data_profile\", which is created by the Profiling API. For example, see the underlined names in the [Parts of a Primary Metadata Document figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure), or the `\"entity.data_profile\"` field in [this asset metadata document](#Section_Assets__GET_ASSET__CSV_File__after_profiling).\n\n\nAlthough the Assets API restricts the _names_ of attribute _objects_ to match the names of asset _types_, the Assets API does not (in general) specify what the _contents_ of those attributes should be. So, in some sense, the fields within an attribute are the opposite of the fields within the [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) field:\n\n - the _Assets API_ \"owns\" (or, specifies) which fields go inside \"metadata\"\n - the _user_ \"owns\" (or, specifies) which fields go inside the attributes (except for some fields of [already available asset types](#Section_Assets__Overview_and_Terminology__Asset_Type__predefined_asset_types))\n\nThe following example shows two attributes, whose names must match asset types, but whose contents are (for the most part) up to the user:\n\n```\n \"entity\": {\n \"data_asset\": { // attribute name must match some asset type's name\n ...\n data_asset *type creator* and\n data_asset *attribute creator*\n decide what fields go here\n ...\n },\n \"data_profile\": { // attribute name must match some asset type's name\n ...\n data_profile *type creator* and\n data_profile *attribute creator*\n decide what fields go here\n ...\n }\n }\n```\n\nBecause the [Asset Types](#Section_Asset_Types__start) API is itself the creator of some [already available asset types](#Section_Assets__Overview_and_Terminology__Asset_Type__predefined_asset_types), the Asset Types API specifies some of the fields for any attribute whose name corresponds to one of those already available asset types. For example, see the discussion of the already available asset type called [\"data_asset\"](#Section_Asset_Types__data_asset_type).\n\nNote: there is a `GET attribute` API that can be used to retrieve just the attributes in the \"entity\" section of the primary metadata document, instead of the entire primary metadata document as returned by the `GET asset` API.\n\n\n\n#### \"attachments\" (optional) field of a Primary Metadata Document ####\n\nThe **\"attachments\"** field of a card (ie, primary metadata document) is a JSON array, each **item** of which contains _metadata_ for one [attachment](#Section_Asset__Terminology_Overview__definition__Attachment). (See the bottom red rectangle in the [parts figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure).)\n\n\nThe word **attachment** (or **attachments**) can be interpreted in multiple ways:\n\n1. the **\"attachments\"** array in the primary metadata document\n\n2. an attachment **item** in the \"attachments\" array\n\n3. a **metadata document** that will be returned from a call to the [GET Attachment API](#Section_Assets__Request__GET_Extended_Metadata_document). That metadata document will contain information that _points to_, and can be used to retrieve, either...\n\n4. the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) being described by the primary metadata document\n\n5. an [extended metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata) stored in the [catalog's bucket](#Section_Catalog__Overview_and_Terminology__catalogs_bucket) and containing extended metadata for the asset resource\n\nEach [attribute](#Section_Assets__Overview_and_Terminology__Attributes) in the [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) field can have a corresponding _attachment item_ in the \"attachments\" array. An attribute and its corresponding attachment item are related to each other by using the name of the attribute as the value for the attachment item's \"asset\\_type\" field. For example, notice in the following card snippet how the attribute name \"data\\_asset\" is used to link that \"data\\_asset\" attribute to its attachment item in the \"attachments\" array:\n\n```\n \"entity\": {\n ...other attributes\n\n \"data_asset\": { // <-- attribute's name matches its...\n ...\n },\n\n ...other attributes\n },\n\n \"attachments\": [\n ...other attachment items\n\n {\n ...\n \"asset_type\": \"data_asset\", // <-- ...attachment's asset_type\n ...\n \"connection_id\": \"...\", // connection_ fields are one way\n \"connection_path\": \"...\", // that item points to attached object\n ...\n },\n\n ...other attachment items\n ]\n```\n\nNotice also in the above card snippet that, in this case, the attachment _item_ contains two \"connection_...\" fields that _point to_ the attachment _object_ located in external storage. So, an _attribute_ has an attachment _item_ which points to an attachment _object_.\n\nLike the fields of [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group), the fields of an attachment item are specified by the Assets API. Some of the most important fields in an attachment _item_ are:\n\n - **\"asset\\_type\"**: \n + describes the type of the [attachment](#Section_Asset__Terminology_Overview__definition__Attachment)\n + figuratively connects the attachment item to the [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute) with the same name\n - **\"connection\\_id\"** and **\"connection\\_path\"** (optional):\n + this pair of fields specify the ID of a `WDP Connection` and a path in the associated data repository that points to the attached object\n + _always_ used for an attached asset like a database table\n + _can_ also be used for an attached asset resource (eg, spreadsheet) that _can_ be stored in the catalog's bucket\n + the presence of these two fields means the attachment will be known as a **remote** attachment\n - **\"object_key\" and \"handle\"** (optional):\n + this pair of fields contain information identifying and pointing to the location of an attached object (either an asset or an extended metadata document) in the catalog's bucket\n + the presence of these two fields means the attachment will be known as a **referenced** attachment\n\nFor any attachment, only one of the following two pairs of fields will be used:\n\n 1. `\"connection_id\"` and `\"connection_path\"` (ie, **remote** attachment), **or**\n 2. `\"object_key\"` and `\"handle\"` (ie, **referenced** attachment).\n\nInterestingly, being **remote** does not tell you whether or not an attachment is in the catalog. **Remote** only tells you _how_ the attached object can be retrieved: by using a connection.\n\nAn attachment _item_ (in the card) points to one of two kinds of attached _object_ (in external storage):\n\n1) an asset, or\n\n2) and extended metadata document.\n\nThose are briefly discussed in the next 2 sections.\n\n\n\n##### Asset Resource Attachment #####\n\nThe most typical attachment object is the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) being described by the card.\n\nFollow the green arrows in the [Parts of a Primary Metadata Document figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure) to see how:\n\n - the asset's _type name_ leads to\n - an _attribute name_, which leads to\n - a primary _attribute_, which leads to\n - an _attachment metadata item_ for that attribute, which finally leads to\n - the attached [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource).\n\nFor a full example that shows an attachment metadata item for an attached csv file, see the (only) item in the \"attachments\" array in [Get Asset - CSV File - Response Body - Before Profiling](#Section_Assets__GET_ASSET__CSV_File__before_profiling).\n\n\n\n##### Extended Metadata Document Attachment(s) ####\n\nThe other kind of attachment objects are **extended metadata documents**. A card can have 0, 1, or many attached extended metadata documents. These documents each contain a related set of (additional) metadata describing the asset resource. Extended metadata documents are stored _externally_ in the [catalog's bucket](#Section_Catalog__Overview_and_Terminology__catalogs_bucket).\n\nSee the underlined \"data_profile\" type name in the [Parts of a Primary Metadata Document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure) figure for a visualization of how, for one extended metadata document, the three parts ([\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group), [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group), [\"attachments\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group)) of a card are related to each other.\n\nSee the second item in the \"attachments\" array in [Get Asset - CSV File - Response Body - _After_ Profiling](#Section_Assets__GET_ASSET__CSV_File__after_profiling) for an example showing an attachment item _for_ a \"data_profile\" extended metadata document.\n\n\n\n#### Uses of `\"asset_type\"` value ####\n\nFrom the previous sections, you can see that the `\"asset_type\"` value shows up in:\n\n - the [\"metadata.asset\\_type\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) field\n - the [\"metadata.asset\\_attributes\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__attributes) array\n - a field (ie, object) in the [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) field. This object is the [primary attribute](#Section_Assets__primary_attribute__definition).\n - the [asset\\_type](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group__asset_type) field of the primary attribute's [attachment](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group) (if such an attachment exists, which it typically does). This **(primary) attachment** will be the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) (eg, database table, spreadsheet, csv file, etc.).\n\nFor example, see the [Parts of a Primary Metadata Document figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure) above, where the name of the primary attribute is, in this case, \"data\\_asset\" and is highlighted with green rectangles in all the places it's used. The path shown by the green arrows in the figure starts at the `\"metadata.asset_type\"` field and ends at the asset resource, in this case a file called Sample.csv.\n\n\n\n### Other Assets API Objects ###\n\nFinally, here is a brief list of some of the remaining objects that can be manipulated with the Assets APIs:\n\n - **owner**\n + the owner of the asset\n - **collaborators**\n + users who are allowed to see and possibly edit (some parts of) the asset\n - **perms**\n + permissions for viewing / editing an asset\n - **ratings**\n + indications of how popular or useful the asset is\n - **stats**\n + statistics on how often and when the asset was viewed or edited, and who did that viewing or editing.\n\n\n\n\n\n### Getting an Asset ###\n\nIt's important to understand that the `GET Asset` API does _not_ return an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) like a database table, a spreadsheet, a csv file, etc. Instead, it returns a [primary metadata document](#Section_Assets__Overview_and_Terminology__definition__primary_metadata_document) (ie, [card](#Section_Assets__Overview_and_Terminology__card_definition)) that _describes_ an asset resource.\n\nObviously, a primary metadata document (ie, card) must have been created before it can be retrieved. Still, it's instructive to see actual examples of a card and its parts before attempting to create those things. After all, many users will retrieve cards that were previously created by someone else.\n\nThis and the following sections show how to retrieve [asset metadata](#Section_Assets__Terminology_Overview__definition__Asset_Metadata) and [attachments](#Section_Asset__Terminology_Overview__definition__Attachment) (eg, an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) and [extended metadata documents](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata)).\n\n\n#### Getting an Asset - for a Connection ####\n\nWe'll start by retrieving a common [primary metadata document](#Section_Assets__Overview_and_Terminology__definition__primary_metadata_document) (ie, [card](#Section_Assets__Overview_and_Terminology__card_definition)): one for a \"connection\" asset type. This is a simple card because it has no [attachments](#Section_Asset__Terminology_Overview__definition__Attachment). That makes it an easy example to start with, even though many of the other cards you'll encounter do have attachments.\n\nUse the following `GET Asset` API to retrieve the primary metadata document for a connection. Note that this requires that you know and supply the IDs of both the primary metadata document (ie, card) and of the catalog that contains the card. Either someone has given you both of those IDs or you can browse to the asset's page using the IBM Knowledge Catalog UI and then extract both the catalog ID and the primary metadata document ID from within the URL in the browser's address bar.\n\n\n##### Getting an Asset - Request URL: #####\n\n```\nGET {service_URL}/v2/assets/{asset_id}?catalog_id={catalog_id}\n```\n\nThe following is the primary metadata document (ie, card) that's returned.\n\nNote: you may find it helpful to look at the [Parts of a Primary Metadata Document Figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure) before looking at the following Response Body.\n\n\n##### Getting an Asset - Connection - Response Body: #####\n\n```json\n{\n \"metadata\": {\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {}\n },\n \"usage\": {\n \"last_updated_at\": \"2018-11-06T17:40:37Z\",\n \"last_updater_id\": \"IBMid-___\",\n \"last_update_time\": 1541526037227,\n \"last_accessed_at\": \"2018-11-06T17:40:37Z\",\n \"last_access_time\": 1541526037227,\n \"last_accessor_id\": \"IBMid-___\",\n \"access_count\": 0\n },\n \"name\": \"ConnectionForCSVFile\",\n \"description\": \"Connection for CSV file\",\n \"tags\": [],\n \"asset_type\": \"connection\",\n \"origin_country\": \"us\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"c6f3cbd8-2b7f-42fb-aa60-___\",\n \"created\": 1541526037227,\n \"created_at\": \"2018-11-06T17:40:37Z\",\n \"owner_id\": \"IBMid-___\",\n \"size\": 0,\n \"version\": 2,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"connection\"\n ],\n \"asset_id\": \"070e9be2-40a8-4e0e-___\",\n \"asset_category\": \"SYSTEM\"\n },\n \"entity\": {\n \"connection\": {\n \"datasource_type\": \"193a97c1-4475-4a19-b90c-295c4fdc6517\",\n \"context\": \"source,target\",\n \"properties\": {\n \"bucket\": \"catalogforgettingsta___\",\n \"secret_key\": \"{wdpaes}12345___=\",\n \"api_key\": \"{wdpaes}eo/12345_=\",\n \"resource_instance_id\": \"crn:v1:bluemix:public:cloud-object-storage:global:a/12345c___:7240b198-b0f6-___::\",\n \"access_key\": \"12345___\",\n \"region\": \"us-geo\",\n \"url\": \"https://s3.us-south.objectstorage.softlayer.net\"\n },\n \"flags\": []\n }\n },\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/assets/070e9be2-40a8-4e0e-___?catalog_id=c6f3cbd8-2b7f-42fb-aa60-___\"\n}\n```\n\nThe above response has two of the three primary groups of metadata that were described in the [Primary Metadata Document section](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview): [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) and [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group).\n\nAs discussed in [Assets API Overview section](#Section_Asset__API_Overview), the contents of the [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) field are common to all primary metadata documents (ie, cards). The set of fields in \"metadata\" is completely defined by the Assets API. The values for some of those fields must be provided by the creator of the card, while other fields' values will be populated by various Assets APIs during the life of the card. Note the following fields' values in particular:\n\n - `\"metadata\"` fields whose values are provided by the _creator_ of the card:\n + `\"name\"`: \"ConnectionForCSVFile\"\n + `\"description\"`: \"Connection for CSV file\"\n + `\"asset_type\"`: \"connection\"\n + `\"asset_attributes\"`: [\n \"connection\"\n\n ]\n\n - `\"metadata\"` fields whose values are set by various _Assets APIs_ during the life of the card:\n + `\"usage\"`: contains various statistics describing usage of the card/asset\n + `\"catalog_id\"`: the ID of the catalog that contains the card\n + `\"created_at\"`: the time and date at which the _card_ was created\n + `\"asset_id\"`: the ID of the [card](#Section_Assets__Overview_and_Terminology__card_definition) (not the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource))\n\nFor more info about the `\"metadata\"` fields, see the discussion on [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) in the [Assets API Overview section](#Section_Asset__API_Overview) above.\n\nThe contents of the `\"entity\"` field are only [partially defined](#Section__Assets__entity_fields_are_only_partially_defined) by the Assets API. In particular, the `\"entity\"` field shown in the above card contains a field whose name must match the value in `\"metadata.asset_type\"`, in this case, `\"connection\"`. That field is the [primary attribute](#Section_Assets__primary_attribute__definition).\n\nOn the other hand, both the names and the values of all the fields _inside_ the primary attribute `\"entity.connection\"` are completely determined by the creator of the \"connection\" [asset type](#Section_Asset_Types__start) and the creator of the \"connection\" [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute). The Assets API does not, in general, decide what fields go _inside_ the primary attribute (or any other attribute). In the example \"connection\" attribute above, some of the more interesting fields are:\n\n - `\"datasource_type\"` - specifies the ID of the type of the data source to which a connection will be formed.\n - `\"properties\"` - specifies connection metadata specific to the _type_ of the datasource. The exact contents of this field will change according to the type of the datasource.\n\nFor more info on the contents of `\"entity\"` in general, see the discussion on [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) in the [Assets API Overview section](#Section_Asset__API_Overview).\n\nNotice the above card contains no [\"attachments\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group) array. That means there is no attached asset resource associated with this card. A natural question is: how can \"connection\" [asset metadata](#Section_Assets__Terminology_Overview__definition__Asset_Metadata) exist for, or describe, a non-existent \"connection\" [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource)? Actually, a \"connection\" asset resource does exist, but only when the metadata in the connection's primary metadata document is used to create a client-server connection at runtime.\n\n\n#### Get Asset - for a CSV File ####\n\nThis section shows a far more typical example in which the [primary metadata document](#Section_Assets__Overview_and_Terminology__definition__primary_metadata_document) (ie, [card](#Section_Assets__Overview_and_Terminology__card_definition)) does have an attached [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) - in this case, a csv file named Sample.csv. Here's the very simple contents of the Sample.csv file:\n\n\n##### Sample.csv file contents #####\n\n```\nName,Number\nabc,123\ndef,456\n```\n\nUse the `GET Asset` API to retrieve the [asset metadata](#Section_Assets__Terminology_Overview__definition__Asset_Metadata) _for_ the Sample.csv [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource). Note: the `GET Asset` API only returns a primary metadata document (ie, card) that _describes_ the Sample.csv file - it does _not_ return the actual Sample.csv _file_.\n\n\n##### Get Asset - Request URL: #####\n\n```\nGET {service_URL}/v2/assets/{asset_id}?catalog_id={catalog_id}\n```\n\nIt's instructive to show two different versions of the primary metadata document for the Sample.csv asset:\n\n1. _Before_ profiling (which returns a small metadata document - without extended metadata)\n2. _After_ profiling (which returns a much larger metadata document - with extended metadata)\n\nNote: you may find it helpful to look at the [Parts of a Primary Metadata Document Figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure) before looking at either of the following two Get Asset Response Bodies.\n\nHere is the smaller primary metadata document that exists before the Profile API is invoked on the Sample.csv file.\n\n\n##### Get Asset - CSV File - Response Body - _Before_ Profiling: #####\n\n```json\n{\n \"metadata\": {\n \"name\": \"Sample.csv\",\n \"description\": \"A simple csv file.\",\n \"asset_type\": \"data_asset\",\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {}\n },\n \"usage\": {\n \"last_updated_at\": \"2018-11-06T17:45:23Z\",\n \"last_updater_id\": \"IBMid-___\",\n \"last_update_time\": 1541526323713,\n \"last_accessed_at\": \"2018-11-06T17:45:23Z\",\n \"last_access_time\": 1541526323713,\n \"last_accessor_id\": \"IBMid-___\",\n \"access_count\": 0\n },\n \"origin_country\": \"united states\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"c6f3cbd8-2b7f-42fb-aa60-___\",\n \"created\": 1541526321437,\n \"created_at\": \"2018-11-06T17:45:21Z\",\n \"owner_id\": \"IBMid-___\",\n \"size\": 0,\n \"version\": 2,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"data_asset\"\n ],\n \"asset_id\": \"45f4ab8c-37d5-45a1-8adf-___\",\n \"asset_category\": \"USER\"\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"text/csv\",\n \"dataset\": false\n }\n },\n \"attachments\": [\n {\n \"id\": \"b8c7a390-e857-4c34-add8-___\",\n \"version\": 2,\n \"asset_type\": \"data_asset\",\n \"name\": \"remote\",\n \"description\": \"remote\",\n \"connection_id\": \"070e9be2-40a8-4e0e-___\",\n \"connection_path\": \"catalogforgettingsta-datacatalog-r1s___/data_asset/Sample_SyjEQUy6m.csv\",\n \"create_time\": 1541526323713,\n \"size\": 0,\n \"is_remote\": true,\n \"is_managed\": false,\n \"is_referenced\": false,\n \"is_object_key_read_only\": false,\n \"is_user_provided_path_key\": true,\n \"transfer_complete\": true,\n \"is_partitioned\": false,\n \"complete_time_ticks\": 1541526323713,\n \"user_data\": {},\n \"test_doc\": 0,\n \"usage\": {\n \"access_count\": 0,\n \"last_accessor_id\": \"IBMid-___\",\n \"last_access_time\": 1541526323713\n }\n }\n ],\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/assets/45f4ab8c-37d5-45a1-8adf-___?catalog_id=c6f3cbd8-2b7f-42fb-aa60-___\"\n}\n```\n\nThe above primary metadata document has all three primary groups of metadata ([\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group), [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group), and [\"attachments\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group)) that were described in the [Assets API Overview section](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview).\n\nThe contents of the \"metadata\" field are very similar to those shown above for the [Connection card example](#Section_Assets__Get_Asset__WDP_Connection). The most important difference is the value that the user specified as the \"asset type\" for the Sample.csv asset, namely `\"data_asset\"`. That asset type name shows up in two places inside the \"metadata\" section of the primary metadata document:\n\n - `\"metadata\"`:\n + `\"asset_type\"`: \"data_asset\"\n + `\"asset_attributes\"`: [\n \"data_asset\"\n ]\n\nAs discussed in the [Attributes](#Section_Assets__Overview_and_Terminology__definition__Attribute) section, the fact that `\"metadata.asset_type\"` has the value `\"data_asset\"` means the \"entity\" field of the card must contain a [primary attribute](#Section_Assets__primary_attribute__definition) called `\"data_asset\"`. The [Asset Types](#Section_Asset_Types__start) API provides the predefined asset _type_ [\"data_asset\"](#Section_Asset_Types__data_asset_type). That `\"data_asset\"` _type_ definition declares that there are two mandatory fields in a `\"data_asset\"` _attribute_: `\"mime_type\"` and `\"dataset\"`, as can be seen in the card above and repeated here:\n\n - `\"entity\"`:\n + `\"data_asset\"`:\n * `\"mime_type\"`: \"text/csv\"\n - specifies the [mime type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the asset resource. Here, the mime type indicates that the asset resource is a text csv file.\n * `\"dataset\"`: false\n - false because there is no \"columns\" field in this primary [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute).\n - Note: false does not mean there are no columns in the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource). Clearly, our [Sample.csv file](#Section_Assets__Get_Asset__CSV_File__sample_csv_file) does have columns. The problem here is that no one has (yet) told the _card_ that the asset resource has columns. Compare this \"data_set\" attribute to the one shown in the next example [Get Asset - CSV File - Response Body - _After_ Profiling](#Section_Assets__GET_ASSET__CSV_File__after_profiling), where the value of \"dataset\" has been changed to true, and the primary attribute does have a \"columns\" field.\n\nUnlike in the [Connection card](#Section_Assets__Get_Asset__WDP_Connection) example above, the card for the Sample.csv file _does_ have an [`\"attachments\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group) field. In this case, the \"attachments\" array has one item in it. That item contains metadata that points to the attached asset resource (ie, the Sample.csv file). Some of the more interesting fields in that attachment item are:\n\n + `\"id\"`: \"b8c7a390-e857-4c34-add8-___\"\n * identifies the metadata _document_ that _points to_ the attached asset resource\n + `\"asset_type\"`: \"data_asset\"\n * matches the name of the [primary attribute](#Section_Assets__primary_attribute__definition) in [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group), so linking the primary attribute to this attachment item and designating this item as the item that points to the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource).\n + `\"connection_id\"`: \"070e9be2-40a8-4e0e-___\"\n * identifies a connection primary metadata document (ie, card) which contains credentials and other info that can be use to connect to the external repository that contains the attached asset resource (ie, the \"Sample.csv\" file)\n * not coincidentally, the particular connection card referred to by \"070e9be2-40a8-4e0e-___\" is the exact same connection card shown above in [Get Asset - Connection Primary Metadata Document](#Section_Assets__Get_Asset__WDP_Connection)\n + `\"connection_path\"`: \"catalogforgettingsta-datacatalog-r1s___/data_asset/Sample_SyjEQUy6m.csv\",\n * identifies the path in the external repository that contains the attached asset (ie, the \"Sample.csv\" file)\n + `\"is_remote\"`: true\n * as discussed in the [\"attachments\" overview section](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group), is\\_remote is true because \"connection\\_id\" and \"connection\\_path\" are being used to describe _how_ to get the Sample.csv asset resource.\n + `\"is_referenced\"`: false (at most one of \"is\\_referenced\" and \"is\\_remote\" will be true)\n\n\n##### Get Asset - CSV File - Response Body - _After_ Profiling: #####\n\nNow, let's compare what `GET {service_URL}/v2/assets/{asset_id}?catalog_id={catalog_id}` returns for the _same_ asset _after_ the Profile API has been invoked on the Sample.csv file:\n\n\n\n```json\n{\n \"metadata\": {\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {}\n },\n \"usage\": {\n \"last_updated_at\": \"2018-11-12T15:33:34Z\",\n \"last_updater_id\": \"iam-ServiceId-12345___\",\n \"last_update_time\": 1542036814782,\n \"last_accessed_at\": \"2018-11-12T15:33:34Z\",\n \"last_access_time\": 1542036814782,\n \"last_accessor_id\": \"iam-ServiceId-12345___\",\n \"access_count\": 0\n },\n \"name\": \"Sample.csv\",\n \"description\": \"Simple csv file for experiment for getting started document.\",\n \"tags\": [],\n \"asset_type\": \"data_asset\",\n \"origin_country\": \"united states\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"c6f3cbd8-2b7f-42fb-aa60-___\",\n \"created\": 1541526321437,\n \"created_at\": \"2018-11-06T17:45:21Z\",\n \"owner_id\": \"IBMid-___\",\n \"size\": 9238,\n \"version\": 2,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"data_asset\",\n \"data_profile\"\n ],\n \"asset_id\": \"45f4ab8c-37d5-45a1-8adf-___\",\n \"asset_category\": \"USER\"\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"text/csv\",\n \"dataset\": true,\n \"columns\": [\n {\n \"name\": \"Name\",\n \"type\": {\n \"type\": \"varchar\",\n \"length\": 1024,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false\n }\n },\n {\n \"name\": \"Number\",\n \"type\": {\n \"type\": \"varchar\",\n \"length\": 1024,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false\n }\n }\n ]\n },\n \"data_profile\": {\n \"971e9c66-be4c-44b4-91f3-___\": {\n \"metadata\": {\n \"guid\": \"971e9c66-be4c-44b4-91f3-___\",\n \"asset_id\": \"971e9c66-be4c-44b4-91f3-___\",\n \"dataset_id\": \"45f4ab8c-37d5-45a1-8adf-___\",\n \"url\": \"https://api.dataplatform.cloud.ibm.com/v2/data_profiles/971e9c66-be4c-44b4-91f3-___?catalog_id=c6f3cbd8-2b7f-42fb-aa60-___&dataset_id=45f4ab8c-37d5-45a1-8adf-___\",\n \"catalog_id\": \"c6f3cbd8-2b7f-42fb-aa60-___\",\n \"created_at\": \"2018-11-12T15:32:53.902Z\",\n \"accessed_at\": \"2018-11-12T15:32:53.902Z\",\n \"owner_id\": \"IBMid-___\",\n \"last_updater_id\": \"IBMid-___\"\n },\n \"entity\": {\n \"data_profile\": {\n \"options\": {\n \"disable_profiling\": false,\n \"max_row_count\": 5000,\n \"max_distribution_size\": 100,\n \"max_numeric_stats_bins\": 200,\n \"classification_options\": {\n \"disabled\": false,\n \"use_all_ibm_classes\": true,\n \"ibm_class_codes\": [],\n \"custom_class_codes\": []\n }\n },\n \"execution\": {\n \"status\": \"finished\",\n \"is_supported\": true,\n \"dataflow_id\": \"3f1ace02-4d40-451d-9bc7-___\",\n \"dataflow_run_id\": \"f774f92f-5a61-49ca-8a68-___\"\n },\n \"columns\": [],\n \"attachment_id\": \"8d614be0-6900-403b-ab50-___\"\n }\n },\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/data_profiles/971e9c66-be4c-44b4-91f3-___?catalog_id=c6f3cbd8-2b7f-42fb-aa60-___&dataset_id=45f4ab8c-37d5-45a1-8adf-___\"\n },\n \"attribute_classes\": [\n \"NoClassDetected\",\n \"Organization Name\"\n ]\n }\n },\n \"attachments\": [\n {\n \"id\": \"b8c7a390-e857-4c34-add8-___\",\n \"version\": 2,\n \"asset_type\": \"data_asset\",\n \"name\": \"remote\",\n \"description\": \"remote\",\n \"connection_id\": \"070e9be2-40a8-4e0e-___\",\n \"connection_path\": \"catalogforgettingsta-datacatalog-r1s___/data_asset/Sample_SyjEQUy6m.csv\",\n \"create_time\": 1541526323713,\n \"size\": 0,\n \"is_remote\": true,\n \"is_managed\": false,\n \"is_referenced\": false,\n \"is_object_key_read_only\": false,\n \"is_user_provided_path_key\": true,\n \"transfer_complete\": true,\n \"is_partitioned\": false,\n \"complete_time_ticks\": 1541526323713,\n \"user_data\": {},\n \"test_doc\": 0,\n \"usage\": {\n \"access_count\": 0,\n \"last_accessor_id\": \"IBMid-___\",\n \"last_access_time\": 1541526323713\n }\n },\n {\n \"id\": \"8d614be0-6900-403b-ab50-___\",\n \"version\": 2,\n \"asset_type\": \"data_profile\",\n \"name\": \"data_profile_971e9c66-be4c-44b4-91f3-___\",\n \"object_key\": \"data_profile_971e9c66-be4c-44b4-91f3-___\",\n \"create_time\": 1542036813627,\n \"size\": 9238,\n \"is_remote\": false,\n \"is_managed\": false,\n \"is_referenced\": true,\n \"is_object_key_read_only\": false,\n \"is_user_provided_path_key\": true,\n \"transfer_complete\": true,\n \"is_partitioned\": false,\n \"complete_time_ticks\": 1542036813627,\n \"user_data\": {},\n \"test_doc\": 0,\n \"handle\": {\n \"bucket\": \"catalogforgettingsta-datacatalog-r1s___\",\n \"location\": \"us-geo\",\n \"key\": \"data_profile_971e9c66-be4c-44b4-91f3-___\",\n \"upload_id\": \"done\",\n \"max_part_num\": 1\n },\n \"usage\": {\n \"access_count\": 0,\n \"last_accessor_id\": \"iam-ServiceId-12345___\",\n \"last_access_time\": 1542036813627\n }\n }\n ],\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/assets/45f4ab8c-37d5-45a1-8adf-___?catalog_id=c6f3cbd8-2b7f-42fb-aa60-___\"\n}\n```\n\nLet's look at a few of the most important differences between the primary metadata document for the Sample.csv file _before_ and _after_ profiling:\n\n - `\"metadata\"`:\n + `\"asset_attributes\"`: [\n \"data\\_asset\",\n \"data\\_profile\"\n ]\n * Note the \"data_profile\" attribute name has been added\n\n - `\"entity\"`:\n + `\"data_asset\"`:\n * `\"columns\"`: the Profile API has added the `\"columns\"` field to the `data_asset` attribute,\n * `\"dataset\"`: the Profile API caused this to change from false to true because of the newly added `\"columns\"` field\n\n + `\"data_profile\"`:\n * this `\"data_profile\"` [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute) is entirely new, and was added by the Profile API.\n * the name of this [secondary attribute](#Section_Assets__secondary_extended_attribute__definition) matches the name of the [secondary asset type](#Section_Assets__Overview_and_Terminology__Asset_Type__Secondary_Extended_Asset_Type_definition) \"data\\_profile\", which was (previously) created by the Profile API.\n * the contents of this `\"data_profile\"` attribute was entirely decided by the Profile API, not by the Assets API.\n * this attribute contains a lot of extended metadata about the \"data\\_profile\" run that produced a `\"data_profile\"` [extended metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata).\n\n - `\"attachments\"`:\n + a new item has been added to the `\"attachments\"` array\n + that new item contains the following `metadata` about an [extended metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata):\n - `\"id\"`: `\"8d614be0-6900-403b-ab50-___\"`\n - `\"asset_type\"`: \"data\\_profile\"\n * note that the value \"data\\_profile\" matches the name of the \"data\\_profile\" [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute) that this attachment item belongs to, so linking the attachment item and the attribute.\n - `\"handle\"`: contains various fields pointing to the _actual_ attached extended metadata document which is located in some external repository. That extended metadata document will contain a great deal more metadata about the asset resource, that is, about the \"Sample.csv\" file.\n\nThe next section shows how to retrieve the Extended Metadata Document that's referred to by the new \"data\\_profile\" `\"attachments\"` item just described above.\n\n\n#### Get Attachment - Extended Metadata Document: ####\n\nThe following example builds on the `GET Asset` example from the previous section and shows how to retrieve an [attachment](#Section_Asset__Terminology_Overview__definition__Attachment) that is an extended metadata document.\n\nAn attachment can be retrieved in 4 steps.\n\n\n**Step 1:** Decide the asset_type of the attachment you want.\n\nThe only choices you have for asset_type in a given primary metadata document are listed in that document's [`\"metadata.asset_attributes\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__attributes) field. In the example above those values are:\n\n - \"data_asset\"\n - \"data_profile\"\n\nThe asset\\_type of the extended metadata document we want is \"data\\_profile\".\n\n\n**Step 2:** Get the `\"id\"` of the `\"attachments\"` item whose `\"asset_type\"` field has the value you chose in Step 1.\n\nIn the primary metadata document, look for the only `\"attachments\"` item whose `\"asset_type\"` field has the value you chose in Step 1, namely \"data\\_profile\". In our [example primary metadata document above](#Section_Assets__GET_ASSET__CSV_File__after_profiling), that `\"attachments\"` item has the `\"id\"` value `\"8d614be0-6900-403b-ab50-___\"`.\n\n\n**Step 3:** Invoke the `Get Attachment` API to get _attachment metadata for_ the attached extended metadata document.\n\n\n##### Get Asset Attachment - Request URL #####\n\n```\nGET /v2/assets/{asset_id}/attachments/{attachment_id}\n```\n\nThe values for the above URL parameters are obtained as follows:\n\n - `{asset_id}`: is the same as what appears in the `\"metadata.asset_id\"` field of the above primary metadata document, namely `\"45f4ab8c-37d5-45a1-8adf-___\"`\n\n - `{attachment_id}` is the of `\"id\"` that was obtained in Step 2, namely `\"8d614be0-6900-403b-ab50-___\"`.\n\nInvoke the above `GET Attachment` API with the above values, which will return an attachment metadata document as shown in the following response body:\n\n\n\n##### Get Asset Attachment - Response Body: #####\n\n```json\n{\n \"attachment_id\": \"8d614be0-6900-403b-ab50-___\",\n \"asset_type\": \"data_profile\",\n \"is_partitioned\": false,\n \"name\": \"data_profile_971e9c66-be4c-44b4-91f3-___\",\n \"created_at\": \"2018-11-12T15:33:33Z\",\n \"object_key\": \"data_profile_971e9c66-be4c-44b4-91f3-___\",\n \"object_key_is_read_only\": false,\n \"bucket\": {\n \"bucket_name\": \"catalogforgettingsta-datacatalog-r1s___\",\n \"bluemix_cos_connection\": {\n \"viewer\": {\n \"bucket_connection_id\": \"5b6bc03d-577d-4609-b3a4-___\"\n },\n \"editor\": {\n \"bucket_connection_id\": \"070e9be2-40a8-4e0e-a468-___\"\n }\n }\n },\n \"url\": \"https://s3.us-south.objectstorage.softlayer.net/catalogforgettingsta-datacatalog-r1s___/data_profile_971e9c66-be4c-44b4-91f3-___?response-content-disposition=attachment%3B%20filename%3D%22data_profile_971e9c66-be4c-44b4-91f3-___%22&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190423T162446Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=d2d518b66ac64de___%2F2019___%2Fus-geo%2Fs3%2Faws4_request&X-Amz-Signature=ce7322d7291396c511a6df38635df4e85b7c78c173___\",\n \"transfer_complete\": true,\n \"size\": 9238,\n \"user_data\": {},\n \"creator_id\": \"iam-ServiceId-12345___\",\n \"usage\": {\n \"access_count\": 1,\n \"last_accessor_id\": \"IBMid-___\",\n \"last_access_time\": 1556036686480\n },\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/assets/45f4ab8c-37d5-45a1-8adf-726c65b68008/attachments/8d614be0-6900-403b-ab50-___?catalog_id=c6f3cbd8-2b7f-42fb-aa60-___\"\n}\n```\n\nIt's important to understand that the `GET Attachment` API _only_ returns a metadata document that _describes where_, or _how_, an attached [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) or [extended metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata) can be accessed or retrieved.\n\nThe most important field in the above response is `\"url\"` which contains a signed URL that can be used to retrieve the actual extended metadata document. Note that the `\"url\"` points to a completely different server than the server that responds to \"Assets API\" calls! Extended metadata documents are not stored in the catalog.\n\n\n**Step 4**: Use the `\"url\"` in the response from Step 3 to call the relevant server to get the extended metadata document.\n\nThe simplest way to use that `\"url\"` value is to paste it into the address bar of a browser, and let the browser retrieve the extended metadata document. Here's a peek at some of the contents of the large extended metadata document that can be retrieved using that `\"url\"` value. That large extended metadata document was created by the Profile API and contains a great deal of extended metadata about our small [Sample.csv file](#Section_Assets__Get_Asset__CSV_File__sample_csv_file):\n\n```\n{\n\t\"summary\": {\n\t\t\"version\": \"1.9.3\",\n\t\t\"row_count\": 2,\n\t\t\"score\": 1,\n\t\t\"score_stats\": {\n\t\t\t\"n\": 2,\n\t\t\t\"mean\": 1.0,\n\t\t\t\"variance\": 0.0,\n\t\t\t\"stddev\": 0.0,\n\t\t\t\"min\": 1.0,\n\t\t\t\"max\": 1.0,\n\t\t\t\"sum\": 2.0\n\t\t},\n...\n\t},\n\t\"columns\": [{\n\t\t\t\"name\": \"Name\",\n\t\t\t\"value_analysis\": {\n\t\t\t\t\"distinct_count\": 2,\n\t\t\t\t\"null_count\": 0,\n\t\t\t\t\"empty_count\": 0,\n\t\t\t\t\"unique_count\": 2,\n\t\t\t\t\"max_value_frequency\": 1,\n\t\t\t\t\"min_string\": \"abc\",\n\t\t\t\t\"max_string\": \"def\",\n\t\t\t\t\"inferred_type\": {\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"length\": 3,\n\t\t\t\t\t\t\"precision\": 0,\n\t\t\t\t\t\t\"scale\": 0,\n\t\t\t\t\t\t\"type\": \"STRING\"\n\t\t\t\t\t}\n\t\t\t\t},\n...\n\t\t}, {\n\t\t\t\"name\": \"Number\",\n\t\t\t\"value_analysis\": {\n\t\t\t\t\"distinct_count\": 2,\n\t\t\t\t\"null_count\": 0,\n\t\t\t\t\"empty_count\": 0,\n\t\t\t\t\"unique_count\": 2,\n\t\t\t\t\"max_value_frequency\": 1,\n\t\t\t\t\"min_string\": \"123\",\n\t\t\t\t\"max_string\": \"456\",\n\t\t\t\t\"min_number\": 123.0,\n\t\t\t\t\"max_number\": 456.0,\n\t\t\t\t\"inferred_type\": {\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"length\": 3,\n\t\t\t\t\t\t\"precision\": 3,\n\t\t\t\t\t\t\"scale\": 0,\n\t\t\t\t\t\t\"type\": \"INT16\"\n\t\t\t\t\t}\n\t\t\t\t},\n...\n\t]\n}\n```\n\n\n#### Get Attachment - Asset Resource: ####\n\nThe 4 steps given above to retrieve an extended metadata document can also be used to retrieve an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) like the [Sample.csv file example](#Section_Assets__Get_Asset__CSV_File__sample_csv_file).\n\nThe main difference is that in [Step 1](#Section_Assets__Request__GET_Extended_Metadata_document__Step_1) you would choose the asset\\_type \"data\\_asset\" because that is the [primary asset type](#Section_Assets__Overview_and_Terminology__Asset_Type__Primary_Asset_Type_definition) of the primary metadata document, ie. the asset_type that identifies both the [primary attribute](#Section_Assets__primary_attribute__definition) and the primary attachment, ie, the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource).\n\n\n\n### Create Asset: book ###\n\nBefore you can create a [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) (ie, [card](#Section_Assets__Overview_and_Terminology__card_definition)) the [asset type](#Section_Asset_Types__start) that you want to use for that card must already exist. You can use one of the [already available asset types](#Section_Assets__Overview_and_Terminology__Asset_Type__predefined_asset_types), or you can use an asset type that you have created.\n\nThe [Create Asset Type: book](#Section_Asset_Types__Create_Asset_Type__book) section shows how to create an asset type named [`book`](#Section_Assets__Request__POST_ASSET_TYPE_request_Body). In this section, that asset type will be used to create a primary metadata document for a book [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource). That primary metadata document will have:\n\n - a [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) field with the value `\"book\"`\n - a [primary attribute](#Section_Assets__primary_attribute__definition) called `\"book\"`.\n\nUse the following endpoint to create a primary metadata document _for_ a book asset resource:\n\n\n#### Create Asset: book - Request URL: ####\n\n```\nPOST {service_URL}/v2/assets?catalog_id={catalog_id}\n```\n\n\n#### Create Asset: book - Request Body: ####\n\n```json\n{\n \"metadata\": {\n \"name\": \"Getting Started with Assets\",\n \"description\": \"Describes how to create and use metadata for assets\",\n \"tags\": [\"getting\", \"started\", \"documentation\"],\n \"asset_type\": \"book\",\n \"origin_country\": \"us\",\n \"rov\": {\n \"mode\": 0\n }\n },\n \"entity\": {\n \"book\": {\n\t \"author\": {\n\t\t \"first_name\": \"Tracy\",\n\t\t \"last_name\": \"Smith\"\n\t },\n\t \"price\": 29.95\n }\n }\n}\n```\n\nThe above request body specifies the preliminary contents for the primary metadata document about to be created. Most of the fields have been described previously in the [Asset's Primary Metadata Document section](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview). However, there are a few things to note in particular about the above request:\n\n - `\"metadata\"`: you supply the values of only some of the fields that will end up appearing inside the [`\"metadata\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) field of the primary metadata document about to be created, including:\n + `\"asset_type\"`: the value [`\"book\"`](#Section_Asset_Types__Create_Asset_Type__book) matches the [name](#Section_Assets__Overview_and_Terminology__Asset_Type__how_names_are_used) of the [asset type](#Section_Asset_Types__start) for this document\n + `\"name\"`: the name to use for the asset being described by this document\n + `\"description\"`: a description for the asset\n\nNotice that you do _not_ supply a [`\"metadata.asset_attributes\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__attributes) field in the request body. If you include a `\"metadata.asset_attributes\"` field in your Create Asset request body then the request will be rejected because it tried to supply a reserved value. The Assets API reserves control of the contents of the `\"metadata.asset_attributes\"` field.\n\n - `\"entity\"`: you supply the entire contents of the `\"entity\"` field\n + `\"book\"`:\n * this is the [primary attribute](#Section_Assets__primary_attribute__definition) of the primary metadata document\n * the name of this attribute matches the name of the corresponding [primary asset type](#Section_Assets__Overview_and_Terminology__Asset_Type__Primary_Asset_Type_definition) [\"book\"](#Section_Asset_Types__Create_Asset_Type__book)\n * contains metadata _describing_ a book (does not contain the actual book [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource))\n\nNotice the above `\"book\"` attribute doesn't contain a field called \"title\" - a field which might be expected in an attribute for a book. In this case, we've chosen to put the title of the book in the `\"metadata.name\"` field of the card. However, the creator of the `\"book\"` attribute is free to include whatever fields they want in that attribute, including a field called \"title\" if desired.\n\n\n#### Create Asset: book - Response Body: ####\n\n```json\n{\n \"metadata\": {\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {}\n },\n \"usage\": {\n \"last_updated_at\": \"2019-04-30T14:37:57Z\",\n \"last_updater_id\": \"IBMid-___\",\n \"last_update_time\": 1556635077746,\n \"last_accessed_at\": \"2019-04-30T14:37:57Z\",\n \"last_access_time\": 1556635077746,\n \"last_accessor_id\": \"IBMid-___\",\n \"access_count\": 0\n },\n \"name\": \"Getting Started with Assets\",\n \"description\": \"Describes how to create and use metadata for assets\",\n \"tags\": [\n \"getting\",\n \"started\",\n \"documentation\"\n ],\n \"asset_type\": \"book\",\n \"origin_country\": \"us\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"c6f3cbd8-___\",\n \"created\": 1556635077746,\n \"created_at\": \"2019-04-30T14:37:57Z\",\n \"owner_id\": \"IBMid-___\",\n \"size\": 0,\n \"version\": 2,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"book\"\n ],\n \"asset_id\": \"3da5389d-d4a4-43da-be1f-___\",\n \"asset_category\": \"USER\"\n },\n \"entity\": {\n \"book\": {\n \"author\": {\n \"first_name\": \"Tracy\",\n \"last_name\": \"Smith\"\n },\n \"price\": 29.95\n }\n },\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/assets/3da5389d-d4a4-43da-be1f-___?catalog_id=c6f3cbd8-___\",\n \"asset_id\": \"3da5389d-d4a4-43da-be1f-___\"\n}\n```\n\nNotice that the card returned in the Create Asset Response Body has many more fields than were present in the Request Body. The Create Asset API has added a lot of information to the `\"metadata\"` part of the primary metadata document:\n\n - `\"asset_id\"`: most importantly, the Create Asset API has given your primary metadata document an id\n - `\"owner_id\"`: the API has made the caller of the API be the owner of the asset\n - `\"created_at\"`: the API has recorded the time at which the metadata document was created. In general, this is not the same as the time at which an attached [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) was created (although in this case there is no attached asset resource).\n - `\"total_ratings\"`: contains the number of ratings this asset has recieved. 0 for now because the primary metadata document is brand new.\n - `\"usage\"`: usage statistics. Since this is a brand new card these statistics don't yet contain much interesting data.\n - `\"asset_attributes\"`: notice that the Create Asset API has added the _name_ of the [primary attribute](#Section_Assets__primary_attribute__definition) to this array.\n\nOn other hand, notice that the Create Asset API did not modify the contents of the `\"entity\"` field in any way. In particular, the Create Asset API did not modify the contents of the primary attribute `\"book\"`.\n\nYour catalog now contains a [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) _for_ a \"book\" [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource).\n\n\n\n### Associate a Term with an Asset ###\n\nYou can associate one or more terms with an asset. Within the asset's [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) a pre-defined [attribute](#Section_Assets__Overview_and_Terminology__Attributes) called `\"asset_terms\"` (one of the global [asset_types](#Section_Assets__Overview_and_Terminology__Asset_Type__predefined_asset_types)) is used to contain the array of terms associated with the asset.\n\nThe first time any term is associated with an asset, the Create Asset Attribute API must be used to create and populate an instance of the `\"asset_terms\"` attribute inside the asset's primary metadata document. In the following example, we're only associating a single term with an asset, so the \"list\" value in the request body is an array with a single element containing info related to that single term.\n\n```\nPOST {service_URL}/v2/assets/{asset_id}/attributes?catalog_id={catalog_id}\n```\nBody:\n```json\n{\n \"name\": \"asset_terms\",\n \"entity\": {\n \"list\": [\n {\n \"term_id\": \"--insert your term's id here--\",\n \"term_display_name\": \"first_term\"\n }\n ]\n }\n}\n\n```\n\nNote: the field named \"term_display_name\" is not strictly mandatory, but is highly recommended because its value is what will be used when searching for assets by term. Its value is also the term name that users will see in the Catalog UI.\n\nThe response should look like:\n\n```json\n{\n \"asset_id\": \"--your asset id--\",\n \"asset_terms\": {\n \"list\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"first_term\"\n }\n ]\n },\n \"href\": \".../v2/{asset_id}/attributes/asset_terms?catalog_id={catalog_id}\"\n}\n```\n\nThe next time you [GET the asset](#Section_Assets__Get_Asset) you should see the `\"asset_terms\"` attribute you just created:\n\n```json\n{\n \"metadata\": {\n ...\n },\n\n \"entity\": {\n ...\n \"asset_terms\": {\n \"list\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"first_term\"\n }\n ]\n }\n },\n\n \"attachments\": [\n ...\n ]\n}\n```\n\nIf you want to associate additional terms with an asset, or remove existing terms, then use the Update Asset Attribute API. For example, the following adds an additional term to the already existing `\"asset_terms\"` attribute of the asset used in the above example:\n\n```\nPATCH {service_URL}/v2/assets/{asset_id}/attributes/asset_terms?catalog_id={catalog_id}\n```\nBody:\n```json\n[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/list\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"term_id\": \"--insert your term's id here--\",\n\t\t\t\t\"term_display_name\": \"first_term\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"term_id\": \"--insert your second term's id here--\",\n\t\t\t\t\"term_display_name\": \"second_term\"\n\t\t\t}\n\t\t]\n\t}\n]\n\n```\n\nYou can use [GET the asset](#Section_Assets__Get_Asset) to see the new collection of terms in the asset_terms attribute of the asset.\n\n\n### Associate a Classification with an Asset ###\n\nYou can associate one or more [classifications](https://cloud.ibm.com/apidocs/watson-data-api#create-classification) with an asset. The classifications associated with the asset reside within the `\"data_profile\"` attribute of the asset. When user runs asset profiling, then the profiling job will add the suitable classifications. However, users can manually add classifications to an asset also.\n\nIf profile has not run on the asset, then the `\"data_profile\"` attribute will not exist. In such a scenario, the Create Asset Attribute API must be used to create and populate an instance of the `\"data_profile\"` attribute inside the asset's primary metadata document. Since the classification is added manually, the property added will be `\"data_classification_manual\"`.\nIn the example below, we are adding a single classification to an asset in a catalog. If you don't know the id and global id of the classification, you can run the API [GET artifact of a given type](https://cloud.ibm.com/apidocs/watson-data-api#get-artifacts). If you know the id of the classification, you can obtain the global_id of the classification by running the [GET classification API](https://cloud.ibm.com/apidocs/watson-data-api#get-classification-by-version-id).\n```\nPOST {service_URL}/v2/assets/{asset_id}/attributes?catalog_id={catalog_id}\n```\n\nBody:\n```json\n{\n \"name\": \"data_profile\",\n \"entity\": {\n \"data_classification_manual\": [\n {\n \"id\": \"--insert your classification's id here--\",\n \"name\": \"your_classification_name\",\n \"global_id\": \"--insert your classification's global id here--\"\n }\n ]\n }\n}\n```\n\nThe response should look like:\n```json\n{\n \"asset_id\": \"{asset_id}\",\n \"data_profile\": {\n \"data_classification_manual\": [\n {\n \"id\": \"{classification id}\",\n \"name\": \"your_classification_name\",\n \"global_id\": \"{classification global id}\"\n }\n ]\n },\n \"href\": \"/v2/assets/{asset_id}/attributes/data_profile?catalog_id={catalog_id}\"\n}\n```\n\nYou can use [GET the asset](#Section_Assets__Get_Asset) to see the new collection of classifications in the data_profile attribute of the asset.\n```json\n{\n \"metadata\": {\n ...\n },\n\n \"entity\": {\n ...\n \"data_profile\": {\n \"data_classification_manual\": [\n {\n \"id\": \"{classification id}\",\n \"name\": \"your_classification_name\",\n \"global_id\": \"{classification global id}\"\n }\n ]\n }\n },\n\n \"attachments\": [\n ...\n ]\n}\n```\n\nIf you want to associate additional classifications with an asset, or remove existing classifications, then use the Update Asset Attribute API. For example, the following adds an additional classification, to the existing `\"data_profile\"` attribute of the asset, without replacing the classification added in the previous example:\n\n```\nPATCH /v2/assets/{asset_id}/attributes/data_profile?catalog_id={catalog_id}\n```\nBody:\n```json\n[\n {\n \"op\": \"add\",\n \"path\": \"/data_classification_manual/1\",\n \"value\":\n {\n \"id\":\"--insert your second classification's id here--\",\n \"name\":\"your_second_classification_name\",\n \"global_id\":\"--insert your second classification's global id here--\"\n }\n }\n]\n```\n\nThe response should look like:\n```json\n{\n \"data_classification_manual\": [\n {\n \"id\": \"{classification id}\",\n \"name\": \"your_classification_name\",\n \"global_id\": \"{classification global id}\"\n },\n {\n \"id\": \"{second classification id}\",\n \"name\": \"your_second_classification_name\",\n \"global_id\": \"{second classification global id}\"\n }\n ]\n}\n```\n\nThe following example replaces all the classifications associated with the asset and replaces with a new list\n```\nPATCH /v2/assets/{asset_id}/attributes/data_profile?catalog_id={catalog_id}\n```\nBody:\n```json\n[\n {\n \"op\": \"replace\",\n \"path\": \"/data_classification_manual\",\n \"value\":\n [\n {\n \"id\":\"--insert your classification's id here--\",\n \"name\":\"your_classification_name\",\n \"global_id\":\"--insert your classification's global id here--\"\n }\n ]\n }\n]\n```\n\nThe response should look like:\n```json\n{\n \"data_classification_manual\": [\n {\n \"id\": \"{classification id}\",\n \"name\": \"your_classification_name\",\n \"global_id\": \"{classification global id}\"\n }\n ]\n}\n```\n\n\n### Duplicate Asset ###\n\n\n#### Duplicate Asset Overview ####\nWhen a CAMS call tries to create an asset (e.g. create a new asset, promote/publish/clone an asset, etc.), CAMS can optionally detect pre-existing duplicate assets and take appropriate actions based on configurations and query parameters, e.g., ignoring the duplicates and create a new asset, or failing the call and returning an error saying duplicates were found, or updating the existing duplicate.\n\nSimilarly, when a CAMS call tries to update an asset, CAMS can also optionally detect if the asset with the incoming change would have any duplicates if the change were persisted and take appropriate actions based on configurations and query parameters, e.g., ignoring the duplicates and update the asset, or failing the call and returning an error saying the change would result in duplicates.\n\nThis process is called duplicate asset processing. This section describes how the duplicate asset processing works in CAMS and how you can make it work in the ways you desire.\n\n\n#### What is a duplicate ####\nAn asset is considered a duplicate if it fits any of the following scenarios:\n* Original asset - the asset that the incoming asset was originally cloned/published from.\n\nFor instance, if you cloned/published an asset A to a project/catalog and resulted in asset B, and then try to publish/clone the asset B back to the original catalog/project, the asset A will be seen as the original asset and considered as a duplicate.\n\n* Copies of the same asset - an asset is cloned/published/promoted from the same asset as the incoming asset\n\nFor example, if you cloned/published/promoted an asset A to a project/catalog/space and resulted in asset B, and then try to clone/publish/promote the asset A again to the same target project/catalog/space, the asset B will be seen as the copy of the same asset and considered as a duplicate.\n\n* Asset with the same values - an asset has the same values as the incoming asset based on the effective duplicate detection strategy of the asset type. See [Duplicate Detection Strategy](#Section_Assets__DUPLICATE_ASSET__Duplicate_Detection_Strategy) section for more details about duplicate detection strategy.\n\nLet's say that the effective duplicate detection strategy of the asset type `data_asset` in a project is `DUPLICATE_DETECTION_BY_NAME` (i.e., the duplicate detection will base on the `metadata.name` field). If you try to create an asset of type `data_asset` with the name `KPIReport2021` in this project, and there is an existing asset A of type `data_asset` with the same name, then the asset A will be considered as a duplicate.\n\n\n#### What to do with a duplicate ####\n\nUsers can set the configuration `duplicate_action` of the asset containers and/or specify the query parameter `duplicate_action` while calling endpoints to control how the service handles duplicate assets. The valid values of `duplicate_action` for calls creating a new asset are:\n\n* `IGNORE` - ignore the duplicates and create a new asset\n* `REJECT` - fail the call and return an error response similar to the one below (no asset will be created):\n```\n{\n \"trace\": \"290c281c-4adc-4e40-aa49-aaf7cd2dbf6a\",\n \"errors\": [\n {\n \"code\": \"already_exists\",\n \"message\": \"ASTSV3040E: Duplicate assets exist. '[cc5f7412-5c96-4d66-9c14-40b3c944ad79, 244a3612-63a8-4140-9423-f40841be33ee]'\"\n }\n ]\n}\n```\n* `UPDATE` - update the duplicate with the incoming changes. See [Multiple duplicates](#Section_Assets__DUPLICATE_ASSET__Multiple_Duplicates) for how to choose the duplicate for updating if more than one duplicate is found. See [here](#Section_Assets__DUPLICATE_ASSET__How_The_Duplicate_Asset_Is_Updated_Or_Overwritten) on how the duplicate asset is updated.\n* `REPLACE` - overwrite the duplicate with the input values. See [Multiple duplicates](#Section_Assets__DUPLICATE_ASSET__Multiple_Duplicates) for how to choose the duplicate for overwriting if more than one duplicate is found. See [here](#Section_Assets__DUPLICATE_ASSET__How_The_Duplicate_Asset_Is_Updated_Or_Overwritten) on how the duplicate asset is overwritten.\n\nThe valid values of `duplicate_action` for calls making changes to an existing asset (including restoring a deleted asset) are:\n* `IGNORE` - ignore the duplicates and update the asset\n* `REJECT` - fail the call and return an error response similar to the one below. The asset will not be updated or restored.\n```\n{\n \"trace\": \"8ea27315-c958-435a-b415-e3632a664dbc\",\n \"errors\": [\n {\n \"code\": \"already_exists\",\n \"message\": \"ASTSV3128E: The asset will have duplicate assets with IDs '[a0a54f65-8a3d-4f22-95b7-5456d8e43a71]' after saving the change.\"\n }\n ]\n}\n```\nOr the below for restoring an asset. Note that the reason that the id of the asset that will have duplicates is also in the message is that restoring an asset may potentially restore multiple related assets and it is possible that some of these related assets will have duplicates.\n```\n{\n \"trace\": \"7b2668a4-c794-4720-83dd-f4f16e9d0a04\",\n \"errors\": [\n {\n \"code\": \"already_exists\",\n \"message\": \"ASTSV3128E: The asset '8c740814-5fc0-4294-a2be-f042f15098f1' will have duplicate assets with IDs '[a0a54f65-8a3d-4f22-95b7-5456d8e43a71]' after being restored.\"\n }\n ]\n}\n```\n* `UPDATE` and `REPLACE` are not allowed to be used for the query parameter `duplicate_action` for calls updating assets. However, if the query parameter `duplicate_action` is not supplied and the configuration `duplicate_action` is set to one of these values in the asset container level, they will be the effective value of the `duplicate_action`. In which case, they will be treated the same as `REJECT`.\n\nThe configuration `duplicate_action` can be set in the asset container level during the creation of a container and can be modified later by using the endpoint `PUT /v2/asset_containers/configurations`. If the configuration `duplicate_action` is not specified in an asset container, it will be equivalent to `IGNORE`.\n\nThe following example shows how to supply the configuration `duplicate_action` (along with other duplicate asset processing related configurations) while creating a catalog:\n```json\n{\n \"name\": \"my catalog\",\n ...\n \"configurations\": {\n \"duplicate_action\": \"REJECT\",\n ...\n }\n}\n```\nThe following example shows how to update the configuration by using the endpoint `PUT /v2/asset_containers/configurations`:\n```json\n{\n \"duplicate_action\": \"REPLACE\",\n ...\n}\n```\n\nThe configuration `duplicate_action` can be overwritten by a query parameter `duplicate_action` for individual calls to control how CAMS handles duplicates for these particular calls. The endpoints that support the query parameter are listed below. Note that the allowed options may differ from endpoint to endpoint depending on if the endpoint supports all available options.\n* `POST /v2/assets`\n* `POST /v2/data_assets`\n* `POST /v2/assets/{asset_id}/publish`\n* `POST /v2/assets/{asset_id}/clone`\n* `POST /v2/assets/{asset_id}/promote`\n* `POST /v2/assets/{asset_id}/deepcopy`\n* `POST /v2/assets/bulk_create`\n* `POST /v2/assets/bulk_patch`\n* `PATCH /v2/assets/{asset_id}`\n* `POST /v2/assets/{asset_id}/attributes`\n* `PATCH /v2/assets/{asset_id}/attributes/{attribute_key}`\n* `DELETE /v2/assets/{asset_id}/attributes/{attribute_key}`\n* `POST /v2/assets/{asset_id}/attachments`\n* `DELETE /v2/assets/{asset_id}/attachments/{attachment_id}`\n* `POST /v2/trashed_assets/{asset_id}/restore`\n\n\n#### Duplicate Detection Strategy ####\n\nThe duplicate detection strategy defines what fields to be used for determining if assets of a particular asset type are duplicates. The available duplicate detection strategies are:\n* `DUPLICATE_DETECTION_BY_NAME` - the `metadata.name` field\n* `DUPLICATE_DETECTION_BY_RESOURCE_KEY` - the `metadata.resource_key` field\n* `DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY` - the `metadata.name` and the `metadata.resource_key` fields\n* `DUPLICATE_DETECTION_NOT_APPLICABLE` - no duplicate will be determined. If this strategy is used, no duplicate will be determined by the strategy. At the same time, it also disables the duplicate detection for `original asset` and `copies of the same asset`. In other words, it disables duplicate detection for assets of the asset type completely.\n\nThe duplicate detection strategy can be set in several levels as shown below (from the highest priority to the lowest priority). Setting with a higher priority will take precedence over the setting with a lower priority.\n* Strategy of the asset type defined in the asset container configuration, e.g.,\n```\n{\n \"duplicate_strategies\": [\n {\n \"asset_type\": \"data_asset\",\n \"strategy\": \"DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY\"\n }\n ]\n}\n```\n* Strategy specified in the asset type definition, e.g.,\n```\n{\n \"description\": \"Job Run\",\n \"fields\": [],\n \"identity\": {\n \t\"strategy\": \"DUPLICATE_DETECTION_NOT_APPLICABLE\"\n }\n}\n```\n* System default strategy of the asset type in the residing asset container. i.e.,\n * Project/Space:\n * `connection`: `DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY`\n * Catalog:\n * `connection`: `DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY`\n * `data_asset`: `DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY`\n\n* The `default_duplicate_strategy` specified in the asset container configuration (which applies to all asset types), i.e.,\n```\n{\n \"default_duplicate_strategy\": \"DUPLICATE_DETECTION_BY_NAME\"\n}\n```\n* System default strategy `DUPLICATE_DETECTION_BY_NAME` (which applies to all asset types)\n\n\n#### Multiple duplicates ####\nIt is possible that a call may find more than one duplicate for a given asset. It could be that the duplicates were created before CAMS started processing duplicate assets, or the duplicates were created because multiple calls were creating the same asset at the same time.\n\nIf the effective value for `duplicate_action` is `REJECT`, CAMS will fail the call and return the asset ids of all the duplicates in the error response. If the effective value for `duplicate_action` is `UPDATE` or `REPLACE`, CAMS will rank the duplicates based on the following order and choose the duplicate that has the highest score and the caller has permission to update as the target for updating or overwriting. When all things are equal, the duplicates will be ranked by the created time (i.e., the `metadata.created` field) from the earliest to the most recent.\n* Original asset\n* Copies of the same asset\n* Asset with the same values\n\n\n#### How the duplicate asset is updated or overwritten ####\nIf the effective value of `duplicate_action` is `UPDATE` or `REPLACE`, the following information of the duplicate asset that has the highest score and the caller has permission to update will be updated or overwritten with the values from the incoming asset based on the rules. Any other aspects of the duplicate asset will not be updated or overwritten, e.g., privacy settings, collaborators, owners, source asset, ratings, revisions, non-inline relationships, related assets, etc.\n* metadata\n * `metadata.name`\n * `metadata.description`\n * `metadata.resource_key`\n * `metadata.origin_country`\n * `metadata.tags`\n* attributes (e.g., `entity.data_asset`, `entity.data_profile`, `entity.column_info`, etc.)\n* attachments (i.e., `attachments[*]`)\n\nIf `duplicate_action` is `UPDATE`, the chosen duplicate asset will be updated as described below. The result will look the same as the duplicate asset but with the incoming changes.\n* The listed metadata fields will be replaced with the values from the incoming asset if the value from the incoming asset is not `null`\n* All attributes in the incoming asset will be copied over and any existing attribute will be replaced. Some exceptions may apply, e.g.,\n * If the existing or incoming attribute `connection` represents a reference connection, the existing attribute `connection` will not be replaced.\n * Reference copy terms are preserved\n* All attachments in the incoming asset will be copied over. Any existing attachments with the same `asset_type` as the attachments in the incoming asset will be removed.\n\nIf `duplicate_action` is `REPLACE`, the chosen duplicate asset will be updated as described below. The result will look the same as the incoming asset with some exceptions.\n* All listed metadata fields will be replaced with the values from the incoming asset (even if the value from the incoming asset is `null`)\n* All existing attributes will be removed and all attributes in the incoming asset will be copied over with the exception of the attribute `connection`. If the existing or incoming attribute `connection` represents a reference connection, the existing attribute `connection` will remain unchanged.\n* All existing attachments will be removed and all attachments in the incoming asset will be copied over\n\nLet's say you have an existing asset that looks like below\n```json\n{\n \"metadata\": {\n \"name\":\"B\",\n \"description\":\"C\",\n \"tags\":[\n \"confidential\"\n ]\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"binary\"\n },\n \"something\": {}\n },\n \"attachments\":[\n {\n \"asset_type\": \"data_asset\",\n \"name\": \"attachment 1\"\n },\n {\n \"asset_type\": \"something\",\n \"name\": \"attachment 2\"\n }\n ]\n}\n```\n\nand you try to add the following asset\n```json\n{\n \"metadata\": {\n \"name\":\"A\",\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"text/csv\"\n }\n },\n \"attachments\":[\n {\n \"asset_type\": \"data_asset\",\n \"name\": \"attachment 3\"\n }\n ]\n}\n```\nIf the effective `duplicate_action` is `UPDATE`, the existing asset will be modified to be the following\n```json\n{\n \"metadata\": {\n \"name\":\"A\",\n \"description\":\"C\",\n \"tags\":[\n \"confidential\"\n ]\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"text/csv\"\n },\n \"something\": {}\n },\n \"attachments\":[\n {\n \"asset_type\": \"something\",\n \"name\": \"attachment 2\"\n },\n {\n \"asset_type\": \"data_asset\",\n \"name\": \"attachment 3\"\n }\n ]\n}\n```\nIf the effective `duplicate_action` is `REPLACE`, the existing asset will be modified to be the following\n```json\n{\n \"metadata\": {\n \"name\":\"A\"\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"text/csv\"\n }\n },\n \"attachments\":[\n {\n \"asset_type\": \"data_asset\",\n \"name\": \"attachment 3\"\n }\n ]\n}\n```\n\n\n#### Backup revision ####\nWhen the best duplicate is updated as a result of asset duplicate processing, a revision is created in case we want to go back or review what was changed. The revision will contain commit information similar to below:\n```json\n{\n \"committed_at\": \"2020-11-17T08:13:39.103Z\",\n \"commit_message\": \"Backup prior to update the best duplicate\",\n \"reason\": \"update_duplicate\",\n \"duplicate_source\": {\n \"operation\": \"clone\",\n \"asset_id\": \"ca0007d9-051d-478f-b87f-82f38fc6997c\",\n \"catalog_id\": \"c548b021-e026-49a6-aa60-35fe478afdb5\"\n }\n}\n```\n\nThe asset in the response will contain the `previous_revision` field in such a case. Which can be used to determine if the call indeed created a new asset or updated an existing asset.\n```json\n{\n \"metadata\": {\n ...,\n \"commit_info\": {\n \"previous_revision\": 1\n }\n },\n \"entity\": {\n ...\n },\n \"asset_id\": \"c1bf6686-836c-4f93-b173-c2ed52da8e76\"\n}\n```\n\n\n#### Check duplicates before creating an asset ####\nThe duplicate asset processing automatically kicks in when a CAMS call tries to create an asset. However, in some cases, you may want to check possible duplicates before creating an asset or before publish/clone/promote/deepcopy an asset. CAMS provides an endpoint `POST /v2/assets/duplicates/search` to help you do this. You can either supply an existing asset or an asset payload to check the duplicates. The endpoint will list all the potential duplicates and why they were considered duplicates.\n\n\n#### Lineage and Activity event messages change ####\nIf the query parameter `duplicate_action` is `UPDATE` or `REPLACE` and duplicate assets are found, the calls will change from creating a new asset to updating an existing asset. As a result, the corresponding Lineage and Activity event messages will also change from `creating` an asset to `updating` an asset.\n\n\n#### Known issues/limitations\n\n##### Duplicate assets may be created due to race condition\nWhen a call is made to create an asset, CAMS searches for potential duplicates and creates the asset only if no duplicate is found. If multiple calls are made at the exact same time to create the same asset, it is possible to result in a duplicate. For example, two calls try to create the same asset at the same time, and both calls search for potential duplicates and do not find any duplicates; both calls think there is no duplicate and create the asset. As the result, the same asset will be created twice and each asset is a duplicate of the other.\n\nThere is currently no way to prevent such cases from happening. If this happened, the user would have to choose one of these assets and delete others. Internally, CAMS always favours the asset that has the earliest value in the `metadata.created` field and chooses it for future duplicate updating/overwriting operations.\n\n\n#### Troubleshooting\n\n##### Duplicate assets are not detected\nSometimes you may see assets that look like duplicates but are not detected as duplicates. You can call the `GET /v2/assets/{asset_id}` API to get the JSON representation of these assets and compare the fields that are used for identifying duplicates. If the fields are not the same, then the assets are not duplicates. Otherwise, it may fall into one of the situations where real duplicates are not detected. Please see the [Known issues/limitations](#Section_Assets__DUPLICATE_ASSET__Known_issues_limitations) section for more details.\n\nFor instance, if the effective duplicate detection strategy is `DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY`, you can compare the `metadata.name` and the `metadata.resource_key` fields of these assets and see if they are indeed the same; if the effective duplicate detection strategy is `DUPLICATE_DETECTION_BY_NAME`, you can compare the `metadata.name` field of these assets. For details about what fields are used for a strategy, please see [Duplicate detection strategy](#Section_Assets__DUPLICATE_ASSET__Duplicate_Detection_Strategy) section.\n\n\n## Asset Types #\n\n[Asset Types Overview](#Section_Assets__Overview_and_Terminology__Asset_Type)\n\n - [Asset Type Fields](#Section_Asset_Types__Asset_Type_Fields)\n + [Search Path Examples](#Section_Asset_Types__Asset_Type_Fields_fields_search_path_examples)\n - [\"data_asset\" Type](#Section_Asset_Types__data_asset_type)\n - [Using Secondary / Extended / Decorator Asset Types to Simulate Type Inheritance](#Section_Simulating_Type_Inheritance)\n\n[Asset Types API Examples](#Section_Asset_Types_API_Examples)\n\n - [Get Asset Types](#Section_Asset_Types__Get_Asset_Types)\n - [Get Asset Type: data_asset](#Section_Asset_Types__Get_Asset_Type__data_asset)\n - [Create Asset Type: book](#Section_Asset_Types__Create_Asset_Type__book)\n - [Search Asset Type: attribute - book](#Section_Asset_Types__Search_Asset_Type__attribute__book)\n - [Search Asset Type: metadata - name](#Section_Asset_Types__Search_Asset_Type__metadata)\n\n\n\nAsset Types serve multiple purposes in the Assets API. Asset types fall into two categories:\n\n\n\n - **Primary asset type**:\n\n + describes the primary type of an asset\n + every [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) (ie, [card](#Section_Assets__Overview_and_Terminology__card_definition)) will have exactly one primary asset type, whose name will be stored in the card's [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) field\n + every card will have exactly one [primary attribute](#Section_Assets__primary_attribute__definition) whose name matches the name of the primary asset type\n + a very common example of a primary asset type is the [\"data_asset\" type](#Section_Asset_Types__data_asset_type), examples of which are shown throughout this documentation\n\n\n\n - **Secondary / Extended asset type**:\n\n + a secondary / extended asset type describes an inter-related group of additional metadata for an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource)\n + a primary metadata document can have 0, 1, or many secondary / extended asset types\n + information for a secondary / extended asset type is stored in a [secondary / extended attribute](#Section_Assets__secondary_extended_attribute__definition) in a primary metadata document\n + a very common example of a secondary / extended asset type is \"data\\_profile\". See [Get Asset - CSV File - Response Body - _After_ Profiling](#Section_Assets__GET_ASSET__CSV_File__after_profiling) for an example \"data\\_profile\" attribute.\n + secondary / extended / decorator asset types can be used to [simulate type inheritance](#Section_Simulating_Type_Inheritance)\n\n\nThe **names** of various asset types are used in the following ways, all at once, within a single [primary metadata document](#Section_Assets__Overview_and_Terminology__definition__primary_metadata_document):\n\n - describe the type of an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource), via the [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) field\n - describe the type of an object that contains _extended_ information for an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource). For example, the type of an [extended metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__attachment__extended_metadata) via an [`\"attachments[_].asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group__asset_type) field.\n - assign names and types to [attributes](#Section_Assets__Overview_and_Terminology__Attributes) in the [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) field of a [primary metadata document](#Section_Assets__Overview_and_Terminology__definition__primary_metadata_document)\n - implicitly tie various related parts of a primary metadata document to each other. For example, see the green rectangles and arrows in the [Parts of a Primary Metadata Document Figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure).\n\nThe [**content**, or definition, of an asset type](#Section_Asset_Types__Asset_Type_Fields) serves the following purposes:\n\n\n\n - tell the catalog what fields of an [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute) should be indexed for [searching](#Section_Asset_Types__Search_Asset_Type__attribute__book)\n - specify [search paths](#Section_Asset_Types__Asset_Type_Fields_fields_search_path_examples) and cross attribute searching\n - specify additional features like relationships and external asset previews (both of which are beyond the scope of this document)\n\nAn asset type must exist in the catalog before it can be used for any of the above purposes.\n\n\n\nAs of this writing there are several asset types available, including the following:\n\n1. data_asset\n2. folder_asset\n3. policy_transform\n4. asset_terms\n5. column_info\n6. connection\n7. ai\\_training\\_definition\n8. data_flow\n9. activity\n10. notebook\n11. machine-learning-stream\n12. dashboard\n13. data\\_profile\\_nlu\n\nYou are free to _use_ any of the above asset types. You do not have to, nor are you allowed to, _create_ or _over-write_ any of the above asset types.\n\nUse the Create Asset Type API to create your own asset type. See [Asset Type Fields](#Section_Asset_Types__Asset_Type_Fields) for an overview of the specification of an asset type. See [Create Asset Type: book](#Section_Asset_Types__Create_Asset_Type__book) for an example of creating an asset type.\n\n\n\n### Asset Type Fields ###\n\nHere is a description for each of the fields in the definition of an asset type. You supply values for these fields when creating an asset _type_. You will see those same values returned when you [get a list of asset types](#Section_Asset_Types__Get_Asset_Types) or [get a specific asset type](#Section_Asset_Types__Get_Asset_Type__data_asset).\n\n- `\"name\"`:\n + the name and identifier for the asset type\n + should contain **only lowercase** letters\n + will be used in various places in primary metadata documents, including:\n \t * [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type)\n \t * [`\"metadata.asset_attributes\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__attributes)\n \t * [`\"entity\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) [attribute](#Section_Assets__Overview_and_Terminology__Attributes) names\n * [`\"attachments[].asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__attachments_group)\n + can be used in catalog searches of [attribute](#Section_Catalog__Overview_and_Terminology__definition__Attribute) contents\n- `\"description\"`: a description for this asset type\n- `\"fields\"`: \n + an _array_ that contains information for the fields in the corresponding [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute) _that should be indexed_ for subsequent searches.\n + does **not** (necessarily) describe _all_ the fields in attributes of this asset type.\n + there must be **at least one** item in this array. In other words, there must be at least one index for an asset type.\n + see the following [Fields Table](#Section_Asset_Types__Asset_Type_Fields_fields_table) for a description of the contents of an item in the `\"fields\"` array\n + see [\"fields\" and \"properties\" Note](#Section_Asset_Types__Asset_Type_Fields__fields_and_properties) below\n- `\"properties\"`: \n + an _object_ that contains \"non-index\" information for the fields in the corresponding [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute). This information is typically used by UIs that display/edit assets.\n + does **not** (necessarily) describe _all_ the fields in attributes of this asset type.\n + see the following [Properties Table](#Section_Asset_Types__Asset_Type_Fields_properties_table) for a description of the contents of an item in the `\"properties\"` object\n + see [\"fields\" and \"properties\" Note](#Section_Asset_Types__Asset_Type_Fields__fields_and_properties) below\n- `\"external_asset_preview\"`: beyond the scope of this document\n- `\"relationships\"`: beyond the scope of this document\n- `\"localized_metadata_attributes\"`: a description for this asset type\n- `\"decorates\"`: list of pointers to types this type can decorate\n- `\"identity\"`: identity definition of the assets of the type\n- `\"global_search_searchable\"`: list of fields made searchable through Global Search functionality\n + The fields correspond the the `\"key\"` defined in the [field](#Section_Asset_Types__Asset_Type_Fields_fields_table)\n- `\"attribute_behavior\"`: define the behavior only if this asset type is used as an attribute\n + it contains a field `\"remove_on_copy\"`. This field can take boolean values true or false.\n + when `\"remove_on_copy\"` is true, then during cloning, publishing or promoting the asset, the attribute is removed from the asset\n- `\"attribute_only\"`: takes boolean values true or false. When true, then this attribute will be used as custom attributes\n- `\"data_protection\"`: asset type properties and attachments that should be removed when user who does not have access is trying to view the data\n- `\"is_column_custom_attribute\"`: takes boolean values true or false. When true, then this attribute can be applied as a column level attribute. See [Columns and Column Level Attributes](#Section_Columns_And_Column_Custom_Attributes)\n- `\"can_have_image\"`: takes boolean values true or false. Set to true if asset type is expected to support uploading of images\n- `\"icon_id\"`: name or id of the svg image to be used as the icon for the asset type\n- `\"allow_decorators\"`: takes boolean value true or false. When true, custom attributes can decorate this asset type\n\n\nNote: [\"fields\"](#Section_Asset_Types__Asset_Type_Fields_field) and [\"properties\"](#Section_Asset_Types__Asset_Type_Properties_field) can, optionally, _both_ be used to describe the exact same field in an [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute). Whether you use `\"fields\"` and/or `\"properties\"` depends on _what_ you want to specify for a field. For example, if you're creating an asset type named `\"person\"` and a person has a field called `\"birthdate\"` (resulting in `\"entity.person.birthdate\"` being present in the [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview)) then:\n\n - if you want `birthdate` to be indexed (for searching) then you would include an entry in the `\"fields\"` array for `birthdate`\n - if you want a UI to understand/display the `birthdate` properly then you would include an entry in the `\"properties\"` object for that same `birthdate` field\n\nSee [this example](#Section_Assets__Request__POST_ASSET_TYPE_request_Body) which shows both an example `\"fields\"` array and an example `\"properties\"` object.\n\n\n**Fields Table:** Asset Type `\"fields\"` array - item contents\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
KeyDescriptionExampleRequired
keythe name of both the field that will appear in an attribute for this asset type, and the name of the corresponding index for that attribute fielddata_asset.mime_typeYes
typethe data type of the field being indexedboolean, or number, or stringYes
facetsbeyond the scope of this documenttrue or falseNo. Defaults to false.
search_patha json path that locates a field in the attributeSee Search Path Examples below.Yes
is_searchable_across_typesspecifies whether this field can be used in a query without specifying the asset typetrue or falseNo. Defaults to false.
\n\n\n**Properties Table:** Asset Type `\"properties\"` object - item contents\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
typeStringSpecifies the data type for the property. This value is required. Possible types are: string, number
descriptionStringA displayable string to describe the property.
is_arraybooleantrue if the property value is multi-valued (json array).
requiredbooleantrue if the property requires a value to be set.
hiddenbooleantrue if the application UI should not display the property or value.
readonlybooleantrue if the property should not be changed once set.
default_valuematches the \"type\"A value that should be set if no value is provided when the asset attribute is created.
placeholderstringA string an application UI can use as a prompt before a value is entered.
valuesarray, elements matching \"type\"An array of allowed values for the property. Used to describe a limited enumeration or \"choice list\".
minimuminteger/numberFor an integer or number property, the minimum allowed value.
maximuminteger/numberFor an integer or number property, the maximum allowed value. If both minimum and maximum are specified, minimum must be less than or equal to maximum.
min_lengthintegerFor a string property, the minimum allowed length. If specified, must be greater than or equal to zero.
max_lengthintegerFor a string property, the maximum allowed length. If specified, must be greater than or equal to zero. If both min_length and max_length are specified, min_length must be less than or equal to max_length.
propertiesobjectFor a property of type 'object', the recursive definition of the properties, described as in this table. This allows describing nested object-valued properties.
\n\n\n#### Search Path Examples ####\n\n - See the [request body](#Section_Assets__Request__POST_ASSET_TYPE_request_Body) in [Create Asset Type: book](#Section_Asset_Types__Create_Asset_Type__book) for an example of where a search path is used _in the definition of an asset type_.\n + Note: when you specify a search path _in the definition of an asset type's_ `\"field\"`, you only specify the path _within_ the correspondingly named [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute). You needn't specify the attribute name. For example if you have an attribute called `\"book\"` that has a field called `\"author.last_name\"` within it, you only need to specify `\"author.last_name\"` as the search path - not `\"book.author.last_name\"`.\n\n - See [Search Asset Type: attribute - book](#Section_Asset_Types__Search_Asset_Type__attribute__book) for an example of where a search path is used _in the body of a search_.\n + Note: when you specify a search path _in the body of search_ you must specify the name of the [attribute](#Section_Assets__Overview_and_Terminology__definition__Attribute) being searched. For example if you have an attribute called `\"book\"` that has a field called `\"author.last_name\"` within it, you would include the name of the attribute in the search path: `\"book.author.last_name\"`.\n\n - `\"price\"` : a simple path contains just the name of the field to be searched. In this case the attribute being searched should have a simple field called `\"price\"`.\n\n - `\"tags[]\"` : traverse a json array called `\"tags\"`. Because tags[] is not followed by any further names it must be a basic type (e.g. string, boolean, or number), and so its elements will be indexed directly.\n\n - `\"asset_terms[].name\"` : this search path indicates a path starting with a json object named `\"term_assignments\"` at the top, traversing through a json array named asset_terms (you use the [] at the end of the field name to indicate it's an array), landing on another json object that has a field called `\"name\"`. The `\"name\"` field will be indexed.\n\n - `\"asset_terms[0].name\"` : same as above but _only the first_ element in the `\"asset_terms\"` array will be traversed.\n\n - `\"columns.*.tags[]\"` : traverse an object called `\"columns\"` followed by any column name (the '*' indicates a wildcard), followed by a json array called `\"tags\"`. Because tags[] is not followed by any further names it must be a basic type (e.g. string, boolean, or number), and so its elements will indexed directly.\n\n - `\"column_tags.*[]\"` : the json object `\"column_tags\"` contains a series of arrays indicated by *[]. The name of the array object doesn't matter - we want to index it.\n\n\n\n#### Global Search searchable custom attributes ####\n\nFields that have been identified as Global Search searchable by being included in `global_search_searchable` array by their key, will be synchronized as custom attributes to Global Search microservice, and will become searchable via Global Search. Note that field will only be synchronized to Global Search if field definition contains a valid `search_path`. Values found at that `search_path` will be synchronized to Global Search, otherwise field will be ignored. Any values provided in `global_search_searchable` array which do not correspond to any existing fields of the type will be ignored.\n\nAn example of valid configuration of `global_search_searchable` attributes would be:\n\n```json\n{\n \"name\": \"book\",\n \"description\": \"Book asset type\",\n \"fields\": [\n {\n \"key\": \"last_name\",\n \"type\": \"string\",\n \"facet\": false,\n \"is_array\": false,\n \"search_path\": \"author.last_name\",\n \"is_searchable_across_types\": true\n }\n ],\n \"global_search_searchable\": [\n \"last_name\"\n ],\n \"properties\": {\n \"price\" : {\n \"type\": \"number\",\n \"description\": \"Suggested retail price\",\n }\n }\n}\n```\n\nFollowing are key characteristics of a valid definition:\n- Key of a field `last_name` is included in `global_search_searchable` array.\n- Field `last_name` has a properly defined `search_path` which contains a valid json path.\n\nCommon pitfalls:\n- Not including `search_path` into the field definition will cause the field to be ignored and prevent it from indexing. Similarly, an invalid json path definition within `search_path` which either is not formatted correctly, or points to a wrong location will prevent field value from being indexed as `global_search_searchable`.\n- Make sure that only the key value of the field is used inside `global_search_searchable`. In the above example `last_name` is the name of the field, so the `global_search_searchable` array contains an `last_name`.\n\n\n### data_asset Type ###\n\n`\"data_asset\"` is by far the most commonly used [already available asset type](#Section_Assets__Overview_and_Terminology__Asset_Type__predefined_asset_types). It can be seen in:\n\n - the [Parts of a Primary Metadata Document Figure](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview__figure)\n - many of the examples in the [Assets API Examples](#Section_Asset__API_Examples) and [Asset Types API Examples](#Section_Asset_Types_API_Examples) sections\n - the default asset type used when you drag an [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) file onto the Create Asset page.\n\nThe reason `\"data_asset\"` is so popular is that it is a _generic_ asset type that allows you to declare a _specific_ type for a given asset resource _without explicitly creating_ an asset type named after that specific type. For example, say you want to create a primary metadata document for a csv file. You _could_ first create a specific asset type named, say, \"csv\\_file\", and then create a primary metadata document (for that csv file) and specify \"csv\\_file\" as the value for [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type). However, you can avoid creating a _specific_ \"csv\\_file\" asset type by instead using the _generic_ \"data\\_asset\" asset type and then use the \"mime\\_type\" field of the \"data\\_asset\" attribute to declare that the specific type of your [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) is a csv file. To do so, the primary metadata document for the csv file would have:\n\n - a `\"metatada.asset_type\"` value of the generic type `\"data_asset\"`\n - a `\"entity.data_asset.mime_type\"` value of the specific type `\"text/csv\"`.\n\nThe fields `\"asset_type\"` and `\"mime_type\"` _both_ describe the \"type\" of the asset resource. However:\n\n - the type specified by the `\"metatada.asset_type\"` field (ie, `\"data_asset\"`) is _generic_\n - the type specified by the `\"entity.data_asset.mime_type\"` field (ie, `\"text/csv\"`) is _specific_\n\nIt is the `\"mime_type\"` field of the `data_asset` type that allows you to *declare* a specific type for an asset _without_ *creating* that specific type(!).\n\nSo, in its most basic use, the `\"data_asset\"` asset type is a very \"lite\" asset type. It's used to avoid creating many other \"heavier\" asset types. However, if you need to create more complex [attributes](#Section_Assets__Overview_and_Terminology__Attributes) with indexes for specific fields in your attribute then you will have to create your own asset type (see [Create Asset Type: book](#Section_Asset_Types__Create_Asset_Type__book) for an example).\n\nThe other two fields of the type `\"data_asset\"` are `\"dataset\"` and `\"columns\"`.\n\n - `\"dataset\"` value of `false` means that the `\"columns\"` field is *absent* in a `\"data_asset\"` attribute\n - `\"dataset\"` value of `true` means that the `\"columns\"` field is *present* in a `\"data_asset\"` attribute\n\nThe `\"columns\"` field of a `\"data_asset\"` attribute is optionally used to specify metadata for columns of assets that have columns, like csv files, spreadsheets, database tables, etc.\n\nThe full definition of the `\"data_asset\"` type is shown in [Get Asset Type: data_asset - Response Body](#Section_Assets__Response__GET_ASSET_TYPE__DATA_ASSET_fields).\n\nSee [Get Asset - CSV File - Response Body - **Before** Profiling](#Section_Assets__GET_ASSET__CSV_File__before_profiling) and [Get Asset - CSV File - Response Body - **After** Profiling](#Section_Assets__GET_ASSET__CSV_File__after_profiling) for examples where a `\"data_asset\"` is used for a csv asset resource.\n\n\n\n### Using Secondary / Extended / Decorator Asset Types to Simulate Type Inheritance ###\n\nAsset type inheritance/subclassing is not supported by the Asset Type API. Asset types can be combined through the use of Secondary / Extended / Decorator Asset Types, to simulate inheritance through composition of multiple types. A \"decorator\" can combine a common set of properties that under a traditional inheritance model would be part of the super class and \"decorate\" those types that would traditionally be the child class. The asset type `decorates` field specifies the child asset types that are decorated. Note that type decoration is not enforced by the API, i.e. there is no checking that the contents of an asset has fields which match what is declared in any asset type. However, the IKC UI honors the type decorator setting by presenting the fields in decorator types as custom attributes in the Asset Overview screen UI under \"Details\" section. For more details on using the asset type decorator feature, see [Tailor your Data Catalog with custom asset attributes](https://medium.com/ibm-data-ai/tailor-your-data-catalog-with-custom-asset-attributes-a2b468535a48).\n\n\n\n\n\n### Get Asset Types ###\n\nYou can get a list of the [asset types](#Section_Assets__Overview_and_Terminology__Asset_Type) in a [catalog](#Section_Catalogs__start) using the following Asset Types API:\n\n\n#### Get Asset Types - Request URL: ####\n\n```\nGET {service_URL}/v2/asset_types?catalog_id={catalog_id}\n```\n\n#### Get Asset Types - Response Body: ####\n\n\n\n```\n{\n \"resources\": [\n {\n \"description\": \"Data Asset Type\",\n \"fields\": [\n {\n \"key\": \"dataset\",\n \"type\": \"boolean\",\n \"facet\": true,\n \"is_array\": false,\n \"is_searchable_across_types\": false\n },\n {\n \"key\": \"mime_type\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"is_searchable_across_types\": false\n },\n {\n \"key\": \"columns\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": true,\n \"search_path\": \"columns[].name\",\n \"is_searchable_across_types\": true\n }\n ],\n \"external_asset_preview\": {},\n \"relationships\": [],\n \"name\": \"data_asset\",\n \"version\": 3\n },\n \"global_search_searchable\": [\n \"mime_type\"\n ],\n {\n \"description\": \"An asset type you can use to describe the columns of a data asset. Normally attached as a property to an existing data asset.\",\n \"fields\": [\n {\n \"key\": \"column_info_term_display_name\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"search_path\": \"*.column_terms[].term_display_name\",\n \"is_searchable_across_types\": true\n },\n {\n \"key\": \"column_info_term_id\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"search_path\": \"*.column_terms[].term_id\",\n \"is_searchable_across_types\": false\n },\n {\n \"key\": \"column_info_tag\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"search_path\": \"*.column_tags[]\",\n \"is_searchable_across_types\": true\n },\n {\n \"key\": \"column_info_description\",\n \"type\": \"string\",\n \"facet\": false,\n \"is_array\": false,\n \"search_path\": \"*.column_description\",\n \"is_searchable_across_types\": true\n },\n {\n \"key\": \"column_info_omrs_guid\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"search_path\": \"*.omrs_guid\",\n \"is_searchable_across_types\": true\n }\n ],\n \"external_asset_preview\": {},\n \"relationships\": [],\n \"name\": \"column_info\",\n \"version\": 4\n },\n {\n \"description\": \"An asset type that you can use to assign terms from a business glossary to any asset. Attach items of this type as attributes to other assets.\",\n \"fields\": [\n {\n \"key\": \"asset_term_display_name\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"search_path\": \"list[].term_display_name\",\n \"is_searchable_across_types\": true\n },\n {\n \"key\": \"asset_term_id\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"search_path\": \"list[].term_id\",\n \"is_searchable_across_types\": false\n }\n ],\n \"external_asset_preview\": {},\n \"relationships\": [],\n \"name\": \"asset_terms\",\n \"version\": 1\n },\n...\n ]\n}\n```\n\nSee [Asset Type Fields](#Section_Asset_Types__Asset_Type_Fields) for descriptions of the fields in each of the above asset types.\n\nIn a scenario in which the user has not yet created any of their own asset types, the result will contain only the pre-existing, global, asset types. For brevity, the actual sample result shown above includes only a subset of those asset types. Try the `GET Asset Types` API on your catalog to see the complete set of pre-existing, global, asset types.\n\n\n### Get Asset Type: data_asset ###\n\nYou can get an individual [asset type](#Section_Assets__Overview_and_Terminology__Asset_Type) in a [catalog](#Section_Catalogs__start) using the following Asset Types API:\n\n\n#### Get Asset Type: data_asset - Request URL: ####\n\n```\nGET {service_URL}/v2/asset_types/{type_name}?catalog_id={catalog_id}\n```\n\nSupplying \"data_asset\" as the value for the `{type_name}` parameter in the above url will produce a response like the following:\n\n#### Get Asset Type: data_asset - Response Body: ####\n\n\n\n```json\n{\n \"description\": \"Data Asset Type\",\n \"fields\": [\n {\n \"key\": \"mime_type\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": false,\n \"is_searchable_across_types\": false\n },\n {\n \"key\": \"dataset\",\n \"type\": \"boolean\",\n \"facet\": true,\n \"is_array\": false,\n \"is_searchable_across_types\": false\n },\n {\n \"key\": \"columns\",\n \"type\": \"string\",\n \"facet\": true,\n \"is_array\": true,\n \"search_path\": \"columns[].name\",\n \"is_searchable_across_types\": true\n }\n ],\n \"global_search_searchable\": [\n \"mime_type\"\n ],\n \"external_asset_preview\": {},\n \"relationships\": [],\n \"name\": \"data_asset\",\n \"version\": 3\n}\n```\n\nSee [Asset Type Fields](#Section_Asset_Types__Asset_Type_Fields) for descriptions of the fields in the above asset type definition.\n\nSince an asset type called `\"data_asset\"` exists, you can create a [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) (ie, [card](#Section_Assets__Overview_and_Terminology__card_definition)) with a [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) value of \"data\\_asset\". That card must then also have a [primary attribute](#Section_Assets__primary_attribute__definition) called \"data\\_asset\".\n\nThe most interesting item in the `\"fields\"` array in the above `\"data_asset\"` asset type definition is the item with `\"key\"` value \"mime\\_type\". That item means that a primary attribute named \"data\\_asset\" will have a field called `\"mime_type\"`. The value of that `\"mime_type\"` attribute field will declare the specific type of the [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) represented by the primary metadata document. For example, see the field `\"entity.data_asset.mime_type\"` in [Get Asset - CSV File - Response Body - _Before_ Profiling](#Section_Assets__GET_ASSET__CSV_File__before_profiling) where the `\"mime_type\"` value is \"text/csv\".\n\nNotice the \"data\\_asset\" attribute in [Get Asset - CSV File - Response Body - _Before_ Profiling](#Section_Assets__GET_ASSET__CSV_File__before_profiling) only contains two fields - `\"mime_type\"` and `dataset`. The `columns` field specified in the definition of the `\"data_asset\"` asset _type_ is not present in the \"data\\_asset\" _attribute_.\n\nNow compare all the items in the `\"fields\"` array in the above `\"data_asset\"` asset _type_ definition with the `\"entity.data_asset\"` _attribute_ fields as shown, for example, in [Get Asset - CSV File - Response Body - _After_ Profiling](#Section_Assets__GET_ASSET__CSV_File__after_profiling). Notice that now _all_ the fields described in the `\"fields\"` array of the `\"data_asset\"` _type_ are present as fields in the `\"entity.data_asset\"` _attribute_. In particular, profiling has added the `\"columns\"` field to the \"data\\_asset\" _attribute_.\n\nThe Before Profiling and After Profiling examples illustrate that not all the fields defined in an asset _type_ need be present in a corresponding _attribute_.\n\nLastly, note that asset type definition includes a `global_search_searchable` list of field keys, including the value `mime_type`. That indicates that `mime_type` value of every instance of this asset type will be seachable via Global Search microservice.\n\n\n### Create Asset Type: book ###\n\nSay you have a book [asset resource](#Section_Asset__Terminology_Overview__definition__Asset_Resource) and you want to create a [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) to describe that book. You will first need to create an asset type called \"book\" (as shown below) so you can then:\n\n1. use the name of that asset type as the value for the [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) field in the primary metadata document\n2. create a [primary attribute](#Section_Assets__primary_attribute__definition) named \"book\" that will contain data about your book.\n\nSay you want that primary attribute to look like the following:\n\n\n\n```json\n \"book\": {\n \"author\": {\n \"first_name\": \"Tracy\",\n \"last_name\": \"Smith\"\n },\n \"price\": 29.95\n }\n }\n```\n\nThe above \"book\" attribute has:\n\n - one complex field called \"author\" (complex fields are allowed in attributes)\n - one simple field called \"price\".\n\nFor this example, assume you'll want to be able to search inside the `\"author.last_name\"` field of \"book\" attributes.\n\nIn addition to that, lets assume that you would like to use value of `\"author.last_name\"` field to search for \"books\" via Global Search microservice.\n\nTo create an asset type named \"book\" that will allow you to do all of the above, use a request like the following:\n\n\n#### Create Asset Type: book - Request URL: ####\n\n```\nPOST {service_URL}/v2/asset_types?catalog_id={catalog_id}\n```\n\n\n\n#### Create Asset Type: book - Request Body: ####\n\n```json\n{\n \"name\": \"book\",\n \"description\": \"Book asset type\",\n \"fields\": [\n {\n \"key\": \"author.last_name\",\n \"type\": \"string\",\n \"facet\": false,\n \"is_array\": false,\n \"search_path\": \"author.last_name\",\n \"is_searchable_across_types\": true\n }\n ],\n \"global_search_searchable\": [\n \"author.last_name\"\n ],\n \"properties\": {\n \"price\" : {\n \"type\": \"number\",\n \"description\": \"Suggested retail price\",\n }\n }\n}\n```\n\nThe purpose of most of the fields used in the above request was described in the [Asset Type Fields](#Section_Asset_Types__Asset_Type_Fields) section. Here are some things to note specifically in the above request:\n\n - `\"name\"`: uses **only lowercase** letters, ie, \"book\"\n - `\"fields\"`: even though our [goal attribute](#Section_Asset_Types__Create_Asset_Type__book_goal_attribute) has multiple fields in it, there is only one item in the asset type's `\"fields\"` array. That is because the `\"fields\"` array should only contain items for the fields of an attribute that we want the catalog to _create an index for_. In this case, we only want an index for the `\"author.last_name\"` field of \"book\" attributes.\n + `\"key\"`: the name of the attribute field that we want indexed, and the name for that index. In this case, `\"author.last_name\"`.\n + `\"type\"`: the type of the `\"author.last_name\"` field is \"string\"\n + `\"facet\"`: an explanation of this field is beyond the scope of this document\n + `\"is_array\"`: false because `\"author.last_name\"` is not an array\n + `\"search_path\"`: this is the path inside the attribute to the value that we want indexed\n + `\"is_searchable_across_types\"`: an explanation of this field is beyond the scope of this document\n - `\"global_search_searchable\"` since we would like to be able to search for `author.last_name` value using Global Search - we include corresponding `field.key` value.\n\n\n#### Create Asset Type: book - Response Body: ####\n\n```\n{\n \"description\": \"Book asset type\",\n \"fields\": [\n {\n \"key\": \"author.last_name\",\n \"type\": \"string\",\n \"facet\": false,\n \"is_array\": false,\n \"search_path\": \"author.last_name\",\n \"is_searchable_across_types\": true\n }\n ],\n \"global_search_searchable\": [\n \"author.last_name\"\n ],\n \"relationships\": [],\n \"name\": \"book\",\n \"version\": 1\n}\n```\n\nThe response to the `POST /v2/asset_types` API echoes the input, with two additional fields:\n\n - `relationships`: an explanation of the contents of this field is beyond the scope of this document\n - `version`: the version of the newly created asset type\n\nYou now have an asset _type_ called `\"book\"` that specifies one indexed, search-able, field called `\"author.last_name\"`. See [Create Asset: book](#Section_Assets__Create_Asset_book) for an example of the ways in which that `\"book\"` asset type can be used when creating a primary metadata document.\n\n\n### Search Asset Type: attribute - book ###\n\nThe Search Asset Type API can be used to search inside a [catalog](#Section_Catalogs__start) for all the [primary metadata documents](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) that satisfy both of the following conditions:\n\n1. have a [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) value that matches the asset type name specified in the {type_name} URL parameter\n2. have an [attribute](#Section_Assets__Overview_and_Terminology__Attributes) whose fields' values match those specified in the request body.\n\nRecall that one of the [primary reasons](#Section_Assets__Overview_and_Terminology__Asset_Type__primary_reason__searching) for creating an [asset type](#Section_Asset_Types__start) is to specify fields in [attributes](#Section_Assets__Overview_and_Terminology__Attributes) (named after that asset type) that will be indexed for searching. The [Create Asset **Type**: book](#Section_Asset_Types__Create_Asset_Type__book) section showed how to create an asset **type** named [`\"book\"`](#Section_Assets__Request__POST_ASSET_TYPE_request_Body). The [Create **Asset**: book](#Section_Assets__Create_Asset_book) section showed how to create a **primary metadata document** whose [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) value and [primary attribute](#Section_Assets__primary_attribute__definition) name are both [\"book\"](#Section_Assets__Request__POST_ASSET__Body). So, if you use the value \"book\" for the `{type_name}` parameter in the URL below, and if you supply the following request body, then you'll get back matching metadata for books.\n\n\n#### Search Asset Type: attribute - book - Request URL ####\n\n```\nPOST {service_URL}/v2/asset_types/{type_name}/search?catalog_id={catalog_id}\n```\n\n\n\n#### Search Asset Type: attribute - book - Request Body: ####\n\n```json\n{\n \"query\":\"book.author.last_name:Smith\"\n}\n```\n\nNotice how the query specifies both the attribute (`book`) to be searched and the search path (`author.last_name`) within that attribute. The value to match is specified after the colon (`:`). In this case, the value is `Smith`.\n\nThe following is the result of the above search:\n\n\n#### Search Asset Type: attribute - book - Response Body: ####\n\n```json\n{\n \"total_rows\": 1,\n \"results\": [\n {\n \"metadata\": {\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {}\n },\n \"usage\": {\n \"last_updated_at\": \"2019-05-01T18:58:51Z\",\n \"last_updater_id\": \"IBMid-___\",\n \"last_update_time\": 1556737131140,\n \"last_accessed_at\": \"2019-05-01T18:58:51Z\",\n \"last_access_time\": 1556737131140,\n \"last_accessor_id\": \"IBMid-___\",\n \"access_count\": 0\n },\n \"name\": \"Getting Started with Assets\",\n \"description\": \"Describes how to create and use metadata for assets\",\n \"tags\": [\n \"getting\",\n \"started\",\n \"documentation\"\n ],\n \"asset_type\": \"book\",\n \"origin_country\": \"us\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"c6f3cbd8-___\",\n \"created\": 1556635077746,\n \"created_at\": \"2019-04-30T14:37:57Z\",\n \"owner_id\": \"IBMid-___\",\n \"size\": 0,\n \"version\": 0,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"book\"\n ],\n \"asset_id\": \"3da5389d-d4a4-43da-be1f-___\",\n \"asset_category\": \"USER\"\n },\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/assets/3da5389d-d4a4-43da-be1f-___?catalog_id=c6f3cbd8-___\"\n }\n ]\n}\n```\n\nIn this case, there is only one primary metadata document returned in the `\"results\"` array (namely, the primary metadata document that was created in the [Create Asset: book](#Section_Assets__Create_Asset_book) section). In general, there can be many matching documents in the `\"results\"` array.\n\nNotice the results of an Asset Type Search, as shown above, only contain the [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) section of a [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview). In particular, the [\"entity\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__entity_group) section that contains the [attributes](#Section_Assets__Overview_and_Terminology__Attributes) is not returned. That is done to reduce the size of the response because, in general, the \"entity\" section of a primary metadata document can be much larger than the \"metadata\" section. Use the value of the `\"metadata.asset_id\"` in one of the items in `\"results\"` to retrieve either:\n\n - the entire primary metadata document (using the GET Asset API), or\n - just the attributes of the primary metadata document (using the GET Attributes API).\n\nNotes:\n\n - searching is not limited to just [primary attributes](#Section_Assets__primary_attribute__definition) (like `book` above). Searches may also be performed on:\n + [Secondary, or extended, attributes](#Section_Assets__secondary_extended_attribute__definition)\n + the [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) field of a primary metadata document, as shown in the [next section](#Section_Asset_Types__Search_Asset_Type__metadata).\n - other parameters available for searches are:\n + limit (number): limit number of search results\n + sort (string): sort columns for search results\n + counts: beyond the scope of this document\n + drilldown: beyond the scope of this document\n\n\n### Search Asset Type: metadata - name ###\n\nYou're not limited to searching within [attributes](#Section_Assets__Overview_and_Terminology__Attributes) (like the attribute search shown in the previous section). You can also search within the [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) section of a [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview).\n\n\n#### Search Asset Type: metadata - name - Request URL: ####\n\n```\nPOST {service_URL}/v2/asset_types/{type_name}/search?catalog_id={catalog_id}\n```\n\n\n\n#### Search Asset Type: metadata - name - Request Body: ####\n\n```json\n{\n \"query\":\"asset.name:Getting Started with Assets\"\n}\n```\n\nNotice the query signifies that the search should take place in the [\"metadata\"](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group) section of the [primary metadata document](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document_Overview) by using the term `asset` at the beginning of the search path. Then the field to be searched within \"metadata\" is specified - `name` in the example above. The value to match is specified after the colon (`:`), in this case the value is `Getting Started with Assets`.\n\nThe following is the result of the above search:\n\n\n#### Search Asset Type: metadata - name - Response Body: ####\n\n```json\n{\n \"total_rows\": 1,\n \"results\": [\n {\n \"metadata\": {\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {}\n },\n \"usage\": {\n \"last_updated_at\": \"2019-04-30T17:27:56Z\",\n \"last_updater_id\": \"IBMid___\",\n \"last_update_time\": 1556645276827,\n \"last_accessed_at\": \"2019-04-30T17:27:56Z\",\n \"last_access_time\": 1556645276827,\n \"last_accessor_id\": \"IBMid___\",\n \"access_count\": 0\n },\n \"name\": \"Getting Started with Assets\",\n \"description\": \"Describes how to create and use metadata for assets\",\n \"tags\": [\n \"getting\",\n \"started\",\n \"documentation\"\n ],\n \"asset_type\": \"book\",\n \"origin_country\": \"us\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"c6f3cbd8-___\",\n \"created\": 1556635077746,\n \"created_at\": \"2019-04-30T14:37:57Z\",\n \"owner_id\": \"IBMid-___\",\n \"size\": 0,\n \"version\": 0,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"book\"\n ],\n \"asset_id\": \"3da5389d-d4a4-43da-be1f-___\",\n \"asset_category\": \"USER\"\n },\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/assets/3da5389d-d4a4-43da-be1f-___?catalog_id=c6f3cbd8-___\"\n }\n ]\n}\n```\n\nIn this case, the result is the same as was described in [Search Asset Type: attribute - book - Response Body](#Section_Asset_Types__Search_Asset_Type__attribute__book__Response_Body). See that section for more details.\n\n\n## Data Assets and Columns #\n\n * [Overview of Data Asset and Columns](#Section_Data_Asset_Overview)\n\n * [Data Assets API Overview](#Section_Data_Asset__API_Overview)\n\n - [Creating a Data Asset](#Creating_Data_Asset__API)\n + [Create Data Asset: Request URL:](#Section_Assets__Request__POST_data_ASSET__Body)\n + [Create Data Asset: - Request Body:](#Section_Assets__Request__POST_data_ASSET__Body)\n + [Create Data Asset: - Response Body:](#Section_Assets__Request__POST_ASSET__Response)\n + [Create Data Asset for Local File: -Sample Request Body:](#Section_Assets__Request__POST_data_ASSET__Body_Local)\n + [Create Data Asset For Local File: - Response Body:](#Section_Assets__Request__POST_ASSET__Response_Local)\n - [Retrieving a Data Asset](#Retrieving_Data_Asset__API)\n + [Retrieve a Data Asset: Request URL:](#Section_Retrieving_Data_Asset__URL)\n + [Retrieve Data Asset: - Response Body:](#Section_Assets__Request__GET_data_ASSET__Response)\n - [Retrieving Columns from a Data Asset](#Retrieving_Data_Asset__Columns_API)\n + [Retrieve Columns from a Data Asset: Request URL:](#Section_Retrieving_Data_Asset_Columns__URL)\n + [Retrieve Columns from a Data Asset: - Response Body:](#Section_Assets__Request__GET_data_ASSET_Columns__Response)\n\n * [Columns and Column Level Attributes](#Section_Columns_And_Column_Custom_Attributes)\n\n - [Column Related Information Present in data_asset Asset Type Asset](#Section_Columns_Related_Info_In_Data_Asset)\n - [Column Related Information Present in column_info Asset Type](#Section_Columns_Related_Info_In_Column_info)\n - [Assigning Terms and Data Class to a Column](#Section_Assigning_Terms_And_Data_Class)\n - [Custom Attributes for Columns](#Section_Column_Custom_Attributes)\n + [Creating an Asset Type for Column Level](#Section_Creating_Column_Custom_Attributes)\n + [Adding the Column Level Attribute to a Column](#Section_Adding_Column_Custom_Attributes)\n + [Adding the Attribute as a Map](#Section_Adding_Column_Custom_Attributes_As_Map)\n + [Adding the Attribute as a List ](#Section_Adding_Column_Custom_Attributes_As_List)\n\n\n\nData assets represent tables or files from a connection to a data source (ex. tables) or files uploaded into cloud object storage associated with Projects or Catalog.\nData assets extend the generic asset service and attachments functionality. This means that like generic assets, data assets also have name, description, visibility, members, tags, classifications and asset_type. In addition, data assets have mime type, column related attributes and properties.\nThe asset type for data asset is [data_asset](#Section_Asset_Types__data_asset_type) and it is one of the [asset types already available](#Section_Assets__Overview_and_Terminology__Asset_Type__predefined_asset_types).\n\nLike other assets, we can add or update attributes on data assets also. In addition, data assets can have attributes which are associated with individuals columns.\nGiven below is a simple format of a data asset, which has attributes associated with columns.\n\n```json\n{\n \"metadata\": {\n ...\n ...\n \"name\": \"Name of the data asset\",\n \"asset_type\": \"data_asset\",\n \"asset_attributes\": [\n \"data_asset\",\n \"column_info\",\n \"column_level_custom_attribute\",\n ... other attributes\n ],\n \"asset_id\": \"id of the data asset\"\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"text/csv\",\n \"dataset\": false,\n \"columns\": [\n {\n \"name\": \"NameOfColumn\", // Name of the column\n \"type\": {\n \"type\": \"varchar\",\n \"length\": 1024,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false\n }\n }\n ]\n },\n \"column_info\": {\n \"NameOfColumn\": { // we are listing the column_info attributes associated with each column\n \"column_description\": \"description of the column\",\n \"column_terms\": [\n {\n \"term_display_name\": \"test_term\",\n \"term_id\": \"d3d667e1-____\"\n }\n ]\n }\n },\n \"column_level_custom_attribute\": { // Column level custom attribute\n \"columns\": [\n {\n \"name\": \"NameOfColumn\",\n \"OtherColumnProperty\": \"dummy value\"\n }\n ]\n },\n ... other attributes\n },\n \"attachments\": [\n ...\n ...\n ]\n}\n\n```\n\n\nAll asset APIs listed in [Assets API Overview](#Section_Asset__API_Overview) apply to data assets as well. In additions, data assets have special APIs.\n\n\n ### Creating a Data Asset ###\nCreating a data asset is similar to [creating any other asset](#Section_Assets__Create_Asset_book). In here,\n\n - a [`\"metadata.asset_type\"`](#Section_Assets__Overview_and_Terminology__Asset_Metadata_Document__metadata_group__asset_type) field will hold value `\"data_asset\"`\n - a [primary attribute](#Section_Assets__primary_attribute__definition) called `\"data_asset\"`.\n\nIn the first example, we will create a connected data asset. It represents a table or a file from an exisitng connection.\nThe sample request body and the corresponding response is given below.\n\n\n#### Create Data Asset: Request URL: ####\n```\nPOST {service_URL}/v2/data_assets\n```\n\n#### Create Data Asset: -Sample Request Body: ####\n```json\n{\n \"metadata\": {\n \"name\": \"CUSTOMER\", // Name of table\n \"description\": \"customer table\", // description\n \"tags\": [\n \"public\"\n ],\n \"asset_type\": \"data_asset\",\n \"origin_country\": \"us\",\n \"rov\": {\n \"mode\": 0\n }\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"application/x-ibm-rel-table\",\n \"dataset\": true,\n \"properties\": [\n {\n \"name\": \"schema_name\",\n \"value\": \"DB2INST1\"\n },\n {\n \"name\": \"table_name\",\n \"value\": \"CUSTOMER\"\n }\n ],\n \"columns\": [ // list of columns in the data asset\n {\n \"name\": \"CID\",\n \"type\": {\n \"type\": \"bigint\",\n \"length\": 19,\n \"scale\": 0,\n \"nullable\": false,\n \"signed\": true,\n \"native_type\": \"BIGINT\"\n }\n },\n {\n \"name\": \"INFO\",\n \"type\": {\n \"type\": \"sqlxml\",\n \"length\": 0,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false,\n \"native_type\": \"XML\"\n }\n },\n {\n \"name\": \"HISTORY\",\n \"type\": {\n \"type\": \"sqlxml\",\n \"length\": 0,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false,\n \"native_type\": \"XML\"\n }\n }\n ]\n }\n },\n \"attachments\": [ // details of the connection\n {\n \"asset_type\": \"data_asset\",\n \"name\": \"CUSTOMER\",\n \"description\": \"customer table\",\n \"mime\": \"application/x-ibm-rel-table\",\n \"connection_id\": \"3a______\",\n \"connection_path\": \"/DB2_path_/CUSTOMER_table_path\",\n \"is_partitioned\": false\n }\n ]\n}\n\n```\n\n\n#### Create Data Asset: - Response Body: ####\n\n```json\n{\n \"metadata\": {\n \"usage\": {\n \"last_updated_at\": \"2023-04-20T20:13:39Z\",\n \"last_updater_id\": \"-- creator id--\",\n \"last_update_time\": 1682021619570,\n \"last_accessed_at\": \"2023-04-20T20:13:39Z\",\n \"last_access_time\": 1682021619570,\n \"last_accessor_id\": \"-- creator id--\",\n \"access_count\": 0\n },\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {},\n \"member_roles\": {\n \"-- creator id--\": {\n \"user_iam_id\": \"-- creator id--\",\n \"roles\": [\n \"OWNER\"\n ]\n }\n }\n },\n \"name\": \"CUSTOMER\",\n \"description\": \"customer table\",\n \"tags\": [\n \"public\"\n ],\n \"asset_type\": \"data_asset\",\n \"origin_country\": \"us\",\n \"resource_key\": \"0000:0000:0000:0000:0000:FFFF:0914:9C3E|50000|sample:/DB2INST1/CUSTOMER\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"e1____\",\n \"created\": 1682021619570,\n \"created_at\": \"2023-04-20T20:13:39Z\",\n \"owner_id\": \"-- creator id--\",\n \"size\": 0,\n \"version\": 2,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"data_asset\"\n ],\n \"asset_id\": \"12____\",\n \"asset_category\": \"USER\",\n \"creator_id\": \"-- creator id--\"\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"application/x-ibm-rel-table\",\n \"dataset\": true,\n \"properties\": [\n {\n \"name\": \"schema_name\",\n \"value\": \"DB2INST1\"\n },\n {\n \"name\": \"table_name\",\n \"value\": \"CUSTOMER\"\n }\n ],\n \"columns\": [\n {\n \"name\": \"CID\",\n \"type\": {\n \"type\": \"bigint\",\n \"length\": 19,\n \"scale\": 0,\n \"nullable\": false,\n \"signed\": true,\n \"native_type\": \"BIGINT\"\n }\n },\n {\n \"name\": \"INFO\",\n \"type\": {\n \"type\": \"sqlxml\",\n \"length\": 0,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false,\n \"native_type\": \"XML\"\n }\n },\n {\n \"name\": \"HISTORY\",\n \"type\": {\n \"type\": \"sqlxml\",\n \"length\": 0,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false,\n \"native_type\": \"XML\"\n }\n }\n ]\n }\n },\n \"href\": \"/v2/assets/12____?catalog_id=e1____\",\n \"asset_id\": \"12____\",\n \"attachments\": [\n {\n \"attachment_id\": \"2a____\",\n \"asset_type\": \"data_asset\",\n \"attachment_type\": \"remote\",\n \"datasource_type\": \"8c____\",\n \"is_partitioned\": false,\n \"name\": \"CUSTOMER\",\n \"description\": \"customer table\",\n \"mime\": \"application/x-ibm-rel-table\",\n \"connection_id\": \"3a____\",\n \"connection_path\": \"/DB2INST1/CUSTOMER\",\n \"user_data\": {},\n \"href\": \"/v2/assets/12____/attachments/2a____?catalog_id=e1____\",\n \"asset_category\": \"USER\"\n }\n ]\n}\n```\n\nIn the next example, we will create a data asset which represents a local file uploaded to catalog.\nThe URL for the API remains [same](#Section_Creating_Data_Asset__URL). The sample request body and the corresponding response are given below.\n\n\n#### Create Data Asset for Local File: -Sample Request Body: ####\n```json\n{\n \"metadata\": {\n \"name\": \"New data Asset\",\n \"description\": \"data table\",\n \"tags\": [\n \"public\"\n ],\n \"asset_type\": \"data_asset\",\n \"origin_country\": \"us\",\n \"rov\": {\n \"mode\": 0\n }\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"application/octet-stream\",\n \"dataset\": true,\n \"columns\": [\n {\n \"name\": \"COLUMN1\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN2\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN3\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN4\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN5\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN6\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN7\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN8\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n }\n ],\n \"properties\": [\n {\n \"name\": \"bucket\",\n \"value\": \"--bucket name--\"\n },\n {\n \"name\": \"file_name\",\n \"value\": \"file_path/file_name-csv\"\n },\n {\n \"name\": \"first_line_header\",\n \"value\": \"false\"\n },\n {\n \"name\": \"encoding\",\n \"value\": \"UTF-8\"\n },\n {\n \"name\": \"invalid_data_handling\",\n \"value\": \"fail\"\n },\n {\n \"name\": \"file_format\",\n \"value\": \"csv\"\n }\n ]\n }\n },\n \"attachments\": [\n {\n \"asset_type\": \"data_asset\",\n \"name\": \"remote\",\n \"description\": \"remote\",\n \"mime\": \"text/csv\",\n \"connection_id\": \"26____\",\n \"connection_path\": \"Cloud_object_storage_path/file_name-csv.csv\",\n \"is_partitioned\": false\n }\n ]\n}\n\n```\n\n\n#### Create Data Asset For Local File: - Response Body: ####\nFor the above request, the expected response is given below.\n\n```json\n{\n \"metadata\": {\n \"usage\": {\n \"last_updated_at\": \"2023-04-20T20:23:21Z\",\n \"last_updater_id\": \"-- creator id--\",\n \"last_update_time\": 1682022201699,\n \"last_accessed_at\": \"2023-04-20T20:23:21Z\",\n \"last_access_time\": 1682022201699,\n \"last_accessor_id\": \"-- creator id--\",\n \"access_count\": 0\n },\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {},\n \"member_roles\": {\n \"-- creator id--\": {\n \"user_iam_id\": \"-- creator id--\",\n \"roles\": [\n \"OWNER\"\n ]\n }\n }\n },\n \"name\": \"New data Asset\",\n \"description\": \"data table\",\n \"tags\": [\n \"public\"\n ],\n \"asset_type\": \"data_asset\",\n \"origin_country\": \"us\",\n \"resource_key\": \"New data Asset\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"e1______\",\n \"created\": 1682022201699,\n \"created_at\": \"2023-04-20T20:23:21Z\",\n \"owner_id\": \"-- creator id--\",\n \"size\": 0,\n \"version\": 2,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"data_asset\"\n ],\n \"asset_id\": \"80___\",\n \"asset_category\": \"USER\",\n \"creator_id\": \"-- creator id--\"\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"application/octet-stream\",\n \"dataset\": true,\n \"columns\": [\n {\n \"name\": \"COLUMN1\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN2\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN3\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN4\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN5\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN6\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN7\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"COLUMN8\",\n \"type\": {\n \"length\": 1024,\n \"nullable\": true,\n \"type\": \"varchar\",\n \"scale\": 0,\n \"signed\": false\n }\n }\n ],\n \"properties\": [\n {\n \"name\": \"bucket\",\n \"value\": \"--bucket name--\"\n },\n {\n \"name\": \"file_name\",\n \"value\": \"file_path/file_name-csv\"\n },\n {\n \"name\": \"first_line_header\",\n \"value\": \"false\"\n },\n {\n \"name\": \"encoding\",\n \"value\": \"UTF-8\"\n },\n {\n \"name\": \"invalid_data_handling\",\n \"value\": \"fail\"\n },\n {\n \"name\": \"file_format\",\n \"value\": \"csv\"\n }\n ]\n }\n },\n \"href\": \"/v2/assets/80__?catalog_id=e1____\",\n \"asset_id\": \"805e24e6-2473-41d4-9e2a-679df9a40e7b\",\n \"attachments\": [\n {\n \"attachment_id\": \"2b____\",\n \"asset_type\": \"data_asset\",\n \"attachment_type\": \"remote\",\n \"is_partitioned\": false,\n \"name\": \"remote\",\n \"description\": \"remote\",\n \"mime\": \"text/csv\",\n \"connection_id\": \"26____\",\n \"connection_path\": \"Cloud_object_storage_path/file_name-csv.csv\",\n \"user_data\": {},\n \"href\": \"/v2/assets/80____/attachments/2b____?catalog_id=e1____\",\n \"asset_category\": \"USER\"\n }\n ]\n}\n```\n\n\n ### Retrieving a Data Asset ###\nRetrieving a data asset can be achieved by calling APIs for [retrieving any other asset](#Section_Assets__Get_Asset). Since data assets are also uploaded locally we can [retrieve csv files](#Section_Assets__Get_Asset__CSV_File) also.\nHowever, we have special APIs designed specifically to retrieve data assets.\n\nIf we retrieve the data asset created in the [previous section](#Section_Assets__Request__POST_ASSET__Response)\n\n#### Retrieve a Data Asset: Request URL: ####\n```\nGET {service_URL}/v2/data_assets/{asset_id}?catalog_id={catalog_id}\n```\n\n\n#### Retrieve Data Asset: - Response Body: ####\n\n```json\n{\n \"metadata\": {\n \"usage\": {\n \"last_updated_at\": \"2023-04-17T20:20:56Z\",\n \"last_updater_id\": \"--id--\",\n \"last_update_time\": 1681762856921,\n \"last_accessed_at\": \"2023-04-17T20:20:56Z\",\n \"last_access_time\": 1681762856921,\n \"last_accessor_id\": \"--id--\",\n \"access_count\": 0\n },\n \"rov\": {\n \"mode\": 0,\n \"collaborator_ids\": {},\n \"member_roles\": {\n \"--id--\": {\n \"user_iam_id\": \"--id--\",\n \"roles\": [\n \"OWNER\"\n ]\n }\n }\n },\n \"name\": \"CUSTOMER\",\n \"description\": \"customer table\",\n \"tags\": [\n \"public\"\n ],\n \"asset_type\": \"data_asset\",\n \"origin_country\": \"us\",\n \"resource_key\": \"string\",\n \"rating\": 0,\n \"total_ratings\": 0,\n \"catalog_id\": \"e12____\",\n \"created\": 1681762856921,\n \"created_at\": \"2023-04-17T20:20:56Z\",\n \"owner_id\": \"--id--\",\n \"size\": 0,\n \"version\": 2,\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"data_asset\"\n ],\n \"asset_id\": \"75____\",\n \"asset_category\": \"USER\",\n \"creator_id\": \"--id--\"\n },\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"application/x-ibm-rel-table\",\n \"dataset\": true,\n \"columns\": [\n {\n \"name\": \"CID\",\n \"type\": {\n \"length\": 19,\n \"nullable\": false,\n \"type\": \"bigint\",\n \"scale\": 0,\n \"signed\": true\n }\n },\n {\n \"name\": \"INFO\",\n \"type\": {\n \"length\": 0,\n \"nullable\": true,\n \"type\": \"sqlxml\",\n \"scale\": 0,\n \"signed\": false\n }\n },\n {\n \"name\": \"HISTORY\",\n \"type\": {\n \"length\": 0,\n \"nullable\": true,\n \"type\": \"sqlxml\",\n \"scale\": 0,\n \"signed\": false\n }\n }\n ],\n \"properties\": [\n {\n \"name\": \"schema_name\",\n \"value\": \"DB2INST1\"\n },\n {\n \"name\": \"table_name\",\n \"value\": \"CUSTOMER\"\n }\n ]\n }\n },\n \"attachments\": [\n {\n \"id\": \"51d____\",\n \"version\": 2,\n \"asset_type\": \"data_asset\",\n \"name\": \"CUSTOMER\",\n \"description\": \"customer table\",\n \"mime\": \"application/x-ibm-rel-table\",\n \"connection_id\": \"3a____\",\n \"connection_path\": \"/DB2_path_/CUSTOMER_table_path\",\n \"datasource_type\": \"8c____\",\n \"creator_id\": \"--id--\",\n \"create_time\": 1681762856936,\n \"size\": 0,\n \"is_remote\": true,\n \"is_managed\": false,\n \"is_referenced\": false,\n \"is_object_key_read_only\": false,\n \"is_user_provided_path_key\": true,\n \"transfer_complete\": true,\n \"is_partitioned\": false,\n \"complete_time_ticks\": 1681762856936,\n \"user_data\": {},\n \"test_doc\": 0,\n \"usage\": {\n \"access_count\": 0,\n \"last_accessor_id\": \"--id--\",\n \"last_access_time\": 1681762856936\n }\n }\n ],\n \"href\": \"/v2/data_assets/75__?catalog_id=e1____\"\n}\n```\n\n\n ### Retrieving Columns from a Data Asset ###\nData assets often contain information regarding the columns in the table or file. Use the `GET columns` API to retrieve the column related information, such as the terms, column description or any other custom attribute assigned to a column etc.\n\n\n#### Retrieve Columns from a Data Asset: Request URL: ####\n```\nGET {service_URL}/v2/data_assets/{asset_id}/columns?catalog_id={catalog_id}\n```\n\n\n#### Retrieve Columns from a Data Asset: - Response Body: ####\n\n```json\n{\n \"total_rows\": 1, // Total number of columns\n \"resources\": [\n {\n \"data_asset\": {\n \"columns\": [\n {\n \"name\": \"NameOfColumn\",\n \"type\": {\n \"type\": \"varchar\",\n \"length\": 1024,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false\n },\n \"position\": 1\n }\n ]\n },\n \"column_info\": {\n \"NameOfColumn\": {\n \"column_description\": \"column description\",\n \"column_terms\": [\n {\n \"term_display_name\": \"test_term\",\n \"term_id\": \"d3d______\"\n }\n ],\n \"name\": \"NameOfColumn\"\n }\n },\n \"column_level_custom_attribute\": {\n \"columns\": [\n {\n \"name\": \"NameOfColumn\",\n \"OtherColumnProperty\": \"dummy value\"\n }\n ]\n }\n }\n ]\n}\n```\n\n\n\nData assets can hold information about the columns of the data. It is important to note that they **do not** hold the actual column and the column values. The information it can stores can be the terms and data class assigned after profiling or manually, data quality score of the column, the type of the column, tags associated with the column and the description of the column.\nWe can create custom attributes and assign them to columns also. The [Create Asset Type: book](#Section_Asset_Types__Create_Asset_Type__book) section shows how to create an asset type named [`book`](#Section_Assets__Request__POST_ASSET_TYPE_request_Body).\n\nAmong the [already available asset types](#Section_Assets__Overview_and_Terminology__Asset_Type__predefined_asset_types), asset types `\"data_asset\"` and `\"column_info\"` contain attributes for columns.\n\n\n### Column Related Information Present in data_asset Asset Type ###\nThe basic structure of data_asset asset type is described in section [data_asset Type](#Section_Asset_Types__data_asset_type). Here we will elaborate on the `\"columns\"` field of the data_asset.\n\nThe `\"columns\"` field consists of a list of elements. Each element represents a column. It is populated after profiling. Example of a single column element is given below\n```json\n{\n \"name\": \"MARITAL_STATUS\", // Name of the column\n \"type\": {\n \"type\": \"varchar\",\n \"length\": 1024,\n \"scale\": 0,\n \"nullable\": true,\n \"signed\": false\n }\n}\n```\n\n\n### Column Related Information Present in column_info Asset Type ###\nThe column_info attribute in a data asset represents information about each column. The informations is added manually, or after running profiling or metadata enrichment. The `\"column_info\"` field consists of a map. Each key-value pair represents an individual column. Each key is the name of the column. The value of the key represents attributes assigned to the column.\nExample of a single column element's column_info is given below\n```json\n\"MARITAL_STATUS\": { // name of the column\n \"data_class\": {\n \"selected_data_class\": {\n \"id\": \"7a8e___\",\n \"name\": \"status\",\n \"setByUser\": false\n }\n },\n \"inferred_type\": {\n \"length\": 10,\n \"precision\": 0,\n \"scale\": 0,\n \"type\": \"STRING\",\n \"display_name\": \"varchar(10)\"\n },\n \"quality\": {\n \"score\": 98\n },\n \"column_terms\": [\n {\n \"term_id\": \"7a8e____\",\n \"term_display_name\": \"TestTerm\",\n \"confidence\": 0.984,\n \"specification\": \"Data class based assignment\"\n }\n ],\n \"suggested_terms\": [],\n \"rejected_terms\": [],\n \"name\": \"MARITAL_STATUS\"\n }\n }\n```\n\n### Assigning Terms and Data Class to a Column ###\n\nWe can assign terms and data class to a column manually also. The terms associated with individual columns reside as an array inside the column_info attribute.\n\nIn the first scenario we will add a single term and data class to a file which does not have the `\"column_info\"` attribute. This can happen if a csv file has been uploaded locally. In this case, we need to use the Create Asset API to create and populate an instance of `\"column_info\"` attribute inside the asset's primary metadata document.\n\n```\nPOST {service_URL}/v2/assets/{asset_id}/attributes?catalog_id={catalog_id}\n```\n\nBody:\n```json\n{\n \"name\": \"column_info\",\n \"entity\": {\n \"BUSINESS_NAME\": {\n \"column_terms\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"term_name\"\n }\n ],\n \"data_class\": {\n \"selected_data_class\": {\n \"id\": \"--your data class id--\",\n \"name\": \"data_class_name\"\n }\n }\n }\n }\n}\n\n```\n\nThe response should look like:\n```json\n{\n \"asset_id\": \"--your asset id--\",\n \"column_info\": {\n \"BUSINESS_NAME\": { // Name of your column\n \"column_terms\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"term_name\"\n }\n ],\n \"data_class\": {\n \"selected_data_class\": {\n \"id\": \"--your data class id--\",\n \"name\": \"data_class_name\"\n }\n }\n }\n },\n \"href\": \"/v2/assets/b8____/attributes/column_info?catalog_id=e1____\"\n}\n```\n\nIf you want to associate additional terms or data class to a column, or add terms or data class to a column which does not have terms or data class, or remove existing terms or data class from a column, then use the Update Asset Attribute API.\nIn the following example, we will replace terms assigned to the column BUSINESS_NAME and add terms to a column which does not have any terms yet.\n\n```\nPATCH {service_URL}/v2/assets/{asset_id}/attributes/column_info?catalog_id={catalog_id}\n```\nBody:\n```json\n[\n {\n \"op\": \"replace\",\n \"path\": \"/BUSINESS_NAME/column_terms\", // column to which we already have terms and data class\n \"value\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"new_term_name\"\n }\n ]\n },\n {\n \"op\": \"add\",\n \"path\": \"/ADDRESS\", // column to which no terms are data classes are assigned\n \"value\": {\n \"column_terms\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"term_name_2\"\n }\n ]\n }\n }\n]\n```\n\nThe response should look like:\n```json\n{\n \"BUSINESS_NAME\": {\n \"column_terms\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"new_term_name\"\n }\n ],\n \"data_class\": {\n \"selected_data_class\": {\n \"id\": \"--your data class id--\",\n \"name\": \"data_class_name\"\n }\n }\n },\n \"ADDRESS\": {\n \"column_terms\": [\n {\n \"term_id\": \"--your term id--\",\n \"term_display_name\": \"term_name_2\"\n }\n ]\n }\n}\n```\n\n### Custom Attributes for Columns ###\nCustom attributes can be added to individual columns.\n\n\n#### Creating an Asset Type for Column Level ####\nThe first step is to create an asset type which can be assigned to a column.\nTo search based on column level custom attributes, use global search. Users are not allowed to create assets of asset type which have properties associated with columns. This asset type can only be used to create attributes on a data_asset or a cobol_copybook. All properties are on column level.\n\n* Ensure is_column_custom_attribute=true. This field can be edited from false to true, but cannot be edited from true to false value\n* Ensure allow_decorators=false\n* Ensure all searchable fields are listed in the fields list. All the elements of the fields list must have a valid key and a valid search_path.\n* Populate the global_search_searchable with the keys mentioned in the elements of the fields\n\nGiven below is an example\n```\nPOST {service_URL}/v2/asset_types\n```\n```json\n{\n \"description\": \"Asset type for custom column attribute\",\n \"name\": \"column_attribute\",\n \"is_column_custom_attribute\" : true, // is_column_custom_attribute should be true\n \"allow_decorators\": false, // allow_decorators shuld be false\n \"attribute_only\":true,\n \"decorates\": [\n {\n \"asset_type_name\": \"data_asset\" // only two values allowed; data_asset and/or cobol_copybook\n }\n ],\n \"fields\": [\n {\n \"key\": \"name\",\n \"type\": \"string\",\n \"facet\": false,\n \"search_path\": \"columns.*.name\"\n },\n {\n \"key\": \"field1\",\n \"type\": \"string\",\n \"facet\": false,\n \"search_path\": \"columns.*.field1\"\n },\n {\n \"key\": \"field2\",\n \"type\": \"string\",\n \"facet\": false,\n \"search_path\": \"columns.*.field2\"\n }\n ],\n \"global_search_searchable\": [\"name\", \"field1\", \"field2\"],\n \"properties\" : {\n \"name\" : {\n \"type\": \"string\"\n },\n \"host\" : {\n \"type\": \"string\"\n },\n \"new_prop\" : {\n \"type\": \"string\"\n }\n }\n\n}\n```\n\n\n#### Adding the Column Level Attribute to a Column ####\n\nUsers can add columns with a map. The top level field name will always be columns. The value of columns fields will be a map.\n\nExample of attribute being listed as a map is\n```json\n\"columns\": {\n \"city\": {\n \"host\": \"host1\",\n \"field1\": \"column1field1\",\n \"field2\": \"column1field2\"\n }\n }\n```\nThe details are listed in section [Adding the Attribute as a Map](#Section_Adding_Column_Custom_Attributes_As_Map).\n\n\n##### Adding the Attribute as a Map #####\n\nWhen column level attribute is added to the asset, then the attribute in the asset's entity will have the following structure. Please note the top level columns field. e.g.\n```json\n \"column_attribute\": {\n \"columns\": {\n \"city\": { // column name\n \"host\": \"host1\",\n \"field1\": \"column1field1\",\n \"field2\": \"column1field2\"\n }\n }\n }\n }\n```\n\nIn the above example, for column name \"city\", the associated property values are host=host1, field1=column1field1, field2=column1field2\n\nTo add this attribute to an asset:\n```\nPOST /v2/assets/{asset_id}/attributes API. Sample body will look like\n```\n```json\n{\n \"name\": \"column_attribute\",\n \"entity\": {\n \"columns\": {\n \"city\": {\n \"host\": \"host1\",\n \"field1\": \"column1field1\",\n \"field2\": \"column1field2\"\n }\n }\n }\n}\n```\nTo update this attribute use the PATCH /v2/assets/{asset_id}/attributes/{attribute_key} or the POST /v2/assets/bulk_patch API\n\n## Data Profiles\n\n#### Introduction\n\nData profiles contains classification and information about the distribution of your data, which helps you to understand your data better and make the appropriate data shaping decisions.\n\nData profiles are automatically created when a data set is added to a catalog with data policy enforcement. The profile summary helps you in analyzing your data more closely and in deciding which cleansing operations on your data will provide the best results for your use-case. You can also perform CRUD operations on data profiles for data sets in catalogs or projects without data policy enforcement.\n\n#### Create a data profile\n\nYou can use this API to:\n\n* Create a data profile\n* Create and execute a data profile\n\nTo create a data profile for a data set in a specified catalog or project and not execute it, call the following POST method:\n\n POST /v2/data_profiles?start=false\n\nOR\n\n POST /v2/data_profiles\n\nTo create a data profile for a data set in a specified catalog or project and execute it, call the following POST method:\n\n POST /v2/data_profiles?start=true\n\nThe minimal request payload required to create a data profile is as follows:\n\n {\n \"metadata\": {\n \"dataset_id\": \"{DATASET_ID}\",\n \"catalog_id\": \"{CATALOG_ID}\"\n }\n }\n\nOR\n\n {\n \"metadata\": {\n \"dataset_id\": \"{DATASET_ID}\",\n \"project_id\": \"{PROJECT_ID}\"\n }\n }\n\nThe request payload can have an `entity` part which is optional:\n\n```\n {\n \"metadata\": {\n \"dataset_id\": \"{DATASET_ID}\",\n \"catalog_id\": \"{CATALOG_ID}\"\n },\n \"entity\": {\n \"data_profile\": {\n \"options\": {\n \"max_row_count\": {MAX_ROW_COUNT_VALUE},\n \"max_distribution_size\": {MAX_SIZE_OF_DISTRIBUTIONS},\n \"max_numeric_stats_bins\": {MAX_NUMBER_OF_STATIC_BINS},\n \"classification_options\": {\n \"disabled\": {BOOLEAN_TO_ENABLE_OR_DISABLE_CLASSIFICATION_OPTIONS},\n \"class_codes\": {DATA_CLASS_CODE},\n \"items\": {ITEMS}\n }\n }\n }\n }\n```\n\nThe following parameters are required in the URI and the payload:\n\n1. `start`: Specifies whether to start the profiling service immediately after the data profile is created. The default is `false`.\n\n2. `max_row_count`: Specifies the maximum number of rows to perform profiling on. If no value is provided or if the value is invalid (negative), the default is to 5000 rows.\n\n3. `row_percentage`: Specifies the percentage of rows to perform profiling on. If no value is provided or if the value is invalid (<0 or >100).\n\n4. `max_distribution_size`: Specifies the maximum size of various distributions produced by the profiling process. If no value is provided, the default is 100.\n\n5. `max_numeric_stats_bins`: Specifies the maximum number of bins to use in the numerical statistics. If no bin size is provided, the default is 100 bins.\n\n6. `classification_options`: Specifies the various options available for classification.\n\n (i). `disabled`: If true, the classification options are disabled and default values are used.\n\n (ii). `class_codes`: Specifies the data class code to consider during profiling.\n\n (iii). `items`: Specifies the items.\n\n **Note:** You can get various data class codes through the data class service.\n\nTo create a data profile for a data set, the following steps must be completed:\n\n1. You must have a valid IAM token to make REST API calls and a project or catalog ID.\n\n2. You must have an IBM Cloud Object Storage bucket, which must be associated with your catalog in the project.\n\n3. The data set must be added to your catalog in the project.\n\n4. Construct a request payload to create a data profile with the values required in the payload.\n\n5. Send a POST request to create a data profile.\n\nWhen you call the method, the payload is validated. If a required value is not specified or a value is invalid, you get a response message with an HTTP status code of 400 and information about the invalid or missing values.\n\nThe response of the method includes a location header with a value that indicates the location of the profile that was created. The response body also includes a field `href` which contains the location of the created profile.\n\nThe `execution.status` of the profile is `none` if the `start` parameter is not set or is set to `false`. Otherwise, it is in `submitted` state or any other state depending on the profiling execution status.\n\nThe following are possible response codes for this API call:\n\n| Response HTTP status | Cause | Possible Scenarios |\n| -------------------- | ------------ | ----------------------- |\n| 201 | Created | A data profile was created. |\n| 400 | Bad Request | The request payload either had some invalid values or invalid/unwanted parameters. |\n| 401 | Unauthorized | Invalid IAM token was provided in the request header. |\n| 403 | Forbidden | User is not allowed to create a data profile. |\n| 500 | Internal Server Error | Some runtime error occurred. |\n\n#### Get a data profile\n\nTo get a data profile for a data set in a specified catalog or project, call the following GET method:\n\n GET /v2/data_profiles/{PROFILE_ID}?catalog_id={CATALOG_ID}&dataset_id={DATASET_ID}\n\nOR\n\n GET /v2/data_profiles/{PROFILE_ID}?project_id={PROJECT_ID}&dataset_id={DATASET_ID}\n\nThe value of `PROFILE_ID` is the value of `metadata.guid` from the successful response payload of the create data profile call.\n\nFor other runtime errors, you might get an HTTP status code of 500 indicating that profiling didn't finished as expected.\n\nThe following are possible response codes for this API call:\n\n| Response HTTP status | Cause | Possible Scenarios |\n| -------------------- | --------------- | -------------------- |\n| 200 | Success | Data profile is created and executed. |\n| 202 | Accepted | Data profile is created and under execution. |\n| 401 | Bad Request | Invalid IAM token was provided in the request header. |\n| 403 | Forbidden | User is not allowed to get the data profile. |\n| 404 | Not Found | The data profile specified was not found. |\n| 500 | Internal Server Error | Some runtime error occurred. |\n\n#### Update a data profile\n\nTo update a data profile for a data set in a specified catalog or project, call the following PATCH method:\n\n PATCH /v2/data_profiles/{PROFILE_ID}?catalog_id={CATALOG_ID}&dataset_id={DATASET_ID}\n\nOR\n\n PATCH /v2/data_profiles/{PROFILE_ID}?project_id={PROJECT_ID}&dataset_id={DATASET_ID}\n\nThe value of `PROFILE_ID` is the value of `metadata.guid` from the successful response payload of the create data profile call.\n\nThe JSON request payload must be as follows:\n\n```json\n\n [\n {\n \"op\": \"add\",\n \"path\": \"string\",\n \"from\": \"string\",\n \"value\": {}\n }\n ]\n```\n\nDuring update, the entire data profile is replaced, apart from any read-only or response-only attributes.\n\nIf profiling processes are running and the start parameter is set to true, then a data profile is only updated if the `stop_in_progress_runs parameter` is set to true.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n\n#### Modify asset level classification\n\nThis API is used for CRUD operations on asset level classification.\n\nTo modify the asset level classification details in the `data_profile` parameter for a data set in a specified catalog or project, call the following PATCH method:\n\n PATCH /v2/data_profiles/classification?catalog_id={CATALOG_ID}&dataset_id={DATASET_ID}\n\nOR\n\n PATCH /v2/data_profiles/classification?project_id={PROJECT_ID}&dataset_id={DATASET_ID}\n\nThe JSON request payload must be structured in the following way:\n\n```json\n [\n {\n \"op\": \"add\",\n \"path\": \"/data_classification\",\n \"value\": [\n {\n \"id\":\"{ASSET_LEVEL_CLASSIFICATION_ID}\",\n \"name\":\"{ASSET_LEVEL_CLASSIFICATION_NAME}\"\n }\n ]\n }\n ]\n```\n\nThe `path` attribute must be set to what is written in the previous JSON request payload, otherwise you will get a validation error with an HTTP status code of 400.\n\nThe values of `ASSET_LEVEL_CLASSIFICATION_ID` and `ASSET_LEVEL_CLASSIFICATION_NAME` can be: `PII` and `PII details` respectively.\n\nThe data updates must be specified by using the JSON patch format, described in RFC 6902 [https://tools.ietf.org/html/rfc6902]. For more details about JSON patch, see [http://jsonpatch.com].\n\nA successful response has an HTTP status code of 200 and lists the asset level classifications.\n\nThe following are possible response codes for this API call:\n\n| Response HTTP status | Cause | Possible Scenarios |\n| -------------------- | ----- | ----------------- |\n| 200 | Success| Asset Level Classification is added to the asset. |\n| 400 | Bad Request | The request payload either had some invalid values or invalid/unwanted parameters. |\n| 401 | Unauthorized | Invalid IAM token was provided in the request header. |\n| 403 | Forbidden | User is not allowed to add asset level classification to the asset. |\n| 500 | Internal Server Error | A runtime error occurred. |\n\n#### Delete a data profile\n\nTo delete a data profile for a data set in a specified catalog or project, call the following DELETE method:\n\n DELETE /v2/data_profiles/{PROFILE_ID}?catalog_id={CATALOG_ID}&dataset_id={DATASET_ID}&stop_in_progress_profiling_runs=false\n\nOR\n\n DELETE /v2/data_profiles/{PROFILE_ID}?project_id={PROJECT_ID}&dataset_id={DATASET_ID}&stop_in_progress_profiling_runs=true\n\nThe value of `PROFILE_ID` is the value of `metadata.guid` from the successful response payload of the create data profile call.\n\nYou can't delete a profile if the profiling execution status is in `running` state and the query parameter `stop_in_progress_profiling_runs` is set to false.\n\nA successful response has an HTTP status code of 204.\n\n## Stream Flows\n\n#### Introduction\n\nThe streams flow service provides APIs to create, update, delete, list, start, and stop stream flows.\n\nA _streams flow_ is a continuous flow of massive volumes of moving data that real-time analytics can be applied to. A streams flow can read data from a variety of sources, process that data by using analytic operations or your custom code, and then write it to one or more targets. You can access and analyze massive amounts of changing data as it is created. Regardless of whether the data is structured or unstructured, you can leverage data at scale to drive real-time analytics for up-to-the-minute business decisions.\n\nThe sources that are supported include Kafka, Message Hub, MQTT, and Watson IoT. Targets that are supported include Db2 Warehouse on Cloud, Cloud Object Storage, and Redis. Analytic operators that are supported include Aggregation, Python Machine Learning, Code, and Geofence.\n\n#### Authorization\n\nAuthorization is done via Identity Access Management (IAM) bearer token.\nAll API calls will require this Bearer token in the header.\n\n#### Create a Streams Flow\n\n##### 1. Streaming Analytics instance ID\n The streams flow is submitted to a Streaming Analytics service for compilation\n and running. When creating a flow, the Streaming Analytics instance ID must be provided.\n The instance ID can be found in the service credentials, which can be accessed from the service dashboard.\n\n##### 2. The pipeline graph\n\n The streams flow represents it's source, targets, and operations in a pipeline graph.\n The pipeline graph can be generated by choosing the relevant operators in the Streams Designer canvas.\n To retrieve a pipeline graphcreated by the Streams Designer, use:\n\n ```\n GET /v2/streams_flows/85be3e09-1c71-45d3-8d5d-220d6a6ea850?project_id=ff1ab70b-0553-409a-93f9-ccc31471c218\n ```\n\n This will return a streams flow containing a pipeline field in the entity.\n This pipeline object can be copied and submitted into another flow via:\n\n ```\n POST /v2/streams_flows/?project_id=ff1ab70b-0553-409a-93f9-ccc31471c218\n ```\n\n Request Payload:\n\n ```json\n{\n \"name\": \"My Streams Flow\",\n \"description\": \"A Sample Streams Flow.\",\n \"engines\": {\n \"streams\": {\n \"instance_id\": \"8ff81caa-1076-41ce-8de1-f4fe8d79e30e\"\n }\n },\n \"pipeline\": {\n \"doc_type\": \"pipeline\",\n \"version\": \"1.0\",\n \"json_schema\": \"http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-flow-v1-schema.json\",\n \"id\": \"\",\n \"app_data\": {\n \"ui_data\": {\n \"name\": \"mqtt 2\"\n }\n },\n \"primary_pipeline\": \"primary-pipeline\",\n \"pipelines\": [\n {\n \"id\": \"primary-pipeline\",\n \"runtime\": \"streams\",\n \"nodes\": [\n {\n \"id\": \"messagehubsample_29xse4zvabe\",\n \"type\": \"binding\",\n \"op\": \"ibm.streams.sources.messagehubsample\",\n \"outputs\": [\n {\n \"id\": \"target\",\n \"schema_ref\": \"schema0\",\n \"links\": [\n {\n \"node_id_ref\": \"mqtt_o6are9c4f\",\n \"port_id_ref\": \"source\"\n }\n ]\n }\n ],\n \"parameters\": {\n \"schema_mapping\": [\n {\n \"name\": \"time_stamp\",\n \"type\": \"timestamp\",\n \"path\": \"/time_stamp\"\n },\n {\n \"name\": \"customerId\",\n \"type\": \"double\",\n \"path\": \"/customerId\"\n },\n {\n \"name\": \"latitude\",\n \"type\": \"double\",\n \"path\": \"/latitude\"\n },\n {\n \"name\": \"longitude\",\n \"type\": \"double\",\n \"path\": \"/longitude\"\n }\n ]\n },\n \"connection\": {\n \"ref\": \"EXAMPLE_MESSAGE_HUB_CONNECTION\",\n \"project_ref\": \"EXAMPLE\",\n \"properties\": {\n \"asset\": {\n \"path\": \"/geofenceSampleData\",\n \"type\": \"topic\",\n \"name\": \"Geospatial data\",\n \"id\": \"geofenceSampleData\"\n }\n }\n },\n \"app_data\": {\n \"ui_data\": {\n \"label\": \"Sample Data\",\n \"x_pos\": 60,\n \"y_pos\": 90\n }\n }\n },\n {\n \"id\": \"mqtt_o6are9c4f\",\n \"type\": \"binding\",\n \"op\": \"ibm.streams.targets.mqtt\",\n \"parameters\": {},\n \"connection\": {\n \"ref\": \"cd5388c3-b203-4c77-803b-bc902d864a30\",\n \"project_ref\": \"a912d673-54d3-4e5c-800f-5088554d3aa8\",\n \"properties\": {\n \"asset\": \"t\"\n }\n },\n \"app_data\": {\n \"ui_data\": {\n \"label\": \"MQTT\",\n \"x_pos\": 420,\n \"y_pos\": 90\n }\n }\n },\n {\n \"id\": \"mqtt_y84zc3vfche\",\n \"type\": \"binding\",\n \"op\": \"ibm.streams.sources.mqtt\",\n \"outputs\": [\n {\n \"id\": \"target\",\n \"schema_ref\": \"schema1\",\n \"links\": [\n {\n \"node_id_ref\": \"debug_9avg3zdig25\",\n \"port_id_ref\": \"source\"\n }\n ]\n }\n ],\n \"parameters\": {\n \"schema_mapping\": [\n {\n \"name\": \"time_stamp\",\n \"type\": \"timestamp\",\n \"path\": \"/time_stamp\"\n },\n {\n \"name\": \"customerId\",\n \"type\": \"double\",\n \"path\": \"/customerId\"\n },\n {\n \"name\": \"latitude\",\n \"type\": \"double\",\n \"path\": \"/latitude\"\n },\n {\n \"name\": \"longitude\",\n \"type\": \"double\",\n \"path\": \"/longitude\"\n }\n ]\n },\n \"connection\": {\n \"ref\": \"cd5388c3-b203-4c77-803b-bc902d864a30\",\n \"project_ref\": \"a912d673-54d3-4e5c-800f-5088554d3aa8\",\n \"properties\": {\n \"asset\": \"t\"\n }\n },\n \"app_data\": {\n \"ui_data\": {\n \"label\": \"MQTT\",\n \"x_pos\": -120,\n \"y_pos\": -210\n }\n }\n },\n {\n \"id\": \"debug_9avg3zdig25\",\n \"type\": \"binding\",\n \"op\": \"ibm.streams.targets.debug\",\n \"parameters\": {},\n \"app_data\": {\n \"ui_data\": {\n \"label\": \"Debug\",\n \"x_pos\": 240,\n \"y_pos\": -270\n }\n }\n }\n ]\n }\n ],\n \"schemas\": [\n {\n \"id\": \"schema0\",\n \"fields\": [\n {\n \"name\": \"time_stamp\",\n \"type\": \"timestamp\"\n },\n {\n \"name\": \"customerId\",\n \"type\": \"double\"\n },\n {\n \"name\": \"latitude\",\n \"type\": \"double\"\n },\n {\n \"name\": \"longitude\",\n \"type\": \"double\"\n }\n ]\n },\n {\n \"id\": \"schema1\",\n \"fields\": [\n {\n \"name\": \"time_stamp\",\n \"type\": \"timestamp\"\n },\n {\n \"name\": \"customerId\",\n \"type\": \"double\"\n },\n {\n \"name\": \"latitude\",\n \"type\": \"double\"\n },\n {\n \"name\": \"longitude\",\n \"type\": \"double\"\n }\n ]\n }\n ]\n }\n}\n ```\n\n#### Streams Flow Lifecycle\n\nAfter a Streams Flow is created it will be in the STOPPED state unless it's been submitted as a job to be started.\nWhen starting a job, a Cloudant asset is created to track the\nstatus of the streams flow run. The start job operation can take up to minute to complete,\nduring which time the streams flow will be in the STARTING state. Once the submission and compilation has\ncompleted, the streams flow will be in the RUNNING state.\n\nTo change the run state use the POST api:\n\n ```\n POST /v2/streams_flows/85be3e09-1c71-45d3-8d5d-220d6a6ea850/runs?project_id=ff1ab70b-0553-409a-93f9-ccc31471c218\n ```\n\nRequest Payload:\n\n```json\n{\n \"state\": \"started\",\n \"allow_streams_start\": true\n}\n```\n\n- For starting the streams flow run, use { state: started }. To stop the flows run, use\n{ state: stopped }.\n\n- Specify \"allow_streams_start\" to start the Streaming Analytics service in the event that it is stopped.\n\nThe start job operation triggers a long running process on the Streaming Analytics service instance.\nDuring this time the progress/status of this job can be viewed:\n\n```\nGET https://api.dataplatform.cloud.ibm.com/v2/streams_flows/85be3e09-1c71-45d3-8d5d-220d6a6ea850/runs?project_id=ff1ab70b-0553-409a-93f9-ccc31471c218\n```\n\nA version of the pipeline that has been deployed is saved to represent the Runtime Pipeline.\nThe streams flow can still be edited in the Streams Designer, and it will not have an impact on the Runtime Pipeline that has\nbeen deployed, until the user stops the running flow, and starts it again..\n\n## Metadata Discovery\n\n1. [Introduction](#Section_Metadata_Discovery__Introduction)\n2. [Create a Metadata Discovery run](#Section_Metadata_Discovery__POST_data_discoveries)\n3. [Monitor the status of a Metadata Discovery run](#Section_Metadata_Discovery__Monitoring_a_Metadata_Discovery_run)\n4. [Retrieve Discovered asset Metadata](#Section_Metadata_Discovery__Retrieving_Discovered_assets)\n5. [Retrieve the ID of a Metadata Discovery run](#Section_Metadata_Discovery__Get_ID_of_Discovery_Run)\n6. [Abort a Metadata Discovery run](#Section_Metadata_Discovery__Abort_Discovery_Run)\n\n\n\nMetadata Discovery can be used to automatically discover assets from a connection. The connection used for a discovery run can be associated with a catalog or project, but new data assets will be created in a project. Each asset that is discovered from a connection is added as a data asset to the project.\n\nFor a list of the supported types of connections against which the Metadata Discovery service can be invoked, see [Discover data assets from a connection](https://dataplatform.ibm.com/docs/content/catalog/discover-assets.html?audience=dc&context=data).\n\n\n\nIn general, the discovery process takes a significant amount of time. Therefore, the API to create a discovery run actually only queues a discovery run and then returns immediately (typically before the discovery run is even started). Subsequent calls to different APIs can then be made to monitor the progress of the discovery run (see [Monitoring a metadata discovery run](#Section_Metadata_Discovery__Monitoring_a_Metadata_Discovery_run) and [Retrieving discovered assets](#Section_Metadata_Discovery__Retrieving_Discovered_assets)).\n\nThe following example shows a request to create a metadata discovery run. It assumes that a project, a connection, and a catalog have already been created, and that their IDs are known by the caller. If a catalog is provided (as in the following example), the connection is associated with the catalog. If no catalog is provided, the connection is associated with the project.\n\nNote: In the following examples, the discovered assets are found in a connection to a DB2 database, but the details of the database are hidden within the connection. So, the caller of the `data_discoveries` API specifies the database to discover *indirectly* via the connection.\n\n#### API request - Create discovery run: ####\n\n```\nPOST /v2/data_discoveries\n```\n\nRequest payload:\n\n```json\n{\n \"entity\": {\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n}\n```\n\nIn the example request payload, you can see the ID of the connection whose assets will be discovered, and the ID of the project into which the newly created assets will be added.\n\n\nResponse payload:\n\n```json\n{\n \"metadata\": {\n \"id\": \"dcb8a234ad5e438d904a4cdbe0ba70e2\",\n \"invoked_by\": \"IBMid-50S...\",\n \"bss_account_id\": \"e348e...\",\n \"created_at\": \"2018-06-22T15:42:02.843Z\"\n },\n \"entity\": {\n \"status\": \"CREATED\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n}\n```\n\nIn the response, you can see that the discovery run was created with the ID `dcb8a234ad5e438d904a4cdbe0ba70e2`, which you'll need to use if you want to get the status of the discovery run that you just created. Also shown in the response is:\n\n - `invoked_by`: the IAM ID of the account that kicked off the discovery process\n - `bss_account_id`: the BSS account ID of the catalog\n - `created_at`: the creation date and time of the discovery job\n\n\n\nTo get the status of a discovery run use the `GET data_discoveries` API. You can request the status of a discovery run as often as desired. In the following sections, you will be shown a few such calls to illustrate the progression of a discovery run.\n\n#### API Request - Get status of discovery run: ####\n\n```\nGET /v2/data_discoveries/dcb8a234ad5e438d904a4cdbe0ba70e2\n```\n\nThere is no request payload for the previous `GET data_discoveries` request. Instead, the ID of the discovery run whose status is being requested is supplied as a path parameter. In the previous URL, use the discovery run ID that was returned by the earlier call to `POST data_discoveries`. If you no longer have access to the ID of the discovery run for which you want to see status information, see the section [Call Discovery API to get the ID of a metadata discovery run](#Section_Metadata_Discovery__Get_ID_of_Discovery_Run).\n\nThe following examples show various responses to the same `GET data_discoveries` monitor request previously shown, made at various points during the discovery run.\n\n#### Response to status request immediately after creation of a discovery run: ####\n\n```json\n{\n \"metadata\": {\n \"id\": \"dcb8a234ad5e438d904a4cdbe0ba70e2\",\n \"invoked_by\": \"IBMid-50S...\",\n \"bss_account_id\": \"e348e...\",\n \"created_at\": \"2018-06-22T15:42:02.843Z\"\n },\n \"entity\": {\n \"status\": \"CREATED\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n}\n```\n\nIn the previous response, you can see that the status of the discovery run has not yet changed - it is still `CREATED`. This is because the request to discover assets is put into a queue and will be initiated in the order in which it was received.\n\n#### Response to status request immediately after a discovery run has actually started: ####\n\n```json\n{\n \"metadata\": {\n \"id\": \"dcb8a234ad5e438d904a4cdbe0ba70e2\",\n \"invoked_by\": \"IBMid-50S...\",\n \"bss_account_id\": \"e348e...\",\n \"created_at\": \"2018-06-22T15:42:02.843Z\",\n \"started_at\": \"2018-06-22T15:42:06.167Z\",\n \"ref_project_connection_id\": \"2526ed95-dedd-4904-bb31-c06d9cb1e105\"\n },\n \"entity\": {\n \"statistics\": {\n\n },\n \"status\": \"RUNNING\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n}\n```\n\nNow notice that the `status` has changed to `RUNNING` which indicates that the discovery process has actually started. Also, the `metadata` field has some additional fields added to it:\n\n - `started_at`: the date and time at which the discovery run started\n - `ref_project_connection_id`: a reference to a cloned project connection ID, internally set when a discovery is created for a connection in a catalog\n\nIn addition, notice that a new `statistics` object was introduced into the response body. In the response, that object is empty because the discovery run, which has just started hasn't yet discovered any assets.\n\n#### Response to status request after some assets were discovered: ####\n\n```json\n{\n \"metadata\": {\n \"id\": \"dcb8a234ad5e438d904a4cdbe0ba70e2\",\n \"invoked_by\": \"IBMid-50S...\",\n \"bss_account_id\": \"e348e...\",\n \"created_at\": \"2018-06-22T15:42:02.843Z\",\n \"started_at\": \"2018-06-22T15:42:06.167Z\",\n \"discovered_at\": \"2018-06-22T15:42:27.970Z\",\n \"ref_project_connection_id\": \"2526ed95-dedd-4904-bb31-c06d9cb1e105\"\n },\n \"entity\": {\n \"statistics\": {\n \"discovered\": 128,\n \"submit_succ\": 128\n },\n \"status\": \"RUNNING\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n}\n```\n\nNotice the `statistics` object now contains two fields:\n\n - `discovered`: the number of assets discovered so far during the discovery run\n - `submit_succ`: the number of assets successfully submitted for creation so far during the discovery run. A discovered asset goes through an internal pipeline with various stages from being *discovered* at the connection to being *created* in the project. Here, *submitted* means the asset was submitted to the internal pipeline.\n\nRefer to [Watson Data API schema](https://api.dataplatform.ibm.com/schemas/swagger.json) for the complete list of the possible fields that might show up in the `statistics` object.\n\nBecause the discovery run isn't yet finished, the `status` in the previous response is still `RUNNING`.\n\n#### Response to status request after the discovery run was completed: ####\n\n```json\n{\n \"metadata\": {\n \"id\": \"dcb8a234ad5e438d904a4cdbe0ba70e2\",\n \"invoked_by\": \"IBMid-50S...\",\n \"bss_account_id\": \"e348e...\",\n \"created_at\": \"2018-06-22T15:42:02.843Z\",\n \"started_at\": \"2018-06-22T15:42:06.167Z\",\n \"discovered_at\": \"2018-06-22T15:42:27.970Z\",\n \"processed_at\": \"2018-06-22T15:42:45.877Z\",\n \"finished_at\": \"2018-06-22T15:43:14.969Z\",\n \"ref_project_connection_id\": \"2526ed95-dedd-4904-bb31-c06d9cb1e105\"\n },\n \"entity\": {\n \"statistics\": {\n \"discovered\": 179,\n \"submit_succ\": 179,\n \"create_succ\": 179\n },\n \"status\": \"COMPLETED\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n}\n```\n\nNotice the `status` field has changed to `COMPLETED` to indicate that the discovery run is finished. Other response fields to note:\n\n - `finished_at`: the date and time at which the discovery run finished\n - `discovered`: indicates that 179 assets were discovered at the connection\n - `submit_succ`: indicates that 179 of the discovered assets were successfully submitted to the discovery run's internal asset processing pipeline.\n - `create_succ`: indicates that 179 assets were successfully created in the project\n\n\n\nAt any time during or after a discovery run, you call Asset APIs to get the list of metadata for the currently discovered assets in the project. To retrieve metadata for any list of assets you can make the following call:\n\n```\nPOST /v2/asset_types/{type_name}/search?project_id={project_id}\n```\n\nMore specifically, to find the metadata for *discovered* assets the value to use for the `{type_name}` path parameter is `discovered_asset`. So, for the discovery run we created, the call to retrieve metadata for the discovered assets would look like this:\n\n#### API Request - Get metadata for discovered assets: ####\n\n```\nPOST /v2/asset_types/discovered_asset/search?project_id=960f6aff-295f-4de1-a9d7-f3b6805b3590\n```\n\nwhere the `project_id` query parameter value `960f6aff-295f-4de1-a9d7-f3b6805b3590` is the same value that was specified in the body of the POST request that was used to create the discovery run.\n\nIn addition, the ID of the connection that the discovery was run against has to be specified in the body of the POST, like this:\n\n```json\n{\n \"query\": \"discovered_asset.connection_id:\\\"f638398f-fcc7-4856-b78d-5c8efa5b9282\\\"\"\n}\n```\n\nHere is part of the response body for the previous query:\n\n```\n{\n \"total_rows\": 179,\n \"results\": [\n {\n \"metadata\": {\n \"name\": \"EMP_SURVEY_TOPIC_DIM\",\n \"description\": \"Warehouse table EMP_SURVEY_TOPIC_DIM describes employee survey questions for employees of the Great Outdoors Company, in supported languages.\",\n \"tags\": [\n \"discovered\",\n \"GOSALESDW\"\n ],\n \"asset_type\": \"data_asset\",\n \"origin_country\": \"ca\",\n \"rating\": 0.0,\n \"total_ratings\": 0,\n \"sandbox_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\",\n \"catalog_id\": \"a682c698-6019-437d-a0b9-224aa0a4dbc9\",\n \"created\": 0,\n \"created_at\": \"2018-06-22T15:41:47Z\",\n \"owner\": \"abc123@us.ibm.com\",\n \"owner_id\": \"IBMid-50S...\",\n \"size\": 0,\n \"version\": 0.0,\n \"usage\": {\n \"last_update_time\": 1.52968210955E12,\n \"last_updater_id\": \"iam-ServiceId-87f49...\",\n \"access_count\": 0.0,\n \"last_accessor_id\": \"iam-ServiceId-87f49...\",\n \"last_access_time\": 1.52968210955E12,\n \"last_updater\": \"ServiceId-87f49...\",\n \"last_accessor\": \"ServiceId-87f49...\"\n },\n \"asset_state\": \"available\",\n \"asset_attributes\": [\n \"data_asset\",\n \"discovered_asset\"\n ],\n \"rov\": {\n \"mode\": 0\n },\n \"asset_category\": \"USER\",\n \"asset_id\": \"e35cfd4d-590f-40a5-b75c-ec07c0a4bcbc\"\n }\n },\n ...\n ]\n}\n```\n\nNotice that the `total_rows` value 179 matches the `create_succ` value that was returned in the result of the API call to get the final status of the completed discovery run.\n\nThe `results` array in the previous response body has an entry containing metadata for each asset that was discovered by the discovery run. In the previous code snippet, for brevity, only 2 of the 179 entries are shown. The metadata created by the discovery run includes:\n\n - `name`: in this case, the name of the DB2 table that was discovered\n - `description`: a description of the table as provided by DB2\n - `tags`: these are useful for searching. The `discovered` tag is one of the tags set for a discovered asset.\n - `asset_type`: the type of the asset that was created in the project\n\nEach entry in the `results` array also contains an `href` field that points to the actual asset that was created by the discovery run.\n\n\n\nThere might be times in which you no longer have the ID of the metadata discovery run whose status you're interested in, and so might not be able to call the following API for the specific discovery run you're interested in (which requires that ID):\n\n```\nGET /v2/data_discoveries/dcb8a234ad5e438d904a4cdbe0ba70e2\n```\n\nThe following example illustrates how to get the IDs of metadata discovery runs for the connection and catalog that were used in the previous call to create a discovery run:\n\n#### API Request - Get information for discovery runs: ####\n\n```\nGET /v2/data_discoveries?offset=0&limit=1000&connection_id=f638398f-fcc7-4856-b78d-5c8efa5b9282&catalog_id=816882fa-dcda-46e1-8c6b-fa23c3cbad14\n```\n\nNote that the values of the query parameters `connection_id` and `catalog_id` correspond to the values for the identically named fields in the payload for the previous request to [create a discovery run](#Section_Metadata_Discovery__POST_data_discoveries).\n\nNotice also that you can use the `offset` and `limit` query parameters to focus on a particular subset of the full list of related discoveries.\n\nThe response payload will look like this:\n\n```json\n{\n \"resources\": [\n {\n \"metadata\": {\n \"id\": \"dcb8a234ad5e438d904a4cdbe0ba70e2\",\n \"invoked_by\": \"IBMid-50S...\",\n \"bss_account_id\": \"e348e...\",\n \"created_at\": \"2018-06-22T15:42:02.843Z\",\n \"started_at\": \"2018-06-22T15:42:06.167Z\",\n \"discovered_at\": \"2018-06-22T15:42:27.970Z\",\n \"processed_at\": \"2018-06-22T15:42:45.877Z\",\n \"finished_at\": \"2018-06-22T15:43:14.969Z\",\n \"ref_project_connection_id\": \"2526ed95-dedd-4904-bb31-c06d9cb1e105\"\n },\n \"entity\": {\n \"statistics\": {\n \"discovered\": 179,\n \"submit_succ\": 179,\n \"create_succ\": 179\n },\n \"status\": \"COMPLETED\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n }\n ],\n \"first\": {\n \"href\": \"http://localhost:9080/v2/data_discoveries?offset=0&limit=1000&connection_id=f638398f-fcc7-4856-b78d-5c8efa5b9282&catalog_id=816882fa-dcda-46e1-8c6b-fa23c3cbad14\"\n },\n \"next\": {\n \"href\": \"http://localhost:9080/v2/data_discoveries?offset=1000&limit=1000&connection_id=f638398f-fcc7-4856-b78d-5c8efa5b9282&catalog_id=816882fa-dcda-46e1-8c6b-fa23c3cbad14\"\n },\n \"limit\": 1000,\n \"offset\": 0\n}\n```\n\nAnything that is found because it matches the query criteria is returned in the `resources` array. In the previous response, there is only one entry and it corresponds to the discovery run which was created in the previous [Create a metadata discovery run](#Section_Metadata_Discovery__POST_data_discoveries) section.\n\n\n\nThere might be times when you want to stop a discovery run before it's completed. To do so, use the `PATCH data_discoveries` API. The following illustrates how to abort a discovery run (a different discovery run than the one used in the previous examples):\n\n#### API Request - Abort a discovery run: ####\n\n```\nPATCH /v2/data_discoveries/09cbff0981f84c51be4b4d93becc17b0\n```\n\nThe previous PATCH request requires the following request body to set the `status` of the discovery run to \"ABORTED\":\n\n```json\n{\n \"op\": \"replace\",\n \"path\": \"/entity/status\",\n \"value\": \"ABORTED\"\n}\n```\n\nThe response payload will look like this:\n\n```json\n{\n \"metadata\": {\n \"id\": \"09cbff0981f84c51be4b4d93becc17b0\",\n \"invoked_by\": \"IBMid-50S...\",\n \"bss_account_id\": \"e348e...\",\n \"created_at\": \"2018-06-22T15:45:54.638Z\",\n \"started_at\": \"2018-06-22T15:45:56.202Z\",\n \"finished_at\": \"2018-06-22T15:46:02.274Z\",\n \"ref_project_connection_id\": \"2526ed95-dedd-4904-bb31-c06d9cb1e105\"\n },\n \"entity\": {\n \"statistics\": {\n\n },\n \"status\": \"ABORTED\",\n \"connection_id\": \"f638398f-fcc7-4856-b78d-5c8efa5b9282\",\n \"catalog_id\": \"816882fa-dcda-46e1-8c6b-fa23c3cbad14\",\n \"project_id\": \"960f6aff-295f-4de1-a9d7-f3b6805b3590\"\n }\n}\n```\n\nNotice in the previous response payload that the `status` has now been set to `ABORTED`.\n\nAny assets discovered before the run was aborted will remain discovered. In the example, the abort occurred so quickly after the creation of the discovery run that no assets had been discovered, hence the `statistics` object is empty.\n\n## Lineage\n\n#### Introduction\nThe lineage of an asset includes information about all events, and other assets, that have led to its current state and its further usage. Asset and Event are the two main entities that are part of the lineage data model. An asset can either be generated from or used in subsequent events. An event can be any of:\n* asset-generation-events\n* asset-modification-events\n* asset-usage-events.\n\nUse the Lineage API to publish events on an asset or to query the lineage of an asset.\n\n##### Publish a lineage event\n\nThe following example shows a sample lineage event that can be posted when a data set is published from a project to a catalog:\n\n##### Request URL\n```\nPOST /v2/lineage_events\n```\n\n##### Request Body\n```json\n{\n \"message_version\": \"v1\",\n\n \"user_id\": \"IAM-Id_of_User\",\n \"account_id\": \"e86f2b06b0b267d559e7c387ceefb089\",\n\n \"event_details\": {\n \"event_id\": \"sample-event1\",\n \"event_type\": \"DATASET_PUBLISHED\",\n \"event_category\": [\n \"additions\"\n ],\n \"event_time\": \"2018-04-03T14:01:08.603Z\",\n \"event_source_service\": \"Watson Knowledge Catalog\"\n },\n\n \"generates_assets\": [\n {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset03\",\n \"asset_type\": \"DataSet\",\n \"relation\": {\n \"name\": \"Created\"\n },\n\n \"properties\": {\n \"dataset\": {\n \"type\": \"dataset\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset03\",\n \"name\": \"Asset Name in Catalog XX\",\n \"catalog_id\": \"9f9c961a-78d1-4c06-a601-4b589catalog\"\n }\n },\n \"catalog\": {\n \"type\": \"catalog\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b589catalog\"\n }\n }\n }\n }\n ],\n \"uses_assets\": [\n {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset02\",\n \"asset_type\": \"DataSet\",\n \"relation\": {\n \"name\": \"Used\"\n },\n\n \"properties\": {\n \"dataset\": {\n \"type\": \"dataset\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset02\",\n \"name\": \"2017_sales_data\",\n \"project_id\": \"9f9c961a-78d1-4c06-a601-4b589project\"\n }\n },\n \"project\": {\n \"type\": \"project\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b589project\"\n }\n }\n }\n }\n ]\n}\n```\n\n#### Response Body\n```json\n{\n \"metadata\": {\n \"id\": \"01014d1f-31cf-4956-bd41-7a77ba14004c\",\n \"source_event_id\": \"sample-event1\"\n }\n}\n```\n\nThe _id_ generated in the response can be used to query the details of the published event with the following request:\n\n##### Request URL\n```\nGET v2/lineage_events/01014d1f-31cf-4956-bd41-7a77ba14004c\n```\n\nFor more details on each field in the lineage event JSON payload, refer to the _Lineage_ _Events_ section of [API documentation](https://developer.ibm.com/api/view/watsondata-prod:watson-data:title-Watson_Data_API#doc).\n\n#### Query lineage of an asset\n\nThe lineage of an asset involved in the sample event can be queried using the following request:\n\n##### Request URL\n```\nGET v2/asset_lineages/9f9c961a-78d1-4c06-a601-4b5890fdataset03\n```\n\n#### Response Body\n```json\n{\n \"resources\": [\n {\n \"metadata\": {\n \"id\": \"01014d1f-31cf-4956-bd41-7a77ba14004c\",\n \"source_event_id\": \"sample-event1\",\n \"created_at\": \"2018-04-03T14:01:08.603Z\",\n \"created_by\": \"IAM-Id_of_User\"\n },\n \"entity\": {\n \"type\": \"DATASET_PUBLISHED\",\n \"generates_assets\": [\n {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset03\",\n \"type\": \"DataSet\",\n \"relation\": {\n \"name\": \"Created\"\n },\n \"properties\": {\n \"catalog\": {\n \"type\": \"catalog\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b589catalog\"\n }\n },\n \"dataset\": {\n \"type\": \"dataset\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset03\",\n \"name\": \"Asset Name in Catalog XX\",\n \"catalog_id\": \"9f9c961a-78d1-4c06-a601-4b589catalog\"\n }\n }\n }\n }\n ],\n \"uses_assets\": [\n {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset02\",\n \"type\": \"DataSet\",\n \"relation\": {\n \"name\": \"Used\"\n },\n \"properties\": {\n \"dataset\": {\n \"type\": \"dataset\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b5890fdataset02\",\n \"name\": \"2017_sales_data\",\n \"project_id\": \"9f9c961a-78d1-4c06-a601-4b589project\"\n }\n },\n \"project\": {\n \"type\": \"project\",\n \"value\": {\n \"id\": \"9f9c961a-78d1-4c06-a601-4b589project\"\n }\n }\n }\n }\n ],\n \"properties\": {\n \"event_time\": \"2018-04-03T14:01:08.603Z\",\n \"event_category\": [\n \"additions\"\n ],\n \"event_source_service\": \"Watson Knowledge Catalog\"\n }\n }\n }\n ],\n \"limit\": 50,\n \"offset\": 0,\n \"first\": {\n \"href\": \"https://api.dataplatform.cloud.ibm.com/v2/asset_lineages/9f9c961a-78d1-4c06-a601-4b5890fdataset03?offset=0&_=1528182675331\"\n }\n}\n```\n\n## Searching\n### Searching in Global Search\nThe Global Search API comes in two flavours: [Simple](https://cloud.ibm.com/apidocs/watson-data-api#simplesearch) and [Advanced](https://cloud.ibm.com/apidocs/watson-data-api#search).\n### Simple Query\nThe simple query can be invoked like this:\n\n```\nGET /v3/search?query='fred flintstone'&limit=100\n```\n\nWith the simple query you can peform simple textual searches using the [Lucene](https://lucene.apache.org/core/2_9_4/queryparsersyntax.html) syntax. The above query will return items containing _fred_, _flintstone_, or both.\n\n### Advanced Query\nYou can use the Global Search api to issue queries using the full capabilities of the [Elasticsearch Query Language](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) to search for Catalog assets and Governance artifacts. For details on the structure of an item indexed in global search see [below](#Documents-in-Global-Search). The advanced query can look something like this:\n\n```json\nPOST /v3/search -d '\n{\n \"_source\":[\"provider_type_id\", \"artifact_id\", \"metadata.name\"],\n \"query\": {\n \"query_string\" : { \"query\" : \"flintstone\" }\n }\n}'\n```\n\nThe above query returns any items containg the string \"flintstone\".\n\n### Searching with authorization cache\nGlobal search searches across the Cloud Pak for Data platform and restricts search results to content that a user is authorized to view. For faster search results, you can use cached authorization information by setting the `auth_cache` parameter to `true`. The `auth_cache` parameter is set to `false` by default to use the most current authorization information.\n\nA simple query using cached authorization information:\n```json\nGET /v3/search?query='fred flintstone'&limit=100&auth_cache=true\n```\n\nAn advanced query using cached authorization information:\n```json\nPOST /v3/search?auth_cache=true -d '\n{\n \"_source\":[\"provider_type_id\", \"artifact_id\", \"metadata.name\"],\n \"query\": {\n \"query_string\" : { \"query\" : \"flintstone\" }\n }\n}'\n```\n\n### Searching with limited authorization scope\nGlobal Search searches across the Cloud Pak for Data platform. For a faster search, you can limit your search scope to certain platform components using the `auth_scope` parameter.\nFor example, to limit the scope of your search to assets within catalogs, you can use `auth_scope=catalog`, or to limit your search to assets within projects, you can use `auth_scope=project`.\nValid values for the `auth_scope` parameter are `catalog`, `project`, `space`, `category`, `ibm_watsonx_governance_catalog`, `ibm_data_product_catalog` and `all` (default). Note that only a single value can be provided.\n\nA simple query limiting the scope of the search to catalog only:\n```json\nGET /v3/search?query='fred flintstone'&limit=100&auth_scope=catalog\n```\n\nAn advanced query limiting the scope of the search to catalogs only:\n\n```json\nPOST /v3/search?auth_scope=catalog -d '\n{\n \"_source\":[\"provider_type_id\", \"artifact_id\", \"metadata.name\"],\n \"query\": {\n \"query_string\" : { \"query\" : \"flintstone\" }\n }\n}'\n\n### Searching for terms in specific fields\nThe above query searched for the word `flintstone` anywhere in an indexed artifact. You can specify which fields to search in, instead of searching throughout the document using the following example:\n\n```json\n{\n \"_source\":[\"provider_type_id\", \"artifact_id\", \"metadata.name\"],\n \"query\": {\n \"match\" : { \"metadata.name\" : \"flintstone\" }\n }\n}\n```\n\nIn the above example, the query is searching for the term `flintstone` but only in the `metadata.name` field.\n\n### Key-Value Search\n\nUse key-value pairs to restrict search within specific properties such as the name, description, tags, column names, terms, custom properties and more\n* `key:value` : This matches `value` in the key property.\n* `key:\"value here\"` : This matches `value here` in the key property. Quoted value is treated as a whole phrase.\n* `key1:value1 key2:value2 key3:value3` : Multiple key value pairs implies an AND between all pairs. The above matches (`value1` in the `key1` property) AND (`value2` in the `key2` property) AND (`value3` in the `key3` property).\n* `text before key1:value1 in-between key2:value2 key3:value3 after`: Key-value pairs mixed with regular strings. The above matches (`text` OR `before` OR `in-between` OR `after` in any property) AND (`value1` in the `key1` property) AND (`value2` in the `key2` property) AND (`value3` in the `key3` property)\n\nThe following properties can be specified as the key.\n```\nname: Search within the name of an asset or artifact\ndesc: Search within the description of an asset or artifact\ntype: Search by the type of an asset (asset_type) or artifact (artifact_type)\nowner: Search by the user ID of the owner of an asset\nterm: Search in assets and artifacts with the specified business term assigned\ntag: Search in assets and artifacts with the specified tag\ncategory: Search for artifacts with the specified primary category\ncategory2: Search for artifacts with the specified secondary category\nabbr: Search by the abbreviation of a business term\nsyn: Search by the synonym of a business term\nclassification: Search by the classification of an asset or artifact\ncolumn: Search with the name of a column in a data asset\ncolumnDesc: Search within the description of a column in a data asset\ncolumnTerm: Search with a business term assigned to a column in a data asset\ncolumnTag: Search with a tag on a column in a data asset\ncolumnDataclass:Search with a data class of a column in a data asset\ncolumnClassification: Search with a classification on a column in a data asset\nconnection: Search with a connection path of an asset\nschema: Search for data assets with the specified schema name\ntable: Search for data assets with the specified table name\nresourceKey: Search with a resource key of an asset\nsteward: Search by the user ID of the steward of an artifact\n```\nGlobal Search searchable custom attribute names can also be used as a key to restrict search to the specified custom attribute.\n\n### Restrictions for keys:\nFor key-value search by `type:`, the value must be an `asset_type` such as `data_asset` (as referenced by `GET /v2/asset_types`) or `artifact_type` such as `data_class` (as referenced by `GET /v3/governance_artifact_types`). The value is case-sensitive.\n\nFor key-value search by `owner:` or `steward:`, the value must be the user ID and not the user name or display name. The value is case-sensitive.\n\n### Sample query to restrict search to few properties\n```\n{\n \"query\":{\n \"bool\":{\n \"must\":[\n {\n \"gs_user_query\":{\n \"search_string\":\" name:job tag:Toronto\",\n \"nlq_analyzer_enabled\": true}\n }\n ]\n }\n }\n}\n```\nIn this sample query, we want to query on any asset or artifact having `job` in the name property AND `Toronto` in the tags property.\n\n### Sample query to restrict search to a custom attribute\n```\n{\n \"query\":{\n \"bool\":{\n\t “must”:[\n \"nested\": {\n \"path\": \"custom_attributes\",\n \"query\": {\n \"gs_user_query\":{\n “search_string” : \"book.author.last_name:Smith”,\n \"nlq_analyzer_enabled\": true,\n \"nested\": true\n }\n }\n }\n ]\n }\n}\n```\nIn this sample query, we want to query on assets of type `book`, having a Global Search searchable (`\"global_search_searchable\"`) field called `author.last_name` with a value of `Smith`.\n\n### Sorting your queries\nBy default, Global Search will sort the search results based on their search score. The more relevant an item is to your search terms, the higher its score. You can override that by sorting your search results based on fields in the indexed item.\n\n### Sample Query with Sort\n```json\n{\n \"_source\":[\"provider_type_id\", \"artifact_id\", \"metadata.name\"],\n \"query\": {\n \"query_string\" : {\n \"query\" : \"flintstone\"\n }\n },\n \"sort\": [\n {\"metadata.modified_on\": {\"order\": \"desc\",\"unmapped_type\": \"date\"}}\n ]\n\n}\n```\nThe above query will sort the search results based on the date the item was modified.\n\n### Getting Counts of Things\nIn addition to querying, you can use the Query Language to get counts of terms that occur in indexed items. For example you might want the top ten words that people add to the `tags` field of their assets or artifacts.\n\n### Sample Query with Aggregation\nHere is a sample query of a search for the word `flintstone` with an aggregation (a count) of the words that people put in their `tags` fields and their `terms` fields. See the [below](#Documents-in-Global-Search) for the fields that exist documents indexed in Global Search.\n\n```json\n{\n \"query\": {\n \"query_string\" : {\n \"query\" : \"flintstone\"\n }\n },\n \"aggregations\" : {\n \"num_tags\" : {\"terms\" : { \"field\" : \"metadata.tags.keyword\" }},\n \"num_terms\" : {\"terms\" : { \"field\" : \"metadata.terms.keyword\" }}\n }\n}\n```\n\n### Nested Queries and Custom Attributes\nYou can add any number of custom attributes to an item you index with Global Search, and each custom attribute consists of combinations of a `name` field, and a `value` field.\n```json\n \"custom_attributes\": [\n {\n \"last_updated_at\": 0,\n \"attribute_name\": \"string\",\n \"attribute_value\": \"string\"\n }\n ]\n```\n\nBecause custom attributes _normally_ consist of two fields acting as one, they are _nested objects_ and you must use _nested queries_ to query on those nested objects.\n\nThe custom_attributes fields will be included in the response for any result which has custom_attributes. Nested queries are only required to query properties of the custom_attributes, such as custom_attributes.attribute_name or custom_attributes.attribute_value.\n\n### Sample Nested Query\nIn this sample query, we want to query on any asset having a custom attribute named `city` having a value of `ottawa`, and a second custom attribute named `colour` having a value `red`. In this example, the `city` attribute is treated as a text field, while the `colour` attribute will simulate an enumerated list of colours having exact values (i.e. red, blue, green, etc).\n\n```json\n{\n \"_source\":[\"metadata.name\", \"custom_attributes\"],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"nested\": {\n \"path\": \"custom_attributes\",\n \"query\": {\n \"bool\": {\n \"must\": [\n {\"term\": {\"custom_attributes.attribute_name\": \"city\"}},\n {\"match\": {\"custom_attributes.attribute_value\": \"Ottawa\"}}\n ]\n }\n }\n }\n },\n {\n \"nested\": {\n \"path\": \"custom_attributes\",\n \"query\": {\n \"bool\": {\n \"must\": [\n {\"term\": {\"custom_attributes.attribute_name\": \"colour\"}},\n {\"term\": {\"custom_attributes.attribute_value.keyword\": \"red\"}}\n ]\n }\n }\n }\n }\n ]\n }\n },\n \"aggs\": {\n \"custom_attr_count\": {\n \"nested\": {\n \"path\": \"custom_attributes\"\n },\n \"aggs\": {\n \"city_count\": {\n \"filter\": {\n \"term\": {\"custom_attributes.attribute_name\": \"city\"}\n },\n \"aggs\": {\n \"city_count\": {\n \"terms\": {\n \"field\": \"custom_attributes.attribute_value.keyword\",\n \"size\": 20\n }\n }\n }\n }\n }\n }\n }\n}\n```\n\nIn the query body illustrated above, there's a query portion, and an aggregations (aggs) portion. There can be any number of custom attributes. Because we only want counts of `city` we must include a `filter` in the aggregation so that only attributes whose name is `city` are counted. Notice that the count is returned for `custom_attribute.attribute_value.keyword`, not `custom_attribute.attribute_value`. This is important to note. You cannot sort or aggregate on `text` fields. You can only do so on `keyword` fields. Every text field in global search has a corresponding keyword field with a `.keyword` extension. Use the `.keyword` field for things you want to count or sort on. Finally, the `size` parameter restricts the number of counts to return to the top 20.\n\n**Caution**\nThe key-value search is not supported inside a nested clause.\n\n### General Purpose Search Function\n\nGlobal Search provides a general purpose search function that is tailored to the requirements of CloudPak For Data users. You can invoke it using Global Search's Advanced API (see the Methods section below). It is this function that CloudPak for Data uses when a user enters a search term at the top search bar of the CloudPak for Data _user interface_. You can invoke it anywhere you would normally invoke a normal ElasticSearch search function. For example it can be the main function of your query:\n\n```json\n{\n \"query\":{\n \"gs_user_query\":{\n \"search_string\":\"The quick red fox jumped over the lazy brown dog\"\n }\n }\n}\n```\n\nThe `search_string` field is required and specifies the search query string.\n\nThe following optional parameters can be specified as part of the `gs_user_query`:\n- `search_fields` - List of fields that the search will be restricted to. If not specified, the search will run across all fields in the configuration.\n- `nlq_analyzer_enabled` - Specify `true` to enable the natural language analyzer. The default value is `false`.\n- `semantic_expansion_enabled` - Specify `true` to enable semantic query expansion. The default value is `false`.\n- `nested` - Specify `true` to optimize nested queries. The default value is `false`.\n\n```json\n{\n \"query\":{\n \"gs_user_query\":{\n \"search_string\": \"The quick red fox jumped over the lazy brown dog\",\n \"search_fields\": [\"metadata.name\", \"metadata.description\"],\n \"nlq_analyzer_enabled\": true,\n \"semantic_expansion_enabled\": true,\n \"nested\": false\n }\n }\n}\n```\n\nThis search function will find:\n1. a single phrase\n2. multiple individual words\n3. partial words (within words or at the beginning of words)\n4. the first letter of a word\n\nIf no search fields are specified, the function will search the entire document, including the `name` fields, the `description` field, `tags`, `synonyms`, `custom attribute values`, `column names`, and `column descriptions`, etc. It will give the highest priority to the **name** field of the document.\n\nYou can embed `gs_user_query` within a compound query:\n\n```json\n{\n \"query\":{\n \"bool\":{\n \"must\":[\n {\"gs_user_query\":{\"search_string\": \"the quick red fox jumped over the lazy brown dog\"}}\n ],\n \"filter\":[\n {\"term\":{\"provider_type_id\":\"cams\"}}\n ]\n }\n },\n \"sort\": [\n {\"metadata.modified_on\": {\"order\": \"desc\",\"unmapped_type\": \"date\"}}\n ]\n}\n```\n\nYou can include `gs_user_query` with complex queries that include aggregations along with sorts:\n\n```json\n{\n \"query\": {\n \"gs_user_query\" : {\n \"search_string\": \"fred flintstone\"\n }\n },\n \"sort\" : [\n {\"metadata.modified_on\": {\"order\": \"desc\", \"unmapped_type\": \"date\"}}\n ],\n \"aggregations\": {\n \"first_letter\": {\n \"terms\": {\n \"script\": \"doc['metadata.name.keyword'].getValue().substring(0,1)\",\n \"order\": {\n \"_key\": \"asc\"\n }\n },\n \"aggs\": {\n \"first_letter_group\": {\n \"terms\": {\n \"field\": \"metadata.name.keyword\",\n \"order\": {\n \"_key\": \"asc\"\n }\n }\n }\n }\n }\n }\n}\n```\n\nYou can use `gs_user_query` in a nested query to search for custom attributes:\n\n```json\n{\n \"query\": {\n \"bool\": {\n \"should\": [\n {\n \"gs_user_query\": {\n \"search_string\": \"quick red fox\",\n \"nlq_analyzer_enabled\": true\n }\n },\n {\n \"nested\": {\n \"path\": \"custom_attributes\",\n \"query\": {\n \"gs_user_query\": {\n \"search_string\": \"lazy brown dog\",\n \"nlq_analyzer_enabled\": true,\n \"nested\": true\n }\n }\n }\n }\n ]\n }\n}\n```\n\n### Searching for a quoted phrase\nWrap the phrase in quotes within your query as follows:\n\n```json\n{\n \"query\":{\n \"gs_user_query\":{\n \"search_string\":\"\\\"The quick red fox jumped over the lazy brown dog\\\"\"\n }\n }\n}\n```\n\nThe above query will search for exactly the phrase _\"The quick red fox jumped over the lazy brown dog\"_.\n\nA quoted phrase can also be included in a longer string:\n\n```json\n{\n \"query\":{\n \"gs_user_query\":{\n \"search_string\":\"The \\\"quick red fox\\\" jumped over the \\\"lazy brown dog\\\"\",\n \"nlq_analyzer_enabled\": true\n }\n }\n}\n```\n\nThe above query will search for the phrases _quick red fox_ and _lazy brown dog_, and will not return results containing only _quick_, _red_, _fox_, _lazy_, _brown_, or _dog_.\nThe query will, however, return results matching the individual words _jumped_ or _over_.\n\n### Searching for words starting with ...\n\nTo search for words starting with a letter or letters, enter only the first 1 to 3 letters of the word.\n\n```json\n{\n \"query\":{\n \"gs_user_query\":{\n \"search_string\":\"in\"\n }\n }\n}\n```\n\nThe above query will return documents with words like _infinite_ and _invitation_, but not words like _definitive_.\n\n### Searching for parts of words\nIf your search terms include more than three letters, then Global Search will search for any partial word matches. For example\n\n```json\n{\n \"query\":{\n \"gs_user_query\":{\n \"search_string\":\"init\"\n }\n }\n}\n```\n\nThe above query will find documents with words like _initialize_ (i.e. at the beginning of the word) and _trinitoluene_ (i.e. within the word).\nPartial matches will not be found on the `metadata.description` or `entity.assets.column_description` fields.\n\n### Searching with natural language\n\nNatural language analysis can be applied to English search strings to optimize search results in the following ways:\n- Words that are not important to the search intent are removed from the search query.\n- Phrases in the search string that are common in English are automatically ranked higher than results for individual words.\n\n```json\n{\n \"query\": {\n \"gs_user_query\": {\n \"search_string\": \"credit card interest in United States\",\n \"nlq_analyzer_enabled\": true\n }\n }\n}\n```\n\nThe above query will find documents with:\n- Matches for the phrases _credit card interest_ and _United States_ ranked highest\n- Matches for individual words _credit_, _card_, _interest_, _United_, and _States_ ranked lower\n\nThe above query will not return documents containing only the word _in_.\n\n### Result scoring\nResults are prioritized using a combination of field priority and type of match as follows:\n\nType of match:\n\n1. Matches for entire phrases will score highest.\n2. Exact matches of complete words will score next highest.\n3. If the search term is 3 characters or less results that contain words STARTING with that search term will score next highest.\n4. Partial matches of complete words will score next highest.\n5. Fuzzy matches (i.e. `adidas` vs `adadas`) will match, but will score lowest.\n\nField:\n1. Name\n2. Synonyms, Abbreviation, Terms, Tags or Classifications\n3. Description, Primary or Secondary Category\n4. Column Descriptions, Column Terms, Column Tags or Column Data Class Names\n\n### Documents in Global Search\nYou can query on any of the fields within the document by including the field name in a flattened json structure. For example the field:\n\n```json\n{\n \"entity\":{\n \t\"artifacts\":{\n\t \"artifact_id\":\"\"\n\t}\n }\n}\n```\n\nis queried for by using the following\n\n```json\nentity.artifacts.artifact_id\n```\n\nDocuments indexed in global search have the following structure:\n\n```json\n{\n \"provider_type_id\": \"string\",\n \"tenant_id\": \"string\",\n \"artifact_id\": \"string\",\n \"last_updated_at\": 0,\n \"metadata\": {\n \"name\": \"string\",\n \"description\": \"string\",\n \"artifact_type\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"modified_on\": \"2021-02-11T11:25:59.384Z\",\n \"modified_by\": \"string\",\n \"terms\": [\n \"string\"\n ],\n \"term_global_ids\": [\n \"string\"\n ],\n \"steward_ids\": [\n \"string\"\n ],\n \"steward_group_ids\": [\n \"string\"\n ]\n \"state\": \"string\",\n \"classifications\": [\n \"string\"\n ],\n \"classification_global_ids\": [\n \"string\"\n ]\n },\n \"entity\": {\n \"artifacts\": {\n \"global_id\": \"string\",\n \"version_id\": \"string\",\n \"artifact_id\": \"string\",\n \"rule_type\": \"string\",\n \"effective_start_date\": \"2021-02-11T11:25:59.384Z\",\n \"effective_end_date\": \"2021-02-11T11:25:59.384Z\",\n \"abbreviation\": [\n \"string\"\n ],\n \"synonyms\": [\n \"string\"\n ],\n \"synonym_global_ids\": [\n \"string\"\n ],\n \"enabled\": true\n },\n \"assets\": {\n \"asset_id\": \"string\",\n \"asset_name\": \"string\",\n \"attribute_quality_score\": 0,\n \"catalog_id\": \"string\",\n \"project_id\": \"string\",\n \"space_id\": \"string\",\n \"column_names\": [\n \"string\"\n ],\n \"column_terms\": [\n \"string\"\n ],\n \"column_term_global_ids\": [\n \"string\"\n ],\n \"column_descriptions\": [\n \"string\"\n ],\n \"connection_paths\": [\n \"string\"\n ],\n \"column_tags\": [\n \"string\"\n ],\n \"connection_ids\": [\n \"string\"\n ],\n \"column_data_class_names\": [\n \"string\"\n ],\n \"data_quality_score\": 0,\n \"data_quality_score_dbl\": 0,\n \"data_quality_delta\": 0,\n \"data_quality_delta_dbl\": 0,\n \"metadata_enrichment_area_id\": \"string\",\n \"metadata_enrichment_review_date\": 0,\n \"resource_key\": \"string\",\n \"metadata_enrichment_area_id\": \"string\",\n \"asset_id\": \"string\",\n \"suggested_column_term_global_ids\": [\n \"string\"\n ],\n \"suggested_column_terms\": [\n \"string\"\n ],\n \"schema_name\": \"string\",\n \"table_name\": \"string\",\n \"structured_profiling_completed_date\": \"2021-02-11T11:25:59.384Z\",\n \"structured_profiling_status\": \"string\",\n \"term_assignment_completed_date\": \"2021-02-11T11:25:59.384Z\",\n \"metadata_import_id\": \"string\",\n \"first_imported_timestamp\": \"2021-02-11T11:25:59.384Z\",\n \"last_imported_timestamp\": \"2021-02-11T11:25:59.384Z\",\n \"outdated_timestamp\": \"2021-02-11T11:25:59.384Z\",\n \"last_discovered_timestamp\": \"2021-02-11T11:25:59.384Z\",\n \"outdated_reason\": \"string\"\n },\n \"data_asset_column\": {\n \"data_class_name\": \"string\",\n \"data_class_id\": \"string\",\n \"data_class_set_by_user\": true,\n \"data_quality_score\": 0,\n \"data_quality_score_dbl\": 0,\n \"metadata_enrichment_review_date\": \"2021-02-11T11:25:59.384Z\",\n \"data_quality_delta\": 0,\n \"data_quality_delta_dbl\": 0,\n \"column_order\": 0,\n \"suggested_class_ids\": [\"string\", \"string\", \"string\"],\n \"suggested_class_names\": [\"string\", \"string\", \"string\"]\n },\n \"ref_data_value\": {\n \"value\": \"string\",\n \"value_long\": 0,\n \"value_dbl\": 0,\n \"ref_data_set_artifact_id\": \"string\",\n \"ref_data_set_version_id\": \"string\",\n \"parent_ref_data_value_artifact_id\": \"string\"\n }\n },\n \"custom_attributes\": [\n {\n \"last_updated_at\": 0,\n \"attribute_name\": \"string\",\n \"attribute_value\": \"string\"\n }\n ],\n \"categories\": [\n {\n \"last_updated_at\": 0,\n \"primary_category_id\": \"string\",\n \"primary_category_global_id\": \"string\",\n \"primary_category_name\": \"string\",\n \"secondary_category_ids\": [\n \"string\"\n ],\n \"secondary_category_global_ids\": [\n \"string\"\n ],\n \"secondary_category_names\": [\n \"string\"\n ]\n }\n ]\n}\n```", "title": "Watson Data API", "version": "2.35.0", "x-last-updated": "2024-09-20" }, "x-tagGroups": [ { "tags": [ "Asset Files", "Asset Files Git Operations", "Search" ], "name": "Platform" }, { "tags": [ "Assets", "Asset Attachments", "Asset Attributes", "Asset Trash", "Asset Types", "Catalogs", "Catalog Members", "Connections", "Data Assets", "Datasource Types", "Folder Assets", "Jobs", "Job Runs", "Projects", "Projects Members", "Transactional Projects", "Streams Flows", "Streams Flow Runs" ], "name": "Catalogs and Projects" }, { "tags": [ "Business terms", "Categories", "Classifications", "Data classes", "Data protection rules", "Enforcement policy metrics", "Governance artifact types", "Policies", "Reference data sets", "Rules", "Workflows", "Workflow User Tasks" ], "name": "Governance" } ], "tags": [ { "name": "Asset Files", "description": "Operations that allow management of asset files." }, { "name": "Asset Files Git Operations", "description": "Additional functionality to use git tooling to create and manage asset files." }, { "name": "Asset Containers" }, { "name": "Asset Lists" }, { "name": "Asset Relationship Types" }, { "name": "Asset Types" }, { "name": "Assets" }, { "name": "Asset Relationships" }, { "name": "Asset Attachments" }, { "name": "Asset Attributes" }, { "name": "Asset Document Conflicts" }, { "name": "Asset Images" }, { "name": "Asset Notes" }, { "name": "Asset Ratings" }, { "name": "Asset Revisions" }, { "name": "CAMS Admin" }, { "name": "Metrics" }, { "name": "Catalogs" }, { "name": "Import Assets" }, { "name": "AWS Temporary Credentials" }, { "name": "Catalog Collections" }, { "name": "Catalog Members" }, { "name": "Data Assets" }, { "name": "Folder Assets" }, { "name": "Asset Trash" }, { "name": "Connections", "description": "Manage the connection assets in a catalog or project.", "x-cli-command-group": "default" }, { "name": "Files" }, { "name": "Datasource Types", "description": "Manage the list of all defined types of data sources.", "x-cli-command-group": "datasource-type" }, { "name": "Metadata Enrichment Area" }, { "name": "Metadata Import" }, { "name": "Metadata Import Run" }, { "name": "Data Profiles", "description": "Manage data profiles belonging to data assets in a catalog or project." }, { "name": "Data Profile Options", "description": "Manage data profile options for a given Account in a catalog or project." }, { "name": "Profiling results", "description": "Internal APIs to manage profiling results of data assets in a catalog or project (restricted)." }, { "name": "Bivariate results", "description": "API's to manage bivariate results of data assets in catalog or project." }, { "name": "Migrate profile results to data quality", "description": "API to migrate existing profiling results of assets to new Data quality service." }, { "name": "Hummingbird tasks", "description": "Internal APIs to manage the Hummingbrid tasks (restricted)." }, { "name": "Data Quality Assets" }, { "name": "Data Quality Checks" }, { "name": "Data Quality Dimensions" }, { "name": "Data Quality Issues" }, { "name": "Data Quality Scores" }, { "name": "Data Quality Service Level Agreements" }, { "name": "Data quality rule" }, { "name": "Data quality rule execution" }, { "name": "Data quality definition" }, { "name": "Data quality dimension" }, { "name": "Project data quality settings" }, { "name": "Environments", "description": "An environment collects all the information about a runtime environment, including but not limited to\nsoftware and hardware specifications.\n\nDefault environments are immutable. Custom environments are scoped to a project or space.\n" }, { "name": "Hardware Specifications", "description": "A hardware specification contains the metadata of a particular hardware description, \ne.g. number of CPU (cores), available memory, etc.\n\nHardware specifications either `global` or `scoped`.\n\nGlobal hardware specifications are available in every project or space.\n\nScoped hardware specifications are available in a specific project or space.\n\nThere is a fixed set of global hardware specifications that are built-in in CPD. They are immutable.\n\nCustom global hardware specifications can be created with the credentials of the `wdp-service-id`.\nScoped hardware specifications can be created with user credentials from the specific project or space." }, { "name": "Software Specifications", "description": "A software specification contains the metadata of a particular software description,\ne.g. a description of a platform, installed libraries, etc.\n\nSoftware specifications can be one of two types: `base` or `derived`.\n\nBase software specifications are available in every project or space.\n\nDerived software specifications are scoped to a project or space.\nThey point to a base software specification and may further be customized with package extensions\n(see '/v2/package_extensions').\nWhen a (derived) software specification has more than one package extension,\nthe order of the package extensions signifies the order in which they should\nbe applied on top of the base software specification.\n\nThere is a fixed set of base software specifications that are built-in in CPD. They are immutable.\n\nCustom base software specification can be created with the credentials of the `wdp-service-id`.\nDerived software specifications can be created with user credentials from the specific project or space." }, { "name": "Package Extensions", "description": "A package extension describes a customization of a given software\nspecification by extending that software specification in any of two ways:\n\n1. customization by conda yml file: a user-provided conda environment yml\nfile that specifies the additional dependencies. This package extension is\nof type 'conda_yml'.\n\n2. customization by custom library: an arbitrary user-provided library, for\nexample a python library, or a JAR file. This package extension is of type\n'pip_zip'.\n\nPackage extensions are always scoped to a project or space. Only derived software specifications can hold\npackage extensions.\n" }, { "name": "Runtime Definitions", "x-internal": "cpd", "description": "A runtime definition specifies information about a runtime image.\n\nDefault runtime definitions are immutable.\n\nTo use a custom image, you can create a custom runtime definition with this image and\nthen create a custom environment with the runtime definition.\n" }, { "name": "Bulk Service" }, { "name": "Heartbeat" }, { "name": "Search" }, { "name": "SearchFacet" }, { "description": "APIs for Categories.", "name": "Categories" }, { "description": "APIs for Category role statistics.", "name": "Category role statistics" }, { "description": "APIs for Category statistics.", "name": "Category statistics" }, { "description": "APIs for Classifications.", "name": "Classifications" }, { "description": "APIs for Data Classes.", "name": "Data classes" }, { "description": "APIs for Business Glossary status.", "name": "Business Glossary status" }, { "description": "APIs for Glossary Terms.", "name": "Business terms" }, { "description": "APIs for all Governance Types.", "name": "Governance artifact types" }, { "description": "APIs for Policies.", "name": "Policies" }, { "description": "APIs for artifact relationships.", "name": "Relationships" }, { "description": "APIs for Rules.", "name": "Rules" }, { "description": "APIs for Reference Data Sets.", "name": "Reference data sets" }, { "description": "APIs for Reference Data Values relationships", "name": "Reference data values" }, { "name": "Jobs" }, { "name": "Job Runs" }, { "name": "Knowledge Accelerators", "description": "APIs for Knowledge Accelerator assignment" }, { "name": "Enforcement Governance Types" }, { "name": "Rule Predicate Terms" }, { "name": "Enforcement Policy Metrics" }, { "name": "Roles Permissions" }, { "name": "Data Protection Rules" }, { "name": "Rule Enforcement Settings" }, { "name": "Projects", "x-cli-command-group": "default" }, { "name": "Project Members", "x-cli-command-group": "member" }, { "name": "Project Tags", "x-cli-command-group": "tag" }, { "name": "Project Settings", "x-cli-command-group": "setting" }, { "name": "Transactional Projects", "x-cli-command-group": "default" }, { "name": "Workflows", "description": "Workflow Controller" }, { "name": "Workflow User Tasks", "description": "User Task Controller" }, { "name": "Workflow Templates", "description": "Workflow Template Controller" }, { "name": "Statistics", "description": "Stat Controller" } ], "security": [ { "CPD": [] } ], "paths": { "/v2/asset_files": { "get": { "tags": [ "Asset Files" ], "summary": "Get a list of file paths.", "description": "Returns a list of file paths (similar to S3 listObjects) for the provided project, catalog, space or account. Requires viewer or higher permission. Assets for a catalog are not retrievable by external users.", "operationId": "getAssetFileList", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "limit", "in": "query", "description": "Pagination param, limit number of resources returned.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Pagination param, resources returned wil be offset by this value.", "schema": { "type": "string" } }, { "name": "flat", "in": "query", "description": "If true folder structures are recursively flattened and the response is a list of files of all files in parent and child directories. The 'path' will show the resource full path from starting directory.", "schema": { "type": "boolean" } }, { "name": "hidden_files", "in": "query", "description": "Whether or not to resturn hidden files. If false, hidden files files will be left out of the response object. Only works when the path being retrieved is a directory. Default is true.", "schema": { "type": "boolean" } }, { "name": "root", "in": "query", "description": "(Internal use only) If '&root=true' is supplied in request URL the api will return relative to target container's root directory instead of standard assets directory. Note, there is one exception. If '&root=true' is supplied along with 'userfs' param targetting a project where the user has correct permissions standard auth will work.'", "schema": { "type": "boolean" } }, { "name": "stream", "in": "query", "description": "The content will be streamed out instead of being fully contructed and sent out all at once. Used mainly when there are a large number of files are expected.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "description": "The total number of resource for the query.", "type": "integer" }, "limit": { "description": "The limit used for the request.", "type": "integer" }, "offset": { "description": "The offset used for the request.", "type": "integer" }, "first": { "$ref": "#/components/schemas/AssetFilesPaginationURL" }, "last": { "$ref": "#/components/schemas/AssetFilesPaginationURL" }, "next": { "$ref": "#/components/schemas/AssetFilesPaginationURL" }, "previous": { "$ref": "#/components/schemas/AssetFilesPaginationURL" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/AssetFilesAssetFileMetadata" } } } } } } }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space or account does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } }, "put": { "tags": [ "Asset Files" ], "summary": "Create project, catalog, space or account root folder.", "description": "Before files can be uploaded, project/catalog/account/space root folder needs to be created. If the folder already exists the call will fail. Project folder can be created with additional content required for internal Git. Requires Bearer auth with admin permission for project or space. Creating folder for a catalog is not available to external users.", "operationId": "createFolder", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "initialize_git", "in": "query", "description": "Optional param for project containers.", "schema": { "type": "boolean" } } ], "responses": { "201": { "description": "The folder was created." }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space or account does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "409": { "description": "Conflict. The directory already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } }, "delete": { "tags": [ "Asset Files" ], "summary": "Batch delete or delete project/catalog/account/space folder.", "description": "Delete either files in batch or a project/catalog/account/space folder. If request body is present it should be a list of filenames/filepaths to be deleted in the provided project, catalog, space or account. Files are deleted asyncronously so some files may be deleted and others skipped. If there is no request body the project/catalog/account/space folder will be deleted but will fail if the project/catalog/account/space folder is not empty. For projects and spaces a batch delete requires editor permission. For accounts, batch delete requires the user to be the account admin. Deletion of the project/catalog/account/space folder requires admin permission. Catalog assets are cannot be deleted by external users (internal only). Please note the 'assets' dir and its subdir 'data_asset' cannot be deleted.", "operationId": "deleteAssetFiles", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "root", "in": "query", "description": "(Internal use only) If '&root=true' is supplied in request URL the api will return relative to target container's root directory instead of standard assets directory. Note, there is one exception. If '&root=true' is supplied along with 'userfs' param targetting a project where the user has correct permissions standard auth will work.'", "schema": { "type": "boolean" } }, { "name": "force_delete", "in": "query", "description": "If '&force_delete=true' all safeguards regarding non-empty directory will be bypassed. Only works for projects, catalogs and spaces.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesDeleteAssetFiles" } } }, "description": "Asset files to delete" }, "responses": { "200": { "description": "The delete partially successful. Response body will be a list of files.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/AssetFilesDeleteOutcome" } } } } } } }, "204": { "description": "The delete operation was completely successful." }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space or account does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/{path}": { "get": { "tags": [ "Asset Files" ], "summary": "Get Asset File", "description": "Streams the content of the specified file, with the appropriate HTTP headers for etag, file size, mime type etc. If the asset file is a directory, response will be JSON listing the content of the directory. If the asset is a file, response will be contents of the file. Requires viewer permission or higher. Assets for a catalog are not available to external users. This endpoint supports authentication via signature paramater. See 'Get auth signature' call for more info.", "operationId": "getAssetFile", "parameters": [ { "name": "path", "in": "path", "description": "Asset file path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "byte_limit", "in": "query", "description": "If passed, indicates how many bytes of data is to be returned.", "schema": { "type": "integer" } }, { "name": "byte_range", "in": "query", "description": "If passed, indicates the bytes that should be returned. Must be in format ('x-y': bytes x to y inclusive, '-y': the last y bytes, 'x-': everything from and including the xth byte). Does not support mulitiple ranges.", "schema": { "type": "string" } }, { "name": "size_limit", "in": "query", "description": "Returns 400 bad request if asset is larger than the value provided here. In MB.", "schema": { "type": "integer" } }, { "name": "signature", "in": "query", "description": "Additional auth method. Signed string obtained by making presigned API request.", "schema": { "type": "string" } }, { "name": "flat", "in": "query", "description": "If true, folder structures are recursively flattened and the response is a list of files of all files in parent and child directories. The 'path' will show the resource full path from starting directory. Only works for directories. ", "schema": { "type": "boolean" } }, { "name": "minimal", "in": "query", "description": "If true, the response will contain less info. (ex// no etag) Only works with flat param set to true.", "schema": { "type": "boolean" } }, { "name": "hidden_files", "in": "query", "description": "Whether or not to resturn hidden files. If false, hidden files files will be left out of the response object. Only works when the path being retrieved is a directory. Default is true.", "schema": { "type": "boolean" } }, { "name": "root", "in": "query", "description": "(Internal use only) If '&root=true' is supplied in request URL the api will return relative to target container's root directory instead of standard assets directory. Note, there is one exception. If '&root=true' is supplied along with 'userfs' param targetting a project where the user has correct permissions standard auth will work.'", "schema": { "type": "boolean" } }, { "name": "inflate", "in": "query", "description": "If '&inflate=true' ALL other query params except the target are ignored. The file being retrieved must be an archive. If all checks pass the archive will be expanded to a temp location and the results will be returned as if flat=true was supplied. If the target archive has perviously be inflated any existing inflate preview will be overwritten if the zip is newer. Otherwise the previous preview will be returned.", "schema": { "type": "boolean" } }, { "name": "force", "in": "query", "description": "Only used when &inflate=true. Tells asset files to skip validation on wheter the target is a zip. Inflate will be run regardless.", "schema": { "type": "boolean" } }, { "name": "stream", "in": "query", "description": "Only works for directories. The content will be streamed out instead of being fully contructed and sent out all at once. Used mainly for when there are a large number of files are expected.", "schema": { "type": "boolean" } }, { "name": "Range", "in": "header", "description": "Similar to byte_range query param. Currently only supports bytes. See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 for more info. Can be used to limit the bytes of a file being returned. Ranges are inclusive. If set will take precedence over anything in byte_limit or byte_range.", "schema": { "type": "string", "default": "Range 0-100" } } ], "responses": { "200": { "description": "If the requested asset is a file, the file is returned. If it is a directory, a JSON object will be returned. The JSON format for a folder will match that of GET /v2/asset_files/path", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space, account or asset does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } }, "head": { "tags": [ "Asset Files" ], "summary": "Get Asset File Headers", "description": "Returns ONLY the HTTP headers for etag, file size, mime type etc. without streaming the file content. Requires viewer permission. Assets for a catalog are not available to external users. This endpoint supports authentication via signature paramater. See 'Get auth signature' call for more info.", "operationId": "getAssetFileHeaders", "parameters": [ { "name": "path", "in": "path", "description": "Asset file path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "signature", "in": "query", "description": "Additional auth method. Signed URL obtained by making presigned API request.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Headers for the requested file are returned in response." }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space, account or asset does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } }, "put": { "tags": [ "Asset Files" ], "summary": "Put New Asset File", "description": "Uploads the bytes into the file with the provided file name using HTTP multi-part format, creating a new file if missing, overriding if existing (unless override=false). Assets cannot be uploaded to a catalog by external users. Adding project or space assets accepts all formats that grant editor access or higher. Adding to accounts requires a user with account admin access. This endpoint supports authentication via signature paramater. See 'Get auth signature' call for more info on signed urls.", "operationId": "putAssetFile", "parameters": [ { "name": "path", "in": "path", "description": "Asset file path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "override", "in": "query", "description": "Default true. If set to false will not overwrite file.", "schema": { "type": "boolean" } }, { "name": "signature", "in": "query", "description": "Additional auth method. Signed string obtained by making API request to signing endpoint.", "schema": { "type": "string" } }, { "name": "inflate", "in": "query", "description": "Root dir must be created. Will take supplied file and decompress into target directory tree. Inflate is only acceptable for project, space and catalog targets. If inflate is selected it will take precedence over any and all other params.", "schema": { "type": "boolean" } }, { "name": "ensure_dir", "in": "query", "description": "Override functionality. If true will ensure the directory specified by 'path' exists (instead of uploading any file provided). 201 will be returned ig created, 200 if already exists and 409 if it is present and not a directory. Will take precedence over other query params except 'inflate'", "schema": { "type": "boolean" } }, { "name": "root", "in": "query", "description": "(Internal use only) If '&root=true' is supplied in request URL the api will return relative to target container's root directory instead of standard assets directory. Note, there is one exception. If '&root=true' is supplied along with 'userfs' param targetting a project where the user has correct permissions standard auth will work.'", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "description": "File to upload.", "type": "string", "format": "binary" } } } } } }, "responses": { "201": { "description": "Asset file/folder created. The asset was successfully uploaded." }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space or account does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } }, "delete": { "tags": [ "Asset Files" ], "summary": "Delete Single Asset File/Folder", "description": "Deletes a file in a project, space or a catalog. Requires minimum editor permission for projects and spaces. Assets in a catalog cannot be deleted by external users. Account requires users to have account admin privelege or internal auth. Please note the 'assets' dir and its subdir 'data_asset' cannot be deleted.", "operationId": "deleteAssetFile", "parameters": [ { "name": "path", "in": "path", "description": "Asset file path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "root", "in": "query", "description": "(Internal use only) If '&root=true' is supplied in request URL the api will return relative to target container's root directory instead of standard assets directory. Note, there is one exception. If '&root=true' is supplied along with 'userfs' param targetting a project where the user has correct permissions standard auth will work.'", "schema": { "type": "boolean" } }, { "name": "force_delete", "in": "query", "description": "If '&force_delete=true' is supplied, non-empty directories will be deleted.", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Asset file/folder was deleted." }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space or account does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/{path}/signed": { "post": { "tags": [ "Asset Files" ], "summary": "Get auth signature", "description": "(Internal use only) Generate a signed URL that can be used to access specific API calls. A signed URL will be returned in the response body as plain text. A fully encoded version of the same url will be sent in the 'Location' header.", "operationId": "sign", "parameters": [ { "$ref": "#/components/parameters/AssetFilesServiceAuthorization" }, { "name": "path", "in": "path", "description": "The path to asset you wish to make signed url for. Must be encoded", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilescatalog_id" }, { "$ref": "#/components/parameters/AssetFilesaccount_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "content_type", "in": "query", "description": "Optional content type (to override the defaults of asset being requested)", "schema": { "type": "string" } }, { "name": "content_disposition", "in": "query", "description": "Optional (to override the defaults) - must be URIEncoded as it can contain spaces if filename is used.", "schema": { "type": "string" } }, { "name": "expires_in", "in": "query", "description": "TTL in seconds.", "required": true, "schema": { "type": "integer" } }, { "name": "root", "in": "query", "description": "Wheter to access the path from root.", "required": false, "schema": { "type": "boolean" } }, { "name": "inflate", "in": "query", "description": "Only useful for put. Will allow signed url to act as inflat request.", "required": false, "schema": { "type": "boolean" } }, { "name": "method", "in": "query", "description": "Accepts 'get' or 'put'. (Defaults to 'get' if not supplied)", "schema": { "type": "string" } } ], "responses": { "201": { "description": "A signed URL that can be used to access other endpoints. The same value will be returned in 'Location' header. The value return in the body can be used as is. The value returned in the location header is url encoded and should be decoded before use.", "content": { "application/json": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "text/plain": { "examples": { "response": { "value": "/v2/asset_files/data_asset%2Fmyfile.csv?project_id=f0bf39f4-8eb9-4a64-9408-4132f850eeac&signature=2YQspmvQndoU%2FvjbzLACUA%3D%3D%3Al%2Bxzj4Z0zeI%2FdjjuxU16IBR03EvA%2FIhAqfKGCMJkcl1fPxMt22GObAW6X%2F8FcbL7s3KxoiI%2BCNICH%2B67m6xGaOUQnI0ZRuJ8NiH8c%2BbUiHTO9Fo6lA59O3XsL7pUNah5HM6ByYXUA6OzCud6hgCVGqFZBfqnpZeU%2BDR3gun2DnZFzWWOnYBHb58ahTyPNn%2BmI%2F2yNZ1Wekhbqae%2BRhWYZ0P%2FQBVxGddejXML5nWtxADoo3mQO9avGQg%3D" } } } } }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/{path}/deflate": { "post": { "tags": [ "Asset Files" ], "summary": "Create archive for target", "description": "(Internal use only) Generate an archive and saves it to the path provided.", "operationId": "deflate", "parameters": [ { "$ref": "#/components/parameters/AssetFilesServiceAuthorization" }, { "name": "path", "in": "path", "description": "The filename where the project archive will be saved.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" }, { "$ref": "#/components/parameters/AssetFilesuserfs" }, { "$ref": "#/components/parameters/AssetFilesiam_id" }, { "name": "is_directory", "in": "query", "description": "If true only one element can be supplied in body and it must be directory. The entire directory content will be zipped into the archive. Default is false.", "required": false, "schema": { "type": "boolean" } }, { "name": "notify", "in": "query", "description": "On completion of the archinving a rabbit MQ task will be sent out. Default is true.", "required": false, "schema": { "type": "boolean" } }, { "name": "event_type", "in": "query", "description": "The event type to specify in the rabbitMQ message once archiving completes. Default is \"export_deflate\".", "required": false, "schema": { "type": "string" } }, { "name": "hide_log", "in": "query", "description": "In true, the deflate log will be a hidden file. Default is false.", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "description": "Either a list of asset paths that should be included in the archive being created or object with key 'file' with list of contents to include. Empty array will result in everything being included." }, "responses": { "202": { "description": "Returned if the deflate operation was started successfully." }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified target does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/inflate": { "post": { "tags": [ "Asset Files" ], "summary": "Inflate the source archive to the target location", "description": "(Internal use only) Inflate the source archive to the specified target location.", "operationId": "inflate", "parameters": [ { "$ref": "#/components/parameters/AssetFilesServiceAuthorization" }, { "$ref": "#/components/parameters/AssetFilesproject_id" }, { "$ref": "#/components/parameters/AssetFilesspace_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesInflate" } } }, "description": "The source and target specifications.", "required": true }, "responses": { "201": { "description": "Returned if the inflate operation was completed successfully." }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified target does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/copy": { "post": { "tags": [ "Asset Files" ], "summary": "Copy Asset File", "description": "Copies a file between source and target provided in the POST body. Any combination of spaces, projects and catalogs are allowed. Viewer permission is required for the source and editor permission is required for the target. Assets for a catalog are not available to external users. For larger files async_copy is recomended.", "operationId": "copyAssetFile", "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/AssetFilesCopyAssetFile" }, "responses": { "200": { "description": "Will be returned when the asset is copied successfully.", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space, account or asset does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/async_copy": { "post": { "tags": [ "Asset Files" ], "summary": "Copy Asset File (async)", "description": "Similar to copy asset however, the response will be returned upon the copy starting instead of on completion.", "operationId": "asyncCopyAssetFile", "parameters": [], "requestBody": { "$ref": "#/components/requestBodies/AssetFilesCopyAssetFile" }, "responses": { "202": { "description": "Will be returned after initial validation is complete and the copy operation started.", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request. Returned if missing / invalid params are supplied.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified catalog, project, space, account or asset does not exist.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/export": { "post": { "tags": [ "Asset Files Git Operations" ], "summary": "Git Export", "description": "Performs git add on the assets provided in the body, then commit and push to the remote", "operationId": "gitExport", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" }, { "$ref": "#/components/parameters/AssetFilestask_id" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "asset_paths": { "type": "array", "items": { "type": "string", "description": "Relative asset path." } }, "repo_url": { "type": "string" }, "access_token": { "$ref": "#/components/schemas/AssetFilesaccessToken" } }, "required": [ "asset_paths", "repo_url" ] } } }, "description": "Git export body" }, "responses": { "202": { "description": "Export transaction accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesSuccessResponse" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/import": { "post": { "tags": [ "Asset Files Git Operations" ], "summary": "Git Import", "description": "Performs a git clone on the remote repo", "operationId": "gitImport", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" }, { "$ref": "#/components/parameters/AssetFilestask_id" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "repo_url": { "type": "string" }, "access_token": { "$ref": "#/components/schemas/AssetFilesaccessToken" } }, "required": [ "repo_url" ] } } }, "description": "Git import body" }, "responses": { "202": { "description": "Import transaction accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesSuccessResponse" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/remote": { "post": { "tags": [ "Asset Files Git Operations" ], "summary": "Git Add Remote", "description": "Performs a git remote add on the given project", "operationId": "gitAddRemote", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "repo_url": { "type": "string" }, "access_token": { "$ref": "#/components/schemas/AssetFilesaccessToken" } }, "required": [ "repo_url" ] } } }, "description": "Git add remote repository information" }, "responses": { "200": { "description": "Successfully added remote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesSuccessResponse" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/delete_remote": { "post": { "tags": [ "Asset Files Git Operations" ], "summary": "Git Remove Remote", "description": "Performs a git remote remove on the given project", "operationId": "gitRemoveRemote", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" } ], "responses": { "204": { "description": "Successfully removed remote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesSuccessResponse" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/fetch": { "post": { "tags": [ "Asset Files Git Operations" ], "summary": "Git Fetch", "description": "Performs a git fetch operation", "operationId": "gitRemoteFetch", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "repo_branch": { "type": "string" } }, "required": [ "repo_branch" ] } } }, "description": "Git fetch body" }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesSuccessResponse" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/status": { "post": { "tags": [ "Asset Files Git Operations" ], "summary": "Git status", "description": "Performs a git status operation", "operationId": "gitLocalStatus", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "repo_branch": { "type": "string" } }, "required": [ "repo_branch" ] } } }, "description": "Git status body" }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesSuccessResponse" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/pull": { "post": { "tags": [ "Asset Files Git Operations" ], "summary": "Git Pull", "description": "Performs a git pull operation", "operationId": "gitPull", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" }, { "$ref": "#/components/parameters/AssetFilestask_id" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "repo_branch": { "type": "string" } }, "required": [ "repo_branch" ] } } }, "description": "Git pull body" }, "responses": { "201": { "description": "Pull transaction accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesSuccessResponse" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_files/git_transactions/settings": { "put": { "tags": [ "Asset Files Git Operations" ], "summary": "Change Git Settings", "description": "Modifies an existing git repo's config", "operationId": "putGitSettings", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesGitSettings" } } }, "description": "Git settings body" }, "responses": { "200": { "description": "Change complete", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesGitSettings" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } }, "get": { "tags": [ "Asset Files Git Operations" ], "summary": "Get Git Settings", "description": "Retrieves an existing git repo's config", "operationId": "getGitSettings", "parameters": [ { "$ref": "#/components/parameters/AssetFilesproject_id_git" } ], "responses": { "200": { "description": "Current settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesGitSettings" } } } }, "401": { "description": "Unauthorized. Returned when a user makes a request without proper Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "403": { "description": "Forbidden. Returned when a user makes a request to something they do not have access to.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "404": { "description": "Not Found. Specified project or asset does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } } } } }, "/v2/asset_containers/archive": { "post": { "tags": [ "Asset Containers" ], "summary": "Archive the asset container", "description": "Archive the assets database of the asset container.

Archiving the assets database of not used asset containers helps saving storage and computing resources of the database, therefore reduce the footprint of CAMS.The information stored in the archived asset containers will not be accessible until the asset containers are restored.", "operationId": "archiveCatalog", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "requestBody": { "description": "Archive request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogArchiveCatalogRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogArchiveInfo" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/asset_containers/archive_info": { "get": { "tags": [ "Asset Containers" ], "summary": "Get archive information of the asset container", "description": "Get archive information of the asset container.", "operationId": "getArchiveInfo", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogArchiveInfo" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/asset_containers/configurations": { "get": { "tags": [ "Asset Containers" ], "summary": "Get configurations", "description": "Get the configurations of a catalog/project/space.", "operationId": "getConfigurations", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetContainerConfiguration" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Asset Containers" ], "summary": "Replace or create configurations", "description": "Replace the configurations of a catalog/project/space or create the configurations if they do not exist.", "operationId": "updateConfigurations", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "requestBody": { "description": "Configurations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetContainerConfiguration" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetContainerConfiguration" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/asset_containers/restore": { "post": { "tags": [ "Asset Containers" ], "summary": "Restore the asset container", "description": "Restore the assets database of the archived asset container. Only successfully archived asset container can be restored.", "operationId": "restoreCatalog", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogArchiveInfo" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogArchiveInfo" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/asset_lists": { "get": { "tags": [ "Asset Lists" ], "summary": "List all asset lists defined for an account", "description": "Retrieve a paginated list of asset lists defined for an account.", "operationId": "list_asset_lists", "parameters": [ { "name": "query", "in": "query", "description": "Query to retrieve a paginated list of asset list metadatas for which the request user has permission to view.

Search query in Common Expression Language, with special characters encoded. For example, & is %26.

Examples of query parameters:
* id
* type
* state
* access_control.owner
* created_at
* last_updated_at", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$%&=|\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" }, "example": "type==order%26%26created_at%3E=2023-08-23T21:10:40Z" }, { "name": "start", "in": "query", "description": "Start token for pagination", "schema": { "maxLength": 512, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" } }, { "name": "limit", "in": "query", "description": "Search result limit", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "default": 200 }, "example": 10 }, { "name": "sort", "in": "query", "description": "This parameter can be repeated to add additional sort fields.

Default: null\n\nExamples of sort fields (these are case insensitive): \n * created_at\n * -created_at\n * last_updated_at\n * -last_updated_at", "content": { "application/json": { "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "A comma delimited array of sort parameters." } } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListCollection" }, "examples": { "asset_list_collection_response": { "summary": "Example Asset list collection response.", "value": { "limit": 200, "total_count": 1, "first": { "href": "https://api.dataplatform.cloud.ibm.com/v2/asset_lists" }, "next": { "href": "https://api.dataplatform.cloud.ibm.com/v2/asset_lists?start=start_token", "start": "start_token" }, "asset_lists": [ { "name": "my_order", "description": "Order of multiple items", "type": "order", "state": "default_state", "id": "3204c622-dcb8-4728-869f-484b6ac73dff", "asset": { "id": "701f4af4-679c-42d1-80b5-0de5796a7514", "type": "ibm_data_product_version", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request GET --url '{url}/v2/asset_lists' --header 'authorization: Bearer {access_token}' --header 'accept: application/json'" ] } ] } ] } } }, "post": { "tags": [ "Asset Lists" ], "summary": "Create a new asset list", "description": "Use this API to creates a new asset list.

If the `state` is not specified, the asset list will be created in **DEFAULT** state.
The list may be created with items, or without items.
The list will be owned by the request user.", "operationId": "create_asset_list", "requestBody": { "description": "The asset list for creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListPrototype" }, "examples": { "asset_list_for_creation": { "summary": "Example REST body for asset list creation of type ORDER.", "value": { "name": "my_order", "description": "Order of multiple items", "type": "order", "items": [ { "asset": { "id": "8509d09e-b3d0-4e8b-9682-726a7b95f69a", "type": "data_asset", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "properties": { "my_property_1": "Value 1", "my_property_2": "Value 2" } }, { "asset": { "id": "8509d09e-b3d0-4e8b-9682-726a7b95f69b", "type": "data_asset", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "properties": { "my_property_1": "Value 1", "my_property_map": { "my_property_map_key": "Value 2" } } } ] } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListSummary" }, "examples": { "asset_list_response": { "summary": "Example Asset list response.", "value": { "name": "my_order", "description": "Order of multiple items", "type": "order", "state": "default_state", "id": "3204c622-dcb8-4728-869f-484b6ac73dff", "asset": { "id": "701f4af4-679c-42d1-80b5-0de5796a7514", "type": "ibm_data_product_version", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request POST --url '{url}/v2/asset_lists' --header 'accept: application/json' --header 'authorization: Bearer {access_token}' --header 'content-type: application/json' --data '{\"name\": \"my_order\",\"description\": \"Order of multiple items\",\"items\": [{\"asset\": {\"metadata\": {\"id\": \"8509d09e-b3d0-4e8b-9682-726a7b95f69a\",\"type\": \"data_asset\",\"container\": {\"id\": \"71993ab5-3374-4355-8a38-fc4c32debc00\",\"type\": \"catalog\"}}},\"properties\": {\"my_property_1\": \"Value 1\",\"my_property_2\": \"Value 2\"}},{\"asset\": {\"metadata\": {\"id\": \"8509d09e-b3d0-4e8b-9682-726a7b95f69b\",\"type\": \"data_asset\",\"container\": {\"id\": \"71993ab5-3374-4355-8a38-fc4c32debc00\",\"type\": \"catalog\"}}},\"properties\": {\"my_property_1\": \"Value 1\",\"my_property_map\": {\"my_property_map_key\": \"Value 2\"}}}],\"type\": \"order\"}'" ] } ] } ] } } }, "delete": { "tags": [ "Asset Lists" ], "summary": "Delete asset lists", "description": "Deletes asset lists based on a query in Common Expression Language format.", "operationId": "delete_asset_lists", "parameters": [ { "name": "query", "in": "query", "description": "Query to delete asset lists for which the request user has permission.

Search query in Common Expression Language, with special characters encoded. For example, & is %26.

Examples of query parameters:
* id
* type
* state
* access_control.owner
* created_at
* last_updated_at", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$%&=|\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" }, "example": "type==order%26%26created_at%3E=2023-08-23T21:10:40Z" } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request DELETE --url '{url}/v2/asset_lists?query=created_at%3E%3D2023-08-23T21%3A10%3A40Z' --header 'accept: application/json' --header 'authorization: Bearer {access_token}'" ] } ] } ] } } } }, "/v2/asset_lists/{asset_list_id}": { "get": { "tags": [ "Asset Lists" ], "summary": "Retrieve an asset list identified by ID", "description": "Retrieves the metadata of an asset list of a given identified by ID.", "operationId": "get_asset_list", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListSummary" }, "examples": { "asset_list_summary_response": { "summary": "Example Asset list summary response.", "value": { "name": "my_order", "description": "Order of multiple items", "type": "order", "state": "default_state", "id": "3204c622-dcb8-4728-869f-484b6ac73dff", "asset": { "id": "701f4af4-679c-42d1-80b5-0de5796a7514", "type": "ibm_data_product_version", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request GET --url '{url}/v2/asset_lists/{asset_list_id}' --header 'authorization: Bearer {access_token}' --header 'accept: application/json'" ] } ] } ] } } }, "delete": { "tags": [ "Asset Lists" ], "summary": "Delete an asset list identified by ID", "description": "Deletes an asset list identified by ID. The user must have permission to perform this action.", "operationId": "delete_asset_list", "parameters": [], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request DELETE --url '{url}/v2/asset_lists/{asset_list_id}' --header 'accept: application/json' --header 'authorization: Bearer {access_token}'" ] } ] } ] } } }, "patch": { "tags": [ "Asset Lists" ], "summary": "Update the metadata of an asset list", "description": "Use this API to update the asset list metadata. Specify patch operations using http://jsonpatch.com/ syntax.\r\n\r\nFields that can be patched:\r\n - /name\r\n - /description\r\n - /type\r\n - /state (Approvers and Functional users only)\r\n - /message (Approvers and Functional users only)\r\n\r\nNote: The ownership cannot be modified after creation.", "operationId": "update_asset_list", "parameters": [], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.", "content": { "application/json-patch+json": { "schema": { "maxItems": 256, "minItems": 1, "type": "array", "description": "JSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.", "items": { "$ref": "#/components/schemas/CatalogJsonStringPatch" } }, "examples": { "asset_list_patch": { "summary": "Example REST body for asset list update of the state parameter.", "value": [ { "op": "replace", "path": "/state", "value": "confirmed" } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListSummary" }, "examples": { "asset_list_summary_response": { "summary": "Example Asset list summary response.", "value": { "name": "my_order", "description": "Order of multiple items", "type": "order", "state": "default_state", "id": "3204c622-dcb8-4728-869f-484b6ac73dff", "asset": { "id": "701f4af4-679c-42d1-80b5-0de5796a7514", "type": "ibm_data_product_version", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "415": { "description": "Unsupported Media Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request PATCH --url '{url}/v2/asset_lists/{asset_list_id}' --header 'accept: application/json' --header 'authorization: Bearer {access_token}' --header 'content-type: application/json' --data '[{\"op\": \"replace\",\"path\": \"/state\",\"value\": \"confirmed\"}]'" ] } ] } ] } }, "x-codegen-request-body-name": "patch" }, "parameters": [ { "name": "asset_list_id", "in": "path", "description": "Asset list id (GUID, or [type]_[userId])", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" }, "example": "aaff9159-8ba4-4ae5-a9d7-3e59d5903d72" } ] }, "/v2/asset_lists/{asset_list_id}/items": { "get": { "tags": [ "Asset Lists" ], "summary": "List the items of an asset list identified by ID", "description": "Retrieves the list items of an asset list identified by ID.", "operationId": "list_asset_list_items", "parameters": [ { "name": "asset_list_id", "in": "path", "description": "Asset list id (GUID, or [type]_[userId])", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" }, "example": "aaff9159-8ba4-4ae5-a9d7-3e59d5903d72" }, { "name": "query", "in": "query", "description": "Query to retrieve a paginated list of asset list items for which the request user has permission to view.

Search query in Common Expression Language, with special characters encoded. For example, & is %26.

", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$%&=|\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" }, "example": "properties.data_product_id==aaff9159-8ba4-4ae5-a9d7-3e59d5903d72%26%26created_at%3E=2023-08-23T21:10:40Z" }, { "name": "start", "in": "query", "description": "Start token for pagination", "schema": { "maxLength": 512, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" } }, { "name": "limit", "in": "query", "description": "Search result limit", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "default": 200 }, "example": 10 }, { "name": "sort", "in": "query", "description": "This parameter can be repeated to add additional sort fields.

Default: null\n\nExamples of sort fields (these are case insensitive): \n * created_at\n * -created_at\n * last_update_time\n * -last_update_time", "content": { "application/json": { "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "A comma delimited array of sort parameters." } } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListItemCollection" }, "examples": { "asset_list_item_collection_response": { "summary": "Example Asset list item collection response.", "value": { "limit": 200, "total_count": 2, "first": { "href": "https://api.dataplatform.cloud.ibm.com/v2/asset_lists/3204c622-dcb8-4728-869f-484b6ac73dff/items" }, "next": { "href": "https://api.dataplatform.cloud.ibm.com/v2/asset_lists/3204c622-dcb8-4728-869f-484b6ac73dff/items?start=start_token", "start": "start_token" }, "items": [ { "asset": { "id": "8509d09e-b3d0-4e8b-9682-726a7b95f69a", "type": "data_asset", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "properties": { "my_property_1": "Value 1", "my_property_2": "Value 2" }, "id": "6357fce0-41ef-433b-95ee-03ade01bd02d", "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId", "asset_list": { "id": "3204c622-dcb8-4728-869f-484b6ac73dff" } }, { "asset": { "id": "8509d09e-b3d0-4e8b-9682-726a7b95f69b", "type": "data_asset", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "properties": { "my_property_1": "Value 1", "my_property_map": { "my_property_map_key": "Value 2" } }, "id": "cdaf6713-ede0-4a61-9fa4-d65467c59e9c", "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId", "asset_list": { "id": "3204c622-dcb8-4728-869f-484b6ac73dff" } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request GET --url '{url}/v2/asset_lists/{asset_list_id}/items' --header 'accept: application/json' --header 'authorization: Bearer {access_token}'" ] } ] } ] } } } }, "/v2/asset_lists/{asset_list_id}/items/{asset_list_item_id}": { "get": { "tags": [ "Asset Lists" ], "summary": "Retrieve an item in an asset list", "description": "Retrieves an item identified by ID of an asset list identified by ID.", "operationId": "get_asset_list_item", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListItem" }, "examples": { "asset_list_item_response": { "summary": "Example Asset list item response.", "value": { "asset": { "id": "8509d09e-b3d0-4e8b-9682-726a7b95f69a", "type": "data_asset", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "properties": { "my_property_1": "Value 1", "my_property_2": "Value 2" }, "id": "6357fce0-41ef-433b-95ee-03ade01bd02d", "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId", "asset_list": { "id": "3204c622-dcb8-4728-869f-484b6ac73dff" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request GET --url '{url}/v2/asset_lists/{asset_list_id}/items/{asset_list_item_id}' --header 'accept: application/json' --header 'authorization: Bearer {access_token}'" ] } ] } ] } } }, "patch": { "tags": [ "Asset Lists" ], "summary": "Update an asset list item", "description": "Use this API to update an asset list item. Specify patch operations using http://jsonpatch.com/ syntax.\r\n\r\nFields that can be patched:\r\n - /properties\r\n\r\n", "operationId": "update_asset_list_item", "parameters": [], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.", "content": { "application/json-patch+json": { "schema": { "maxItems": 256, "minItems": 1, "type": "array", "description": "JSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.", "items": { "$ref": "#/components/schemas/CatalogJsonPatchInstruction" } }, "examples": { "asset_list_item_patch": { "summary": "Example REST body for asset list item update of the properties map.", "value": [ { "op": "add", "path": "/properties/my_prop", "value": { "key": "Val 1" } }, { "op": "replace", "path": "/properties/my_prop2", "value": { "key": "Val 2" } } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetListItem" }, "examples": { "asset_list_item_response": { "summary": "Example Asset list item response.", "value": { "asset": { "id": "8509d09e-b3d0-4e8b-9682-726a7b95f69a", "type": "data_asset", "container": { "id": "71993ab5-3374-4355-8a38-fc4c32debc00", "type": "catalog" } }, "properties": { "my_property_1": "Value 1", "my_property_2": "Value 2" }, "id": "6357fce0-41ef-433b-95ee-03ade01bd02d", "access_control": { "owner": "userId", "bss_account_id": "bss_account_id" }, "created_at": "2023-09-17T23:19:08.000Z", "last_updated_at": "2023-09-17T23:19:08.000Z", "last_updated_by": "userId", "asset_list": { "id": "3204c622-dcb8-4728-869f-484b6ac73dff" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "415": { "description": "Unsupported Media Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl --request PATCH --url '{url}/v2/asset_lists/{asset_list_id}/items/{asset_list_item_id}' --header 'accept: application/json' --header 'authorization: Bearer {access_token}' --header 'content-type: application/json' --data '[{\"op\": \"add\",\"path\": \"/properties/my_prop\",\"value\": {\"key\": \"Val 1\"}},{\"op\": \"replace\",\"path\": \"/properties/my_prop2/key\",\"value\": \"Val 2\"}]'" ] } ] } ] } }, "x-codegen-request-body-name": "patch" }, "parameters": [ { "name": "asset_list_id", "in": "path", "description": "Asset list id (GUID, or [type]_[userId])", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" }, "example": "aaff9159-8ba4-4ae5-a9d7-3e59d5903d72" }, { "name": "asset_list_item_id", "in": "path", "description": "Asset list item id (GUID)", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string" }, "example": "aaff9159-8ba4-4ae5-a9d7-3e59d5903d73" } ] }, "/v2/asset_relationship_types": { "get": { "tags": [ "Asset Relationship Types" ], "summary": "Searches for relationship types", "description": "Searches for relationship types using various criteria. The query parameters here provide filters for the relationship types that are returned in the result. If no query parameters are provided, the result will include all relationship types that are visible to your bss account. If an asset container is specified, the results are limited to relationship types where at least one end can be used with the specified asset container. This is the case if the relationship end either has no declared asset container (for example because the end references a global asset type or is untyped) or if the end has an asset container that is the same as the asset container specified. If a `relname` filter is specified, the results are limited to relationship types where at least one end has a relationship name in the list. In order to see relationship types where at least one end is in the container asset type(s), you must either belong to the container's BSS account or have at least editor permission on the container. All users have permission to see global relationship types. \n\nLimit the relationship types based on the item types:\n * If the `asset_type` is specified, the results are limited to relationship types where at least one end is either untyped or is in the specified asset type list. \n * If both `asset_type` and `related_asset_type` are specified, the results are limited to relationship types where both ends are untyped, or where one end is in the specified asset type list and the other end has the specified asset type list. \n * If the `artifact_type` is specified, the results are limited to relationship types where at least one end is either untyped or is in the specified artifact type list. \n * If both `artifact_type` and `related_asset_type` are specified, the results are limited to relationship types where both ends are untyped, or where one end is in the specified artifact type list and the other end has the specified asset type list. \n * If the `asset_type` or `related_asset_type` is set to `*#_column`, the results are limited to relationship types where one end can be used with any supported column type (currently limited to `data_asset` columns) \n * If the item type is set to `*`, the results are limited to relationship types where one end can be used with any asset type or any artifact type. \n\nNote: In CP4D environments there is just one global bss account, so all relationship types are always visible to all users.", "operationId": "findRelationshipTypes", "parameters": [ { "name": "container_type", "in": "query", "description": "Required when container_id is specified and the container is not a catalog. Specifies the type of the container (CATALOG/PROJECT/SPACE). Defaults to CATALOG.", "schema": { "type": "string", "default": "CATALOG" } }, { "name": "container_id", "in": "query", "description": "Container ID. This limits results to relationship types that have an endpoint with the specified ID of a catalog, project, or space. If the container is a project or space, the container_type parameter must be also specified, otherwise container_id is treated as a catalog ID. This parameter is required when querying for relationship types associated with a catalog, project, or space. If this parameter is omitted, relationships types are not filtered by their container. Note that any type with an endpoint that has no container ID will also be included the result.", "schema": { "type": "string" } }, { "name": "type_name", "in": "query", "description": "The parameter `type_name` is deprecated, please use `asset_type` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "asset_type", "in": "query", "description": "Asset Type Name(s). This limits the results to only relationship types that have an endpoint in the specified asset type list, or have an endpoint that is untyped.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "artifact_type", "in": "query", "description": "Artifact Type Name(s). This limits the results to only relationship types that have an endpoint in the specified artifact type list, or have an endpoint that is untyped.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "related_asset_type", "in": "query", "description": "Related Asset Type Name(s). This parameter can only be set when either asset_type or artifact_type is also set. \n\nWhen asset_type is set, this limits the results to only relationship types that have an endpoint with the specified asset type and the other endpoint with this specified asset type. \n\nWhen artifact_type is set, this limits the results to only relationship types that have an endpoint with the specified artifact type and the other endpoint with this specified asset type. ", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "description": "limit to use when finding relationship types", "schema": { "type": "integer", "default": "25" } }, { "name": "bookmark", "in": "query", "description": "Optional bookmark to use when finding relationship types.", "schema": { "type": "string" } }, { "name": "relname", "in": "query", "description": "Relationship name(s). This limits the results to relationship types that have an endpoint with the specified name. The parameter should be repeated for each allowed relationship name.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "default_display_name", "in": "query", "description": "Default display name(s). This limits the results to relationship types that have an endpoint with the specified name. The parameter should be repeated for each allowed relationship name.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "scope", "in": "query", "description": "Specifies the scope of the relationship types which can be (GLOBAL/BSS_ACCOUNT). If GLOBAL - it returns all types scoped to Global.If BSS_ACCOUNT - it returns all types scoped to BSS_ACCOUNT.If query parameter is omitted, it returns all.", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "If specified, the results are limited to relationship types that can be accessed by the specified BSS account. If `container_id` is also specified, the catalog's BSS account must be the same as the BSS account specified here. \n\nIf `bss_account_id` is not specified and the API is called with an accredited service ID access token, then there is no filtering of the results based on BSS account. \n\n\nIf `bss_account_id` is not specified, and the API is called with a regular user (i.e. non-service ID) access token, then the result depends on whether `container_id` is specified. If `container_id` is specified, then the result includes global relationship types and account-scoped relationship types for the container's BSS account. If `container_id` is not specified, then the result includes global relationship types, and account-scoped relationship types for all of the user's BSS accounts.\n\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindRelationshipTypesResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" } } }, "post": { "tags": [ "Asset Relationship Types" ], "summary": "Creates an asset relationship type", "description": "Use this API to create an asset relationship type. The type definition consists of two endpoints which specify the two ends of a bidirectional relationship.\nThe endpoints define the name of the relationship at each end, and the qualified asset type or the qualified artifact type that contains the relationship endpoint. The names of the relationships that can be used with any given asset type or artifact type are required to be unique.\nIf the qualified asset type and the qualified artifact type are omitted, that end can be used with any asset type and any artifact type in any container.\n\n## Specifying the Type\nThe combination of `container_type`, `container_id`, and `containing_asset_type(s)` control what asset types can be used at each end of the relationship. The asset type can be a global asset type, an account-level asset type, a container-scoped asset type, or any asset type.\n\n### Global Asset Type\nTo define a relationship end for a global asset type, the `containing_asset_type(s)` field must be set to the name of the asset type and the `container_id` must be omitted. In this case, the relationship end can only be used with the specified global asset type. If the `container_type` field is set when using a global asset type, it is ignored.\n\n### Account Level Asset Type\n\nTo define a relationship end for an account-level asset type, the `containing_asset_type(s)` field must be set to the name of the asset type and the `container_id` must be omitted. In addition, the `bss_account_id` query parameter must be set to the bss account that owns the account-level asset type. In this case, the relationship end can only be used with the specified account-level asset type. If the `container_type` field is set when using an account-level asset type, it is ignored.\n\n### Container-Scoped Asset Type\n\nThe relationship mechanism allows relationship ends to be restricted to an asset type defined in a specific catalog, project, or space. To do this, the `containing_asset_type(s)`, `container_type`, and `container_id` fields must all be set.\n\n### Artifact Type\n\nTo define a relationship end for an governance artifact type, the `containing_artifact_type(s)` field must be set to the name of the artifact type and the `container_id` must be omitted.\nThe on_delete field can only set to IGNORE on both ends\n\n### Column Type\n\nTo define a relationship end for a column type, the `containing_asset_type(s)` field must be set in the format of `#_column`.\nWhen `*#_column` is specified, the relationship end can be used with any supported column type.\nCurrently, only `data_asset` columns are supported.\nThe `on_delete` field can only set to `IGNORE` on both ends\n\n### Any Type\n\nTo allow a relationship end to be used with any asset type, the `containing_artifact_type(s)`, `containing_asset_type(s)` and `container_id` fields for the relationship end must be omitted. In this case, the relationship end can be used with any asset type, any artifact type, and any supported column type in any container. If the `container_type` field is set, it will be ignored.\n\nNote: Cannot have `containing_artifact_type(s)` specified in both ends\n\n## Specifying the Relationship Type Scope\n\nA relationship type can either be global or be scoped to a BSS account.\n\nA relationship type can be explicitly scoped to a specific bss account using the `bss_account_id` query parameter. When a relationship type is scoped to a bss account, all specified asset containers and account-level asset types must belong to that bss account. If either endpoint for the relationship type has a specific asset container, the relationship type is automatically scoped to the bss account for the asset container. Account scoped relationship types can only be created if the user either belongs to the same bss account or is an administrator of all asset containers in the relationship type definition.\n\nBy default, if neither end of the relationship type specifies an asset container, the relationship type is created in the global scope and is accessible to all users. Only service ids with permission to create global asset types are allowed to create globally scoped relationship types. It is possible to scope a relationship type where neither end has an asset container to a specific BSS account. To do this, you must set the `bss_account_id` query parameter when creating the relationship type. The bss account must be set to a bss account that you have access to. In that case, the relationship type will be created, but its use will be restricted to asset containers associated with that bss account.\n\nBy default, on_delete is set to `IGNORE` if it is not specified\n\nNote that in CP4D environments, there is only one bss account (`999`). As a result, in that context relationship types scoped to a specific BSS account are effectively global.\n\n## Cascading clone/publish/promote to Referenced Assets\n\nThe following flags control how related assets are processed when an asset is copied using the `deepcopy` endpoint\n\n|Option |Allowed Value |Default |Description |\n|-----------|----------------|----------|-----------------------------------------------------------------------------------------------------------|\n|on_clone |CASCADE/IGNORE |IGNORE |If `CASCADE`, `deepcopy` from a catalog to a project causes the referenced assets to be copied as well |\n|on_publish |CASCADE/IGNORE |IGNORE |If `CASCADE`, `deepcopy` from project to a catalog causes the referenced assets to be copied as well |\n|on_promote |CASCADE/IGNORE |IGNORE |If `CASCADE`, `deepcopy` from a project to a space causes the referenced assets to be coped as well |\n\n", "operationId": "createRelationshipType", "parameters": [ { "name": "bss_account_id", "in": "query", "description": "This parameter forces the relationship type to be scoped to the specified bss account. It allows the creation of an account-scoped relationship type where both ends are either untyped, or are global asset types. It is required if the relationship type entity references any account-level asset types. An account-scoped relationship type is only visible to users in the BSS account for the relationship type. If the query parameter is unset, such relationships will be global in scope and can only be created if the user has permission to create a global asset type. Note: the BSS account can also be set via an impersonation header. If it is set in both places, the `bss_account_id` query parameter has precedence. This parameter is not required if either end of the relationship type has a catalog asset type. If it is set for a relationship type that has a catalog asset type, it must be the same as the BSS account for the catalog.", "schema": { "type": "string" } } ], "requestBody": { "description": "Relationship Type request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogRelationshipTypeEntity" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseRelationshipType" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Request" } } } }, "/v2/asset_relationship_types/search_ends": { "post": { "tags": [ "Asset Relationship Types" ], "summary": "Searches for relationship type ends", "description": "Find relationship type ends that can be used with an asset type or artifact type. This API supports finding relationship type ends that use global or catalog asset types.\n### For an asset type: \n * set `asset_type`. This parameter should be repeated for each allowed asset type\n * All asset types in the list must either be global/account level asset types or be scoped to the asset container specified by the `catalog_id`, `project_id`, or `space_id`.\n\n### For a column type: \n * set `asset_type` as `#_column`\n * if `asset_type` is specific to a container (catalog, space, or project), then set a container ID parameter as appropriate (`catalog_id`, `space_id`, `project_id`).\n\n#### For a governance artifact type: \n * set `artifact_type`. This parameter should be repeated for each allowed artifact type\n\n", "operationId": "searchOutgoingRelationshipEnds", "parameters": [ { "name": "catalog_id", "in": "query", "description": "catalog_id. If no container parameters are set, any asset container the user has access to are allowed.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "project_id. If no container parameters are set, any asset containers the user has access to are allowed.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "space_id. If no container parameters are set, any asset containers the user has access to are allowed.", "schema": { "type": "string" } }, { "name": "asset_type", "in": "query", "description": "asset_type(s). This specifies the asset type(s) whose relationship type ends should be found. This parameter should be repeated for each allowed asset type.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "artifact_type", "in": "query", "description": "artifact_type(s). This specifies the artifact type(s) whose relationship type ends should be found. This parameter should be repeated for each allowed artifact type.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "end_types", "in": "query", "description": "end_types. This filters the result to only include relationship type ends of the specified type(s) - valid filter values are {ASSET, ARTIFACT, COLUMN}. If this parameter is not specified, all relationship ends that match other criteria will be returned.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "description": "Optional limit to use when finding relationship type ends", "schema": { "type": "integer", "default": "25" } }, { "name": "bookmark", "in": "query", "description": "Optional bookmark to use when finding relationship type ends. ", "schema": { "type": "string" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: relationship_display_name_asc\n\nSupported sort fields (these are case insensitive): \n * relationship_name_asc\n * relationship_name_desc\n * relationship_display_name_asc\n * relationship_display_name_desc\n * create_time_asc\n * create_time_desc", "schema": { "type": "array", "items": { "type": "string" }, "default": "relationship_display_name_asc" } }, { "name": "relationship_names", "in": "query", "description": "Limits results to only include the specified relationships. By default, all relationship type ends which match the other search criteria are included. Repeat the query parameter to specify multiple relationship names.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindOutgoingRelationshipTypesResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" } } } }, "/v2/asset_relationship_types/search_used_ends": { "post": { "tags": [ "Asset Relationship Types" ], "summary": "Finds relationship types that are used by an asset, column or governance artifact", "description": "Finds relationship types that are used by an asset, column or a governance artifact. This API only returns the first page of results. It does not accept a bookmark. Any additional pages of results must be fetched using the next page url included in the response.

You can refer to the options in the response to get the full list of relationship names.", "operationId": "searchUsedRelationshipTypesForAssetOrArtifact", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog ID", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Space ID", "schema": { "type": "string" } }, { "name": "asset_id", "in": "query", "description": "Asset ID", "schema": { "type": "string" } }, { "name": "artifact_id", "in": "query", "description": "Artifact ID", "schema": { "type": "string" } }, { "name": "artifact_type", "in": "query", "description": "Artifact Type", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Optional limit to use when finding relationship types", "schema": { "type": "integer", "default": "25" } }, { "name": "lookup_related_item_types", "in": "query", "description": "Includes a list of the related asset types and artifact types in the result. This option adds overhead, so enable it only if the related type information is needed.", "schema": { "type": "boolean", "default": "false" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: relationship_display_name_asc\n\nSupported sort fields (these are case insensitive): \n * relationship_name_asc\n * relationship_name_desc\n * relationship_display_name_asc\n * relationship_display_name_desc\n * create_time_asc\n * create_time_desc", "schema": { "type": "array", "items": { "type": "string" }, "default": "relationship_display_name_asc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindOutgoingRelationshipTypesResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" } } } }, "/v2/asset_relationship_types/{relationship_type_id}": { "delete": { "tags": [ "Asset Relationship Types" ], "description": "Deletes a relationship type.", "operationId": "deleteRelationshipType", "parameters": [ { "name": "relationship_type_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Request" } } }, "patch": { "tags": [ "Asset Relationship Types" ], "summary": "Patches a relationship type", "description": "Updates an existing relationship type. The patch body must be an array of json patch operations as defined in RFC 6902.\n\nThe following fields can be patched in each relationship type endpoint:\n - `default_display_name` (value can be changed but not removed)\n - `localized_display_name` (values can be added, changed, and removed)\n - `on_delete` (value can be added, removed, or deleted)\n\nRelationship types where at least one endpoint is a catalog asset type can be patched either by an admin member of the catalog, or by a user in the catalog's BSS account. Global relationship types can only be patched by a user with permission to create global asset types.\n\nIt is important to note that the patch specifies updates to apply the current json representation of the relationship types. When specifying an add/replace/remove patch operation, all of parent elements in the path must already exist. In particular, if the\nrelationship type endpoint was originally created without a `localized_display_name` element, that element needs to be created by the patch operations.\n\nHere are some examples of patches that can be applied:\n\n\n### Add a display name to an endpoint without an existing `localized_display_name` element:\n```\n[\n {\n \"op\": \"add\",\n \"path\": \"/end2/localized_display_name\",\n \"value\": {\"\n \"en-us\": \"English Display Name\"\n }\n }\n]\n```\n### Add a display name to an endpoint with an existing `localized_display_name` element:\n```\n[\n {\n \"op\": \"add\",\n \"path\": \"/end2/localized_display_name/en-gb\",\n \"value\": \"British Display Name\",\n }\n]\n```\n### Change localized display name for en-gb in end2:\"\n```\n[\n {\n \"op\": \"replace\",\n \"path\": \"/end2/localized_display_name/en-gb\",\n \"value\": \"New British Display Name\"\n }\n]\n```\n### Remove localized display name for en-gb rom end1:\n```\n[\n {\n \"op\": \"remove\",\n \"path\": \"/end1/localized_display_name/en-gb\"\n }\n]\n```\n### Add a relationship option override, replace an existing relationship option override, delete an existing relationship option override:\n```\n[\n {\n \"op\": \"add\",\n \"path\": \"/end1/option_overrides/-\",\n \"value\": {\n \"this_asset_type\": \"ibm_bi_report\",\n \"other_asset_type\": \"ibm_bi_report_query\",\n \"on_delete\": \"CASCADE\",\n \"on_publish\": \"IGNORE\",\n \"on_promote\": \"CASCADE\",\n \"on_clone\": \"IGNORE\"\n }\n },\n {\n \"op\": \"replace\",\n \"path\": \"/end1/option_overrides/1/on_delete\",\n \"value\": \"CASCADE\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/end1/option_overrides/1/on_promote\",\n \"value\": \"IGNORE\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/end1/option_overrides/1/on_promote\"\n }\n[\n```\n", "operationId": "patchRelationshipType", "parameters": [ { "name": "relationship_type_id", "in": "path", "description": "relationship_type_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": " JSON array of patch operations as defined in RFC 6902.\n Note: Any ‘~’ characters need to be escaped as ~0 in the path field.\n Any ‘/’ characters need to be escaped as ~1 in the path field.\n For example, in `{\"foo/\" : {\"~bar\" : \"value\"}}`, the path for `\"~bar\"` is `\"/foo~1/~0bar\"`.\n", "content": { "application/json": { "schema": { "type": "object", "description": "JSON array of patch operations as defined in RFC 6902", "example": "[\n {\n \"op\": \"replace\",\n \"path\": \"/end2/default_display_name\",\n \"value\": \"new end2 display name\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/end1/default_display_name\",\n \"value\": \"new end1 display name\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/flags/use_for_lineage_traversal\",\n \"value\": \"true or false\"\n },\n {\n \"op\": \"add\",\n \"path\": \"flags/copy_to_knowledge_graph\",\n \"value\": \"true or false\"\n }\n]\n" } } }, "required": true }, "responses": { "200": { "description": "Relationship type was successfully patched", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseRelationshipType" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" } } } }, "/v2/asset_types": { "get": { "tags": [ "Asset Types" ], "summary": "List all asset types defined for an account, catalog, project or space.", "description": " Get all asset types in an account, catalog, project or space. Custom properties added/updated at the account level asset types can only be fetched if bss_account_id parameter is passed", "operationId": "getAllCatalogTypesNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "This parameter allows retrieving catalog-scoped asset types. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "This parameter allows retrieving project-scoped asset types. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "This parameter allows retrieving space-scoped asset types. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "This parameter allows retrieving account-scoped asset types. May be different than account of user specified in Bearer token. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "permits_decorators", "in": "query", "description": "This parameter allows to retrieve asset types which can be decorated. You can provide either a true or a false.", "schema": { "type": "boolean", "default": "FALSE" } }, { "name": "custom_attributes", "in": "query", "description": "This parameter allows to retrieve asset types which can be used only as attributes and are user defined. You can provide either a true or a false. At a time, either permits_decorators or custom_attributes can be true.", "schema": { "type": "boolean", "default": "FALSE" } }, { "name": "locale", "in": "query", "description": "Language code, such as default, en, etc.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTypesResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Asset Types" ], "summary": "Creates an asset type in an account, catalog, project or space.", "description": "Creates an asset type in account, catalog, project or space.", "operationId": "registerTypeNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "This parameter allows the creation of a catalog-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "This parameter allows the creation of a project-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "This parameter allows the creation of a space-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "This parameter allows the creation of an account-scoped asset type. May be different than account of user specified in Bearer token. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } } ], "requestBody": { "description": "Asset Type request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreationType" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogType" } } } }, "202": { "description": "Accepted - indicates the asset type creation is being completed in the background", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogType" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Request" } } } }, "/v2/asset_types/{type_name}": { "get": { "tags": [ "Asset Types" ], "summary": "Retrieves an asset type of a given name.", "description": " Retrieves an asset type of a given name. Custom properties added/updated at the account level asset types can only be fetched if bss_account_id parameter is passed", "operationId": "getCatalogType", "parameters": [ { "name": "type_name", "in": "path", "description": "Asset Type name (eg: data_asset)", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "This parameter allows retrieving a catalog-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "This parameter allows retrieving a project-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "This parameter allows retrieving a space-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "This parameter allows retrieving an account-scoped asset type. May be different than account of user specified in Bearer token. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "Language code, such as default, en, etc.", "schema": { "type": "string" } }, { "name": "search_scopes", "in": "query", "description": "This parameter can have one or more values as below:\n\n * GLOBAL - return asset type in global scope\n * BSS_ACCOUNT - return asset type in account scope\n * CONTAINER - return asset type in catalog/ project/ space scope\n\nIf no value is provided, the default value is taken as null, and the asset type with the highest search scope is returned.\nA combination of more than one search scope is also valid. In this case, an asset type with the highest search scope from the given scopes will be returned.\n", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogType" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Asset Types" ], "summary": "Replace an asset type", "description": "Replace asset attributes for the given asset type or create a new asset type if the given asset type does not exist.", "operationId": "replaceAssetType", "parameters": [ { "name": "type_name", "in": "path", "description": "Asset Type name (eg: data_asset)", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "This parameter allows creating or updating a catalog-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "This parameter allows creating or updating a project-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "This parameter allows creating or updating a space-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "This parameter allows creating or updating an account-scoped asset type. May be different than account of user specified in Bearer token. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } } ], "requestBody": { "description": "Asset Type request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogUpdateType" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogType" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogType" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Request" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset Types" ], "summary": "Deletes an asset type", "description": "Deletes an asset type in given account or container. Note that, deletion of an account scope asset type or a container scope asset type triggers background clean up of assets:
  • Assets of this type are deleted.
  • And in case of other assets, attributes of this type are removed.
", "operationId": "deleteAssetType", "parameters": [ { "name": "type_name", "in": "path", "description": "Asset Type name (eg: data_asset)", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "This parameter allows creating or updating a catalog-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "This parameter allows creating or updating a project-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "This parameter allows creating or updating a space-scoped asset type. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "This parameter allows creating or updating an account-scoped asset type. May be different than account of user specified in Bearer token. You must provide either a catalog_id, a project_id, a space_id, OR a bss_account_id but not more than one.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Request" }, "500": { "description": "Internal Server Error" } } } }, "/v2/asset_types/{type_name}/relationships": { "get": { "tags": [ "Asset Types" ], "summary": "Finds relationship types for an asset type", "description": "Finds relationship types that originate from a given asset type. This API supports limiting the results to a specific set of relationship types as well as providing pagination and sorting options. It also supports finding relationship types that use both global and catalog asset types.
This API is deprecated - use `POST /v2/asset_relationship_types/search_ends` instead", "operationId": "findOutgoingRelationshipTypes", "parameters": [ { "name": "type_name", "in": "path", "description": "type_name. This specifies the asset type whose relationships should be found.", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "catalog_id. If set, this restricts catalog asset types in the result to the given catalog. If no container parameters are set, any asset container the user has access to are allowed.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "catalog_id. If set, this restricts catalog asset types in the result to the given project. If no container parameters are set, any asset containers the user has access to are allowed.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "catalog_id. If set, this restricts catalog asset types in the result to the given space. If no container parameters are set, any asset containers the user has access to are allowed.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Optional limit to use when finding relationship types", "schema": { "type": "integer", "default": "25" } }, { "name": "bookmark", "in": "query", "description": "Optional bookmark to use when finding relationship types.", "schema": { "type": "string" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: relationship_display_name_asc\n\nSupported sort fields (these are case insensitive): \n * relationship_name_asc\n * relationship_name_desc\n * relationship_display_name_asc\n * relationship_display_name_desc\n * create_time_asc\n * create_time_desc", "schema": { "type": "array", "items": { "type": "string" }, "default": "relationship_display_name_asc" } }, { "name": "relname", "in": "query", "description": "Limits results to only include the specified relationships. By default, all relationship types for the asset type are included. Repeat the query parameter to specify multiple relationship names.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindOutgoingRelationshipTypesResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" } }, "deprecated": true } }, "/v2/asset_types/{type_name}/search": { "post": { "tags": [ "Asset Types" ], "summary": "Search for asset metadata within assets of the specified type", "description": "Use this API to search for assets of the generic asset type (asset) or any specific asset type in a Catalog, Space, or Project.\n\nThe request body must contain a `query` field, which specifies a Lucene query to search for assets on indexed fields.
\nSee Searchable Asset and Attachment Fields below for the list of fields that can be searched in the query.
\n\nIf `query` contains no selection criteria (`\"*:*\"`), then the result includes all assets that are instances of the type specified in the `type_name` path parameter,\nincluding assets whose primary asset type (i.e. its `metadata.asset_type` value) is that type, and assets that have an attribute of that type.
\nTo filter out assets whose primary type does not match the `type_name` parameter, the query must include an `asset.asset_type:{type_name}` predicate.\n\nThe query results can be sorted by specifying a `sort` field in the request with format `field`. The `sort_type` can be either `number` or `string` (e.g. `\"sort\" : \"asset.name\"`).\n\n Search With Pagination \n\nThe `limit` request body field can be specified to limit the number of assets in the search results.
\nThe default `limit` is 200. The maximum `limit` value is 200, and any greater value is ignored.
\n\nSample Request Body:\n```\n{\n \"query\" : \"asset.name:Asset*\",\n \"limit\" : 2,\n \"sort\" : \"asset.name\"\n}\n```\n\nResponse:\n```\n{\n \"next\": {\n \"bookmark\": \"g1AAAXXXXXXXX\",\n \"query\" : \"asset.name:Asset*\",\n \"limit\" : 2,\n \"sort\" : \"asset.name\"\n },\n \"results\": [\n {\n ..asset 1...\n },\n {\n ..asset 2...\n }\n ],\n \"total_rows\": 3\n}\n```\n\n\nWhen more search results are available, then the response will contain a `next` JSON object - `next` contains `bookmark` along with original query which needs to be returned\nto retrieve the next page of results. To paginate through the entire result set, the request should be re-executed with the `bookmark` from the `next.bookmark` value of the\nprevious response until there is no `next` object in the response (note that this response may contain an empty `results` array).\n\nSample request body to get the next page of results:\n```\n{\n \"bookmark\": \"g1AAAXXXXXXXX\",\n \"query\" : \"asset.name:Asset*\",\n \"limit\" : 2,\n \"sort\" : \"asset.name\"\n}\n```\n\nSearchable Asset and Attachment Fields\n\nThe following asset and attachment fields can be searched in the query - note that type `` or `` only needs to be added for use in the `sort` request field:
\n`asset.asset_attributes`
\n`asset.asset_category`
\n`asset.asset_state`
\n`asset.asset_type`
\n`asset.catalog_id`
\n`asset.created_at`
\n`asset.delete_timestamp`
\n`asset.description`
\n`asset.memberIds`
\n`asset.editor_id`
\n`asset.viewer_id`
\n`asset.member_or_owner_id`
\n`asset.memberGroupIds`
\n`asset.editor_group_id`
\n`asset.viewer_group_id`
\n`asset.member_or_owner_group_id`
\n`asset.mode`
\n`asset.name`
\n`asset.owner_id`
\n`asset.owner_group_id`
\n`asset.project_id`
\n`asset.rating`
\n`asset.resource_key`
\n`asset.identity_key`
\n`asset.source_asset_id`
\n`asset.source_catalog_id`
\n`asset.source_project_id`
\n`asset.source_space_id`
\n`asset.source_system`
\n`asset.source_system_asset_id`
\n`asset.source_system_created_at`
\n`asset.source_system_id`
\n`asset.source_history_asset_id`
\n`asset.source_history_system_id`
\n`asset.space_id`
\n`asset.tags`
\n`attachment.connection_id`
\n`attachment.connection_path`
\n`attachment.name`
\n`attachment.object_key`
\n", "operationId": "searchNewAssetV2", "parameters": [ { "name": "type_name", "in": "path", "description": "Asset Type name (eg: data_asset)", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } } ], "requestBody": { "description": "Search Criteria. The \"include\" field in the request body is a list of asset sections to include in the search results, values are comma-separated and the supported values are \"entity\" or \"entity,attachments\".", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalogSearch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetSearchResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/asset_types/{type_name}/status": { "get": { "tags": [ "Asset Types" ], "summary": "Get the status of an account scope or global scope asset type.", "description": "Retrieves an account scope or global scope status, If bss_account_id is not provided, api will try to retreive status of an asset type at global level if present.", "operationId": "getAccountAssetTypeStatus", "parameters": [ { "name": "type_name", "in": "path", "description": "Asset Type name (eg: account_type)", "required": true, "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "This parameter allows retrieving status of an account-scoped asset type. May be different than account of user specified in Bearer token.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetTypeStatusResponse" } } } }, "303": { "description": "See Other" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/v2/assets": { "post": { "tags": [ "Assets" ], "summary": "Create an asset", "description": "Use this API to create an asset in catalog or project. Assets contain information about the contents of your data and how to access the data. You store asset metadata in a catalog and add collaborators from your organization to analyze data. Your data can reside in a variety of sources. For example, you can keep your data in your existing on-premises data sources, cloud data services, or streaming data feeds. By adding connection information to these remote sources in the catalog, you can allow other catalog users to access the data with the stored credentials. Alternatively, you can copy a snapshot of the remote data into the catalog's encrypted cloud storage.
All asset types have a common set of properties. Some asset types have additional properties.
When you add an asset to a catalog, you specify these common properties:\n * The asset name and an optional description. The name can only contain letters, numbers, underscore, dash, space, and period. The name can't be only blank spaces.\n * Privacy. You can choose to restrict access to the asset with the privacy level and asset membership. \n \t* Public = Default. No restrictions on finding or using the asset.\n \t* Private = Only asset members can find or use the asset.\n * Members. The catalog collaborators can be added as members of the asset. Members are important if you restrict access to the asset. When you create an asset, you are the owner (and implicitly a member) of it. Members can be set in metadata/rov/collaborator_ids or metadata/rov/member_roles, but not both. Members set in metadata/rov/member_roles are given an explicit set of roles. Members can have up to two roles: OWNER and either EDITOR or VIEWER. Only service ids can assign the OWNER role. The request to add the OWNER role is ignored for other callers. Asset members with the EDITOR or VIEWER role must also be members of the catalog. Members set in metadata/rov/collaborator_ids are automatically assigned a role based on their role in the catalog.\n * Tags. Metadata that makes searching for the asset easier. Tags can contain only letters, numbers, underscores, dashes, and the symbols # and @.", "operationId": "createNewAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Asset metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAsset" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreationResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/bulk": { "get": { "tags": [ "Assets" ], "summary": "Get one or more assets.", "description": "Use this API to retrieve one or more assets located in catalog or project or space. Access to an asset is controlled by a combination of the privacy level and the members of the asset. For a governed catalog, data assets are protected from unauthorized access by the governance policies that are defined in Data Governance. Data assets in ungoverned catalogs are not subject to governance policies.

Response includes, for each asset, asset ID, status, HTTP status and, if no errors, asset details & relationship count or list of errors. For example:\r\n\n```\n{\r\n \"resources\":[\r\n {\r\n \"asset_id\":\"cf38d92c-eb55-462e-89bf-cdb9fe67f0b7\",\r\n \"status\":\"success\",\r\n \"http_status\":200,\r\n \"asset\":{...},\r\n \"relationship_count\":2\r\n },\r\n {\r\n \"asset_id\":\"c6650020-3176-4d67-8fbe-5a19ba1c2c7e\",\r\n \"status\":\"failed\",\r\n \"http_status\":404,\r\n \"errors\":[\r\n ...\r\n ]\r\n },\r\n ...\r\n ]\r\n}\r\n```\r\n", "operationId": "retrieveAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_ids", "in": "query", "description": "Comma separated list of asset IDs; maximum of 20. For assets with revisions, an optional revision number can be specified using colon character in the form of '<asset id>:<revision>,<asset id>,...'. Revision numbers are non-zero positive numbers likes 1, 2, 3 etc.", "required": true, "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "include_relationship_count", "in": "query", "description": "Whether to include per-asset relationship count. Note: The default will be changed to 'false' in a later release.", "schema": { "type": "boolean", "default": "true" } }, { "name": "include_source_columns", "in": "query", "description": "Whether to include relationships where source end is a column of the source asset in the asset's relationship counter.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Assets" ], "summary": "Marks existing assets for delete", "description": "Use this API to delete assets. You can delete an asset if you are the owner of the asset or a member of the asset with Admin or Editor permissions on the catalog or project or space. \r\n## Purge Options to Delete Assets\r\n\r\n purge_on_delete = true and purge_after_days is not specified: the asset is purged immediately.\r\n purge_on_delete = true and purge_after_days = n: the asset is moved to trash and purged after n days.\r\n purge_on_delete = false and purge_after_days is not specified: the asset is moved to trash and never purged.\r\n purge_on_delete is not specified and purge_after_days is not specified: the asset will be deleted/purged based on the catalog setting.\r\n purge_on_delete = false or is not specified and purge_after_days = n: invalid combination - the call will fail with a 400 Bad Request error.\r\n\r\n", "operationId": "deleteAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "purge_on_delete", "in": "query", "description": "If true, asset is also deleted from the trash.", "schema": { "type": "boolean", "default": "false" } }, { "name": "purge_after_days", "in": "query", "description": "Number of days after which asset will be purged. Purge On Delete should be true for this to be valid", "schema": { "type": "integer" } }, { "name": "asset_ids", "in": "query", "description": "Comma separated list of asset IDs; maximum of 20.", "required": true, "schema": { "type": "string" } } ], "responses": { "207": { "description": "Check response body for status of each asset being deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsDeleteResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/bulk/members/{member_id}": { "get": { "tags": [ "Assets" ], "summary": "Get assets membership for a specific user", "description": " Returns any memberships this user has on assets, including direct membership and any access group memberships.", "operationId": "getMemberForAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_ids", "in": "query", "description": "Comma separated list of asset IDs; maximum of 25.", "required": true, "schema": { "type": "string" } }, { "name": "member_id", "in": "path", "description": "member_id", "required": true, "schema": { "type": "string" } }, { "name": "resolve_member_roles", "in": "query", "description": "Should resolve member roles from usergroup(s) and collaborator roles", "schema": { "type": "boolean", "default": "false" } }, { "name": "member_type", "in": "query", "description": "Type of the member specified by the member_id. If not specified, the service will determine if the member is a user or an access group based on the member_id, which is not always possible or accurate. Always supplying the member type is recommended.", "schema": { "type": "string", "enum": [ "user", "group" ] } }, { "name": "profile_id", "in": "query", "description": "IAM Profile ID for Trusted Profile users: If the getMemberForAssetV2 API is called to fetch details for a Trusted Profile, the member_id is the IAM ID of the actual user, and the profile_id will be the IAM ID of the trusted user. For IBM users and App ID users, this value should be null.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMemberSet" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/bulk_copy": { "post": { "tags": [ "Assets" ], "summary": "Copies one or more assets and, if deep copy option is on, their related assets from a source container to a target container.", "description": "Use this API to publish one or more assets from a project to a catalog or promote from a project to a space. This API can also be used to clone one or more assets from a catalog to a project. The default maximum number of assets in a request is 50.

Copy sends the same Rabbit MQ messages as publish, promote or clone. Messages are sent for all assets that are copied.

This API supports using a refresh token in place of an access token. This can be helpful if the copy is expected to be a long running operation. The copy operation uses the access token to authenticate with other services, so it is important that it not expire while the operation is in progress. When a refresh token is specified, it is used to generate an initial access token as well as additional access tokens if the initial access token expires", "operationId": "deepCopyAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Source catalog ID. Only one of either catalog ID or project ID must be provided.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Source project ID. Only one of either catalog ID or project ID must be provided.", "schema": { "type": "string" } }, { "name": "deepcopy", "in": "query", "description": "Determines if the copy operation should be cascaded to referenced assets. Referenced assets are determined using bidirectional external relationships and as well as in-line relationships. In-line relationship types are defined as part of asset type definitions. Cascading happens only if `CASCADE` is set for the following relationship type property:\n\n* `on_clone`, in case of copying from catalog to project,\n* `on_publish`, in case of copying from project to catalog and\n* `on_promote`, in case of copying from project to space.\n\n", "schema": { "type": "boolean", "default": "false" } }, { "name": "auto_copy_connections_in_remote_attachments", "in": "query", "description": "Whether to automatically copy connections in remote attachments", "schema": { "type": "boolean", "default": "true" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Request body should include target container ID and list of assets with metadata overrides, and may include asset permissions override. Target container ID should be either that of a catalog (publish) or of a space (promote) if source conatiner is a project, or that of a project (clone) if source is a catalog. Example: \n\n\n```\n{\r\n \"catalog_id\": \"string\",\n \"rov_mode\": \"integer\",\n \"member_roles\": {\n \"Member's IAM ID\": {\n \"user_iam_id\": \"Member's IAM ID\",\n \"roles\": [\"EDITOR\"]\n },\n \"Access Group ID\": {\n \"access_group_id\": \"Access Group ID\",\n \"roles\": [\"VIEWER\"]\n },\n \"Another IAM ID\": {\n ...\n }\n },\n \"copy_configurations\":[\n {\n \"asset_id\": \"string\",\n \"revision_id\": \"string\",\n \"metadata_overrides\": {\n \"name\":\"string\", \"description\":\"string\", \"tags\":[\"string\",\"string\"]\n }\n },\n ...\n ]\n}\n```\nFields 'rov_mode' and 'member_roles' are optional.\n * If specified, they apply to all newly copied (target) assets.\n * If not supplied, newly copied asset gets mode and 'member_roles' from its corresponding source asset.\n * Valid values for 'rov_mode' are 0 (public), 8 (private) and 16 (hidden).\n * If caller doesn't have permissions to set any of the roles then 'member_roles' is completely ignored.\n * If supplied, 'member_roles' should include at least one OWNER role.\n\nThe 'metadata_overrides' field is optional and may contain attributes to overwrite the values in original asset. Currently only name, description and tags can be overriden. If specified 'metadata_overrides' cannot be empty and only applies to respective root asset.\n\nAny cross-referenced asset is copied only once. ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsCopyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK - indicates the copy operation has completed - assets and its related assets (if applicable) have been fully copied to the target catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsCopyResponse" } } } }, "202": { "description": "Accepted - indicates that the copy request is being completed in the background.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsCopyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } } } }, "/v2/assets/bulk_create": { "post": { "tags": [ "Assets" ], "summary": "Create one or more assets. ", "description": "Use this API to create one or more assets in a catalog or a project or a space. The default maximum number of assets in a request is 20. Example of request (POST) data:

\n```\n{\r\n \"assets\":[\r\n {\r\n \"name\":\"\",\r\n \"description\":\"\",\r\n \"tags\":[\"\", \"\", ...],\r\n \"asset_type\":\"\",\r\n \"entity\":{\r\n ...\r\n }\r\n \"attachments\":{\r\n ...\r\n }\r\n },\r\n {\r\n \"name\":\"\",\r\n ...\r\n },\r\n ...\r\n ]\r\n}\r\n```\r\nResponse includes, for each asset in the request and in the same order, details of newly created asset or details of updated asset if a duplicate/match is found or errors if any:\r\n\r\n\n```\n{\r\n \"trace\":\"\", \r\n \"responses\":[\r\n {\r\n \"http_status\":201,\r\n \"asset\":{...}\r\n },\r\n {\r\n \"http_status\":400,\r\n \"errors\":[\r\n ...\r\n ]\r\n },\r\n ...\r\n ]\r\n}\r\n```\r\n", "operationId": "createAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "JSON containing list of assets to be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsCreateResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/bulk_patch": { "post": { "tags": [ "Assets" ], "summary": "Patch one or more assets. ", "description": "Use this API to patch one or more assets in catalog or project or space.\nThe default maximum number of assets in a request is 20.\n\nThe API supports the following operations:\n- Patching of allowed metadata properties. See `PATCH /v2/assets/{asset_id}` API for list of allowed metadata properties that can be patched.\"\n- Add, update and delete of attributes such as `asset_terms`, `data_profile`, etc.\"\n- Create, update and delete of attachments:\n - The (asset) `attachments` field is an array and the index of the first attachment is 0, the index of the second one is 1 and so on. Adding or deleting an attachment shifts indexes of any attachments that follow it.\n - A newly created attachment is added at the specified location. If the `path` is `/attachments/-` then it will be added at the end.\n - Newly added attachment cannot be updated or deleted (in the same API call). And, newly updated attachment cannot be deleted.\n - Some of the new attachment fields like `attachment_id`, `url1`, `url2`, etc. are only included in the response the first time when the attachments are created.\n - Only the following attachment fields can be updated: `name`, `description`, `mime`, `size`, `partitions` and `transfer_complete`.\n\nThe API does not support patching of whole metadata, entity and attachments.\n- i.e. The `path` cannot be the following values: `/metadata`, `/entity` or `/attachments`.\n\nAccess to an asset is controlled by a combination of the privacy level and the members of the asset.\nFor a governed catalog, data assets are protected from unauthorized access by the governance policies that are defined in Data Governance. Data assets in ungoverned catalogs are not subject to governance policies.\n\n> Note: Patch 'operations' should conform to [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) specification.\n\nExample of request (POST) data:\n\n```\n{\n \"resources\": [\n {\n \"asset_id\": \"cf38d92c-eb55-462e-89bf-cdb9fe67f0b7\",\n \"operations\": [\n {\n \"op\": \"add\",\n \"path\": \"/metadata/description\",\n \"value\": \"Four score and seven years ago...\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/entity/data_asset/mime_type\",\n \"value\": \"text/csv\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/attachments/1/name\",\n \"value\": \"New name for the 2nd attachment.\"\n },\n {\n \"op\": \"remove\",\n \"path\": \"/attachments/0\"\n }\n {\n \"op\":\"add\",\n \"path\":\"/attachments/-\",\n \"value\":{...}\n },\n {\n \"op\":\"replace\",\n \"path\":\"/attachments/1/name\",\n \"value\":\"New name for the 2nd attachment.\"\n },\n {\n \"op\":\"add\",\n \"path\":\"/attachments/2\",\n \"value\":{...}\n },\n ]\n },\n {\n \"asset_id\":\"c6650020-3176-4d67-8fbe-5a19ba1c2c7e\",\n \"operations\": [\n ...\n ]\n },\n ...\n ]\n}\n```\nResponse includes, for each asset, asset ID, status and updated version or errors, if any:\n```\n{\n \"resources\": [\n {\n \"asset_id\": \"cf38d92c-eb55-462e-89bf-cdb9fe67f0b7\",\n \"status\": 200,\n \"http_status\": 200,\n \"asset\": {\n ...\n }\n },\n {\n \"asset_id\": \"c6650020-3176-4d67-8fbe-5a19ba1c2c7e\",\n \"status\": 404,\n \"http_status\": 404,\n \"errors\": [\n ...\n ]\n },\n ...\n ]\n}\n```\n\nCurrently the API allows to patch up to twenty (20) assets. There is no limit on number of patch instructions. Any number of (allowed) metadata properties and/or attributes can be:\n- modified,\n- new ones added,\n- existing ones be replaced or\n- deleted\n\nJSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.\n\n> Note: Any `~` characters need to be escaped as `~0` in the path field\n\nAny `/` characters need to be escaped as `~1` in the path field\n\nFor example, in `{\"foo/: {\"~bar: \"value\"}}`, the path for `~bar` is `/foo~1/~0bar`\n", "operationId": "updateAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "JSON containing per-asset updates/patches.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK - indicates successful completion of overall request. The 'http_status' of sub-response provides status of corresponding sub-request i.e. asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetsUpdateResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/copy_status/{copy_task_id}": { "get": { "tags": [ "Assets" ], "summary": "Gets the status of asset copy operation", "description": "For large deep copies, portions of the copy operation are performed in the background. This API provides a way to get the status of the background processing. It also provides additional details about deep copy operations that have already been completed.\n\nSimilar to /v2/assets/deepcopy/{deep_copy_task_id} API but response can support completion details of multiple source assets. \n\nNote: The status of completed copy operations is only available for 24 hours.", "operationId": "getDeepCopyStatusNew", "parameters": [ { "name": "copy_task_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetCopyStatusNew" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } } } }, "/v2/assets/create_object_url": { "post": { "tags": [ "Assets" ], "summary": "Create a PUT signed url for an object or a file", "description": "Use this API to create a PUT signed url to an object or a file in the catalog/project/space bucket/storage.
You must specify both name and asset_type (to create a new object or a file) OR the asset_id (to overwrite an existing object or a file) in the request.
You must specify one of these -- catalog_id, project_id or the space_id as a query parameter.
Details:\n * No new meta-data (asset_id) is created or updated for this request.\n * Only the PUT signed url is returned for the object or the file.\n * If the asset_id is given in the request, a PUT signed url is returned for that asset's attachment's object/file, if the object/file is stored in the catalog/project/space bucket/storage. If the asset_type is given, the object/file from the first attachment with that asset_type is the one for which the PUT signed url will be returned. If the asset_type is not given, then, the asset's asset_type, then the \"data_asset\", will be used to find the attachment with the object/file.\n * If the asset_id is not given in the request, and asset_type and name are specified, a PUT signed url is returned for an object_key where the object_key value is created using the combination of asset_type, sanitized name, and a random string.\n * The name in the request can only contain letters, numbers, underscore, dash, space, and period -- same requirements as the attachment name.\n * The value of expires_in is in seconds. The default value of expires_in is 604800 (7 days). Given a value of 0, the default value will be applied. The max value is the same as the default value; if a value larger than the max value is input, the max value will be used.", "operationId": "createObjectURL", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "requestBody": { "description": "object_url request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogObjectURLReqResp" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/deepcopy/{deep_copy_task_id}": { "get": { "tags": [ "Assets" ], "summary": "Gets the status of a deep copy operation", "description": "For large deep copies, portions of the copy operation are performed in the background. This API provides a way to get the status of the background processing. It also provides additional details about deep copy operations that have already been completed.\n\nNote: The status of completed deep copy operations is only available for 24 hours.", "operationId": "getDeepCopyStatus", "parameters": [ { "name": "deep_copy_task_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetCopyStatus" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } } } }, "/v2/assets/duplicates/bulk_search": { "post": { "tags": [ "Assets" ], "summary": "Bulk search duplicate assets", "description": "Use this API to search for duplicate assets of an array of assets in the target catalog, project, or space. The maximum number of assets in a request is 20.\r\n\nEach asset in the request can either be an existing asset, or an asset object that is the same as the user would provide for creating a new asset. E.g.,\n```\n{\r\n \"resources\":[\r\n {\r\n \"asset\": {\r\n \"metadata\": {},\r\n \"entity\": {}\r\n }\r\n },\r\n {\r\n \"project_id\": \"6f79ff7d-9227-4cba-81e7-726db8984d16\",\r\n \"asset_id\": \"faad7530-4a30-41da-ac27-d3a0f07b2070\"\r\n },\r\n {\r\n \"asset\": {\r\n \"metadata\": {},\r\n \"entity\": {}\r\n }\r\n }\r\n ]\r\n}\r\n```\nThe response contains an array of duplicate search results. The index of the results in the array is the same as the index of the corresponding asset in the request array. Each result can be a success or failure depending on the corresponding request asset. E.g.,\n```\n{\r\n \"trace\":\"32s0wywr3wdqpsn86b4cfzb4i\",\r\n \"resources\":[\r\n {\r\n \"http_status\": 200,\r\n \"total_count\": 1,\r\n \"best_updatable_duplicate_asset_id\": \"b81c84f5-a551-43bb-9a6e-c8e7820995f9\",\r\n \"results\": [\r\n {\r\n \"asset_id\": \"b81c84f5-a551-43bb-9a6e-c8e7820995f9\",\r\n \"highest_match_score\": {},\r\n \"asset\": {\r\n \"metadata\": {},\r\n \"entity\": {}\r\n }\r\n }\r\n ]\r\n },\r\n {\r\n \"http_status\": 404,\r\n \"errors\": [\r\n {\r\n \"code\": \"does_not_exist\",\r\n \"message\": \"ATTSV3024E: There is no asset with an ID of 'faad7530-4a30-41da-ac27-d3a0f07b2070' in a project with an ID of '6f79ff7d-9227-4cba-81e7-726db8984d16' .\"\r\n }\r\n ]\r\n },\r\n {\r\n \"http_status\": 200,\r\n \"total_count\": 0,\r\n \"results\": [\r\n ]\r\n }\r\n ]\r\n}\r\n```\nThe response of each requested item contains a `http_status` field that can be used to determine if the specific request was successful or not. If a request failed, the corresponding response will contain a field `errors` indicating the cause of the failure. For detail explaination of other fields in the request and response of each item, please refer to the `POST /v2/assets/duplicates/search` endpoint.", "operationId": "bulkSearchDuplicateAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of items to return for each requested asset", "schema": { "type": "integer", "default": "100" } } ], "requestBody": { "description": "The assets to search for duplicate assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkSearchDuplicateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkSearchDuplicateResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/duplicates/search": { "post": { "tags": [ "Assets" ], "summary": "Search duplicate assets", "description": "Use this API to search for duplicate assets of an asset in the target catalog, project, or space.\r\n\nUsers can provide an existing asset like below to search for duplicate assets of the given asset in the target asset container. The authenticated user needs to have the read access to the specified asset. \n```\n{\r\n \"project_id\": \"6f79ff7d-9227-4cba-81e7-726db8984d16\",\r\n \"asset_id\": \"faad7530-4a30-41da-ac27-d3a0f07b2070\"\r\n}\n```\n\nOr provide an asset object to search for duplicate assets of the given asset payload in the target asset container. The asset payload is the same as the user would provide for creating a new asset.\n```\n{\r\n \"asset\": {\r\n \"metadata\": {},\r\n \"entity\": {}\r\n }\r\n}\r\n```\r\n\nThe query parameter `limit` can be used to limit the number of duplicates in the response. If not supplied, the maximum allowed value `100` is used. Note that the API does not support paignation as users usually only care about top `x` number of duplicates instead of all duplicates. If they do, they can always use a large limit to retrieve all duplicates. There number of the duplicates of any given asset should be far less than the maximum allowed value of the parameter `limit`. The system would become unusable long before the number of duplicates reaches that value.\r\n\nThe duplicate assets in the response are ordered by the matching score from high to low. The higher the matching score, the more certain that the asset is a duplicate of the incoming asset.\r\n\nThe `total_count` indicates the total number of duplicates of the given asset. This is useful in case the total number of duplicates is greater than the specified limit.\r\n\nThe `best_updatable_duplicate_asset_id` indicates the highest ranking duplicate asset that can be updated by the authenticated user. This duplicate asset would be updated/replaced if the incoming asset were to be added in the target asset container and the effective `duplicate_action` were `UPDATE/REPLACE`. If duplicates are found but this field doesn't have a value, it indicates that the authenticated user doesn't have permission to update any of the duplicates. In such a case, if the incoming asset were to be added in the target asset container and the effective `duplicate_action` were `UPDATE/REPLACE`, the transaction would fail.\n\r\n", "operationId": "searchDuplicateAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of items to return", "schema": { "type": "integer", "default": "100" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Supply either an existing asset or an asset payload to search for duplicate assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogSearchDuplicateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogSearchDuplicateResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/get_relationships": { "post": { "tags": [ "Asset Relationships" ], "summary": "Finds related assets", "description": "Finds assets related to a given asset or a given governance artifact. This API supports limiting the results to a specific set of relationships as well as providing pagination and sorting options. \n ### Finds assets and artifacts related to an asset: \n* One of the {`catalog_id`, `project_id`, `space_id`} must be specified. \n* asset_id must be specified. \n* artifact_id and artifact_type cannot be specified. \n### Finds assets related to an artifact: \n* artifact_id and artifact_type must be specified. \n* asset_id and container id cannot be specified. \n### Finds assets and artifacts related to a column: \n* One of the {`catalog_id`, `project_id`, `space_id`} must be specified. \n* asset_id must be specified. asset_id should be in the format of `#COLUMN#` \n* artifact_id and artifact_type cannot be specified. \n\n

Note:When self references are present (i.e. when the source and target asset in the relationship are the same), more rows than specified by the limit may be returned. When this happens, the total rows reported is accurate and the bookmark points to next page of results.", "operationId": "searchRelatedAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog ID", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Space ID", "schema": { "type": "string" } }, { "name": "asset_id", "in": "query", "description": "Asset ID", "schema": { "type": "string" } }, { "name": "artifact_id", "in": "query", "description": "Artifact ID", "schema": { "type": "string" } }, { "name": "artifact_type", "in": "query", "description": "Artifact Type", "schema": { "type": "string" } }, { "name": "related_asset_types", "in": "query", "description": "Related Asset Types", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "related_artifact_types", "in": "query", "description": "Related Artifact Types", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "bookmark", "in": "query", "description": "bookmark", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "limit. Defaults to 25", "schema": { "type": "integer", "default": "25" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: update_time_asc\n\nSupported sort fields (these are case insensitive): \n * create_time_asc\n * create_time_desc\n * update_time_asc\n * update_time_desc\n * creator_id_asc\n * creator_id_desc\n * updater_id_asc\n * updater_id_desc", "schema": { "type": "array", "items": { "type": "string" }, "default": "update_time_asc" } }, { "name": "relationship_names", "in": "query", "description": "Limits results to only include the specified relationships. By default, all relationships are included. Repeat the query parameter to specify multiple relationship names.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "lookup_asset_names", "in": "query", "description": "Whether to lookup the asset names. This adds overhead, so only set this to true if the asset names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } }, { "name": "lookup_artifact_names", "in": "query", "description": "Whether to lookup the artifact names. This adds overhead, so only set this to true if the artifact names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } }, { "name": "lookup_container_names", "in": "query", "description": "Whether to lookup the container names. This adds overhead, so only set this to true if the asset names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } }, { "name": "include_columns", "in": "query", "description": "(DEPRECATED) Whether to return relationships where target end is a column for the given source asset, artifact, or column. This parameter is deprecated. Use 'include_target_columns' instead.", "schema": { "type": "boolean", "default": "false" } }, { "name": "include_target_columns", "in": "query", "description": "Whether to return relationships where target end is a column for the given source asset, artifact, or column.", "schema": { "type": "boolean", "default": "false" } }, { "name": "include_source_columns", "in": "query", "description": "Whether to return relationships where source end is either the given asset or a column of the given asset. When this parameter set to 'true', 'include_target_columns' must also be set to 'true'. By this, all relationships of asset-asset, asset-column, asset-artifact, column-asset, column-column, column-artifact will be returned.Use this parameter when 'asset_id' refers to an asset which has columns.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindRelatedObjectsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/ibm_data_source": { "get": { "tags": [ "Assets" ], "summary": "Get an ibm_data_source asset", "description": "Use this API to get an ibm_data_source asset with provided endpoint or physical_collection.\r\nThere is only one ibm_data_source asset that meets the specified parameters.\r\nCurrently we only support the following three query methods:\r\n1. host + port, the host is either ipV4 or ipV6 or a DNS name\r\n2. host + port + physical_collection\r\n3. physical_collection", "operationId": "retrieveDatasourceAsset", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog GUID or UID", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "the bss_account_id", "schema": { "type": "string" } }, { "name": "host", "in": "query", "schema": { "type": "string" } }, { "name": "port", "in": "query", "schema": { "type": "string" } }, { "name": "physical_collection", "in": "query", "description": "It can be database, project_id or bucket", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/publish": { "post": { "tags": [ "Assets" ], "summary": "Publish an asset from a project which is only referenced in that project", "description": "Use this API to publish an asset whose only metadata are only in project as reference to a target catalog. Assets contain information about the contents of your data and how to access the data. You store asset metadata in a catalog and add collaborators from your organization to analyze data. Your data can reside in a variety of sources. For example, you can keep your data in your existing on-premises data sources, cloud data services, or streaming data feeds. By adding connection information to these remote sources in the catalog, you can allow other catalog users to access the data with the stored credentials. Alternatively, you can copy a snapshot of the remote data into the catalog's encrypted cloud storage.
All asset types have a common set of properties. Some asset types have additional properties.
When you add an asset to a catalog, you specify these common properties:\n * The asset name and an optional description. The name can only contain letters, numbers, underscore, dash, space, and period. The name can't be only blank spaces.\n * Privacy. You can choose to restrict access to the asset with the privacy level and asset membership. \n \t* Public = Default. No restrictions on finding or using the asset.\n \t* Private = Only asset members can find or use the asset.\n * Members. The catalog collaborators can be added as members of the asset. Members are important if you restrict access to the asset. When you create an asset, you are the owner (and a member) of it.\n * Tags. Metadata that makes searching for the asset easier. Tags can contain only letters, numbers, underscores, dashes, and the symbols # and @.", "operationId": "createVirtualAssetV2", "parameters": [ { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Asset metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPublishAsset" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/search_relationships": { "post": { "tags": [ "Asset Relationships" ], "summary": "Searches for relationships", "description": "Finds relationships that match the specified criteria. There are two general kinds of criteria that can be used: criteria that at least one relationship end must match and criteria that the overall relationship must match.\r\n\r\n### Specifying conditions that at least one end of the relationship must match\r\nThere are three different conditions of this type that can be specified:\r\n\r\n * relationship name - limits results to relationships with the specified name(s)\r\n\r\n * Required object criteria:\r\n * required artifact — must specify artifact_type and artifact_id\r\n * required asset - must specify asset_id and one of: catalog_id, project_id, space_id\r\n * required asset container - must specify one of: catalog_id, project_id, space_id\r\n * Only one type of required object criteria can be used\r\n\r\n * Opposite end criteria:\r\n * related_asset_types - specifies that opposite end must have one of the specified asset types\r\n * related_artifact_types - specifies that opposite end must have one of the specified artifact types\t\n * related_asset_types and related_artifact_types can be used together to specify that the opposite end must have either the specified asset or artifact types\r\n### Specifying global conditions that the overall relationship much match:\r\n\r\nThere are 2 global conditions that can be specified:\r\n * modified_after - Restricts results to relationships created/updated after a specific date and time\r\n * modified_before - Restricts results to relationships created/updated before a specific date and time\r\n * modified_after and modified_before can be used together to filter for relationships created/updated within a specific time window.", "operationId": "searchRelationships", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog ID. Specifies that a specific catalog_id must be in the returned relationships. If filtering by asset container, either catalog_id, project_id, or space_id must be specified.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID. Specifies that a specific project_id must be in the returned relationships. If filtering by asset container, either catalog_id, project_id, or space_id must be specified.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Space ID. Specifies that a specific space_id must be in the returned relationships. If filtering by asset container, either catalog_id, project_id, or space_id must be specified.", "schema": { "type": "string" } }, { "name": "asset_id", "in": "query", "description": "Asset ID. Specifies that a specific asset must be in the returned relationships If specified, either catalog_id, project_id, or space_id must also be specified.", "schema": { "type": "string" } }, { "name": "artifact_id", "in": "query", "description": "Artifact ID. Specifies that a specific artifact must be in the returned relationships. If specified, artifact_type must also be specified", "schema": { "type": "string" } }, { "name": "artifact_type", "in": "query", "description": "Artifact Type. Required if artifact_id is specified", "schema": { "type": "string" } }, { "name": "related_asset_types", "in": "query", "description": "Related Asset Types. Filters the result to include relationships based on their target asset type. The parameter can be repeated to specify multiple asset types. If both related_artifact_types and related_asset types are omitted, all target types are included in the result.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "related_artifact_types", "in": "query", "description": "Related Artifact Types. Filters the result to include relationships based on their target artifact type. The parameter can be repeated to specify multiple artifact types. If both related_artifact_types and related_asset types are omitted, all target types are included in the result.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "bookmark", "in": "query", "description": "bookmark", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "limit. Defaults to 25", "schema": { "type": "integer", "default": "25" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: update_time_asc\n\nSupported sort fields (these are case insensitive): \n * create_time_asc\n * create_time_desc\n * update_time_asc\n * update_time_desc\n * creator_id_asc\n * creator_id_desc\n * updater_id_asc\n * updater_id_desc", "schema": { "type": "array", "items": { "type": "string" }, "default": "update_time_asc" } }, { "name": "relationship_names", "in": "query", "description": "Limits results to only include the specified relationships. By default, all relationships are included. Repeat the query parameter to specify multiple relationship names.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "lookup_asset_names", "in": "query", "description": "Whether to lookup the asset names. This adds overhead, so only set this to true if the asset names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } }, { "name": "lookup_artifact_names", "in": "query", "description": "Whether to lookup the artifact names. This adds overhead, so only set this to true if the artifact names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } }, { "name": "lookup_container_names", "in": "query", "description": "Whether to lookup the container names. This adds overhead, so only set this to true if the asset names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } }, { "name": "modified_after", "in": "query", "description": "Includes relationships modified after this date/time - specified in ISO-8601 format (examples: 2022-09-01T14:32:17Z, 2022-09-01T14:32:17.802Z). This can be used in conjunction with modified_before to specify a required modification time window.", "schema": { "type": "string" } }, { "name": "modified_before", "in": "query", "description": "Includes relationships modified before this date/time - specified in ISO-8601 format (examples: 2022-09-01T14:32:17Z, 2022-09-01T14:32:17.802Z). This can be used in conjunction with modified_after to specify a required modification time window.", "schema": { "type": "string" } }, { "name": "include_columns", "in": "query", "description": "(DEPRECATED) Whether to return relationships where target end is a column for the given source asset, artifact, or column. This parameter is deprecated. Use 'include_target_columns' instead.", "schema": { "type": "boolean", "default": "false" } }, { "name": "include_target_columns", "in": "query", "description": "Whether to return relationships where target end is a column for the given source asset, artifact, or column.", "schema": { "type": "boolean", "default": "false" } }, { "name": "include_source_columns", "in": "query", "description": "Whether to return relationships where source end is either the given asset or a column of the given asset. When this parameter set to 'true', 'include_target_columns' must also be set to 'true'. By this, all relationships of asset-asset, asset-column, asset-artifact, column-asset, column-column, column-artifact will be returned.Use this parameter when 'asset_id' refers to an asset which has columns.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindRelatedObjectsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/set_relationships": { "post": { "tags": [ "Asset Relationships" ], "summary": "Create asset relationships", "description": "Use this API to create up to 20 asset relationships.\n* The relationship name must correspond to a relationship type defined on the source type.\n* The source must be an asset, column or governance artifact of the type specified in the relationship type definition.
\n Relationships created with a governance artifact as the source cannot be retrieved, modified, or deleted in the IKC UI.
\n These relationships can only be accessed through API calls such as `POST /v2/assets/search_relationships`, `POST /v2/assets/get_relationships`, and `POST /v2/assets/unset_relationships`.\n* The target must be an asset, column or governance artifact of the type specified in the relationship type definition.\n* If the specified relationship does not exist between a source and target, a new relationship is created.\n* If either end of the relationship is defined as multiplicity-one, any existing value of a multiplicity-one end is replaced.\n\n\n### For Asset\n\n* The `asset_id` and one of the {`catalog_id`, `project_id`, `space_id`} must be set\n\n### For Column\n\n* The `asset_id` and one of the {`catalog_id`, `project_id`, `space_id`} must be set\n* The `asset_id` of a column must be in the format of `#COLUMN#`\n\n### For Artifact\n\n* The `artifact_id` and `artifact_type` must be set. Use the global id of the artifact for `artifact_id`\n", "operationId": "setRelationships", "requestBody": { "description": "relationships", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetRelationshipsRequest" } } }, "required": true }, "responses": { "207": { "description": "Check response body for results of processing each target artifact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreateRelationshipsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/unset_relationships": { "post": { "tags": [ "Asset Relationships" ], "summary": "Deletes asset relationships", "description": "Use this API to delete up to 20 asset relationships.\n * The relationship name must correspond to a relationship type defined on the source type.\n * The source must be an asset or governance artifact of the type specified in the relationship type definition.\n * The target must be an asset or governance artifact of the type specified in the relationship type definition.\n * If the specified relationship does not exist between the source and the target, it will be ignored.\n### For Asset\n\n\n* The `asset_id` and one of the {`catalog_id`, `project_id`, `space_id`} must be set\n### For Column\n\n\n* The `asset_id` and one of the {`catalog_id`, `project_id`, `space_id`} must be set\n* The `asset_id` of a column must be in the format of `#COLUMN#`\n### For Artifact\n\n\n* The `artifact_id` and `artifact_type` must be set", "operationId": "unsetRelationships", "requestBody": { "description": "relationships", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CatalogBulkAssetRelationshipsRequest" } } }, "required": true }, "responses": { "207": { "description": "Check response body for status of each asset relationships being deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDeleteRelationshipsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}": { "get": { "tags": [ "Assets" ], "summary": "Get an asset", "description": "Use this API to retrieve an asset located in catalog or project. Access to an asset is controlled by a combination of the privacy level and the members of the asset. For a governed catalog, data assets are protected from unauthorized access by the governance policies that are defined in Data Catalog. Data assets in ungoverned catalogs are not subject to governance policies.", "operationId": "retrieveNewAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Assets" ], "summary": "Marks an existing asset for delete", "description": "Use this API to delete an existing asset. \r\n## Permissions Required to Delete an Asset\r\n\r\n### To delete an asset in a project or space, all of the following must hold:\r\n - Caller must have the EDITOR or ADMIN role in the project/space\r\n\r\n### To delete a public asset in a catalog, any of the following must hold:\r\n - Caller must have the ADMIN role in the catalog\r\n - Caller must have the EDITOR role in the catalog and caller must have either the OWNER or EDITOR role on the asset\r\n\r\n### To delete a private asset in a catalog, all of the following must hold:\r\n - Caller must have either the ADMIN or EDITOR role in the CATALOG\r\n - Caller must have either the OWNER, EDITOR, or VIEWER role in the asset\r\n\r\n## Purge Options to Delete an Asset\r\n\r\n purge_on_delete = true and purge_after_days is not specified: the asset is purged immediately.\r\n purge_on_delete = true and purge_after_days = n: the asset is moved to trash and purged after n days.\r\n purge_on_delete = false and purge_after_days is not specified: the asset is moved to trash and never purged.\r\n purge_on_delete is not specified and purge_after_days is not specified: the asset will be deleted/purged based on the catalog setting.\r\n purge_on_delete = false or is not specified and purge_after_days = n: invalid combination - the call will fail with a 400 Bad Request error.\r\n\r\n", "operationId": "deleteNewAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "purge_on_delete", "in": "query", "description": "If true, asset is also deleted from the trash.", "schema": { "type": "boolean", "default": "false" } }, { "name": "purge_after_days", "in": "query", "description": "Number of days after which asset will be purged. Purge On Delete should be true for this to be valid", "schema": { "type": "integer" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Assets" ], "summary": "Update an asset", "description": "## Overview\r\nUse this API to update certain metadata fields in assets. \r\n\r\n## Fields that can be patched:\r\n - `/metadata/name`\r\n - `/metadata/description`\r\n - `/metadata/tags`\r\n - `/metadata/origin_country`\r\n - `/metadata/resource_key`\r\n - `/metadata/source_system/last_modification_timestamp`, Expected Format: `yyyy-MM-ddTHH:mm:ssX`\r\n - `/metadata/child_source_systems/{idx}/last_modification_timestamp`, Expected Format: `yyyy-MM-ddTHH:mm:ssX`\r\n - `/metadata/source_system_history` - array, use `add` operation with path `/metadata/source_system_history/-` to append a new element\r\n - `/metadata/rov/mode` - allowed values are 0 (public), 8 (private) or 16 (hidden)\r\n - `/metadata/rov/collaborator_ids`\r\n - `/metadata/rov/member_roles`\r\n - `/metadata/rov/member_roles/{iam id}/roles` - array, allowed values are OWNER/EDITOR/VIEWER, see below for details\r\n\r\n## Updating Asset Collaborators and Owners\r\n\r\nEither the metadata/rov/collaborator_ids field or the metadata/rov/member_roles field can be updated, but not both.\r\n\r\nThe collaborator_ids field shown in the asset is derived from the information in member_roles, so updating one of these fields will automatically update the other. The collaborator_ids field shows the members in the member_roles field that have either the asset editor role or the asset viewer role. This field is present for backward compatibility with earlier versions of the catalog service.\r\n\r\nCollaborators added to the metadata/rov/collaborator_ids field will be assigned a default asset role based on their role in the catalog. Catalog editors will be assigned the asset editor role, and Catalog viewers will be assigned the asset viewer role.\r\n\r\nUsers added to the metadata/rov/member_roles present must have either the OWNER role, the OWNER role and EDITOR role, or the OWNER role and VIEWER role. Other combinations of roles are not allowed. Asset users with the VIEWER or EDITOR role must be members of the catalog. In addition, asset users with the OWNER role must also be members if the catalog with either the EDITOR or ADMIN role unless certain service ids are used. For projects and spaces, new owners must have a role in the project/space.\r\n\r\n## Permissions Required to Modify Asset\r\n\r\n### To update non-governed fields an asset in a project or space, all of the following must hold:\r\n - Caller must have the EDITOR or ADMIN role in the project/space\r\n\r\n### To update non-governed fields in a private asset in a catalog, all of the following must hold:\r\n - Caller must have either the ADMIN or EDITOR role in the CATALOG\r\n - Caller must have either the OWNER, EDITOR, or VIEWER role in the asset\r\n\r\n### To update non-governed fields in a public asset in a catalog, any of the following must hold:\r\n - Caller must have the ADMIN role in the CATALOG\r\n - Caller must have the EDITOR role in the CATALOG and caller must have either the OWNER or EDITOR role in the asset\r\n\r\n### Permissions required to modify governed metadata fields\r\n\r\nThe \"tags\" field is the only governed field. For governed catalogs a policy check is made to determine whether updates to it are allowed and if an asset transformation is needed. The outcome of the policy check can either be \"ALLOW\", \"DENY\", or \"TRANSFORM\"\r\n - If the outcome is \"ALLOW\", the operation is allowed if the caller has either the \"ADMIN\" or \"EDITOR\" catalog role\r\n - If the outcome is \"TRANSFORM\", the permission checks described above for non-governed fields are applied\r\n - If the outcome is \"DENY\", the permission checks described above for non-governed fields are applied\r\n\r\n\r\n## Allowed Operations\r\n\r\nThe combination of asset roles and catalog roles determines what asset operations are allowed by users.\r\n\r\n### These abilities apply to public assets:\r\n - All members of the catalog can find the asset and see its properties.\r\n - All members of the catalog who have the Editor, Auditor, or Admin roles can use the asset.\r\n\r\n### These abilities apply to private assets:\r\n - All asset collaborators can find the asset and see its properties. Asset collaborators with the Editor, Auditor, or Admin role can use the asset.", "operationId": "updateNewAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info. \n
\n Note:
\n Any ‘~’ characters need to be escaped as ~0 in the path field.
\n Any ‘/’ characters need to be escaped as ~1 in the path field.
\n For example, in {\"foo/\" : {\"~bar\" : \"value\"}}, the path for \"~bar\" is \"/foo~1/~0bar\". \n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/attachments": { "post": { "tags": [ "Asset Attachments" ], "summary": "Create an attachment", "description": " Creates an attachment.", "operationId": "createAttachmentNewV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } } ], "requestBody": { "description": "Attachment meta-data. \n The \"asset_type\" is required. \n The \"mime\" is a reliable way to indicate the nature and format of the attachment. It should be used instead of other implementation-specific means, e.g., file extension. \n If not supplied, or if the value given is less than 1, data_partitions defaults to 1 (for non-remote and non-referenced attachments). \n For remote attachments, both connection_id and connection_path are required. \n For referenced attachments, both object_key and object_key_is_read_only are required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAttachment" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/attachments/{attachment_id}": { "get": { "tags": [ "Asset Attachments" ], "summary": "Get an attachment", "description": " Retrieve an attachment.", "operationId": "retrieveAttachmentNewV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "Attachment GUID", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "private_url", "in": "query", "description": "private_url", "schema": { "type": "boolean", "default": "false" } }, { "name": "response-content-disposition", "in": "query", "description": "response-content-disposition", "schema": { "type": "string" } }, { "name": "response-content-type", "in": "query", "description": "response-content-type", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset Attachments" ], "summary": "Delete an attachment", "description": " Delete an attachment.", "operationId": "attachmentDeleteNewV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "Attachment GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Asset Attachments" ], "summary": "Update attachment metadata", "description": " Update attachment metadata. Only the following fields are allowed to update:\n * name\n * description\n * mime\n * size\n * partitions\n * transfer_complete", "operationId": "updateAttachmentNewV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "Attachment GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.
[ \n { \"op\": \"add\", \"path\": \"/name\", \"value\": \"my_attachment\"}, \n { \"op\": \"replace\", \"path\": \"/mime\", \"value\": \"text/csv\" }, \n { \"op\": \"remove\", \"path\":\"/description\"}\n]
Note:
\n 1. Any ‘~’ characters need to be escaped as ~0 in the path field. \n
Any ‘/’ characters need to be escaped as ~1 in the path field. \n
\n For example, in {\"foo/\" : {\"~bar\" : \"value\"}}, the path for \"~bar\" is \"/foo~1/~0bar\". \n 2. The transfer_complete field can only be set to true if its current value is false and the type of attachment is managed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAttachment" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/attachments/{attachment_id}/complete": { "post": { "tags": [ "Asset Attachments" ], "summary": "Mark an attachment as transfer complete", "description": " Marks an attachment as transfer complete.", "operationId": "attachmentTransferCompleteNewV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "Attachment GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/attachments/{attachment_id}/datasource_type": { "patch": { "tags": [ "Asset Attachments" ], "summary": "Auto update attachment's datasource_type from connection asset", "description": "Auto update attachment's datasource_type from connection asset", "operationId": "updateAttachmentDataSourceType", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "Attachment GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAttachment" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/attachments/{attachment_id}/resources": { "get": { "tags": [ "Asset Attachments" ], "summary": "Get resources info for an attachment", "description": " Get resources info for an attachment.", "operationId": "getAttachmentResourcesNewV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "Attachment GUID", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Asset Attachments" ], "summary": "Increase resources for an attachment", "description": " Increase resources for an attachment.", "operationId": "incAttachmentResourcesNewV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "path", "description": "Attachment GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "requestBody": { "description": "attachment resource to increase, e.g. {\"data_partitions\":5, \"private_url\":false}", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAttachmentIncRes" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/attributes": { "get": { "tags": [ "Asset Attributes" ], "summary": "List all attributes", "description": "Use this API to retrieve all attributes of an asset.", "operationId": "getAssetAttributesNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Asset Attributes" ], "summary": "Create an attribute", "description": "Use this API to create an asset attribute. An attribute is identically named with, and has fields that are partially defined by, an asset type.\nThe `name` specified in the request payload must match an existing built-in or user-defined asset type.\n\n\n### column_info attribute\nThe built-in `column_info` type defines metadata (e.g. description, tags) for columns contained in a data asset which represents a relational database table or columnar data file (e.g. csv file).\n\nCreate a `column_info` asset attribute to add column descriptions and/or tags if that attribute does not already exist on the asset.
Once the `column_info` attribute has been created, entries can be added, updated, or removed using the `PATCH /v2/assets/{asset_id}/attributes/column_info` endpoint. \n\nThe `column_info` attribute is a map structure where the key is a column name corresponding to an existing entry in the asset's `entity.data_asset.columns` array.
For example, here is the request payload to create a `column_info` attribute that assigns a description and tags to `ACCOUNT_HOLDER_ID` and `NAME` columns:\n```\n{\r\n \"name\": \"column_info\",\r\n \"entity\": {\r\n \"ACCOUNT_HOLDER_ID\": {\r\n \"column_description\": \"Globally unique identifier of the account holder.\",\r\n \"column_tags\": [\r\n \"identifier\",\r\n \"unique_key\"\r\n ]\r\n },\r\n \"NAME\": {\r\n \"column_description\": \"Full legal name of the account holder.\",\r\n \"column_tags\": [\r\n \"legal_name\"\r\n ]\r\n }\r\n }\r\n}\r\n```\r\n", "operationId": "createAssetAttributeNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } } ], "requestBody": { "description": "Attribute metadata. \n The \"entity\" is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAttribute" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/attributes/{attribute_key}": { "get": { "tags": [ "Asset Attributes" ], "summary": "Get an attribute", "description": "Use this API to retrieve an attribute of an asset.", "operationId": "getAssetAttributeNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "attribute_key", "in": "path", "description": "attribute_key", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset Attributes" ], "summary": "Delete an attribute", "description": "Use this API to delete an attribute of an asset.", "operationId": "deleteAssetAttributeNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "attribute_key", "in": "path", "description": "attribute_key", "required": true, "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Asset Attributes" ], "summary": "Update attributes", "description": "Use this API to update/modify an asset attribute.\n\n\n### Updating the column_info attribute\nUse this API for updating an existing `column_info` attribute to set or replace the `column_description` or `column_tags` for any column.\n\n> Note: Use `POST /v2/assets/{asset_id}/attributes` to create the `column_info` attribute if it does not exist on the asset.\n> Use `GET /v2/assets/{asset_id}/attributes/column_info` to check the existence of the attribute.\n\n\n### Payload Examples\nTo add a `column_info` entry that specifies a description and tags for the `INVOICE_ID` column:\n `[{\"op\":\"add\",\"path\":\"/INVOICE_ID\",\"value\":{\"column_description\":\"Unique identifier of the invoice\", \"column_tags\":[\"tag1\", \"tag2\"]}}]`\n\nTo add or update a description on the existing `column_info` entry for the `ADDRESS` column:\n`[{\"op\":\"add\",\"path\":\"/ADDRESS/column_description\",\"value\":\"customer street address\"}]`\nTo unset/remove the `ADDRESS` column's description:\n`[{\"op\": \"remove\", \"path\":\"/ADDRESS/column_description\"}]`\nTo remove the entire `column_info` entry for the `ADDRESS` column: `[{\"op\": \"remove\", \"path\":\"/ADDRESS\"}]`\n\nTo update value of `properties` of data_asset:\n```\n{\n \"entity\": {\n \"data_asset\": {\n \"mime_type\": \"text/csv\",\n \"dataset\": true,\n \"properties\": [\n {\n \"name\": \"schema_name\",\n \"value\": \"GOSALES1021\"\n },\n {\n \"name\": \"table_name\",\n \"value\": \"COUNTRY\"\n }\n ]\n }\n }\n}\n```\nRequest body:\n```\n[\n { \"op\": \"replace\", \"path\": \"/properties/1/value\", \"value\": \"COUNTRY2\" }\n]\n```\n\nTo update value of `data_source_deployment`:\n```\n{\n \"entity\": {\n \"ibm_data_source\": {\n \"data_source_type_id\": \"8c1a4480-1c29-4b33-9086-9cb799d7b157\",\n \"data_source_deployment\": \"on_cloud\",\n \"data_source_flags\": [],\n \"data_source_state\": \"ACTIVE\",\n \"data_source_encoding\": \"UTF-8\",\n \"data_source_protection_method\": \"guardium\"\n }\n }\n}\n```\nRequest body:\n```\n[\n { \"op\": \"replace\", \"path\": \"/data_source_deployment\", \"value\": \"cpd\" }\n]\n```\n\nJSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.\n> Note:\n> Any ‘~’ characters need to be escaped as ~0 in the path field.\n> Any ‘/’ characters need to be escaped as ~1 in the path field.\n> For example, in {\"foo/\" : {\"~bar\" : \"value\"}}, the path for \"~bar\" is \"/foo~1/~0bar\".\n", "operationId": "updateAssetAttributeNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "attribute_key", "in": "path", "description": "attribute_key", "required": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } } ], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902.
", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } } }, "required": true }, "responses": { "200": { "description": "Created" }, "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/clone": { "post": { "tags": [ "Assets" ], "summary": "Clone an asset", "description": "Use this API to clone catalog asset to project. This will create new copy of asset metadata, including asset attachments. ", "operationId": "cloneAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "catalog_id must be provided", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Request body should include project ID, and may include asset permissions override.\n\n```\n{\r\n \"project_id\": \"string\",\n \"member_roles\": {\n \"Member's IAM ID\": {\n \"user_iam_id\": \"Member's IAM ID\",\n \"roles\": [\"EDITOR\"]\n },\n \"Access Group ID\": {\n \"access_group_id\": \"Access Group ID\",\n \"roles\": [\"VIEWER\"]\n },\n \"Another IAM ID\": {\n ...\n }\n }\n}\n``` \nField 'member_roles' is optional.\n * If specified, 'member_roles' apply to newly cloned asset.\n * If not supplied, newly cloned asset gets 'member_roles' from its source asset.\n * If caller doesn't have permissions to set any of the roles then 'member_roles' is completely ignored.\n * If supplied, 'member_roles' should include at least one OWNER role.\n * If caller has only EDITOR role on the source asset and if 'member_roles' does not include all the owners of the source asset then it will be ignored.\n\n'project_id' is the target project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetCopyTo" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/collaborators": { "patch": { "tags": [ "Assets" ], "summary": "Add/Update asset collaborators", "description": "## Overview\nThis API adds and removes users as collaborators and owners on an asset. A collaborator or owner is identified by user ID.\nNote that access groups are not supported as asset collaborators or owners. Access groups can be configured as catalog members.\n\nEither the `metadata/rov/collaborator_ids` field or the `metadata/rov/member_roles` field can be updated, but not both.\nThe `collaborator_ids` field shown in the asset is derived from the information in `member_roles`, so updating one of these fields will automatically update the other. The `collaborator_ids` field shows the members in the `member_roles` field that have either the asset editor role or the asset viewer role. This field is present for backward compatibility with earlier versions of the catalog service.\n\nCollaborators added to the `metadata/rov/collaborator_ids` field will be assigned a default asset role based on their role in the catalog. Catalog editors will be assigned the asset editor role, and Catalog viewers will be assigned the asset viewer role.\n\nUsers added to the `metadata/rov/member_roles` present must have either the OWNER role, the OWNER role and EDITOR role, or the OWNER role and VIEWER role. Other combinations of roles are not allowed. Asset users with the VIEWER or EDITOR role must be members of the catalog. In addition, asset users with the OWNER role must also be members of the catalog with either the EDITOR or ADMIN role unless certain service ids are used. For projects and spaces, new owners must have a role in the project/space.\n\n## Permissions Required to Modify Asset Members\n\n### To add or remove asset owners for a private asset in a catalog, any of the following must hold:\n - Caller must have OWNER role on the asset\n - Caller must have the ADMIN role on catalog and caller must have either the OWNER, EDITOR, or VIEWER role in the asset\n\n### To add or remove asset owners for a public asset in a catalog, any of the following must hold:\n - Caller must have OWNER role on the asset\n - Caller must have the ADMIN role in the catalog\n\n### To add or remove asset collaborators, other than asset owner, for a private asset in a catalog, any of the following must hold:\n - Caller must have OWNER role on the asset\n - Caller must have EDITOR role on the asset\n - Caller must have the ADMIN role on catalog and caller must have either the OWNER, EDITOR, or VIEWER role in the asset\n\n### To add or remove asset collaborators, other than asset owner, for a public asset in a catalog, any of the following must hold:\n - Caller must have OWNER role on the asset\n - Caller must have EDITOR role on the asset\n - Caller must have the ADMIN role on catalog\n\n## Allowed Operations\nThe combination of asset roles and catalog roles determines what asset operations are allowed by users.\n\n### These abilities apply to public assets:\n - All members of the catalog can find the asset and see its properties.\n - All members of the catalog who have the Editor, Auditor, or Admin catalog roles can use the asset.\n\n### These abilities apply to private assets:\n - All asset collaborators can find the asset and see its properties. Asset collaborators with the Editor, Auditor, or Admin catalog role can use the asset.\n", "operationId": "addAndUpdateNewAssetCollaboratorsV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } } ], "requestBody": { "description": " JSON array of patch operations as defined in RFC 6902. See [http://jsonpatch.com/](http://jsonpatch.com/) for more info.\n```\n[{\n \"op\": \"add\",\n \"path\": \"/metadata/rov/collaborator_ids/test-iam-id\",\n \"value\": {\n \"user_id\": \"test@us.ibm.com\",\n \"user_iam_id\": \"test-iam-id\"\n }\n },\n {\n \"op\": \"replace\",\n \"path\": \"/metadata/rov/collaborator_ids/test-iam-id\",\n \"value\": {\n \"user_id\": \"test2-iam-id\",\n \"user_iam_id\": \"test-iam-id\"\n }\n },\n {\n \"op\": \"remove\",\n \"path\": \"/metadata/rov/collaborator_ids/test2-iam-id\"\n }\n ]\n ```\n (DEPRECATED)\n ```\n [{\n \"op\": \"add\",\n \"path\": \"/metadata/rov/collaborators/test@us.ibm.com\",\n \"value\": {\n \"user_id\": \"test@us.ibm.com\"\n }\n },\n {\n \"op\": \"replace\",\n \"path\": \"/metadata/rov/collaborators/test@us.ibm.com\",\n \"value\": {\n \"user_id\": \"test2@us.ibm.com\"\n }\n },\n {\n \"op\": \"remove\",\n \"path\": \"/metadata/rov/collaborators/test2@us.ibm.com\"\n }\n ]\n ```\n Note: Any ‘~’ characters need to be escaped as ~0 in the path field.\n Any ‘/’ characters need to be escaped as ~1 in the path field.\n For example, in `{\"foo/\" : {\"~bar\" : \"value\"}}`, the path for \"~bar\" is `/foo~1/~0bar`.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/conflicts": { "get": { "tags": [ "Asset Document Conflicts" ], "summary": "Get asset document conflicts", "description": "Use this API to retrieve asset document conflicts in database.", "operationId": "getDocumentConflicts", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "The number of items to skip before starting to collect the result set", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "The maximum number of items to return", "schema": { "type": "integer", "default": "10" } }, { "name": "fetch_conflicting_revisions", "in": "query", "description": "Whether to retrieve conflict revision document content", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetDocumentConflictsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset Document Conflicts" ], "summary": "Delete asset document conflicts", "description": "Use this API to delete asset document conflicts in database.", "operationId": "deleteDocumentConflicts", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Document conflicts to delete", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDeleteAssetDocumentConflictsRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/deepcopy": { "post": { "tags": [ "Assets" ], "summary": "Deep copies an asset and its related assets to a catalog, project, or space", "description": "Use this API to deep copy an asset to a project, catalog, or space. Unlike clone, publish, and promote, this API enables cascading the copy operation to referenced assets.

When copying from a project to a space, the on_promote relationship option is used to determine whether the related assets for a given relationship type should be copied. In addition, you must have Admin or Editor permissions on both the project and the space.

Deep copy sends the same Rabbit MQ messages as clone, publish, and promote. Messages are sent for all assets that are copied.

This API supports copying from a project to a catalog (publish), from a project to a space (promote), and from a catalog to a project (clone).

This API supports using a refresh token in place of an access token. This can be helpful if the deep copy is expected to be a long running operation. The deep copy uses the access token to authenticate with other services, so it is important that it not expire while the operation is in progress.When a refresh token is specified, it is used to generate an initial access token as well as additional access tokens if the initial access token expires", "operationId": "deepCopy", "parameters": [ { "name": "project_id", "in": "query", "description": "project_id", "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "catalog_id", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } } ], "requestBody": { "description": "Request body should include target (container) ID, and may include asset permissions and metadata overrides.\nFields 'mode' and 'member_roles' are optional.\n * If specified, they apply to newly copied (target) assets.\n * If not supplied, newly copied asset gets mode and 'member_roles' from its corresponding source asset.\n * Valid values for 'mode' are 0 (public), 8 (private) and 16 (hidden).\n * If caller doesn't have permissions to set any of the roles then 'member_roles' is completely ignored.\n * If supplied, 'member_roles' should include at least one OWNER role.\n\n'space_id' is the target space ID i.e. target container ID.\n\n'metadata' is optional and may contain attributes to overwrite the values in original asset;currently only name, description and tags may be overwritten.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "example request": { "summary": "requestBody in json", "value": { "space_id": "string", "mode": 0, "member_roles": { "Member's IAM ID": { "user_iam_id": "Member's IAM ID", "roles": [ "EDITOR" ] }, "Access Group ID": { "access_group_id": "Access Group ID", "roles": [ "VIEWER" ] }, "Another IAM ID": { "iam_id": "Another IAM ID", "roles": [ "role" ] } }, "metadata": { "name": "string", "description": "string", "tags": [ "string", "string" ] } } } } } }, "required": true }, "responses": { "200": { "description": "OK - indicates the deep copy operation has completed - the asset and its related assets (if applicable) have been fully copied to the target container", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDeepCopyResponse" } } } }, "202": { "description": "Accepted - indicates that the copy request is being completed in the background.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDeepCopyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } } } } } }, "/v2/assets/{asset_id}/images": { "get": { "tags": [ "Asset Images" ], "summary": "Get the image of asset", "description": "Get the image of asset.", "operationId": "getImages", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetImage" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Asset Images" ], "summary": "Upload an image for asset", "description": "Upload an image for asset. Use this api, you must put the image's binary data to the HTTP body.
For example:
    curl -X \"PUT\" \"api_url\" -H \"Authorization: $access token\" --data-binary \"@/image_dir_path/abc.png\"", "operationId": "uploadImage", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Uploaded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetImage" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/images/{image_id}": { "delete": { "tags": [ "Asset Images" ], "summary": "Delete the image of asset", "description": "Delete the image of asset.", "operationId": "deleteImages", "parameters": [ { "name": "asset_id", "in": "path", "description": "Asset GUID", "required": true, "schema": { "type": "string" } }, { "name": "image_id", "in": "path", "description": "Image id", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/notes": { "get": { "tags": [ "Asset Notes" ], "summary": "Get asset or column notes", "description": "Use this API to retrieve a paginated list of notes from an asset or a column within an asset.\n Any user who has viewer permission on an asset can retrieve its notes.", "operationId": "searchNotes", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of asset/column notes to return.
The default value is 25. The limit cannot exceed 200.
Use the `next` URL from the response to retrieve the next page of notes.", "schema": { "type": "integer", "default": "25" } }, { "name": "sort", "in": "query", "description": "Sorting order.

The following fields can be used for sorting. Use hyphen prefix (`-`) for descending order:
`column_name`
`created_at`
`updated_at`
", "schema": { "type": "string", "default": "-updated_at" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "column_names", "in": "query", "description": "Filters the result to include notes on the specified column(s). The parameter should be repeated for each column name.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "note_type", "in": "query", "description": "Type of notes to include in the search result:
Note TypeDescription
`ALL`Include all asset and column notes
`ASSET`Include asset notes only - cannot be used with the `column_names` parameter
`COLUMN`Include column notes only
", "schema": { "type": "string", "default": "ALL", "enum": [ "ALL", "ASSET", "COLUMN" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTokenPaginatedAssetNoteList" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Asset Notes" ], "summary": "Create notes on an asset", "description": "Use this API to create notes for an asset and for columns within an asset.\n Accredited Service Editors and Viewers, and any user who has edit permission on an asset can create a note.", "operationId": "createAssetNotes", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } } ], "requestBody": { "description": "Asset notes to be created - limited to 20 notes per request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetNotesCreationRequest" } } }, "required": true }, "responses": { "207": { "description": "Check response body for results of processing each requested note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetNotesCreationResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/notes/{note_id}": { "get": { "tags": [ "Asset Notes" ], "summary": "Get an asset or column note", "description": "Use this API to retrieve a note from an asset or a column within an asset.\n Any user who has viewer permission on an asset can retrieve a note.", "operationId": "getAssetNote", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "description": "Note ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetNote" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset Notes" ], "summary": "Delete an asset or a column note", "description": "Use this API to delete an asset or a column note.\n Accredited Service Editors and Viewers, and any user who has edit permission on an asset can delete a note.", "operationId": "deleteNote", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "description": "Asset or column note ID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Asset Notes" ], "summary": "Update an asset or column note", "description": "Use this API to update a note on an asset or a column within an asset.\n Accredited Service Editors and Viewers, and any user who has edit permission on an asset can update a note.", "operationId": "updateNote", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "description": "Note ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more info.
Example :
`[ \n {\"op\": \"replace\", \"path\": \"/note\", \"value\": \"Description of a Note\" }\n]`
Note:
\n Only supported operation is `replace`.
\n Any ‘~’ characters need to be escaped as ~0 in the path field. \n
Any ‘/’ characters need to be escaped as ~1 in the path field. \n
\n For example, in `{\"foo/\" : {\"~bar\" : \"value\"}}`, the path for `~bar` is `/foo~1/~0bar`. \n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetNote" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/owner": { "put": { "tags": [ "Assets" ], "summary": "Update the owner of an asset", "description": "Use this API to assign new owner of an asset. You must be the current owner of the asset or a collaborator of the asset with Admin permissions to change the owner.\nIf the asset has multiple owners and the specified user is not currently an owner, the last owner in the owner list\n(which is the one shown in the owner_id field) is replaced with the specified owner.\nIf the specified user is already an owner of the asset, the user is moved to the end of the owner list so that it is reported\nin the owner_id field.\n\nThis API is deprecated, since this is an older API and supports only single asset owner, not assets with multiple owners.\nMoving forward owners should be created or updated using below APIs\n\n`/v2/assets/{asset_id}`\n\nor\n\n`/v2/assets/{asset_id}/collaborators`", "operationId": "updateNewAssetOwnerV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Asset Owner", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetOwner" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/v2/assets/{asset_id}/perms": { "put": { "tags": [ "Assets" ], "summary": "Update privacy settings of an asset", "description": "Use this API to change privacy settings on an asset.
\n * The owner of the asset or asset collaborators with the Admin role can change the owner of the asset or delete the asset.\n * Asset collaborators with the Editor, Auditor, or Admin role can change the asset members or the privacy setting.", "operationId": "updateNewAssetRovV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } } ], "requestBody": { "description": "Asset ROV", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetRov" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/promote": { "post": { "tags": [ "Assets" ], "summary": "Promote an asset", "description": "Use this API to promote project assets to space. You must have Admin or Editor permissions on both the project and the space.", "operationId": "promoteAssetV2", "parameters": [ { "name": "project_id", "in": "query", "description": "project_id must be provided", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Request body should include space ID, and may include asset permissions and metadata overrides.\nFields 'mode' and 'member_roles' are optional.\n * If specified, they apply to newly promoted asset.\n * If not supplied, newly promoted asset gets mode and 'member_roles' from source asset.\n * Valid values for 'mode' are 0 (public), 8 (private) and 16 (hidden).\n * If caller doesn't have permissions to set any of the roles then 'member_roles' is completely ignored.\n * If supplied, 'member_roles' should include at least one OWNER role.\n * If caller has only EDITOR role on the source asset and if 'member_roles' does not include all the owners of the source asset then it will be ignored.\n\n'space_id' is the target space id.'\n\nmetadata' is optional and may contain attributes to overwrite the values in original asset; currently only name, description and tags may be overwritten.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "example request": { "summary": "requestBody in json", "value": { "space_id": "string", "mode": 0, "member_roles": { "Member's IAM ID": { "user_iam_id": "Member's IAM ID", "roles": [ "EDITOR" ] }, "Access Group ID": { "access_group_id": "Access Group ID", "roles": [ "VIEWER" ] }, "Another IAM ID": { "iam_id": "Another IAM ID", "roles": [ "role" ] } }, "metadata": { "name": "string", "description": "string", "tags": [ "string", "string" ] } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/publish": { "post": { "tags": [ "Assets" ], "summary": "Publish an asset", "description": "Use this API to publish project assets to catalog. You can publish data assets from a project into a catalog. You must have Admin or Editor permissions on both the project and the catalog.", "operationId": "publishNewAssetV2", "parameters": [ { "name": "project_id", "in": "query", "description": "project_id must be provided", "required": true, "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Request body should include catalog ID, and may include asset permissions and metadata overrides.\nFields 'mode' and 'member_roles' are optional.\n * If specified, they apply to newly published asset.\n * If not supplied, newly published asset gets mode and 'member_roles' from source asset.\n * Valid values for 'mode' are 0 (public), 8 (private) and 16 (hidden).\n * If caller doesn't have permissions to set any of the roles then 'member_roles' is completely ignored.\n * If supplied, 'member_roles' should include at least one OWNER role.\n * If caller has only EDITOR role on the source asset and if 'member_roles' does not include all the owners of the source asset then it will be ignored.\n\n'catalog_id' is the target catalog id. To support backwards compatibility when it is not supplied, the asset is published to the catalog associated with the project.\n\n'metadata' is optional and may contain attributes to overwrite the values in original asset; currently only name, description and tags may be overwritten.", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "request": { "summary": "requestBody in json", "value": { "catalog_id": "string", "mode": 0, "member_roles": { "Member's IAM ID": { "user_iam_id": "Member's IAM ID", "roles": [ "EDITOR" ] }, "Access Group ID": { "access_group_id": "Access Group ID", "roles": [ "VIEWER" ] }, "Another IAM ID": { "iam_id": "Another IAM ID", "roles": [ "role" ] } }, "metadata": { "name": "string", "description": "string", "tags": [ "string", "string" ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/ratings": { "get": { "tags": [ "Asset Ratings" ], "summary": "Get ratings of an asset", "description": "Get ratings for the specified asset.", "operationId": "getRatings", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of asset ratings to return.
The default value is 25.", "schema": { "type": "integer", "default": "25" } }, { "name": "start", "in": "query", "description": "Bookmark that gives the start of the page.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sorting order.
Valid values: updated_at, rating
Use hyphen prefix (-) for descending order", "schema": { "type": "string", "default": "-updated_at" } }, { "name": "user_filter", "in": "query", "description": "Filter results by user.
Valid values: all, user, other
The default value is all", "schema": { "type": "string", "default": "all", "enum": [ "all", "user", "other" ] } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTokenPaginatedAssetRatingList" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Asset Ratings" ], "summary": "Rate an asset", "description": "Use this API to rate an asset.", "operationId": "rateAsset", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } } ], "requestBody": { "description": "Asset rating to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetRatingEntity" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetRating" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/ratings/stats": { "get": { "tags": [ "Asset Ratings" ], "summary": "Get the count of each rating value for the specified asset", "description": "Get the counts of each rating value for the specified asset.", "operationId": "getRatingsStats", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetRatingStatsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/ratings/{asset_rating_id}": { "delete": { "tags": [ "Asset Ratings" ], "summary": "Delete an asset rating", "description": "Use this API to delete an asset rating.", "operationId": "deleteRating", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "asset_rating_id", "in": "path", "description": "asset_rating_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Asset Ratings" ], "summary": "Use this API to update an asset rating.", "description": "Update an asset rating", "operationId": "updateRating", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "asset_rating_id", "in": "path", "description": "asset_rating_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Asset rating to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetRatingEntity" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetRating" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/relationship_types": { "get": { "tags": [ "Asset Relationships" ], "summary": "Finds relationship types used by an asset", "description": "Finds relationship types that are used by a given asset. This API only returns the first page of results. It does not accept a bookmark. Any additional pages of results must be be fetched using the next page url included in the response.

You can refer to the options in the response to get the full list of relationship names.

This API is deprecated - use `POST /v2/assets/search_relationships` instead.", "operationId": "getRelationshipTypesForAsset", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog ID", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Space ID", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Optional limit to use when finding relationship types", "schema": { "type": "integer", "default": "25" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: relationship_display_name_asc\n\nSupported sort fields (these are case insensitive): \n * relationship_name_asc\n * relationship_name_desc\n * relationship_display_name_asc\n * relationship_display_name_desc\n * create_time_asc\n * create_time_desc", "schema": { "type": "array", "items": { "type": "string" }, "default": "relationship_display_name_asc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindOutgoingRelationshipTypesResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" } }, "deprecated": true } }, "/v2/assets/{asset_id}/relationships": { "get": { "tags": [ "Asset Relationships" ], "summary": "Finds related assets", "description": "Finds assets related to a given asset. This API supports limiting the results to a specific set of relationships as well as providing pagination and sorting options.

Note:When self references are present (i.e. when the source and target asset in the relationship are the same), more rows than specified by the limit may be returned. When this happens, the total rows reported is accurate and the bookmark points to next page of results.

This API is deprecated - use `POST /v2/assets/get_relationships` instead.", "operationId": "findRelatedAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog ID", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Space ID", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "bookmark", "in": "query", "description": "bookmark", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "limit. Defaults to 25", "schema": { "type": "integer", "default": "25" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: update_time_asc\n\nSupported sort fields (these are case insensitive): \n * create_time_asc\n * create_time_desc\n * update_time_asc\n * update_time_desc\n * creator_id_asc\n * creator_id_desc\n * updater_id_asc\n * updater_id_desc", "schema": { "type": "array", "items": { "type": "string" }, "default": "update_time_asc" } }, { "name": "relname", "in": "query", "description": "Limits results to only include the specified relationships. By default, all relationships are included. Repeat the query parameter to specify multiple relationship names.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "lookup_asset_names", "in": "query", "description": "Whether to lookup the asset names. This adds overhead, so only set this to true if the asset names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } }, { "name": "lookup_container_names", "in": "query", "description": "Whether to lookup the container names. This adds overhead, so only set this to true if the asset names are required. Defaults to false.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFindRelatedObjectsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/v2/assets/{asset_id}/relationships/{relationship_name}": { "put": { "tags": [ "Asset Relationships" ], "summary": "Create asset relationships", "description": "Use this API to create relationships between a source asset and up to 20 target artifacts.\n* The relationship name must correspond to a relationship type defined on the source asset's type.\n* The target artifacts must be assets of the type specified in the relationship type definition.\n* If the specified relationship does not exist between a source and target asset, a new relationship is created.\n* If either end of the relationship is defined as multiplicity-one, any existing value of a multiplicity-one end is replaced.\n\nThis API is deprecated - use `POST /v2/assets/set_relationships` instead.", "operationId": "createRelationships", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog ID", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Space ID", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "relationship_name", "in": "path", "description": "Name of relationship defined on the source asset type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Target artifacts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreateRelationshipsRequestBody" } } }, "required": true }, "responses": { "207": { "description": "Check response body for results of processing each target artifact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreateRelationshipsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "delete": { "tags": [ "Asset Relationships" ], "summary": "Deletes asset relationships", "description": "Use this API to remove a relationship between an asset and one or more target artifacts. The relationship name must correspond to a relationship type defined on the source asset's type. If the specified relationship does not exist between the source and one or more target assets, it will be ignored. For this api, all of the relationship targets need to be in the same catalog, project, or space. If the target space/catalog/project is omitted, it is assumed to be the same as the source.

This API is deprecated - use `POST /v2/assets/unset_relationships` instead.", "operationId": "deleteRelationships", "parameters": [ { "name": "asset_id", "in": "path", "description": "Source Asset Id", "required": true, "schema": { "type": "string" } }, { "name": "relationship_name", "in": "path", "description": "Name of relationship defined on the source asset type", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "Source Asset Catalog", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Source Asset Project", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Source Asset Space", "schema": { "type": "string" } }, { "name": "target_catalog_id", "in": "query", "description": "Target Asset Catalog", "schema": { "type": "string" } }, { "name": "target_project_id", "in": "query", "description": "Target Asset Project", "schema": { "type": "string" } }, { "name": "target_space_id", "in": "query", "description": "Target Asset Space", "schema": { "type": "string" } }, { "name": "target_asset_id", "in": "query", "description": "target asset id. To delete multiple relationships, this parameter can be repeated.", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK. Check response body for results of processing each target artifact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogRelationshipDeleteResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "head": { "tags": [ "Asset Relationships" ], "summary": "Determine if a relationship exists between an asset and a target artifact", "description": "Use this API to determine if a relationship exists between an asset and a target artifact. The relationship name must correspond to a relationship type defined on the source asset's type. The target artifact must be an asset of the type specified in the relationship type definition. The source and target assets must reside in the same catalog.", "operationId": "relationshipExists", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Catalog ID", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "Space ID", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "Asset ID", "required": true, "schema": { "type": "string" } }, { "name": "relationship_name", "in": "path", "description": "Name of relationship defined on the source asset type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Target artifact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogRelationshipTarget" } } }, "required": true }, "responses": { "204": { "description": "The relationship exists" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "410": { "description": "Gone - If either asset in the relationship is in the deleted state" }, "500": { "description": "Internal Server Error" } } } }, "/v2/assets/{asset_id}/revisions": { "get": { "tags": [ "Asset Revisions" ], "summary": "Get a list of revisions for an asset", "description": "Use this API to retrieve an ordered list of revisions for an asset, most to least recent.", "operationId": "retrieveRevisions", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated.", "deprecated": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of revisions to return. The default is 25. Maximum is 200", "schema": { "type": "integer", "default": "25" } }, { "name": "start", "in": "query", "description": "The revision number to start from, or 'latest'. Latest revision is the default.", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogListAssetRevisionsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Asset Revisions" ], "summary": "Commit a revision of an asset", "description": "Use this API to commit a revision of an asset. ", "operationId": "commitRevision", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Commit options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogAssetCommitOptions" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset Revisions" ], "summary": "Delete a revision", "description": "Use this API to delete a revision of an asset.", "operationId": "deleteRevision", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "You must provide a revision id (1, 2, 3, ...)", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/cams/admin/index_repairs": { "post": { "tags": [ "CAMS Admin" ], "summary": "Find and repair stuck temporary design documents by creating cache entries that resume their processing", "description": "Use this API to find and repair broken indexes", "operationId": "repairIndexes", "parameters": [ { "name": "catalog_id", "in": "query", "description": "Optionally limits to checking to certain catalogs. For projects and spaces you must use the id of the private catalog. Repeat this parameter to check multiple catalogs. If this is omitted, all catalogs are checked", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sleep_every", "in": "query", "description": "Allows rate limiting the creation of cache entries. To disable rate limiting, set to -1. If set, the operation pauses every time this number of cache entries have been created.", "schema": { "type": "integer", "default": "50" } }, { "name": "sleep_time_mins", "in": "query", "description": "When using cache entry rate limiting, this controls how long the service pauses between creating groups of cache entries.", "schema": { "type": "integer", "default": "1" } }, { "name": "max_cache_entries_to_create", "in": "query", "description": "Allows restricting total the number of cache entries created.", "schema": { "type": "integer" } }, { "name": "preview_only", "in": "query", "schema": { "type": "boolean", "default": "true" } } ], "responses": { "202": { "description": "Accept, the processing was successfully started", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogRepairIndexesResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/cams/admin/index_repairs/{id}": { "get": { "tags": [ "CAMS Admin" ], "summary": "Gets the status of a temporary design document repair operation", "description": "Use this API to get the status of the task to find and repair stuck temporary design documents", "operationId": "getIndexRepairStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogIndexRepairStatusResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/cams/admin/reconfigure": { "post": { "tags": [ "CAMS Admin" ], "summary": "Reconfigure the asset container", "description": "Use this API to reconfigure the asset container. The supported items are:
\n * type_search_indexes - reconfigure type search indexes for all asset types. It requires the user to have permission to register asset types.", "operationId": "reconfigure", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "item", "in": "query", "description": "The item to reconfigure, e.g. type_search_indexes", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/cams/admin/roles_cache_entry": { "delete": { "tags": [ "CAMS Admin" ], "operationId": "invalidateRoleCacheEntry", "parameters": [ { "name": "catalog_id", "in": "query", "description": "The catalog id", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project id", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The space id", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "description": "The id of the user whose role to remove from the cache", "required": true, "schema": { "type": "string" }, "example": "IBMid-0123456ABC" } ], "responses": { "200": { "description": "Cache entry was deleted" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Cache entry was not found" } } } }, "/v2/cams/metrics/asset_list_count": { "get": { "tags": [ "Metrics" ], "summary": "Get metrics of the asset lists", "description": "Get metrics of the asset lists.\n

The caller should use the `href` returned by the service to navigate through pages and should not try to manually construct URLs for pagination.\nThe `href` for the first page is always available, and the `href` for the next page is only available if there may be a next page.\n

The `total_rows` field is only available when `summary_level` is `CATALOG`.\n

The caller must be in at least one of the allow-lists based on the product offering to perform the operation:\n* `DATA_PRODUCT` - `data_product_account_viewers`, `data_product_account_managers`\n", "operationId": "getAssetListMetrics", "parameters": [ { "name": "month", "in": "query", "description": "The month of the metrics to retrieve. The value must be in format `yyyy-MM`. If not supplied, the metrics of the current month are retrieved.", "schema": { "type": "string" } }, { "name": "bss_account_ids", "in": "query", "description": "Retrieve metrics only for asset lists belonging to any of the given bss accounts. Specify as a comma-separated list.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of items to return. If not specified, it will be set to 200.", "schema": { "type": "integer", "default": "200" } }, { "name": "start", "in": "query", "description": "Start token for pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogUserAccessMetricsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/cams/metrics/user_access_count": { "get": { "tags": [ "Metrics" ], "summary": "Get metrics of the users who accessed the catalogs", "description": "Get metrics of the users who accessed the catalogs.\n

The caller should use the `href` returned by the service to navigate through pages and should not try to manually construct URLs for pagination.\nThe `href` for the first page is always available, and the `href` for the next page is only available if there may be a next page.\n

The `total_rows` field is only available when `summary_level` is `CATALOG`.\n

The caller must be in at least one of the allow-lists based on the product offering to perform the operation:\n(Note: the `WKC` product offering represents IBM Knowledge Catalog):\n* `DATA_PRODUCT` - `data_product_account_viewers`, `data_product_account_managers`\n* `WATSONX_GOVERNANCE` - `watsonx_governance_account_viewers`, `watsonx_governance_account_managers`\n* `WKC` - `wkc_account_viewers`, `wkc_account_managers`\n", "operationId": "getUserAccessMetrics", "parameters": [ { "name": "month", "in": "query", "description": "The month of the metrics to retrieve. The value must be in format `yyyy-MM`. If not supplied, the metrics of the current month is retrieved.", "schema": { "type": "string" } }, { "name": "summary_level", "in": "query", "description": "The level for aggregating the user access statistics.", "schema": { "type": "string", "default": "ACCOUNT", "enum": [ "ACCOUNT", "CATALOG" ] } }, { "name": "product_offering", "in": "query", "description": "Product offering. If omitted, it is default to WKC.", "schema": { "type": "string", "default": "WKC", "enum": [ "WKC", "DATA_PRODUCT", "WATSONX_GOVERNANCE" ] } }, { "name": "bss_account_ids", "in": "query", "description": "Retrieve metrics only for catalogs belonging to any of the given bss accounts. Specify as a comma-separated list.", "schema": { "type": "string" } }, { "name": "catalog_ids", "in": "query", "description": "Retrieve metrics only for catalogs with the given ids. Specify as a comma-separated list.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of items to return. If not specified, it will be set to 200.", "schema": { "type": "integer", "default": "200" } }, { "name": "start", "in": "query", "description": "Start token for pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogUserAccessMetricsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/catalogs": { "get": { "tags": [ "Catalogs" ], "summary": "List all catalogs for a specific account", "description": "Use this API to get a list of catalogs or projects or spaces, or to get the total number of public catalogs, for a given account. You can use 'roles' parameter to filter results by roles for standard callers.
\n * Standard Callers: to list all catalogs where caller is collaborator, omit \"bss_account_id\" field and \"include\" field.
\n * Accredited Services: to list all catalogs or projects or spaces for a specific account, enter bss account value in \"bss_account_id\" field and one of 'catalogs', 'projects', or 'spaces' in \"include\" field.
\n * Accredited Services: to get the number of public catalogs for a specific account, enter bss account value in \"bss_account_id\" field and 'total_count' in \"include\" field.", "operationId": "listCatalogsV2", "parameters": [ { "name": "limit", "in": "query", "description": "limit", "schema": { "type": "integer", "default": "25" } }, { "name": "bookmark", "in": "query", "description": "bookmark", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "description": "skip", "schema": { "type": "integer", "default": "0" } }, { "name": "include", "in": "query", "description": "Limited to use by accredited services (which must also supply 'bss_account_id'). Currently, the only supported values are 'catalogs', 'projects', 'spaces' or 'total_count'. Not supplying any of these values results in public 'catalogs', 'projects', AND 'spaces' being returned for a specific account.
\n * Use 'catalogs' for including all public catalogs for a specific bss_account_id.
\n * Use 'projects' for including all projects for a specific bss_account_id.
\n * Use 'spaces' for including all spaces for a specific bss_account_id.
\n * Use 'total_count' for including total number of public catalogs for a specific account.", "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "\"Used for listing catalogs, projects, or spaces for the account, or for retrieving the number of public catalogs for the account. Must be supplied when caller is an accredited service.\"\n+ \"If caller is a non-service id user, then the catalogs from that user's bss account are included in the list.", "schema": { "type": "string" } }, { "name": "roles", "in": "query", "description": "Filter results by user roles. Use comma separated list for multiple roles.\n Valid role value: admin, editor, viewer. This param is not allowed if caller is from accredited service or ICIP mode is enabled.", "schema": { "type": "string" } }, { "name": "orderby", "in": "query", "description": "orderby. This parameter can be repeated to add additional sort fields.

Default: null\n\nSupported sort fields (these are case insensitive): \n * catalog_name_asc\n * catalog_name_desc\n * create_time_asc\n * create_time_desc\n * update_time_asc\n * update_time_desc", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "exclude_subtypes", "in": "query", "description": "(DEPRECATED) Indicates whether results should include catalogs with a subtype. If not specified, catalogs with a subtype are excluded.This parameter is deprecated. Use 'subtype' instead.", "schema": { "type": "boolean" } }, { "name": "subtype", "in": "query", "description": "Filter results by catalogs with the specified subtypes. \n\nIf nothing is specified, by default catalogs with subtype are not returned.\n * If set to 'NO_SUBTYPES', catalogs with subtype are not returned\n * If set to 'ALL_SUBTYPES', only catalogs with a subtype are returned\n * If set to 'ALL_SUBYTPES, NO_SUBTYPES', both catalogs which have subtypes and not are returned\n * If set to 'subtypeA, subtypeB' , only catalogs with those subtypes are returned. ", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "name", "in": "query", "description": "Filter results by catalogs with a case insensitive name. This matches substrings.", "schema": { "type": "string" } }, { "name": "governance_type", "in": "query", "description": "Filter results by catalogs with the specified governance type. Allowed values: governed, ungoverned, all. Default: all", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalogSet" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Catalogs" ], "summary": "Create a catalog", "description": "Use this API to create a catalog to organize your assets and collaborators. You can use a catalog to easily find and share data for your organization, regardless of the location or format of the data.\n\nOn IBM Cloud, to create a catalog you must have the Manager role in your organization's IBM Knowledge Catalog account.
\nIn CPD, to create a catalog you must have the Administrator role.\n\nThe catalog name can be 1 to 256 printable Unicode characters - ISO control characters and Unicode Special characters are not permitted.\n\nOn IBM Cloud, IBM Cloud Object Storage (S3 API) credentials are required in the request body's `bucket` structure. This provides encrypted storage for file assets that are copied to the catalog.\n\nIn CPD, file asset storage for a catalog is provisioned after catalog creation, via a separate call to the Asset Files API. Creating a catalog does not automatically provision this storage.
\nWhen creating a catalog in CPD, set the `check_bucket_existence` query parameter to `false`, and the request body's `bucket` structure should just have `bucket_type` set to `assetfiles`.
\nAfter the catalog is created, call the `PUT /v2/asset_files` API to create a bucket for this catalog.\n\nSample request body for creating a catalog in CPD:\n```\n{\n \"name\": \"catalog1\",\n \"description\": \"A catalog in CPD\",\n \"generator\": \"catalogadmin@mycompany.com\",\n \"bucket\": {\n \"bucket_type\": \"assetfiles\"\n }\n}\n```\n", "operationId": "createCatalogV2", "parameters": [ { "name": "check_bucket_existence", "in": "query", "description": "Whether an existence check should be performed on the catalog bucket", "schema": { "type": "boolean", "default": "true" } }, { "name": "check_duplicate_name", "in": "query", "description": "Whether to check if catalogs with the same name already exist", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Note: `name`, `generator`, and the `bucket` structure are required fields in the request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalogEntityWithBucket" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalog" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Request" } } } }, "/v2/catalogs/default": { "get": { "tags": [ "Catalogs" ], "summary": "Retrieve the default catalog", "description": "Use this API to retrieve the default catalog.", "operationId": "getDefaultCatalog", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalog" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Catalogs" ], "summary": "Create the default catalog", "description": "Use this API to create the default catalog.", "operationId": "createDefaultCatalog", "parameters": [ { "name": "check_bucket_existence", "in": "query", "description": "Whether an existence check should be performed on the catalog bucket", "schema": { "type": "boolean", "default": "true" } }, { "name": "check_duplicate_name", "in": "query", "description": "Whether to check if catalogs with the same name already exist", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Example:\n```\n{\n \"catalog\": {\n \"name\": \"The Default Catalog\",\n \"generator\": \"API\",\n \"description\": \"The default catalog\",\n \"bss_account_id\": \"999\",\n \"is_governed\": true,\n \"bucket\": {\n \"bucket_type\": \"assetfiles\"\n }\n }\n}\n```\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreateDefaultCatalogRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreateDefaultCatalogResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/default/rehome": { "post": { "tags": [ "Catalogs" ], "summary": "Rehome one or more synced assets. ", "description": "Use this API for rehoming assets in a catalog that had been synced from an external OMRS repository to be native IKC assets. The API supports rehoming a single asset, or a bulk rehome of all synced data assets of specific external repository.\n\nIf the request is accepted, the response header contains the rehome request ID `x-future-id` which can then be used to monitor the request status via `/v2/catalogs/default/rehome/status?request_id=`.\n\n> Service ID is required to call this API.\n", "operationId": "rehomeSyncedAssets", "parameters": [ { "name": "asset_id", "in": "query", "description": "Synced asset to be rehomed - if omitted, all synced assets of `source_metadata_collection_id` repository will be rehomed", "schema": { "type": "string" } }, { "name": "source_metadata_collection_id", "in": "query", "description": "Source metadata collection id required if all assets of single external repository need to be rehomed", "schema": { "type": "string" } }, { "name": "is_bulk_rehome", "in": "query", "description": "Set to true to bulk re-home all synced data assets in a catalog", "required": true, "schema": { "type": "boolean", "default": "false" } }, { "name": "catalog_id", "in": "query", "description": "Catalog containing the synced assets to be re-homed. If not specified, synced assets in the default catalog are re-homed.", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted - indicates request has been accepted" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/default/rehome/status": { "get": { "tags": [ "Catalogs" ], "summary": "Monitor status of rehome task", "description": "Use this API to check the status of a rehome asset(s) request, using the x-future-id response header value returned by a previous `/v2/catalogs/default/rehome` request.", "operationId": "getRehomeRequestStatus", "parameters": [ { "name": "request_id", "in": "query", "description": "x-future-id response header value returned by a previous rehome request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - indicates successful completion of the rehome request" }, "202": { "description": "Accepted - indicates the rehome request corresponding to the specified request_id is still processing" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/export_assets": { "post": { "tags": [ "Import Assets" ], "summary": "Export as a zip file containing appropriate csv files for the selected assets", "description": "This API is responsible for preparing a zip file containing csv files related to the selected assets for export.", "operationId": "processExportAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "required": true, "schema": { "type": "string" } }, { "name": "export_asset_id", "in": "query", "description": "The id of the ibm_export_asset type asset", "required": true, "schema": { "type": "string" } }, { "name": "export_type", "in": "query", "description": "The list of export types the operation is expected to handle. Export Type includes `metadata, relationship, lineage`. But, for now, we are supporting only `metadata, relationship`.", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "description": "A json object containing a list of asset IDs; maximum of 100.", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/import_assets": { "post": { "tags": [ "Import Assets" ], "summary": "Process an import asset", "description": "This API begins processing of import assets. This function is used to import lineage mappings from EMD CSV documents.", "operationId": "processImportAsset", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "import_asset_id", "in": "query", "description": "The id of the import_asset", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "The action to perform on this import_asset. \"process\" (default): Validate and run an import job, \"validate\": Validate an import only without starting an import job.", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "description": "When performing a processing request, proceed with the import even if validation fails. This option is only used when 'action' = 'process' (which is the default case)", "schema": { "type": "boolean" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/temporary_credentials": { "post": { "tags": [ "AWS Temporary Credentials" ], "summary": "Request temporary security credentials", "description": "Request temporary security credentails that can be used for storing asset attachment files.\r\n\r\nThe endpoint is currently only applicable for AWS deployments.\r\n\r\nIf role_arn and external_id are supplied, the caller must be a sevice id in the allow-list 'aws_s3_administrator'. The requested credentials will have permission for accessing the resources in the bucket of the catalog or the bucket itself depending on the supplied information. The allowed combinations of the fields are:\r\n - role_arn, external_id: list and create buckets in the account that the role is defined in\r\n - role_arn, external_id, bucket_name, shared (optional, default to false), catalog_id (must be supplied if shared is true): put/get/list/delete objects in the bucket, and list multipart uploads and delete the bucket if the bucket is not shared.\r\n\r\nIf catalog_id is supplied, the caller must be a member of the catalog, or a service id that is in the allow-list 'aws_s3_administrator', 'accredited_service_editors', 'accredited_service_viewers', or 'accredited_service_exporters'. The requested credentials will have permission for accessing the resources in the bucket of the catalog or the bucket itself based on the membership.\r\n - admin or service id in allow-list 'aws_s3_administrator': put/get/list/delete objects in the bucket, and list multipart uploads and delete the bucket if the bucket is not shared.\r\n - editor or service id in allow-list 'accredited_service_editors': put/get/delete objects in the bucket\r\n - viewer or service id in allow-list 'accredited_service_viewers' or 'accredited_service_exporters': get objects in the bucket\r\n\r\nIf none of above is supplied, the caller must have permission to create catalogs in the account that the access token is scoped for. The requested credentials will have permission to list and create buckets in the account.\r\n\r\nIf min_duration_seconds is supplied, the requested temporary credentials must be valid for at least the specified duration. If it is not supplied or if the cached temporary credentials of the same requirement is valid for at least specified duration, the cached credentials will be returned.\r\n\r\nNote: when a bucket is shared, the objects in the shared bucket must have the prefix of '{catalog_id}/', e.g. '553fa5a8-bea5-43fa-9f04-b2f5ed39e6d3/myreport.csv'. All the permissions in shared buckets are granted to only allow accesing resources with the prefix of a specific catalog id.", "operationId": "getTemporaryCredentials", "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTemporaryCredentialsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTemporaryCredentials" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}": { "get": { "tags": [ "Catalogs" ], "summary": "Get a catalog by catalog ID", "description": "Members of the catalog can use this API to retrieve information about a catalog.", "operationId": "retrieveCatalogV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "Catalog GUID or UID", "required": true, "schema": { "type": "string" } }, { "name": "bss_account_id", "in": "query", "description": "You must provide bss_account_id when querying for uid", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalog" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Catalogs" ], "summary": "Delete a catalog by catalog ID", "description": "Use this API to delete a catalog if you have the Admin role.Deleting a catalog removes all items that are associated with the catalog, such as metadata for all assets in the catalog.", "operationId": "deleteCatalogV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "Catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "delete_bucket", "in": "query", "description": "delete_bucket", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Catalogs" ], "summary": "Update catalog", "description": "Use this API to update the name or description of the catalog.", "operationId": "patchCatalogV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "check_duplicate_name", "in": "query", "description": "Whether to check if catalogs with the same name already exist. Only applicable if the name is to be updated.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902.
[\n{ \"op\": \"replace\", \"path\": \"/entity/name\", \"value\": \"new-name\" },
{ \"op\": \"replace\", \"path\": \"/entity/description\", \"value\": \"new-description\" }\n]
Note:
\n Any ‘~’ characters need to be escaped as ~0 in the path field.
\n Any ‘/’ characters need to be escaped as ~1 in the path field. \n
\n For example, in {\"foo/\" : {\"~bar\" : \"value\"}}, the path for \"~bar\" is \"/foo~1/~0bar\". \n ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalog" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/collections/{collection_id}": { "get": { "tags": [ "Catalog Collections" ], "summary": "Get a catalog-level collection by collection ID", "description": "Use this API to retrieve a catalog-level collection in catalog.", "operationId": "getCatalogCollection", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "collection_id", "in": "path", "description": "Collection GUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalogCollectionResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Catalog Collections" ], "summary": "Update a catalog-level collection for a catalog", "description": "Update a catalog-level collection for a catalog", "operationId": "updateCatalogCollection", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "collection_id", "in": "path", "description": "Collection GUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Collection updates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCollection" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalogCollectionResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Catalog Collections" ], "summary": "Delete a catalog-level collection by collection id", "description": "Use this API to retrieve a catalog-level collection in catalog.", "operationId": "deleteCatalogCollection", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "collection_id", "in": "path", "description": "Collection GUID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/members": { "get": { "tags": [ "Catalog Members" ], "summary": "List all members of the catalog", "description": " Get members for the catalog.", "operationId": "getMembersV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "limit", "schema": { "type": "integer", "default": "25" } }, { "name": "bookmark", "in": "query", "description": "bookmark", "schema": { "type": "string" } }, { "name": "member_type", "in": "query", "description": "member_type", "schema": { "type": "string", "default": "user", "enum": [ "user", "group", "all" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMemberSearchResult" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Catalog Members" ], "summary": "Add members to a catalog", "description": " Adds members to a catalog. A catalog member can be a user (specified as a user name or user ID), a service ID, or an access group.", "operationId": "addNewMembersV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Members with roles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMemberSet" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMemberSetPartialResult" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMemberSetPartialResult" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/members/bulk": { "delete": { "tags": [ "Catalog Members" ], "summary": "Delete members from a catalog", "description": " Delete members from a catalog.You can delete a member or more if you are the owner of the catalog or a member of the catalog with Admin or Editor permissions on the catalog.", "operationId": "deleteMembers", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "member_ids", "in": "query", "description": "Comma-separated list of Member GUIDs, with a maximum of 20.", "required": true, "schema": { "type": "string" } }, { "name": "member_type", "in": "query", "description": "Type of the members specified in the `member_ids` parameter. Specify `user` or `group` if all members are user or access group IDs. If `member_ids` contains a mixture of user or group IDs, then specify `all` for `member_type` or alternatively do not specify any value. If `member_type` is `all` or not specified, use `member_types` to indicate the type of each member in `member_ids`", "schema": { "type": "string", "enum": [ "user", "group", "all" ] } }, { "name": "member_types", "in": "query", "description": "Comma-separated list of types for each member specified in `member_ids`. The supported types are `user` and `group`. If both `member_types` and `member_type` parameters are specified, `member_types` takes precedence over `member_type`. If `member_types` is not specified, and `member_type` is not specified or is `all`, the API will attempt to determine the member type based on the member ID. In a CPD environment, user and access group IDs are numeric and have no prefix indicating whether the ID represents a user or group ID, so `member_types` should be specified if `member_ids` contains a mixture of user and access group IDs", "schema": { "type": "string" } } ], "responses": { "207": { "description": "Check response body for status of each member being deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogBulkMembersDeleteResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/members/{member_id}": { "get": { "tags": [ "Catalog Members" ], "summary": "Get catalog membership for a specific user", "description": " Returns any memberships this user has on the catalog, including direct membership and any access group memberships.", "operationId": "getMemberV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "member_id", "in": "path", "description": "member ID", "required": true, "schema": { "type": "string" } }, { "name": "resolve_member_roles", "in": "query", "description": "Should resolve member roles from usergroup(s) and collaborator roles", "schema": { "type": "boolean", "default": "false" } }, { "name": "member_type", "in": "query", "description": "Type of the member specified by the member_id. If not specified, the service will determine if the member is a user or an access group based on the member_id, which is not always possible or accurate. Always supplying the member type is recommended.", "schema": { "type": "string", "enum": [ "user", "group" ] } }, { "name": "profile_id", "in": "query", "description": "IAM Profile ID for Trusted Profile users: If the getMemberV2 API is called to fetch details for a Trusted Profile, the member_id is the IAM ID of the actual user, and the profile_id will be the IAM ID of the trusted user. For IBM users and App ID users, this value should be null.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMemberSet" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Catalog Members" ], "summary": "Delete a member from a catalog", "description": " Delete a member from a catalog.", "operationId": "deleteMemberV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "member_id", "in": "path", "description": "Member GUID", "required": true, "schema": { "type": "string" } }, { "name": "member_type", "in": "query", "description": "Type of the member specified by the member_id. If not specified, the service will determine if the member is a user or an access group based on the member_id, which is not always possible or accurate. Always supplying the member type is recommended.", "schema": { "type": "string", "enum": [ "user", "group" ] } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Catalog Members" ], "summary": "Update members in a catalog", "description": " Update a member of a catalog.", "operationId": "updateMemberRoleV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "member_id", "in": "path", "description": "Member GUID", "required": true, "schema": { "type": "string" } }, { "name": "member_type", "in": "query", "description": "Type of the member specified by the member_id. If not specified, the service will determine if the member is a user or an access group based on the member_id, which is not always possible or accurate. Always supplying the member type is recommended.", "schema": { "type": "string", "enum": [ "user", "group" ] } } ], "requestBody": { "description": "Member updates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMemberRole" } } }, "required": true }, "responses": { "200": { "description": "Updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogMember" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/properties": { "get": { "tags": [ "Catalogs" ], "summary": "List all properties of a catalog", "description": "Use this API to get all properties of catalog.", "operationId": "getAllCatalogPropertiesV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "Catalogs" ], "summary": "Update catalog properties", "description": "Use this API to patch catalog properties.", "operationId": "patchCatalogPropertiesV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON array of patch operations as defined in RFC 6902.
[\n{ \"op\": \"add\", \"path\": \"/properties/new-property\", \"value\": \"new-value\" }\n]
Note:
\n Any ‘~’ characters need to be escaped as ~0 in the path field.
\n Any ‘/’ characters need to be escaped as ~1 in the path field.
\n For example, in {\"foo/\" : {\"~bar\" : \"value\"}}, the path for \"~bar\" is \"/foo~1/~0bar\". \n ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CatalogJsonPatch" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/properties/{property_key}": { "get": { "tags": [ "Catalogs" ], "summary": "Get a single property in a catalog", "description": " Use this API to get the property of catalog by given property key.", "operationId": "getCatalogPropertyV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } }, { "name": "property_key", "in": "path", "description": "catalog property key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/reconfigure": { "patch": { "tags": [ "Catalogs" ], "summary": "Update catalog connections", "description": "Use this API to patch catalog properties.", "operationId": "patchCatalogReconfigureV2", "parameters": [ { "name": "catalog_id", "in": "path", "description": "catalog GUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error" } } } }, "/v2/catalogs/{catalog_id}/state": { "get": { "tags": [ "Catalogs" ], "summary": "Get the catalog state", "operationId": "getCatalogState", "parameters": [ { "name": "catalog_id", "in": "path", "description": "Catalog GUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCatalogStateResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/data_assets": { "post": { "tags": [ "Data Assets" ], "summary": "Create a data asset", "description": "You can use this API to add data assets to a catalog. Data assets could be data from a connection to a data source (ex. tables) or files from your local system uploaded into cloud object storage associated with Projects or Catalog.All asset types have a common set of properties, such as name, description, asset type, visibility, tags, classifications. Data Asset have additional attributes such as mime type, columns with types, and properties. Use v2/attachments API to indicate location of data (ex. table path) from a connection to a data source.", "operationId": "createDataAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the call would result in a duplicate asset. `IGNORE` means the call will ignore the duplicate and create a new asset. `REJECT` means the call will fail and no asset will be created. `UPDATE` means the best matched duplicate will be updated with the incoming changes according to the predefined rules. `REPLACE` means the best matched duplicate will be overwritten with the input values according to the predefined rules. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT", "UPDATE", "REPLACE" ] } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Data Asset Metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDataAsset" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreationResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/data_assets/{data_asset_id}": { "get": { "tags": [ "Data Assets" ], "summary": "Get a data asset", "description": "Use this API to retrieve _metadata_ about a data asset. The response document will contain three top-level fields:
\n * **'metadata':** contains metadata common to all types of assets\n * **'entity':** contains metadata specific to the asset_type - in this case 'data_asset'\n * **'attachments':** an array containing one item of metadata per attached resource

The data described by the above metadata is stored in attached resources. Examples of attached resources are database tables, csv files, word documents, extended metadata documents, etc. Because an item in the 'attachments' array only contains metadata about an attached resource, accessing the actual attached resource requires additional server calls. Exactly which additional server calls are needed depends on the kind of attached resource. Follow the steps below to access an attached resource.

\n **Step 1**: find the index i of the item in the above 'attachments' array whose 'asset_type' value matches the type of the attached resource you want to access. For a 'data_asset' attached resource look for the item i where 'attachments[i].asset_type' is 'data_asset'.

There are two important pairs of fields (among many others) which may appear in 'attachments[i]'. Only one of those pairs will actually appear. Which pair appears influences which steps to perform next.
\n * **Pair 1:** **'connection_id'** and **'connection_path'**:\n \t* The above two fields will appear in 'attachments[i]' if the value of 'attachments[i].is_remote' is true.\n \t* 'attachments[i].is_remote' WILL be true if the attached resource is a database table. In this case, 'attachments[i].connection_path' will contain a schema name and table name.\n \t* 'attachments[i].is_remote' MAY be true if the attached resource is, for example, a csv file. In this case, 'attachments[i].connection_path' will contain a folder path and file name.

If the above pair of fields are present in 'attachments[i]' then:
\n **Step 2**: use the value of the 'attachments[i].connection_id' field to make a call to the **GET /v2/connections/{connection_id}** API. You'll need appropriate credentials.
\n **Step 3**: use the values in the 'entity.properties' field of the result from Step 2 to either create a connection to the database containing the table or to retrieve the file.

Note: even if 'attachments[i].is_remote' is true and the above pair of fields are present in 'attachments[i]', if the attached resource is located in the catalog/project bucket then you may optionally perform the two steps discussed for Pair 2 ('object_key' and 'handle') below.
\n * **Pair 2:** **'object_key'** and **'handle'**:\n \t* The above two fields will appear in 'attachments[i]' if the value of 'attachments[i].is_remote' is false. In this case, 'attachments[i].handle' will contain information about the attached resource.
\n **Step 2**: use the value of the 'attachments[i].id' field as the value for 'attachment_id' in a call to the **GET /v2/assets/{asset_id}/attachments/{attachment_id}** API. The value to use for 'asset_id' in the call to the attachments API is the same as the value that was used for 'data_asset_id' in the original call to the GET /v2/data_assets/{data_asset_id} API.
\n **Step 3**: use the value in the 'url' field of the result from Step 2 to download (for example, with a browser) a copy of the file.", "operationId": "getDataAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "catalog_id", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "project_id (only catalog_id is supported at this time)", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "space_id (only catalog_id is supported at this time)", "schema": { "type": "string" } }, { "name": "data_asset_id", "in": "path", "description": "data_asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/data_assets/{data_asset_id}/columns": { "get": { "tags": [ "Data Assets" ], "summary": "Get columns of a data asset", "description": "Use this API to retrieve columns of a data asset located in catalog or project. Access to an asset is controlled by a combination of the privacy level and the members of the asset. For a governed catalog, data assets are protected from unauthorized access by the governance policies that are defined in Data Catalog. Data assets in ungoverned catalogs are not subject to governance policies.", "operationId": "retrieveColumns", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "data_asset_id", "in": "path", "description": "data_asset_id", "required": true, "schema": { "type": "string" } }, { "name": "revision_id", "in": "query", "description": "Revision id (1, 2, 3, ...), or leave empty for the current asset version. Use 'latest' for the most recent revision.", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "The maximum number of items to return", "schema": { "type": "integer", "default": "100" } }, { "name": "bookmark", "in": "query", "description": "The bookmark for the next page of results, received from a previous call.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sorting the columns, e.g., 'data_asset.columns', '-column_info.column_info_quality_score', 'data_asset.columns,column_info.column_info_quality_score", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Filter columns by name, e.g., 'A*'", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "resources", "total_rows" ], "type": "object", "properties": { "total_rows": { "type": "integer", "format": "int64", "readOnly": true }, "resources": { "type": "array", "readOnly": true, "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "bookmark": { "type": "string", "readOnly": true } }, "description": "OK" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/v2/folder_assets": { "post": { "tags": [ "Folder Assets" ], "summary": "Create a folder asset", "description": "You can use this API to add folder assets to a catalog. Folder assets are similar to folders or directories in a file system. In the same way that a directory in a file system can contain many files, a folder asset can represent groups of files or objects all sharing a common path. An example of a path may be '/sales_data/by_month/february'. There may be many different files with that common path, but we only need to register just the common path when we create a folder asset.

Along with other types of assets, such as data assets, folder assets share a common set of properties such as name, description, asset type, visibility, tags, classifications, etc. In addition to other types of assets, folder assets are denoted by a `folder_asset` json object within the common `entity` object. The `folder_asset` json object contains a `connection_id`, and a `connection_path`. E.g.,\r\n\r\n\n```\n{\r\n \"metadata\":{...},\r\n \"entity\":{\r\n \"folder_asset\":{\r\n \"connection_id\":\"f1fea17c-a7e5-49e4-9f8e-23cef3e11ed5\",\r\n \"connection_path\":\"/bucket1/folder1/folder1.1\"\r\n }\r\n }\r\n}\r\n```\r\n
A folder asset can be mediated by a connection. In other words, you can access the contents of the folder asset only through a connection in the connection service. The connection can be to any external data store such as DashDB, Salesforce.com,IBM's Cloud Object Storage, etc. You must specify the `connection_id` and the `connection_path` within the `folder_asset` json object.

Folder assets can also be local to the catalog or project, similar to local or referenced data attachments. For such a folder asset you don't need the connection_id in the `folder_asset` json. You only need to provide the connection_path. The API can use it's internal connection to asset storage associated with the catalog/project/space (Cloud Object Storage in IBM Cloud, or Asset Files storage in CPD) for accessing that folder.

A connection path is like the path of a folder or a directory in a file system. Using IBM Cloud Object Storage as an example, a `connection_path` for a folder object might be `/Bucket1/monthly_data_collection/March`. Any objects falling under that path are part of the folder asset. This API cannot show you those files directly. Instead, you can use your IBM Cloud Object Storage connection to traverse to that folder location and retrieve the files.", "operationId": "createFolderAssetV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "requestBody": { "description": "Folder Asset Metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogFolderAsset" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogCreationResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/folder_assets/{asset_id}": { "get": { "tags": [ "Folder Assets" ], "summary": "Get a folder asset", "description": "Use this API to retrieve metadata about a folder asset.", "operationId": "getFolderAssetV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Enter the id of the folder asset whose metadata you want to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated.", "deprecated": true, "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/folder_assets/{asset_id}/contents": { "get": { "tags": [ "Folder Assets" ], "summary": "Get a signed URL of an item to be downloaded", "description": "If you have created folder assets for things that you store in IBM Cloud Object Storage, you can download individual contents of that folder. Every item within a folder has a path within that folder. For example there may be a folder asset in IBM Cloud Object Storage whose path is `/bucket1/retail_sales/cosmetics`. Within that folder, there may be several individual files. You can download these files with this API. When you call the API, you will receive a URL that, when you invoke it with a GET HTTP command, you can download a file that is within that folder.", "operationId": "getFolderAssetContentsV2", "parameters": [ { "name": "asset_id", "in": "path", "description": "Enter the id of the folder asset whose content you want to download.", "required": true, "schema": { "type": "string" } }, { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "The path to the object from where the folder leaves off. For example if your folder path is `/Bucket1/homedecore` and your object path is `/bathrooms/sinkaccessories/soapdish1000.jpg` then the API will return a signed URL that includes the full object key `/Bucket1/homedecore/bathrooms/sinkaccessories/soapdish1000.jpg`.", "required": true, "schema": { "type": "string" } }, { "name": "content_type", "in": "query", "description": "The type of content you will download. Default is `application/octet-stream`", "schema": { "type": "string", "default": "application/octet-stream" } }, { "name": "content_disposition", "in": "query", "description": "content_disposition specifies how you want the content downloaded. The default is as an attachment (i.e. a separate file).", "schema": { "type": "string", "default": "attachment" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/trashed_assets": { "get": { "tags": [ "Asset Trash" ], "summary": "List all assets in the trash (Marked for delete)", "description": " Retrieve all assets in the trash (Marked for delete.", "operationId": "getTrashContentsNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "older_than", "in": "query", "description": "older than the given timestamp. Format: \"yyyy-MM-dd'T'hh:mm:ss[.sss]X\" Example '2017-11-23T00:00:00-12', '2017-11-23T23:59:59.999Z', etc.", "schema": { "type": "string" } }, { "name": "newer_than", "in": "query", "description": "newer than the given timestamp. Format: \"yyyy-MM-dd'T'hh:mm:ss[.sss]X\" Example '2017-11-23T00:00:00-12', '2017-11-23T23:59:59.999Z', etc.", "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated.", "deprecated": true, "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "limit", "in": "query", "description": "limit", "schema": { "type": "integer", "default": "25" } }, { "name": "bookmark", "in": "query", "description": "bookmark", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogGetTrashContentsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/trashed_assets/count": { "get": { "tags": [ "Asset Trash" ], "summary": "Get count of all assets in the trash (Marked for delete)", "description": " Get count of all assets in the trash (Marked for delete.", "operationId": "getTrashedAssetCount", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTrashedAssetCountResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/trashed_assets/purge_all": { "delete": { "tags": [ "Asset Trash" ], "summary": "Delete all assets from trash", "description": "Delete all assets from trash. \r\n\n If number of assets in trash is less than or equal to 20 , the assets will be deleted synchrnonously and response will be 204 - No Content. \r\n\n If number of assets in trash is more than 20, the assets will be deleted asynchrnonously, response will be 202 - Accepted and the status can be tracked using `/v2/trashed_assets/count`. \r\n\n\r\n", "operationId": "purgeTrashedAssets", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/trashed_assets/{asset_id}": { "get": { "tags": [ "Asset Trash" ], "summary": "Get a soft-deleted object from trash", "description": " Get a soft-deleted object from trash.", "operationId": "getTrashedAssetNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "allow_metadata_on_dpr_deny", "in": "query", "description": "Whether to allow access to metadata when the evaluation outcome of data protection rules is Deny.", "schema": { "type": "boolean" } }, { "name": "include", "in": "query", "description": "The parameter `include` is deprecated, please use `exclude` instead", "deprecated": true, "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset Trash" ], "summary": "Delete an asset from the trash", "description": "Purge an asset from the trash.", "operationId": "purgeAssetNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/trashed_assets/{asset_id}/restore": { "post": { "tags": [ "Asset Trash" ], "summary": "Restore an asset from the trash", "description": "Restore an asset from the trash.", "operationId": "restoreAssetNewV2", "parameters": [ { "name": "catalog_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "You must provide either a catalog id, a project id, or a space id, but not more than one", "schema": { "type": "string" } }, { "name": "exclude", "in": "query", "description": "Exclude columns from the asset result. Available value: columns. Default value is empty, which will return the complete asset, including the columns.", "schema": { "type": "string" } }, { "name": "hide_deprecated_response_fields", "in": "query", "description": "Defaults to false. If true, deprecated fields are not included in the response. This parameter is provided as a way to check compatibility with future releases and remove duplicated information from responses. It has not been implemented for all deprecated fields. The primary fields that are omitted are collaborator_ids in the asset metadata rov and the owner_id field in the asset metadata.", "schema": { "type": "boolean", "default": "false" } }, { "name": "asset_id", "in": "path", "description": "asset_id", "required": true, "schema": { "type": "string" } }, { "name": "duplicate_action", "in": "query", "description": "Action to take if the changes to an asset would make it a duplicate to other assets. `IGNORE` means the call will continue and update the asset anyway; as a result, the asset will become a duplicate to other assets. `REJECT` means the call will fail and the asset will not be changed. No value means the duplicate_action specified in catalogs/projects/spaces will be used.", "schema": { "type": "string", "enum": [ "IGNORE", "REJECT" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponseAsset" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v2/connections": { "get": { "tags": [ "Connections" ], "summary": "List defined connections", "description": "Lists defined connections.\n\nConnections created with shared credentials will return secrets such as database passwords and API keys in clear text. Such secrets are stored encrypted but will be decrypted by the API when retrieved by the caller in order to access the data source defined by the connection. Clear text credentials are allowed because it is understood that the caller has already been explicitly added as a collabaorator in the project or catalog in which the connection is stored and is thus implicitly permitted access to the credentials required to connect to a data source.\n\nConnections created with personal credentials will only display clear text credentials to the same user who provided them.\n\nUse the following parameters to sort the results:\n\n| Field | Example |\n| ------------------------- | ----------------------------------- |\n| entity.name | ?_sort=+entity.name |\n| metadata.create_time | ?_sort=-metadata.create_time |\n\nUse the following parameters to filter the results:\n\n| Field | Example |\n|-------------------------- | ----------------------------------- |\n| entity.name | ?entity.name=MyConnection |\n| entity.datasource_type | ?entity.datasource_type= |\n| entity.context | ?entity.context=source |\n| entity.properties | ?entity.properties={\"name\":\"value\"} |\n| entity.flags | ?entity.flags=+personal_credentials |\n| metadata.creator_id | ?metadata.creator_id=userid |\n\nFiltering is done by specifying the fields to filter on.\n\nTo filter on the properties of a connection, the exact values to compare must be provided in the entities.properties field and all values supplied must exactly match a property of a connection.\n\nThe entity.flags field specifies the flags a connection can have to be included in the list results. By default, all connections with no flags are returned.\n\nAdding the name of a flag to entity.flags will add the connections with that flag to the list results. The name can be optionally prefixed with a plus sign (+) to indicate that it is being added.\n\nAdding the name of a flag to entity.flags with a minus sign (-) prefix will remove those connections with that flag from the list results. All additions are done before the subtractions.\n", "operationId": "listConnections", "parameters": [ { "$ref": "#/components/parameters/Connectionssort" }, { "$ref": "#/components/parameters/Connectionsstart" }, { "$ref": "#/components/parameters/Connectionslimit" }, { "$ref": "#/components/parameters/Connectionsmetadata_creator" }, { "$ref": "#/components/parameters/Connectionsentity_name" }, { "$ref": "#/components/parameters/Connectionsentity_datasource_type" }, { "$ref": "#/components/parameters/Connectionsentity_context" }, { "$ref": "#/components/parameters/Connectionsentity_properties" }, { "$ref": "#/components/parameters/Connectionsentity_flags" }, { "$ref": "#/components/parameters/Connectionsinject_token" }, { "$ref": "#/components/parameters/Connectionsinteraction_properties" }, { "$ref": "#/components/parameters/Connectionsdecrypt_secrets" }, { "$ref": "#/components/parameters/Connectionsinclude_properties" } ], "responses": { "200": { "description": "Connections with metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionCollection" } } } }, "401": { "description": "You are not authorized to list the defined connections.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The defined connections cannot be listed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "list" }, "post": { "tags": [ "Connections" ], "summary": "Define connection", "description": "Defines a connection.\n\nBy default, a connection is created with shared credentials. Though credentials'\nsecrets are stored encrypted, all credentials including secrets will be visible\nin clear text to API users who retrieve the connection and who are collaborators\nof the project or catalog in which a connection with shared credentials has been\ncreated.\n\nAlternatively, a connection can be created with personal credentials by using\nthe personal_credentials flag. The credentials' secrets will be visible only\nto the user who created the connection.\n", "operationId": "saveConnection", "parameters": [ { "$ref": "#/components/parameters/Connectionstest" }, { "$ref": "#/components/parameters/Connectionsskip_enforcement" }, { "$ref": "#/components/parameters/Connectionspersist" } ], "requestBody": { "description": "The definition of the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionEntity" } } }, "required": true }, "responses": { "201": { "description": "The connection was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnection" } } } }, "400": { "description": "The connection test failed. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "You are not authorized to define a connection.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. A connection was not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "create", "x-codegen-request-body-name": "connection" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/Connectionscatalog_id" }, { "$ref": "#/components/parameters/Connectionsproject_id" }, { "$ref": "#/components/parameters/Connectionsspace_id" }, { "$ref": "#/components/parameters/Connectionsuserfs" } ] }, "/v2/connections/{connection_id}": { "get": { "tags": [ "Connections" ], "summary": "Get connection", "description": "Gets details of a specific connection definition.\n\nConnections created with shared credentials will\nreturn secrets such as database passwords and API keys in clear text. Such\nsecrets are stored encrypted but will be decrypted by the API when retrieved\nby the caller in order to access the data source defined by the connection.\nClear text credentials are allowed because it is understood that the caller\nhas already been explicitly added as a collabaorator in the project or catalog\nin which the connection is stored and is thus implicitly permitted access to\nthe credentials required to connect to a data source.\n\nConnections created with personal credentials will\nonly display clear text credentials to the same user who provided them.\n", "operationId": "getConnection", "parameters": [ { "$ref": "#/components/parameters/Connectionsinject_token" }, { "$ref": "#/components/parameters/Connectionsentity_product" }, { "$ref": "#/components/parameters/Connectionsinteraction_properties" }, { "$ref": "#/components/parameters/Connectionsdecrypt_secrets" } ], "responses": { "200": { "description": "The connection object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnection" } } } }, "401": { "description": "You are not authorized to get details about the connection.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The connection cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The connection definition details cannot be retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "get" }, "delete": { "tags": [ "Connections" ], "summary": "Delete connection", "description": "Deletes a connection definition. This call does not\ncheck whether the connection is used by activities,\ndata sets or other assets. The caller must check this\nbefore deleting a connection.\n", "operationId": "deleteConnection", "responses": { "204": { "description": "The connection was deleted.", "content": {} }, "401": { "description": "You are not authorized to delete a connection.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The connection cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The connection was not deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "delete" }, "patch": { "tags": [ "Connections" ], "summary": "Update connection", "description": "Updates the definition of a connection.\n", "operationId": "updateConnection", "parameters": [ { "$ref": "#/components/parameters/Connectionstest" }, { "$ref": "#/components/parameters/Connectionsskip_enforcement" }, { "$ref": "#/components/parameters/Connectionspersist" } ], "requestBody": { "description": "Fields to update within the connection.", "content": { "application/json-patch+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" } } }, "required": true }, "responses": { "200": { "description": "The updated connection definition object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionEntity" } } } }, "400": { "description": "The connection test failed. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "You are not authorized to update the connection definition.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The connection cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The connection definition was not updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "update", "x-codegen-request-body-name": "patch_request" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/Connectionscatalog_id" }, { "$ref": "#/components/parameters/Connectionsproject_id" }, { "$ref": "#/components/parameters/Connectionsspace_id" }, { "$ref": "#/components/parameters/Connectionsuserfs" }, { "$ref": "#/components/parameters/Connectionsconnection_id" } ] }, "/v2/connections/upgrade": { "post": { "tags": [ "Connections" ], "summary": "Upgrade connections", "description": "Upgrades connection.\n", "operationId": "upgradeConnections", "parameters": [ { "$ref": "#/components/parameters/Connectionscatalog_id" }, { "$ref": "#/components/parameters/Connectionsproject_id" }, { "$ref": "#/components/parameters/Connectionsspace_id" }, { "$ref": "#/components/parameters/Connectionsstart" }, { "$ref": "#/components/parameters/Connectionslimit" }, { "$ref": "#/components/parameters/Connectionscalculate_resource_key" }, { "$ref": "#/components/parameters/Connectionscalculate_data_source_definition_searchable" } ], "responses": { "201": { "description": "The connections were upgraded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionUpgradeResponse" } } } }, "400": { "description": "Bad request. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "You are not authorized to define a connection.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "500": { "description": "An error occurred. Connections were not updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-exclude": true }, "servers": [ { "url": "/" } ] }, "/v2/connections/assets": { "post": { "tags": [ "Connections" ], "summary": "Discover assets", "description": "Discovers assets from the data source accessed via a connection description.\n", "operationId": "discoverAssetsAnonymously", "parameters": [ { "$ref": "#/components/parameters/Connectionspath" }, { "$ref": "#/components/parameters/Connectionslimit" }, { "$ref": "#/components/parameters/Connectionsoffset" }, { "$ref": "#/components/parameters/Connectionsfetch" }, { "$ref": "#/components/parameters/Connectionsdetail" }, { "$ref": "#/components/parameters/Connectionscontext" }, { "$ref": "#/components/parameters/Connectionsaccept" }, { "$ref": "#/components/parameters/Connectionsproperties" }, { "$ref": "#/components/parameters/Connectionsfilters" } ], "requestBody": { "description": "The connection definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionEntity" } } }, "required": true }, "responses": { "200": { "description": "The discovered assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetCollection" } } } }, "401": { "description": "You are not authorized to discover assets.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. No assets were found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "discover-adhoc", "x-codegen-request-body-name": "connection" }, "servers": [ { "url": "/" } ] }, "/v2/connections/{connection_id}/assets": { "get": { "tags": [ "Connections" ], "summary": "Discover assets", "description": "Discovers assets from the data source accessed via the connection.\n", "operationId": "discoverAssets", "parameters": [ { "$ref": "#/components/parameters/Connectionsconnection_id" }, { "$ref": "#/components/parameters/Connectionspath" }, { "$ref": "#/components/parameters/Connectionscatalog_id" }, { "$ref": "#/components/parameters/Connectionsproject_id" }, { "$ref": "#/components/parameters/Connectionsspace_id" }, { "$ref": "#/components/parameters/Connectionsuserfs" }, { "$ref": "#/components/parameters/Connectionsdata_asset_id" }, { "$ref": "#/components/parameters/Connectionsdata_asset_catalog_id" }, { "$ref": "#/components/parameters/Connectionsdata_asset_project_id" }, { "$ref": "#/components/parameters/Connectionsdata_asset_space_id" }, { "$ref": "#/components/parameters/Connectionslimit" }, { "$ref": "#/components/parameters/Connectionsoffset" }, { "$ref": "#/components/parameters/Connectionsfetch" }, { "$ref": "#/components/parameters/Connectionsdetail" }, { "$ref": "#/components/parameters/Connectionscontext" }, { "$ref": "#/components/parameters/Connectionsaccept" }, { "$ref": "#/components/parameters/Connectionsproperties" }, { "$ref": "#/components/parameters/Connectionsfilters" } ], "responses": { "200": { "description": "The discovered assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetCollection" } } } }, "401": { "description": "You are not authorized to discover assets in the data source accessed through the connection.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The connection cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. No assets were discovered in the data source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "discover" }, "servers": [ { "url": "/" } ] }, "/v2/connections/assets/{data_asset_id}": { "get": { "tags": [ "Connections" ], "summary": "Discover data asset", "description": "Discover a data asset.\n", "operationId": "discoverDataAsset", "parameters": [ { "$ref": "#/components/parameters/Connectionsdata_asset_id_path" }, { "$ref": "#/components/parameters/Connectionscatalog_id" }, { "$ref": "#/components/parameters/Connectionsproject_id" }, { "$ref": "#/components/parameters/Connectionsspace_id" }, { "$ref": "#/components/parameters/Connectionsuserfs" }, { "$ref": "#/components/parameters/Connectionslimit" }, { "$ref": "#/components/parameters/Connectionsoffset" }, { "$ref": "#/components/parameters/Connectionsfetch" }, { "$ref": "#/components/parameters/Connectionsdetail" }, { "$ref": "#/components/parameters/Connectionscontext" }, { "$ref": "#/components/parameters/Connectionsaccept" }, { "$ref": "#/components/parameters/Connectionsproperties" }, { "$ref": "#/components/parameters/Connectionsfilters" }, { "name": "path", "in": "query", "description": "Path of the asset.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The discovered asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetCollection" } } } }, "401": { "description": "You are not authorized to discover the asset.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The asset cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. No assets were discovered in the data source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "discover-data-asset" }, "servers": [ { "url": "/" } ] }, "/v2/connections/{connection_id}/actions": { "get": { "tags": [ "Connections" ], "summary": "List actions", "description": "Lists all supported actions for the connection.\n", "operationId": "listActions", "parameters": [ { "$ref": "#/components/parameters/Connectionsaccept_language" }, { "$ref": "#/components/parameters/Connectionsconnection_id" }, { "$ref": "#/components/parameters/Connectionscatalog_id" }, { "$ref": "#/components/parameters/Connectionsproject_id" }, { "$ref": "#/components/parameters/Connectionsspace_id" }, { "$ref": "#/components/parameters/Connectionsuserfs" } ], "responses": { "200": { "description": "The actions supported for the connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionActions" } } } }, "401": { "description": "You are not authorized to list the actions for the connection.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The connection cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The actions for the connection cannot be listed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "list-actions" }, "servers": [ { "url": "/" } ] }, "/v2/connections/{connection_id}/actions/{action_name}": { "put": { "tags": [ "Connections" ], "summary": "Perform action", "description": "Performs an action on the data source accessed using the connection.\n", "operationId": "performAction", "parameters": [ { "$ref": "#/components/parameters/Connectionsconnection_id" }, { "name": "action_name", "in": "path", "description": "The name of the action to be performed. This list is expanded over time. The current actions are:\n\n| action | description |\n| --------------------- | ------------------------------------------------------------------------ |\n| get_dsd_details | to obtain Data Source Definition Asset details from a connector. |\n| get_oauth2_tokens | to get refresh and authorization tokens for sources that support OAuth2. |\n| get_record_count | to get the number of records available for the specified asset. |\n| get_signed_url | to get a signed URL for accessing a data source. |\n| test | to check if a connection can be established to the data source. |\n| validate | to validate the connection properties without establishing a connection. |\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "get_dsd_details", "get_oauth2_tokens", "get_record_count", "get_signed_url", "test", "validate" ] } }, { "$ref": "#/components/parameters/Connectionscatalog_id" }, { "$ref": "#/components/parameters/Connectionsproject_id" }, { "$ref": "#/components/parameters/Connectionsspace_id" }, { "$ref": "#/components/parameters/Connectionsuserfs" } ], "requestBody": { "description": "The perform action request configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionActionConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Any output produced by the action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionActionResponse" } } } }, "400": { "description": "The perform action request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "You are not authorized to perform an action on a data source accessed through the connection.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The connection cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. No action was performed on the data source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "perform-action", "x-codegen-request-body-name": "request" }, "servers": [ { "url": "/" } ] }, "/v2/connections/files/{file_name}": { "get": { "tags": [ "Files" ], "summary": "Download a file", "description": "Download a file\n", "operationId": "getFile", "parameters": [ { "name": "file_name", "in": "path", "description": "The name of file to download", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "hash", "in": "query", "description": "The hash of file to download", "required": true, "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The file object.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "You are not authorized to get content of the file.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The file cannot be found.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The driver jar cannot be retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "get" }, "post": { "tags": [ "Files" ], "summary": "Upload a file", "description": "Upload a file and get back a signed handle in 'Location' header with a hash\n", "operationId": "uploadFile", "parameters": [ { "name": "file_name", "in": "path", "description": "The name of file to upload", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "byte" } } } }, "responses": { "201": { "description": "The file object.", "content": {} }, "401": { "description": "You are not authorized to get content of the file.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The file cannot be found.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The driver jar cannot be retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "post" }, "delete": { "tags": [ "Files" ], "summary": "Delete a file", "description": "Delete a file\n", "operationId": "deleteFile", "parameters": [ { "name": "file_name", "in": "path", "description": "The name of file to delete", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "hash", "in": "query", "description": "The hash of file to delete", "required": true, "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The file was deleted.", "content": {} }, "401": { "description": "You are not authorized to get content of the file.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The file cannot be found.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The driver jar cannot be retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "delete" }, "servers": [ { "url": "/" } ] }, "/v2/connections/files": { "get": { "tags": [ "Files" ], "summary": "List files", "description": "List files available in mounted directory\n", "operationId": "listFiles", "parameters": [ { "$ref": "#/components/parameters/Connectionslimit" }, { "$ref": "#/components/parameters/Connectionsoffset" } ], "responses": { "200": { "description": "List of available files", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionFileCollection" } } } }, "401": { "description": "You are not authorized to get the list of files.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The file cannot be found.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The driver jar cannot be retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "list" }, "put": { "tags": [ "Files" ], "summary": "Migrate files", "description": "Migrates files from old locations to new one\n", "operationId": "migrateFiles", "parameters": [ { "name": "listOnly", "in": "query", "description": "Indicator, if only list files to be migrated.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "catalogs", "in": "query", "description": "Indicator, if migrate connections from catalogs.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "projects", "in": "query", "description": "Indicator, if migrate connections from projects.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "spaces", "in": "query", "description": "Indicator, if migrate connections from spaces.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "List of newly uploaded files", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsConnectionMigratedCollection" } } } }, "401": { "description": "You are not authorized to migrate files.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The driver jar cannot be retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "migrate" }, "servers": [ { "url": "/" } ] }, "/v2/datasource_types": { "get": { "tags": [ "Datasource Types" ], "summary": "List defined types of data sources", "description": "Gets all defined types of data sources.\n\nThe following fields are available for use with the sort parameter:\n\n| field name | description |\n| ------------ | ---------------------------------------------------- |\n| entity.label | The name of the data source type in a readable form. |\n| entity.type | The major type of the data source type. |\n", "operationId": "listDatasourceTypes", "parameters": [ { "$ref": "#/components/parameters/Connectionsaccept_language" }, { "$ref": "#/components/parameters/Connectionssort" }, { "$ref": "#/components/parameters/Connectionsoffset" }, { "$ref": "#/components/parameters/Connectionslimit" }, { "$ref": "#/components/parameters/Connectionsconnection_properties" }, { "$ref": "#/components/parameters/Connectionsinteraction_properties" }, { "$ref": "#/components/parameters/Connectionsdiscovery" }, { "$ref": "#/components/parameters/Connectionsactions" }, { "$ref": "#/components/parameters/Connectionsentity.environment" }, { "$ref": "#/components/parameters/Connectionsentity_product" }, { "$ref": "#/components/parameters/Connectionsproduct_selector_scope" }, { "$ref": "#/components/parameters/Connectionsgenerate_transitive_conditions" }, { "$ref": "#/components/parameters/Connectionsshow_data_source_definitions_only" } ], "responses": { "200": { "description": "Collection of data source types.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeCollection" } } } }, "401": { "description": "You are not authorized to list the defined types of data sources.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. No data source types were retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "list" }, "post": { "tags": [ "Datasource Types" ], "summary": "Define data source type", "description": "Defines a data source type.\n", "operationId": "saveDatasourceType", "requestBody": { "description": "The definition of the data source type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeEntity" } } }, "required": true }, "responses": { "201": { "description": "The data source type was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypes" } } } }, "400": { "description": "The data source type definition is not valid. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "You are not authorized to define a data source type.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. A data source type was not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-exclude": true, "x-codegen-request-body-name": "custom_datasource_type" }, "servers": [ { "url": "/" } ] }, "/v2/datasource_types/{datasource_type}": { "get": { "tags": [ "Datasource Types" ], "summary": "Get details for type of data source", "description": "Get details for type of data source.\n", "operationId": "getDatasourceType", "parameters": [ { "$ref": "#/components/parameters/Connectionsaccept_language" }, { "$ref": "#/components/parameters/Connectionsdatasource_type" }, { "$ref": "#/components/parameters/Connectionsconnection_properties" }, { "$ref": "#/components/parameters/Connectionsinteraction_properties" }, { "$ref": "#/components/parameters/Connectionsdiscovery" }, { "$ref": "#/components/parameters/Connectionsactions" }, { "$ref": "#/components/parameters/Connectionsentity.environment" }, { "$ref": "#/components/parameters/Connectionsentity_product" }, { "$ref": "#/components/parameters/Connectionsproduct_selector_scope" }, { "$ref": "#/components/parameters/Connectionsgenerate_transitive_conditions" } ], "responses": { "200": { "description": "A data source type definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsDatasourceType" } } } }, "401": { "description": "You are not authorized to retrieve the type details of the data source.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The data source type details cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. No data source type details were retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-cli-command": "get" }, "delete": { "tags": [ "Datasource Types" ], "summary": "Delete data source type", "description": "Deletes a data source type definition. This call does not\ncheck whether the data source type is used by connections\nor other assets. The caller must check this before deleting\na data source type.\n", "operationId": "deleteDatasourceType", "parameters": [ { "$ref": "#/components/parameters/Connectionsdatasource_type" } ], "responses": { "204": { "description": "The data source type was deleted.", "content": {} }, "401": { "description": "You are not authorized to delete a data source type.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The data source type cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The connection was not deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-exclude": true }, "patch": { "tags": [ "Datasource Types" ], "summary": "Update datasource type", "description": "Updates the definition of a datasource type.\n", "operationId": "updateDatasourceType", "parameters": [ { "$ref": "#/components/parameters/Connectionsdatasource_type" } ], "requestBody": { "description": "Fields to update within the data source type.", "content": { "application/json-patch+json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" } } }, "required": true }, "responses": { "200": { "description": "The updated data source type definition object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeEntity" } } } }, "400": { "description": "The data source type patch request is not valid. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "You are not authorized to update the data source type definition.", "content": {} }, "403": { "description": "You are not permitted to perform this action.", "content": {} }, "404": { "description": "The data source type cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "429": { "description": "The service is currently receiving more requests than it can process in a timely fashion. Please retry submitting your request later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The data source type definition was not updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "504": { "description": "A timeout occurred when processing your request. Please retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-exclude": true, "x-codegen-request-body-name": "patch_request" }, "servers": [ { "url": "/" } ] }, "/v2/metadata_enrichment/metadata_enrichment_area": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Create a metadata enrichment area asset", "description": "Creates a new metadata enrichment asset and the corresponding job definition. If a data scope is provided the decoration of data scope assets will be started in background and the response will contain the execution ID of that background process. After background processing has finished a RabbitMQ event is sent to CAMS topic exchange CatalogServiceMessageHub with topic v2.metadata_enrichment.{mdeAreaId}.create_enrichment_area and message body as described in model RabbitMqNotificationMessage. If no data scope is provided an empty enrichment area is created without starting a background decoration task. In that case the field asyncExecutionInfo will be missing in the response. If query paramter enrichImmediate is true, which is the default setting, and the data scope is not empty a new enrichment job run will be triggered automatically. ", "parameters": [ { "name": "enrichImmediate", "in": "query", "description": "should enrichment be run immediately after area creation", "schema": { "default": "true", "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Object containing information for creating a metadata enrichment area asset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaRequest" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentArea" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/settings": { "get": { "tags": [ "Metadata Enrichment Area" ], "summary": "Retrieve metadata enrichment settings", "description": "Retrieve metadata enrichment settings", "parameters": [ { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentSettings" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "put": { "tags": [ "Metadata Enrichment Area" ], "summary": "Create or update metadata enrichment settings", "description": "Create or update metadata enrichment settings", "parameters": [ { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Metadata enrichment settings", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } }, "required": true }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}": { "get": { "tags": [ "Metadata Enrichment Area" ], "summary": "Retrieve details of a Metadata Enrichment Area asset", "description": " Retrieve details of a metadata enrichment area asset ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "include_summary", "in": "query", "description": "whether to include data asset count summary in the response", "schema": { "default": "false", "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentArea" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "410": { "description": "Gone" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "delete": { "tags": [ "Metadata Enrichment Area" ], "summary": "Delete a metadata enrichment asset", "description": " Delete a metadata enrichment area asset ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "410": { "description": "Gone" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "patch": { "tags": [ "Metadata Enrichment Area" ], "summary": "edit a metadata enrichment area asset", "description": " Edit a metadata enrichment area asset ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "description": "Force the operation even when the metadata enrichment area is being updated.", "schema": { "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Object carrying the update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentArea" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "410": { "description": "Gone" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope": { "patch": { "tags": [ "Metadata Enrichment Area" ], "summary": "Add or remove assets from data scope", "description": " Add or remove assets from data scope ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "description": "Force the operation even when the metadata enrichment area is being updated.", "schema": { "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Object carrying the update request.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesEnrichmentDataScopePatchRequestInner" } } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "410": { "description": "Gone" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/assign_terms": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Assign business terms to data assets", "description": " Add terms to given data assets. This api is executed synchronously. It verifies that all assets are part of the given MDE area. If validation fails method ends with an error. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "async", "in": "query", "description": "whether to process the request asynchronously", "schema": { "default": "false", "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of data assets and terms to assign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesTermAssignmentOptions" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesDataAssetTermAssignments" } } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesAsyncExecutionInfo" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/assign_terms": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Assign business terms to columns of data assets", "description": " Add terms to given asset columns. This api is executed synchronously. It verifies that all assets are part of the given MDE area. If validation fails method ends with an error. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "async", "in": "query", "description": "whether to process the request asynchronously", "schema": { "default": "false", "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of columns of data assets and terms to assign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesColumnTermAssignmentOptions" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesDataAssetColumnTermAssignments" } } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesAsyncExecutionInfo" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/dataclass": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Assign or remove a data class to columns of data assets", "description": "Assign or remove data class to columns of data assets", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "async", "in": "query", "description": "whether to process the request asynchronously", "schema": { "default": "false", "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of columns of data assets and id of data class and operation to be performed", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesDataClassAssignmentOptionsInner" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/remove_terms": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Remove business terms from columns of data assets.", "description": "Removes either all terms or selected terms from given asset columns. When terms are provided with the payload only the given terms are removed from the given columns. If no terms are provided all terms are removed. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "async", "in": "query", "description": "whether to process the request asynchronously", "schema": { "default": "false", "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of columns of data assets and terms to assign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesColumnTermAssignmentOptions" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesDataAssetColumnTermAssignments" } } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesAsyncExecutionInfo" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/review": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Adds or updates the review timestamp for given columns.", "description": " Adds/updates the 'reviewed' time stamp to/of the given asset columns.This api is executed synchronously. It fetches the assets that belong to the given columns via CAMS bulk get and verifies that all given assets are part of the given MDE area and are ready for review which means that either profiling or term assignment must be finished. It also validates that the columns exist on the asset. If validation fails the method returns an error. Otherwise for all given columns the review timestamp gets updated via CAMS bulk patch. Returns the new review timestamp. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Array containing list of asset Ids with columns.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesMdeAssetColumns" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesReviewdateMde" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/columns/unreview": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Removes review timestamp for given columns.", "description": " Removes the 'reviewed' time stamp from the given asset columns. This api is executed synchronously. It fetches alle assets that belong to the given columns via CAMS bulk get and verifies that all given assets are part of the given MDE area. Assets that have no review data are skipped. It also validates that the columns exist on the asset. If validation fails the method returns an error. Otherwise for all given columns the review timestamp will be removed via CAMS bulk patch. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Array containing list of asset Ids with columns.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesMdeAssetColumns" } } } }, "required": true }, "responses": { "204": { "description": "No content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/enrich": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Enrich selected data assets", "description": "Enrich selected data assets", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Array containing list of asset Ids.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesJobRunInfo" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/remove_terms": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Remove business terms from data assets", "description": " Removes either all terms or selected terms from given list of data assets. When terms are provided with the payload only the given terms are removed from the given assets. If no terms are provided all terms are removed. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "async", "in": "query", "description": "whether to process the request asynchronously", "schema": { "default": "false", "type": "boolean" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of data assets and terms to remove", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesTermAssignmentOptions" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesDataAssetTermAssignments" } } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesAsyncExecutionInfo" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/review": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Review a given list of data assets.", "description": " Adds/updates the 'reviewed' time stamp to/of given data assets. This api is executed synchronously. It fetches the given assets via CAMS bulk get and verifies that all given assets are part of the given MDE area and are ready for review which means that either profiling or term assignment must be finished. If validation fails the method returns an error. Otherwise the review timestamp of all assets gets updated via CAMS bulk patch. Returns the new review timestamp. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Array containing list of asset Ids.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesReviewdateMde" } } } }, "400": { "description": "Bad Request. If parameters are missing or at least one of the given assets is not ready for review" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found. If at least one of the given assets is not member of the given metadata enrichment area." }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/data_scope/enrichment_assets/unreview": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Removes review timestamp from the given assets", "description": " Removes the 'reviewed' time stamp from the given data assets. This api is executed synchronously. It fetches the given assets via CAMS bulk get and verifies that all given assets are part of the given MDE area. Assets that have no review data are skipped. If validation fails the method returns an error. Otherwise the review timestamp is removed from of all assets via CAMS bulk patch. ", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Array containing list of asset Ids.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request. If parameters are missing." }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found. If at least one of the given assets is not member of the given metadata. enrichment area." }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_enrichment/metadata_enrichment_area/{metadata_enrichment_area_id}/publish_assets": { "post": { "tags": [ "Metadata Enrichment Area" ], "summary": "Publish all assets or a subset of assets of a Metadata Enrichment Area to a catalog", "description": "Publish assets asynchronously. If publishScope is 'selected_assets' either /asset_ids or /filter/search_criteria has to be specified. If publisScope is 'all_assets' none of both must be specified.", "parameters": [ { "name": "metadata_enrichment_area_id", "in": "path", "description": "Id of the metadata enrichment area asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } }, { "name": "publishScope", "in": "query", "description": "tells if all assets in mde area should be published or only selected assets", "required": true, "schema": { "enum": [ "all_assets", "selected_assets" ] } } ], "requestBody": { "description": "Publish assets to a catalog", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesPublishRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesJobRunInfo" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports": { "post": { "tags": [ "Metadata Import" ], "summary": "Create a Metadata Import asset", "description": "Create a Metadata Import asset. ", "parameters": [ { "name": "create_job", "in": "query", "description": "If this value is set to true, a Job is created together. The relation is also done between mdetadata import asset. The response message includes entity.jobId. The job name is generated from the name of metadata import with a unique suffix.", "schema": { "default": "false", "type": "boolean" } }, { "name": "job_name", "in": "query", "description": "A candidate of Job name. The job is created with a specified name. If the name already exists, an error is returned. The create_job parameter should be set to true.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Object containing information for creating a metadata import asset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportRequest" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataImport" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/bulk_delete_assets": { "post": { "tags": [ "Metadata Import" ], "summary": "Bulk delete data assets in Metadata discovery", "description": "Delete assets in bulk ", "parameters": [ { "name": "catalog_id", "in": "query", "description": "The catalog_id and / or project_id must be provided. If catalog_id is provided, the catalog must exist and the caller must be an admin or editor member of the catalog. Only data discovery runs associated with the catalog will be returned.", "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Array containing list of data asset Ids.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "201": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/bulk_delete_metadataImport_assets": { "delete": { "tags": [ "Metadata Import" ], "summary": "Bulk delete metadata import assets in Metadata discovery", "description": "Delete metadata import assets in bulk ", "parameters": [ { "name": "asset_ids", "in": "query", "description": "Comma separated list of metadata import asset IDs.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/bulk_publish_assets": { "post": { "tags": [ "Metadata Import" ], "summary": "Bulk publish data assets in Metadata discovery", "description": "Publish assets in bulk ", "parameters": [ { "name": "catalog_id", "in": "query", "description": "The catalog_id and / or project_id must be provided. If catalog_id is provided, the catalog must exist and the caller must be an admin or editor member of the catalog. Only data discovery runs associated with the catalog will be returned.", "schema": { "type": "string" } }, { "name": "connection_id", "in": "query", "description": "The connection_id may be optionally provided to retrieve data discovery runs associated with the connection.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Array containing list of data asset Ids.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/connections": { "get": { "tags": [ "Metadata Import" ], "summary": "Get a list of supported datasource types", "description": "INTERNAL: Get list of supported connection types. ", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportDatasourceType" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/job_runs": { "post": { "tags": [ "Metadata Import Run" ], "summary": "Start a Metadata Import job", "description": "INTERNAL: Run a Metadata Import job. ", "parameters": [ { "name": "job_id", "in": "query", "description": "Id of the metadata import job.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Job definition object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesJob" } } }, "required": true }, "responses": { "201": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/job_runs/cancel": { "post": { "tags": [ "Metadata Import Run" ], "summary": "cancel a Metadata Import run", "description": " INTERNAL: Cancel a metadata import job run ", "parameters": [ { "name": "jobrun_id", "in": "query", "description": "Id of the metadata import job run.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Job definition object", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesJobRun" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/job_runs/reconcile": { "post": { "tags": [ "Metadata Import" ], "summary": "Reconcile the status of the job run record w.r.t the Discovery status", "description": "INTERNAL: Reconcile the status of the job run record w.r.t the Discovery status ", "parameters": [ { "name": "jobrun_id", "in": "query", "description": "Id of the metadata import job run.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesJobRun" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesJobRunReconcileRequest" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/recover_task": { "post": { "tags": [ "Metadata Import" ], "summary": "Restart the pending a job run", "description": "Restart the pending a job run. It should be called after restore from the backup data. This API is not unavailable on IBM Cloud. The Admin role is necessary to call this API. ", "requestBody": { "description": "Object containing information for recovering import", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesRecoveryCondition" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesRecoveryResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/validate_metadata_import_job": { "post": { "tags": [ "Metadata Import" ], "summary": "Validate the attempt to delete job associated with Metadata import asset", "description": "Validate the attempt to delete job associated with Metadata import asset ", "parameters": [ { "name": "job_id", "in": "query", "description": "Id of the metadata import job.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/validate_sap_connection": { "post": { "tags": [ "Metadata Import" ], "summary": "Validates a SAP Business Metadata connection", "description": "Validates a SAP Business Metadata connection. ", "parameters": [ { "name": "connection_id", "in": "query", "description": "The connection_id may be optionally provided to retrieve data discovery runs associated with the connection.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/metadata_imports/{metadata_import_id}": { "get": { "tags": [ "Metadata Import" ], "summary": "Retrieve details of a Metadata Import", "description": " Retrieve details of a metadata import ", "parameters": [ { "name": "metadata_import_id", "in": "path", "description": "Id of the metadata import asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataImport" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "410": { "description": "Gone" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "delete": { "tags": [ "Metadata Import" ], "summary": "delete a metadata import asset", "description": " delete a metadata import asset ", "parameters": [ { "name": "metadata_import_id", "in": "path", "description": "Id of the metadata import asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "410": { "description": "Gone" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "patch": { "tags": [ "Metadata Import" ], "summary": "edit a metadata import asset", "description": " edit a metadata import asset ", "parameters": [ { "name": "metadata_import_id", "in": "path", "description": "Id of the metadata import asset.", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "The project_id must be provided. The project must exist and the caller must be an admin or editor member of the project.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Object carrying the update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataDiscoveriesMetadataImport" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "410": { "description": "Gone" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/data_profiles": { "get": { "tags": [ "Data Profiles" ], "summary": "List data profiles", "description": "__Status: *Complete*__\n\nGet the list of data profiles in the specified project or catalog for a given dataAsset, provided the caller has the necessary rights to do so.\nThe returned results can be filtered by using one or more of the listed parameters.\n\n| Field | Match type | Example |\n| --------------- | ------------ | ------------------------------ |\n| dataset_id | Equals | ?dataset_id=5210c7d-cf6b |\n", "operationId": "getDataProfiles", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilesinclude_entity" }, { "$ref": "#/components/parameters/DataProfileslite_mode" }, { "name": "column", "in": "query", "description": "Return the analysis results for specified column. This option will be ignored for data profile run using data flow.", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfilePagedCollection" } } } }, "401": { "description": "You are not permitted to perform this action." }, "403": { "description": "You are not authorized to list the available data profiles." }, "404": { "description": "Not Found." }, "500": { "description": "An error occurred. The data profiles cannot be listed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } }, "post": { "tags": [ "Data Profiles" ], "summary": "Create data profile", "description": "__Status: *Complete*__\n\nCreates a data profile for a given data set in the specified project or catalog, provided the caller has the necessary rights to do so. Subsequent calls to use the data profile must specify the relevant project or catalog ID that the data profile was created in.\n\nThe request payload must include the 'metadata' section containing the data set id and catalog/project id.\n\nThe request payload can have the 'entity' section which is optional specifying the data profile options. If these options are not specified, default options are taken.\nTo create several data profiles at once in the specified project or catalog, specify an array of data set in the attribute dataset_ids instead of a single data set in the attribute dataset_id. In this case, the data profiles are created in a single job that can be found in the execution section of the returned data profile entity.\n##### AMQP 1.0 Messages\nWhen a new data profile is created, a message is fired with a state of the new data profile in the body.\n\n###### Topic\nv2.data_profiles.:guid.POST ,where the \":guid\" represents the profile_id of the created Data Profile\n\nSubscribe to it by using \"v2.data_profiles.*.POST\" Binding Key.\n\n###### Example Message\nTopic: v2.data_profiles.5210c7d-cf6b-4204-95d2-95d84ecbe382.POST\n\nMessage:\n~~~~ \n{\n \"event\": \"CREATE_DATA_PROFILE\",\n \"actor\": { \n \"user_name\": \"john@acme.com\" \n },\n \"published\": \"2015-05-10T15:04:15Z\",\n \"url\": { /* The href of the DataProfile created */}\n \"status_code\": { /* The Http Status code , 201 if the DataProfile is created successfully */}\n \"state\": { /* the data profile object equivalent to the one obtained by GET /v2/data_profiles/{profile_id} API */ }\n \"details\": {\n \"catalog_id\": \"f3c59258-abdd-4e24-828b-0495ec519339\",\n \"dataset_id\": \"e522db21-59e8-44ab-81b2-bb40c3030a6f\",\n \"profile_id\": \"5165d439-96f0-40d4-90b2-93795deab61b\",\n \"is_governed\": false { /* set to true if the catalog is_governed else set it to false}\n }\n}\n~~~~\n", "operationId": "createDataProfile", "parameters": [ { "name": "start", "in": "query", "description": "Whether to start the profiling service immediately after the data profile is created.\n", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/DataProfilesuse_mde" }, { "$ref": "#/components/parameters/DataProfilescharge_term_assignment" } ], "requestBody": { "description": "The data profile to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfile" } } }, "required": true }, "responses": { "201": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfile" } } } }, "202": { "description": "Accepted.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfile" } } } }, "401": { "description": "You are not authorized to create a data profile." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile cannot be found." }, "500": { "description": "An error occurred. The data profile cannot be created.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/{profile_id}": { "get": { "tags": [ "Data Profiles" ], "summary": "Get data profile", "description": "__Status: *Complete*__\n\nGets a data profile from a project or catalog, provided the call has the required right to do so.\n", "operationId": "getDataProfile", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesprofile_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfileslite_mode" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfile" } } } }, "401": { "description": "You are not authorized to get the data profile you specified." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. The data profile you specified cannot be fetched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } }, "delete": { "tags": [ "Data Profiles" ], "summary": "Delete data profile", "description": "__Status: *Complete*__\n\nDeletes a specified data profile in a project or catalog, provided the caller has the necessary rights to do so.\n\nThe data profile is not deleted if the profiling process is still running unless the stop_in_progress_runs parameter is set to true.\n", "operationId": "deleteDataProfile", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesprofile_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilesstop_in_progress_profiling_runs" }, { "$ref": "#/components/parameters/DataProfilesuse_mde" } ], "responses": { "204": { "description": "Success." }, "401": { "description": "You are not authorized to delete data profiles." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Data profile not found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "415": { "description": "Data source not supported for profiling." }, "500": { "description": "An error occurred. The data profile cannot be deleted.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } }, "patch": { "tags": [ "Data Profiles" ], "summary": "Update data profile", "description": "__Status: *Complete*__\n\nUpdates a data profile in the project or catalog specified in the data profile, provided the caller has the necessary rights to do so. \n\nDuring update, the entire data profile is replaced, apart from any read-only or response-only attributes.\n\nIf the profiling processes is running and the start parameter is set to true, then a data profile is only updated if the stop_in_progress_runs parameter is set to true.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n\n##### AMQP 1.0 Messages\nWhen a data profile is modified, a message is fired with a state of the modified data profile in the body.\n\n###### Topic\nv2.data_profiles.:guid.PATCH\n\nSubscribe to it by using \"v2.data_profiles.*.PATCH\" Binding Key.\n\n###### Example Message\nTopic: v2.data_profiles.5210c7d-cf6b-4204-95d2-95d84ecbe382.PATCH\n\nMessage:\n~~~~ \n{\n \"event\": \"UPDATE_DATA_PROFILE\",\n \"actor\": { \n \"user_name\": \"john@acme.com\", \n },\n \"published\": \"2015-05-10T15:04:15Z\",\n \"url\": { /* The href of the DataProfile created */}\n \"status_code\": { /* The Http Status code , 200 if the DataProfile is updated successfully */}\n \"state\": { /* the data profile object equivalent to the one obtained by GET /v2/data_profiles/{profile_id} API */ }\n \"details\": {\n \"catalog_id\": \"f3c59258-abdd-4e24-828b-0495ec519339\",\n \"dataset_id\": \"e522db21-59e8-44ab-81b2-bb40c3030a6f\",\n \"profile_id\": \"5165d439-96f0-40d4-90b2-93795deab61b\",\n \"is_governed\": false { /* set to true if the catalog is_governed else set it to false}\n }\n}\n~~~~ \n", "operationId": "patchDataProfile", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesprofile_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilesstop_in_progress_profiling_runs" }, { "$ref": "#/components/parameters/DataProfilesuse_mde" }, { "name": "start", "in": "query", "description": "Whether to start the profiling service immediately after the data profile is updated.\n", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean" } } ], "requestBody": { "description": "The updates to make in the data profile.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfile" } } } }, "401": { "description": "You are not authorized to update the data profile you specified." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile you specified cannot be found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. The data profile you specified cannot be updated.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/bulk": { "post": { "tags": [ "Data Profiles" ], "summary": "Update data profiles", "description": "__Status: *Complete*__\n\nUpdates data profiles in the project or catalog for one or more assets, provided the caller has the necessary rights to do so. \n\nDuring update, the entire data profiles are replaced, apart from any read-only or response-only attributes.\n\nIf any profiling process is running and the start parameter is set to true, then a data profile is only updated if the stop_in_progress_runs parameter is set to true.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n\n##### AMQP 1.0 Messages\nWhen a data profile is modified, a message is fired with a state of the modified data profile in the body.\n\n###### Topic\nv2.data_profiles.:guid.PATCH\n\nSubscribe to it by using \"v2.data_profiles.*.PATCH\" Binding Key.\n\n###### Example Message\nTopic: v2.data_profiles.5210c7d-cf6b-4204-95d2-95d84ecbe382.PATCH\nMessage:\n~~~~ \n{\n \"event\": \"UPDATE_DATA_PROFILE\",\n \"actor\": { \n \"user_name\": \"john@acme.com\", \n },\n \"published\": \"2015-05-10T15:04:15Z\",\n \"url\": { /* The href of the DataProfile created */}\n \"status_code\": { /* The Http Status code , 200 if the DataProfile is updated successfully */}\n \"state\": { /* the data profile object equivalent to the one obtained by GET /v2/data_profiles/{profile_id} API */ }\n \"details\": {\n \"catalog_id\": \"f3c59258-abdd-4e24-828b-0495ec519339\",\n \"dataset_id\": \"e522db21-59e8-44ab-81b2-bb40c3030a6f\",\n \"profile_id\": \"5165d439-96f0-40d4-90b2-93795deab61b\",\n \"is_governed\": false { /* set to true if the catalog is_governed else set it to false}\n }\n}\n~~~~ \n", "operationId": "bulkAssetsUpdate", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" } ], "requestBody": { "description": "The updates to make in the one or more data profiles.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DataProfilesBulkAssetsUpdateRequest" } } } }, "responses": { "200": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesBulkAssetsUpdateResponse" } } } }, "401": { "description": "You are not authorized to update the data profile you specified." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The catalog / project you specified cannot be found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. The catalog / project you specified cannot be updated.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/{profile_id}/execution": { "put": { "tags": [ "Data Profiles" ], "summary": "Stop profiling process", "description": "__Status: *Complete*__\n\nStops an in-progress profiling run in the specified project or catalog, provided the caller has the necessary rights to do so.\nThis API will request the action to be performed and return, not perform the action and wait for it to complete.\n", "operationId": "updateDataProfileExecution", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilesprofile_id" }, { "$ref": "#/components/parameters/DataProfilesuse_mde" } ], "requestBody": { "description": "The requested action to perform on the profile run.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileRunStatusRequest" } } }, "required": true }, "responses": { "202": { "description": "Requested." }, "401": { "description": "You are not authorized to stop the profiling process." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile you specified cannot be found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. The profiling process cannot be stopped.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/{profile_id}/logs": { "get": { "tags": [ "Data Profiles" ], "summary": "Get profiling logs", "description": "__Status: *Complete*__\n\nGet the logs for the data profile job run on data set in a project or catalog.\n", "operationId": "getDataProfileJobLog", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilesprofile_id" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileJobLogEntryCollection" } } } }, "401": { "description": "You are not authorized to get the profiling logs." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. Failed to get profiling logs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/dqdimensions": { "get": { "tags": [ "Data Profiles" ], "summary": "Get the list of data quality dimensions available.", "description": "__Status: *Complete*__\n\nGet the list of data quality dimensions available.\n", "operationId": "getDataQualityDimensions", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataQualityDimensionCollection" } } } }, "403": { "description": "You are not permitted to perform this action." }, "500": { "description": "An error occurred. Failed to get quality dimensions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/classification": { "patch": { "tags": [ "Data Profiles" ], "summary": "Modify asset level classification", "description": "__Status: *Complete*__\n\nModifies asset level classification detail in the data_profile attribute in the specified project or catalog, provided the caller has the necessary rights to do so. \nThis API is used for CRUD operations on asset level classification.\n\nThe patch request for classification should contain the classification details that are to be added to the data_profile attribute.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n", "operationId": "patchAssetClassification", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilesuse_mde" } ], "requestBody": { "description": "The asset level classification details that are added to the data_profile attribute.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesCommonCustomObject" } } } }, "400": { "description": "Invalid classification details provided as part of the patch call." }, "401": { "description": "You are not authorized to modify the data_profile attribute with asset level classification details." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The asset classification cannot be found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. The data_profile attribute cannot be modified with asset level classification detail.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/options": { "get": { "tags": [ "Data Profile Options" ], "summary": "Get data profile options", "description": "__Status: *Complete*__\n\nGet the data profile options for the Account specified in the IAM token. If the account level data profile options is not \navailable check if it is specified at project or catalog account level, provided the caller has the necessary rights to do so.\n", "operationId": "getDataProfileOptions", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesuse_mde" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileOptionsObject" } } } }, "401": { "description": "You are not permitted to perform this action." }, "403": { "description": "You are not authorized to list the available data profiles options." }, "404": { "description": "Not Found." }, "500": { "description": "An error occurred. The data profiles options cannot be listed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } }, "post": { "tags": [ "Data Profile Options" ], "summary": "Create data profile options", "description": "__Status: *Complete*__\n\nCreates a data profile options for a given Account Id in the specified project or catalog, provided the caller has the necessary rights to do so.\n", "operationId": "createDataProfileOptions", "parameters": [ { "$ref": "#/components/parameters/DataProfilesuse_mde" } ], "requestBody": { "description": "The data profile option to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileOptionsObject" } } }, "required": true }, "responses": { "201": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileOptionsObject" } } } }, "401": { "description": "You are not authorized to create data profile options." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile options cannot be found." }, "500": { "description": "An error occurred. The data profile options cannot be created.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } }, "delete": { "tags": [ "Data Profile Options" ], "summary": "Delete data profile options", "description": "__Status: *Complete*__\n\nDelete the list of data profile options in the specified project or catalog, provided the caller has the necessary rights to do so.\nIf the user specifies the catalog_id or the project_id then the data profile options specified for the catalog or project is deleted.\nIf none of the query parameters,catalog_id or project_id is specified, the default is to delete the account level data profile options.\n", "operationId": "deleteDataProfileOptions", "parameters": [ { "$ref": "#/components/parameters/DataProfilesbss_account_ids" }, { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesuse_mde" } ], "responses": { "204": { "description": "Success." }, "401": { "description": "You are not permitted to perform this action." }, "403": { "description": "You are not authorized to list the available data profiles options." }, "404": { "description": "Not Found." }, "500": { "description": "An error occurred. The data profiles options cannot be listed.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } }, "patch": { "tags": [ "Data Profile Options" ], "summary": "Update the data profile options.", "description": "__Status: *Complete*__\n\nUpdates the data profile options for a given Account in the specified project or catalog, provided the caller has the necessary rights to do so.\nThe data profile options that can be modified are max_row_count,row_percentage,max_distribution_size,max_numeric_stats_bin\ndisabled flag in classification options,ibm_class_codes and custom_class_codes.\n\nIf the user specifies the catalog_id or the project_id then the data profile options specified for the catalog or project is updated.\nUpdate the account level data profile options if catalog_id or project_id is not specified.\n", "operationId": "patchDataProfileOptions", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesuse_mde" } ], "requestBody": { "description": "The data profile options to add.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileOptionsObject" } } } }, "401": { "description": "You are not authorized to update the data profile options." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile options you specified cannot be found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. The data profile options cannot be updated.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } } }, "/v2/data_profiles/results": { "post": { "tags": [ "Profiling results" ], "summary": "Persist profiling results", "description": "__Status: *Complete*__\n\nPersist profiling results of dataset in a project or catalog. (For internal use only)\n", "operationId": "persistProfilingResults", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilestenant_id" }, { "$ref": "#/components/parameters/DataProfilescorrelation_id" } ], "requestBody": { "description": "The data profile option to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesProfilingResults" } } }, "required": true }, "responses": { "200": { "description": "Success." }, "401": { "description": "You are not authorized to persist results." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Asset or profile is missing" }, "500": { "description": "An error occurred. The profiling results cannot be saved.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } } }, "/v2/data_profiles/results/status": { "post": { "tags": [ "Profiling results" ], "summary": "Update data profile results status", "description": "__Status: *Complete*__\n\nUpdate data profile result status of dataset in a project or catalog. (For internal use only)\n", "operationId": "updateDataProfileResultsStatus", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilestenant_id" }, { "$ref": "#/components/parameters/DataProfilescorrelation_id" } ], "requestBody": { "description": "The data profile result status to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileResultStatus" } } }, "required": true }, "responses": { "200": { "description": "Success." }, "401": { "description": "You are not authorized to update data profile result status." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Asset or profile is missing" }, "500": { "description": "An error occurred. The data profile result status cannot be saved.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } } }, "/v2/data_profiles/bivariate_results": { "get": { "tags": [ "Bivariate results" ], "summary": "Get bivariate results of given asset.", "description": "__Status: *Complete*__\n\nGet bivariate results of dataset in a project or catalog. (For internal use only)\n", "operationId": "persistBivariateResults", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesBivariateResults" } } } }, "401": { "description": "You are not authorized to persist results." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Asset is missing" }, "500": { "description": "An error occurred. The bivariate results cannot be retrieved.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } }, "post": { "tags": [ "Bivariate results" ], "summary": "Persist bivariate results of given asset.", "description": "__Status: *Complete*__\n\nPersist bivariate results of dataset in a project or catalog. (For internal use only)\n", "operationId": "persistBivariateResults_0", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" } ], "requestBody": { "description": "The bivariate results to persist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesBivariateResults" } } }, "required": true }, "responses": { "200": { "description": "Success." }, "401": { "description": "You are not authorized to persist results." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Asset is missing" }, "500": { "description": "An error occurred. The bivariate results cannot be saved.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } } }, "/v2/data_profiles/export": { "get": { "tags": [ "Data Profiles" ], "summary": "Export data profile", "description": "__Status: *Complete*__\n\nExport data profile of dataset in a project or catalog. (For internal use only)\n", "operationId": "exportDataProfile", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" }, { "$ref": "#/components/parameters/DataProfilestaskId" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileExport" } } } }, "401": { "description": "You are not authorized to persist results." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Asset or profile is missing" }, "500": { "description": "An error occurred. The profiling results cannot be saved.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } } }, "/v2/data_profiles/import": { "post": { "tags": [ "Data Profiles" ], "summary": "Import data profile", "description": "__Status: *Complete*__\n\nImport data profile of dataset in a project or catalog. (For internal use only)\n", "operationId": "importDataProfile", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id" } ], "requestBody": { "description": "The data profile to import.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesDataProfileImport" } } }, "required": true }, "responses": { "200": { "description": "Success." }, "401": { "description": "You are not authorized to persist results." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Asset or profile is missing" }, "500": { "description": "An error occurred. The profiling results cannot be saved.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } } }, "/v2/data_profiles/{profile_id}/unique_values": { "post": { "tags": [ "Data Profiles" ], "summary": "This filters rows from the frequency distribution.", "description": "This filters rows from the frequency distribution.", "operationId": "searchDeepProfilingUniqueValue", "parameters": [ { "$ref": "#/components/parameters/DataProfilesprofile_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesFrequencyDistributionRequestBody" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesFrequencyDistributionResults" } } } }, "401": { "description": "You are not authorized to get the key analysis you specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "403": { "description": "You are not permitted to perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "404": { "description": "The key analysis task you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "500": { "description": "An error occurred. The data profile you specified cannot be fetched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } } } } }, "/v2/data_profiles/migrate": { "post": { "tags": [ "Migrate profile results to data quality" ], "summary": "Migrate data profile quality results to new Data Quality service", "description": "__Status: *Complete*__\n\nMigrate data profile quality results of dataset in a project or catalog to new Data Quality service.\n", "operationId": "migrateDataQualityResults", "parameters": [ { "$ref": "#/components/parameters/DataProfilescatalog_id" }, { "$ref": "#/components/parameters/DataProfilesproject_id" }, { "$ref": "#/components/parameters/DataProfilesdataset_id_optional" } ], "responses": { "200": { "description": "Successfully initiated migration process.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesMigrationResponseLogs" } } } }, "400": { "description": "Bad request. Provided parameters could be invalid." }, "401": { "description": "You are not authorized, either token is expired or invalid." }, "403": { "description": "You are not permitted to perform this action. Only Editor or Admin are allowed." }, "404": { "description": "Catalog or Project not found." }, "500": { "description": "An error occurred. The profiling results cannot be migrated to data quality service.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesErrorContainer1" } } } }, "501": { "description": "This API is not Implemented." } } } }, "/v1/hb_tasks": { "get": { "tags": [ "Hummingbird tasks" ], "summary": "List Hummingbird tasks", "description": "__Status: *Complete*__\n\nGet the list of Hummingbird tasks for a specified accout or type, provided the caller has the necessary rights to do so.\n", "operationId": "getHbTasks", "parameters": [ { "$ref": "#/components/parameters/DataProfilesbss_account_id" }, { "$ref": "#/components/parameters/DataProfilesjob_type" }, { "$ref": "#/components/parameters/DataProfilesall_details" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesHbTaskResponseCollection" } } } }, "401": { "description": "You are not permitted to perform this action." }, "403": { "description": "You are not authorized to list the available Hummingbird tasks." }, "404": { "description": "Not Found." }, "500": { "description": "An error occurred. The HB tasks cannot be listed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "post": { "tags": [ "Hummingbird tasks" ], "summary": "Create a Hummingbird task", "description": "__Status: *Complete*__\n\nCreates a Hummingbird task entry job.\n", "operationId": "createHbTask", "requestBody": { "description": "The Hummingbird task to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesHbTaskRequest" } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesHbTaskResponse" } } } }, "401": { "description": "You are not authorized to create a Hummingbird task." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The data profile cannot be found." }, "500": { "description": "An error occurred. The Hummingbird task cannot be created.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v1/hb_tasks/stop": { "post": { "tags": [ "Hummingbird tasks" ], "summary": "Stop Hummingbird tasks", "description": "__Status: *Complete*__\n\nStops given Hummingbird task ids. If the Hummingbird task is already completed or is not found then it will be ignored. If the task is locked by other process then it will be ignored as well.\n", "operationId": "stopHbTasks", "parameters": [], "requestBody": { "description": "The Hummingbird task ids to stop.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesHbTaskIds" } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesStopHbTasksResponse" } } } }, "401": { "description": "You are not authorized to cancel Hummingbird tasks." }, "403": { "description": "You are not permitted to perform this action." }, "500": { "description": "An error occurred. The Hummingbird tasks cannot be stopped.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v1/hb_tasks/delete": { "post": { "tags": [ "Hummingbird tasks" ], "summary": "Delete Hummingbird tasks", "description": "__Status: *Complete*__\n\nDelete given Hummingbird task ids. If a Hummingbird task is not found then it will be ignored. If the Hummingbird task is running and stop_in_progress_job is not true then it will be ignored. If the task is locked by other process then it will be ignored as well.\n", "operationId": "deleteHbTasks", "parameters": [ { "$ref": "#/components/parameters/DataProfilesstop_in_progress_job" } ], "requestBody": { "description": "The Hummingbird task ids to delete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesHbTaskIds" } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataProfilesDeleteHbTasksResponse" } } } }, "401": { "description": "You are not authorized to cancel a Hummingbird task." }, "403": { "description": "You are not permitted to perform this action." }, "500": { "description": "An error occurred. The Hummingbird tasks cannot be deleted.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v1/hb_tasks/{hb_task_id}": { "get": { "tags": [ "Hummingbird tasks" ], "summary": "Get HB task", "description": "__Status: *Complete*__\n\nGets a Hummingbird task.\n", "operationId": "getHbTask", "parameters": [ { "$ref": "#/components/parameters/DataProfileshb_task_id" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProfilesHbTaskResponse" } } } }, "401": { "description": "You are not authorized to get the data profile you specified." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "The HB task you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The HB task you specified cannot be fetched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "delete": { "tags": [ "Hummingbird tasks" ], "summary": "Delete Hummingbird task", "description": "__Status: *Complete*__\n\nDeletes a specified Hummingbird task.\n\nThis api will throw an exception if stop_in_progress_job parameter is not true and if job is running.\n", "operationId": "deleteHbTask", "parameters": [ { "$ref": "#/components/parameters/DataProfileshb_task_id" }, { "$ref": "#/components/parameters/DataProfilesstop_in_progress_job" } ], "responses": { "204": { "description": "Success." }, "401": { "description": "You are not authorized to delete Hummingbird task." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Hummingbird task not found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The Hummingbird task cannot be deleted.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v1/hb_tasks/{hb_task_id}/start": { "post": { "tags": [ "Hummingbird tasks" ], "summary": "Start Hummingbird task", "description": "__Status: *Complete*__\n\nStart the specified Hummingbird task, if it is in QUEUED state.\n\nThe Hummingbird task is starte in engine, if it is in queued state\n", "operationId": "startHbTask", "parameters": [ { "$ref": "#/components/parameters/DataProfileshb_task_id" } ], "responses": { "204": { "description": "Success." }, "400": { "description": "The Hummingbird task is not QUEUED." }, "401": { "description": "You are not authorized to start Hummingbird task." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Hummingbird task not found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The failed to start Hummingbird task.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v1/hb_tasks/{hb_task_id}/stop": { "post": { "tags": [ "Hummingbird tasks" ], "summary": "Stop Hummingbird task", "description": "__Status: *Complete*__\n\nStop the specified Hummingbird task.\n\nThe Hummingbird task is force stopped in engine\n", "operationId": "stopHbTask", "parameters": [ { "$ref": "#/components/parameters/DataProfileshb_task_id" } ], "responses": { "204": { "description": "Success." }, "401": { "description": "You are not authorized to delete Hummingbird task." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Hummingbird task not found.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. The failed to stop Hummingbird task.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v1/hb_tasks/{hb_task_id}/logs": { "get": { "tags": [ "Hummingbird tasks" ], "summary": "Get Hummingbird task logs", "description": "__Status: *Complete*__\n\nGet the spark job logs for Hummingbird task. In order to retrieve the job logs, the HB spark job must be successfully submitted. This will generate a job_id.\nWhen successful, this api would return the Hummingbird spark job log.\n", "operationId": "getHbTaskLogs", "parameters": [ { "$ref": "#/components/parameters/DataProfileshb_task_id" } ], "responses": { "200": { "description": "Success.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "You are not authorized to get Hummingbird task logs." }, "403": { "description": "You are not permitted to perform this action." }, "404": { "description": "Hummingbird task not found.", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "An error occurred. Failed to retrieve Hummingbird task logs.", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/data_quality/v4/version": { "servers": [ { "url": "/" } ] }, "/data_quality/v4/assets": { "get": { "tags": [ "Data Quality Assets" ], "summary": "Get data quality assets", "description": "Get a list of data quality assets.\n", "operationId": "list_dq_assets", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityStartQuery" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" }, { "$ref": "#/components/parameters/DataQualityTypeQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityAssetCollection" }, "examples": { "AssetCollection": { "$ref": "#/components/examples/DataQualityAssetCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality assets cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assets.read", "description": "User must be a collaborator for the container" } ] } }, "post": { "tags": [ "Data Quality Assets" ], "summary": "Create Data quality assets", "description": "Create a data quality asset.\n", "operationId": "create_dq_asset", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "requestBody": { "description": "Data quality asset to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityAssetPrototype" }, "examples": { "AssetPrototype": { "$ref": "#/components/examples/DataQualityAssetPrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/assets/894d01fd-bdfc-4a4f-b68b-62751e06e06a" }, "Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/assets/894d01fd-bdfc-4a4f-b68b-62751e06e06a" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityAsset" }, "examples": { "Asset": { "$ref": "#/components/examples/DataQualityAsset" } } } } }, "400": { "description": "The given payload is invalid and the asset is not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer400" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to create a data quality asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "409": { "description": "The data quality asset exists already and cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer409" } } } } }, "500": { "description": "An error occurred. The data quality asset cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assets.create", "description": "User must be either Admin(administrator) or Editor for the container" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/assets/{id}": { "get": { "tags": [ "Data Quality Assets" ], "summary": "Get a data quality asset", "description": "Get the data quality asset with the given identifier.\n", "operationId": "get_dq_asset", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/assets/894d01fd-bdfc-4a4f-b68b-62751e06e06a" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityAsset" }, "examples": { "Asset": { "$ref": "#/components/examples/DataQualityAsset" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality asset with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality asset cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assets.read", "description": "User must be a collaborator for the container" } ] } }, "delete": { "tags": [ "Data Quality Assets" ], "summary": "Delete data quality asset", "description": "Delete the data quality asset with the given identifier and all its\nchildren recursively\n", "operationId": "delete_dq_asset", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityDeleteChildren" } ], "responses": { "204": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/assets/894d01fd-bdfc-4a4f-b68b-62751e06e06a" } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to delete the data quality asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality asset cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality asset cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assets.delete", "description": "User must be either Admin(administrator) or Editor for the container" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.issue.delete", "description": "Tracking event with action name 'wdp-data_quality.issue.delete' is logged as the asset related issues are deleted." } ] } }, "patch": { "tags": [ "Data Quality Assets" ], "summary": "Update or patch a data quality asset", "description": "Update a data quality asset as specified in the payload details\nof the request.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n

\nThe following attributes can be updated:\n - /name (value can only be replaced)\n - /weight (value can only be replaced)\n", "operationId": "update_dq_asset", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "requestBody": { "description": "The updates to make in the data quality rule.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" }, "examples": { "JSONResourcePatchRequestModel": { "$ref": "#/components/examples/DataQualityJSONResourcePatchRequestModel" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/assets/894d01fd-bdfc-4a4f-b68b-62751e06e06a" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityAsset" }, "examples": { "Asset": { "$ref": "#/components/examples/DataQualityAsset" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to update the data quality asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality asset with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality asset cannot be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assets.update", "description": "User must be either Admin(administrator) or Editor for the container" } ] }, "x-codegen-request-body-name": "resource_patch_request_model" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityAssetId" } ] }, "/data_quality/v4/search_dq_asset": { "post": { "tags": [ "Data Quality Assets" ], "summary": "Search data quality asset with given native id and type", "description": "Search for a data quality asset by its native id and type", "operationId": "search_dq_asset", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityNativeIdQuery" }, { "$ref": "#/components/parameters/DataQualityTypeQuery" }, { "$ref": "#/components/parameters/DataQualityWKCAssetId" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/assets/894d01fd-bdfc-4a4f-b68b-62751e06e06a" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityAsset" }, "examples": { "Asset": { "$ref": "#/components/examples/DataQualityAsset" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to search data quality assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality asset cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality asset cannot be searched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assets.read", "description": "User must be a collaborator for the container" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/checks": { "get": { "tags": [ "Data Quality Checks" ], "summary": "Get data quality checks", "description": "Get a list of data quality checks.\n", "operationId": "list_dq_checks", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityStartQuery" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" }, { "$ref": "#/components/parameters/DataQualityTypeQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityCheckCollection" }, "examples": { "CheckCollection": { "$ref": "#/components/examples/DataQualityCheckCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality checks.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality checks cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.checks.read", "description": "User must be a collaborator for the container" } ] } }, "post": { "tags": [ "Data Quality Checks" ], "summary": "Create data quality checks", "description": "Create a data quality check.\n", "operationId": "create_dq_check", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "requestBody": { "description": "Data quality check to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityCheckPrototype" }, "examples": { "CheckPrototype": { "$ref": "#/components/examples/DataQualityCheckPrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/checks/6be18374-573a-4cf8-8ab7-e428506e428b" }, "Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/checks/6be18374-573a-4cf8-8ab7-e428506e428b" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityCheck" }, "examples": { "Asset": { "$ref": "#/components/examples/DataQualityCheck" } } } } }, "400": { "description": "The given payload is invalid and the check is not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer400" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to create a data quality check.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "409": { "description": "The data quality check exists already and cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer409" } } } } }, "500": { "description": "An error occurred. The data quality check cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.checks.create", "description": "User must be either Admin(administrator) or Editor for the container" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/checks/{id}": { "get": { "tags": [ "Data Quality Checks" ], "summary": "Get a data quality check", "description": "Get the data quality check with the given identifier.\n", "operationId": "get_dq_check", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/checks/6be18374-573a-4cf8-8ab7-e428506e428b" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityCheck" }, "examples": { "Check": { "$ref": "#/components/examples/DataQualityCheck" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality check.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality check with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality check cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.checks.read", "description": "User must be a collaborator for the container" } ] } }, "delete": { "tags": [ "Data Quality Checks" ], "summary": "Delete a data quality check", "description": "Delete the data quality check with the given identifier and all its\nchildren recursively\n", "operationId": "delete_dq_check", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityDeleteChildren" } ], "responses": { "204": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/checks/6be18374-573a-4cf8-8ab7-e428506e428b" } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to delete the data quality check.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality check cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality check cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.checks.delete", "description": "User must be either Admin(administrator) or Editor for the container" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.issue.delete", "description": "Tracking event with action name 'wdp-data_quality.issue.delete' is logged as corresponding issues for check are deleted" } ] } }, "patch": { "tags": [ "Data Quality Checks" ], "summary": "Update or patch a data quality check", "description": "Update a data quality check as specified in the payload details\nof the request.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n

\nThe following attributes can be updated:\n - /name (value can only be replace)\n - /dimension/id (value can be add, remove or replace)\n - /details (value can be add, remove or replace)\n", "operationId": "update_dq_check", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "requestBody": { "description": "The updates to make in the data quality rule.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" }, "examples": { "JSONResourcePatchRequestModel": { "$ref": "#/components/examples/DataQualityJSONResourcePatchRequestModel" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/checks/6be18374-573a-4cf8-8ab7-e428506e428b" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityCheck" }, "examples": { "Check": { "$ref": "#/components/examples/DataQualityCheck" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to update the data quality check.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality check with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality check cannot be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.checks.update", "description": "User must be either Admin(administrator) or Editor for the container" } ] }, "x-codegen-request-body-name": "resource_patch_request_model" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityCheckId" } ] }, "/data_quality/v4/search_dq_check": { "post": { "tags": [ "Data Quality Checks" ], "summary": "Search for a data quality check by its native id and type", "description": "Search for a data quality check by its native id and type", "operationId": "search_dq_check", "parameters": [ { "$ref": "#/components/parameters/DataQualityNativeIdQueryRequired" }, { "$ref": "#/components/parameters/DataQualityTypeQueryRequired" }, { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/checks/6be18374-573a-4cf8-8ab7-e428506e428b" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityCheck" }, "examples": { "Check": { "$ref": "#/components/examples/DataQualityCheck" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to search data quality checks.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality check cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality check cannot be searched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.checks.read", "description": "User must be a collaborator for the container" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/dimensions": { "get": { "tags": [ "Data Quality Dimensions" ], "summary": "Get a list of data quality dimensions", "description": "Get a list of data quality dimensions.\n", "operationId": "list_dq_dimensions", "parameters": [ { "$ref": "#/components/parameters/DataQualityStartQuery" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDimensionCollection" }, "examples": { "DimensionCollection": { "$ref": "#/components/examples/DataQualityDimensionCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality dimensions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality dimensions cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.dimensions.read", "description": "Any platform level user." } ] } }, "post": { "tags": [ "Data Quality Dimensions" ], "summary": "Create a data quality dimension", "description": "Create a data quality dimension.\n", "operationId": "create_dq_dimension", "requestBody": { "description": "Data quality dimension to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDimensionPrototype" }, "examples": { "DimensionPrototype": { "$ref": "#/components/examples/DataQualityDimensionPrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/dimensions/7b3f3a79-6412-480b-a20c-393a3f7addbf" }, "Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/dimensions/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDimension" }, "examples": { "Dimension": { "$ref": "#/components/examples/DataQualityDimension" } } } } }, "400": { "description": "The given payload is invalid and the dimension is not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer400" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to create a data quality dimension.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "409": { "description": "The data quality dimension exists already and cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer409" } } } } }, "500": { "description": "An error occurred. The data quality dimension cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.dimensions.create", "description": "User must have the platform administrator permission" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/dimensions/{id}": { "get": { "tags": [ "Data Quality Dimensions" ], "summary": "Get the data quality dimension with the given identifier", "description": "Get the data quality dimension with the given identifier.\n", "operationId": "get_dq_dimension", "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/dimensions/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDimension" }, "examples": { "Dimension": { "$ref": "#/components/examples/DataQualityDimension" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality dimension.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality dimension with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality dimension cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.dimensions.read", "description": "Any platform level user." } ] } }, "delete": { "tags": [ "Data Quality Dimensions" ], "summary": "Delete the data quality dimension with the given identifier.\n", "description": "Delete the data quality dimension with the given identifier.\n

\nAll data quality checks associated to this dimension will point to no dimension. \nAll DQ scores stored for this dimension will be deleted\n", "operationId": "delete_dq_dimension", "responses": { "204": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/dimensions/7b3f3a79-6412-480b-a20c-393a3f7addbf" } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to delete the data quality dimension.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality dimension cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality dimension cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.dimensions.delete", "description": "User must have the platform administrator permission." } ] } }, "patch": { "tags": [ "Data Quality Dimensions" ], "summary": "Update a data quality dimension as specified in the payload details of the request", "description": "Update a data quality dimension as specified in the payload details\nof the request.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n

\nThe following attributes can be updated:\n - /name (value can only be replaced)\n - /description (value can be added, removed, or replaced)\n", "operationId": "update_dq_dimension", "requestBody": { "description": "The updates to make in the data quality rule.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" }, "examples": { "JSONResourcePatchRequestModel": { "$ref": "#/components/examples/DataQualityJSONResourcePatchRequestModel" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/dimensions/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDimension" }, "examples": { "Dimension": { "$ref": "#/components/examples/DataQualityDimension" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to update the data quality dimension.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality dimension with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality dimension cannot be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.dimensions.update", "description": "User must have the platform administrator permission." } ] }, "x-codegen-request-body-name": "resource_patch_request_model" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityDimensionId" } ] }, "/data_quality/v4/search_dq_dimension": { "post": { "tags": [ "Data Quality Dimensions" ], "summary": "Search for data quality dimensions by name or part of their names", "description": "Search for data quality dimensions by name or part of their names", "operationId": "search_dq_dimension", "parameters": [ { "$ref": "#/components/parameters/DataQualityNameQueryRequired" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/dimensions/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDimensionCollection" }, "examples": { "DimensionCollection": { "$ref": "#/components/examples/DataQualityDimensionCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to search data quality dimensions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The data quality dimension cannot be searched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.dimensions.read", "description": "Any platform level user." } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/issues": { "get": { "tags": [ "Data Quality Issues" ], "summary": "Get a list of data quality issues", "description": "Get a list of data quality issues.\n", "operationId": "list_dq_issues", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityStartQuery" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityAssetReportedForIdentitiesQuery" }, { "$ref": "#/components/parameters/DataQualityCheckIdentityQuery" }, { "$ref": "#/components/parameters/DataQualityCheckNativeIdQuery" }, { "$ref": "#/components/parameters/DataQualityCheckNameQuery" }, { "$ref": "#/components/parameters/DataQualityDimensionIdsQuery" }, { "$ref": "#/components/parameters/DataQualityLatestOnlyQuery" }, { "$ref": "#/components/parameters/DataQualityTypeQuery" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQueryWithChildren" }, { "$ref": "#/components/parameters/DataQualitySortByQuery" }, { "$ref": "#/components/parameters/DataQualitySortDirectionQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssueCollection" }, "examples": { "IssueCollection": { "$ref": "#/components/examples/DataQualityIssueCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality issues cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.issues.read", "description": "User must be a collaborator for the container" } ] } }, "post": { "tags": [ "Data Quality Issues" ], "summary": "Create a data quality issue", "description": "Create a data quality issue.\n", "operationId": "create_dq_issue", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "requestBody": { "description": "Data quality issue to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssuePrototype" }, "examples": { "IssuePrototype": { "$ref": "#/components/examples/DataQualityIssuePrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/issues/fd387036-72e4-4787-85af-cce05f86ac5e" }, "Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/issues/fd387036-72e4-4787-85af-cce05f86ac5e" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssue" }, "examples": { "Asset": { "$ref": "#/components/examples/DataQualityIssue" } } } } }, "400": { "description": "The given payload is invalid and the issue is not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer400" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to create a data quality issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "409": { "description": "The data quality issue exists already and cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer409" } } } } }, "500": { "description": "An error occurred. The data quality issue cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.issues.create", "description": "User must be either Admin(administrator) or Editor for the container" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.issue.create", "description": "Tracking event with action name 'wdp-data_quality.issue.create' is logged" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/issues/{id}": { "get": { "tags": [ "Data Quality Issues" ], "summary": "Get the data quality issue with the given identifier", "description": "Get the data quality issue with the given identifier.\n", "operationId": "get_dq_issue", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/issues/fd387036-72e4-4787-85af-cce05f86ac5e" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssue" }, "examples": { "Issue": { "$ref": "#/components/examples/DataQualityIssue" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality issue with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality issue cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.issues.read", "description": "User must be a collaborator for the container" } ] } }, "patch": { "tags": [ "Data Quality Issues" ], "summary": "Update a data quality issue as specified in the payload details\nof the request.\n", "description": "Update a data quality issue as specified in the payload details\nof the request.\n\nThe updates must be specified by using the JSON patch format, described in RFC 6902.\n

\nThe following attributes can be updated:\n - /ignored (value can only be replaced)\n", "operationId": "update_dq_issue", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "requestBody": { "description": "The updates to make in the data quality rule.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" }, "examples": { "JSONResourcePatchRequestModel": { "$ref": "#/components/examples/DataQualityJSONResourcePatchRequestModel" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/issues/fd387036-72e4-4787-85af-cce05f86ac5e" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssue" }, "examples": { "Issue": { "$ref": "#/components/examples/DataQualityIssue" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to update the data quality issue.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality issue with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality issue cannot be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.issues.update", "description": "User must be either Admin(administrator) or Editor for the container" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.issue.update", "description": "Tracking event with action name 'wdp-data_quality.issue.update' is logged" } ] }, "x-codegen-request-body-name": "resource_patch_request_model" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityIssueId" } ] }, "/data_quality/v4/search_dq_issue": { "post": { "tags": [ "Data Quality Issues" ], "summary": "Search for a data quality issue by its native id", "description": "Search for a data quality issue by its native id", "operationId": "search_dq_issue", "parameters": [ { "$ref": "#/components/parameters/DataQualityAssetReportedForIdentityQueryRequired" }, { "$ref": "#/components/parameters/DataQualityCheckIdentityQueryRequired" }, { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" }, "example": "https://cloud.ibm.com/data_quality/v4/issues/fd387036-72e4-4787-85af-cce05f86ac5e" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssueCollectionItem" }, "examples": { "Issue": { "$ref": "#/components/examples/DataQualityIssueCollectionItem" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to search data quality issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality issue cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality issue cannot be searched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.issues.read", "description": "User must be a collaborator for the container" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/create_issues": { "post": { "tags": [ "Data Quality Issues" ], "summary": "Create several data quality issues. The related DQ assets referenced by their native ID are created if they do not already exist", "description": "Create several data quality issues. The related DQ assets referenced by their native ID are created if they do not already exist.", "operationId": "create_issues", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "requestBody": { "description": "Data quality issues to create and their related DQ assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssuesBatchPrototype" }, "examples": { "IssuesBatchPrototype": { "$ref": "#/components/examples/DataQualityIssuesBatchPrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityIssueCollection" }, "examples": { "IssueCollection": { "$ref": "#/components/examples/DataQualityIssueCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to create data quality issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The data quality issues cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.issues.create", "description": "User must be either Admin(administrator) or Editor for the container" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.issue.bulk.create", "description": "Tracking event with action name 'wdp-data_quality.issue.bulk.create' is logged" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/scores": { "get": { "tags": [ "Data Quality Scores" ], "summary": "Get a list of data quality scores for a given asset", "description": "Get a list of data quality scores for a given asset.\n", "operationId": "list_dq_scores", "parameters": [ { "$ref": "#/components/parameters/DataQualityAssetIdentityQueryRequired" }, { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityDimensionIdQuery" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" }, { "$ref": "#/components/parameters/DataQualityScoreOlderByDaysQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityScoreCollection" }, "examples": { "ScoreCollection": { "$ref": "#/components/examples/DataQualityScoreCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality scores.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality scores cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.scores.create", "description": "User must be either Admin(administrator) or Editor for the container" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/bulkScores": { "get": { "tags": [ "Data Quality Scores" ], "summary": "Get a list of data quality scores for a given assets", "description": "Get a list of data quality scores for a given assets.\n", "operationId": "list_dq_scores_in_bulk", "parameters": [ { "$ref": "#/components/parameters/DataQualityAssetsIdentityQueryRequired" }, { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityDimensionIdQuery" }, { "$ref": "#/components/parameters/DataQualityIncludeChildrenQuery" }, { "$ref": "#/components/parameters/DataQualityScoreOlderByDaysQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityScoreCollectionItems" }, "examples": { "ScoreCollectionItems": { "$ref": "#/components/examples/DataQualityScoreCollectionItems" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality scores.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality scores cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.scores.create", "description": "User must be either Admin(administrator) or Editor for the container" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/slas": { "get": { "tags": [ "Data Quality Service Level Agreements" ], "summary": "Get a list of data quality SLAs", "description": "Returns all defined data quality Service Level Agreements", "operationId": "list_slas", "parameters": [ { "$ref": "#/components/parameters/DataQualityStartQuery" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLACollection" }, "examples": { "SLACollection": { "$ref": "#/components/examples/DataQualitySLACollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality SLAs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality SLAs cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.sla.read", "description": "User must have the platform administrator permission" } ] } }, "post": { "tags": [ "Data Quality Service Level Agreements" ], "summary": "Create a data quality SLA", "description": "Create a data quality Service Level Agreement (SLA) as specified in the payload.\nSLAs apply globally and are not tied to specific asset containers.\n", "operationId": "create_sla", "requestBody": { "description": "Data quality SLA to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLAPrototype" }, "examples": { "SLAPrototype": { "$ref": "#/components/examples/DataQualitySLAPrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success", "headers": { "Content-Location": { "description": "The URL of the resource", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" } }, "Location": { "description": "The URL of the resource", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLA" }, "examples": { "Asset": { "$ref": "#/components/examples/DataQualitySLA" } } } } }, "400": { "description": "The given payload is invalid and the asset is not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer400" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to create the data quality SLA.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "409": { "description": "The data quality SLA name exists already and cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer409" } } } } }, "500": { "description": "An error occurred. The data quality SLA cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.sla.create", "description": "User must have the platform administrator permission" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.sla.create", "description": "Tracking event with action name 'wdp-data_quality.sla.create' is logged" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v4/slas/{sla_id}": { "get": { "tags": [ "Data Quality Service Level Agreements" ], "summary": "Get a data quality SLA", "description": "Get the data quality Service Level Agreement with the given identifier\n", "operationId": "get_sla", "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLA" }, "examples": { "SLA": { "$ref": "#/components/examples/DataQualitySLA" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality SLA.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality SLA with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality SLA cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.sla.read", "description": "User must have the platform administrator permission" } ] } }, "put": { "tags": [ "Data Quality Service Level Agreements" ], "summary": "Update a data quality SLA", "description": "Update a data quality SLA as specified in the payload.\n", "operationId": "replace_sla", "requestBody": { "description": "The updates to make on the SLA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLAPrototype" }, "examples": { "SLAPrototype": { "$ref": "#/components/examples/DataQualitySLAPrototype" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLA" }, "examples": { "SLA": { "$ref": "#/components/examples/DataQualitySLA" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to update the data quality SLA.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality SLA with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality SLA cannot be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.sla.update", "description": "User must have the platform administrator permission" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.sla.update", "description": "Tracking event with action name 'wdp-data_quality.sla.update' is logged" } ] } }, "delete": { "tags": [ "Data Quality Service Level Agreements" ], "summary": "Delete a data quality SLA", "description": "Delete the data quality SLA with the given identifier\n", "operationId": "delete_sla", "responses": { "204": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to delete the data quality SLA.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality SLA cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality SLA cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.sla.delete", "description": "User must have the platform administrator permission" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.sla.delete", "description": "Tracking event with action name 'wdp-data_quality.sla.delete' is logged" } ] } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualitySLAIdentity" } ] }, "/data_quality/v4/assets/{id}/sla_assessments": { "get": { "tags": [ "Data Quality Assets", "Data Quality Service Level Agreements" ], "summary": "List SLA assessments for an asset", "description": "List the Service Level Agreement assessments for an asset\n", "operationId": "list_assessments", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualitySLAIdentityQuery" }, { "$ref": "#/components/parameters/DataQualityLatestAssessmentsOnlyQuery" }, { "$ref": "#/components/parameters/DataQualityViolationsFirstQuery" }, { "$ref": "#/components/parameters/DataQualityStartQuery" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLAAssessmentCollection" }, "examples": { "SLAAssessmentCollection": { "$ref": "#/components/examples/DataQualitySLAAssessmentCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the list of data quality SLA assessments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. The list of data quality SLA assessments cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assessments.read", "description": "User must be a collaborator for the container" } ] } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityAssetId" } ] }, "/data_quality/v4/assets/{id}/sla_assessments/{assessment_id}": { "get": { "tags": [ "Data Quality Assets", "Data Quality Service Level Agreements" ], "summary": "Get an SLA assessment", "description": "Get the Service Level Agreement assessment with the given identifier\n", "operationId": "get_assessment", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityViolationLimitQuery" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLAAssessment" }, "examples": { "SLAAssessment": { "$ref": "#/components/examples/DataQualitySLAAssessment" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality SLA assessment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality SLA assessment with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality SLA assessment cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assessments.read", "description": "User must be a collaborator for the container" } ] } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityAssetId" }, { "$ref": "#/components/parameters/DataQualitySLAAssessmentIdentity" } ] }, "/data_quality/v4/assets/{id}/sla_assessments/{assessment_id}/violations": { "get": { "tags": [ "Data Quality Assets", "Data Quality Service Level Agreements" ], "summary": "Get the SLA violations for the given assessment", "description": "Get the Service Level Agreement violations for the assessment with the given identifier.\nThe violations are sorted by descending score deviation (threshold minus score).\n", "operationId": "get_sla_assessment_violations", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityStartQuery" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySLAViolationCollection" }, "examples": { "SLAViolationCollection": { "$ref": "#/components/examples/DataQualitySLAViolationCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality SLA violations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "404": { "description": "The data quality SLA violations for the assessment with the given ID cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer404" } } } } }, "500": { "description": "An error occurred. The data quality SLA violations cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assessments.read", "description": "User must be a collaborator for the container" } ] } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityAssetId" }, { "$ref": "#/components/parameters/DataQualitySLAAssessmentIdentity" } ] }, "/data_quality/v4/sla_assessment_activation": { "get": { "tags": [ "Data Quality Service Level Agreements" ], "summary": "Get the status of the data quality SLA assessment activation", "description": "Get the status of the data quality SLA assessment activation (active/inactive) for a container such as a project or catalog", "operationId": "get_sla_assessment_activation", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityBooleanStatus" }, "examples": { "SLAAssessmentActivationStatus": { "$ref": "#/components/examples/DataQualityBooleanStatus" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to get the data quality SLA assessment activation status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. Data quality SLA assessment activation status cannot be retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assessments.activate", "description": "User must be a collaborator for the container" } ] } }, "put": { "tags": [ "Data Quality Service Level Agreements" ], "summary": "Activate or deactivate data quality SLA assessments", "description": "Activate or deactivate data quality SLA assessments for a IKC(IBM Knowledge Catalog) container such as a project or catalog", "operationId": "set_sla_assessment_activation", "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId" }, { "$ref": "#/components/parameters/DataQualityProjectId" }, { "$ref": "#/components/parameters/DataQualityActiveQuery" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityBooleanStatus" }, "examples": { "SLAAssessmentActivationStatus": { "$ref": "#/components/examples/DataQualityBooleanStatus" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "You do not have permission to activate or deactivate data quality SLA assessments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer403" } } } } }, "500": { "description": "An error occurred. Data quality SLA assessments cannot be activated or deactivated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer500" } } } } } }, "x-ibm-permissions": { "actions": [ { "name": "dataquality.assessments.activate", "description": "User must be either administrator or editor for the container" } ] }, "x-ibm-events": { "events": [ { "name": "wdp-data_quality.sla.assessments.activate", "description": "Tracking event with action name 'wdp-data_quality.sla.assessments.activate' is logged" } ] } }, "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/rules": { "get": { "tags": [ "Data quality rule" ], "summary": "List all data quality rules or a subset of them", "description": "Get a list of data quality rules in the project.\n", "operationId": "list_rules", "parameters": [ { "$ref": "#/components/parameters/DataQualityStartQuery1" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityRuleIds" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRuleCollection" }, "examples": { "RuleCollection": { "$ref": "#/components/examples/DataQualityRuleCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the list of data quality rules in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The list of data quality rules could not be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "post": { "tags": [ "Data quality rule" ], "summary": "Create data quality rule", "description": "Create a data quality rule.\n", "operationId": "create_rule", "requestBody": { "description": "Data quality rule to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRulePrototype" }, "examples": { "RulePrototype": { "$ref": "#/components/examples/DataQualityRulePrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" }, "Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRule" }, "examples": { "Rule": { "$ref": "#/components/examples/DataQualityRule" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to create data quality rules in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rule could not be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "delete": { "tags": [ "Data quality rule" ], "summary": "Delete data quality rules", "description": "Delete the data quality rules for the given list of rule identifiers.\n", "operationId": "delete_rules", "parameters": [ { "$ref": "#/components/parameters/DataQualityRuleIdsRequired" }, { "$ref": "#/components/parameters/DataQualityDeleteOutput" }, { "$ref": "#/components/parameters/DataQualityCancelUnfinishedJobs" } ], "responses": { "204": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to delete the data quality rules in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rules cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/projects/{project_id}/validate_rule": { "post": { "tags": [ "Data quality rule" ], "summary": "Validate data quality rule", "description": "Check the validity of the data quality rule.\n", "operationId": "validate_rule", "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ], "requestBody": { "description": "Data quality rule to validate.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRulePrototype" }, "examples": { "RulePrototype": { "$ref": "#/components/examples/DataQualityRulePrototype" } } } }, "required": true }, "responses": { "200": { "description": "The data quality rule is valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRule" }, "examples": { "Rule": { "$ref": "#/components/examples/DataQualityRule" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to validate data quality rules in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "The data quality rule is invalid. See the error message for the cause.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/rules/{id}/validate": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleId" } ] }, "/data_quality/v3/projects/{project_id}/rules/{id}": { "get": { "tags": [ "Data quality rule" ], "summary": "Get data quality rule", "description": "Gets the data quality rule with the given identifier.\n", "operationId": "get_rule", "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRule" }, "examples": { "Rule": { "$ref": "#/components/examples/DataQualityRule" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the data quality rule with the given identifier from the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality rule cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rule with the given identifier cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "delete": { "tags": [ "Data quality rule" ], "summary": "Delete data quality rule", "description": "Delete the data quality rule with the given identifier.\n", "operationId": "delete_rule", "parameters": [ { "$ref": "#/components/parameters/DataQualityDeleteOutput" }, { "$ref": "#/components/parameters/DataQualityCancelUnfinishedJobs" } ], "responses": { "204": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to delete the data quality rule from the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality rule cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rule cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "patch": { "tags": [ "Data quality rule" ], "summary": "Update data quality rule", "description": "\nUpdates a data quality rule as specified in the payload details of the update rule request.\nThe updates must be specified by using the JSON patch format, described in RFC 6902.

The following attributes can be patched:\n - name (value can only be replaced)\n - definition (value can only be replaced)\n - description (value can be added, removed, or replaced)\n - dimension (value can be added, removed, or replaced)\n - input (value can be added, removed or replaced)\n - output (value can be added, removed, or replaced)\n - joins (value can be added, removed, or replaced)\n - sampling (value can be added, removed, or replaced)\n - data_stage/propagate_all_incoming_columns (value can be added, removed, or replaced)\n", "operationId": "update_rule", "parameters": [ { "$ref": "#/components/parameters/DataQualityCancelUnfinishedJobs" }, { "$ref": "#/components/parameters/DataQualityKeepRuleRelationships" } ], "requestBody": { "description": "The updates to make in the data quality rule.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" }, "examples": { "JSONResourcePatchRequestModel": { "$ref": "#/components/examples/DataQualityJSONResourcePatchRequestModel1" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRule" }, "examples": { "Rule": { "$ref": "#/components/examples/DataQualityRule" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to update the data quality rule in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality rule cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rule was not updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } }, "x-codegen-request-body-name": "resource_patch_request_model" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleId" } ] }, "/data_quality/v3/projects/{project_id}/rules/{id}/execute": { "post": { "tags": [ "Data quality rule" ], "summary": "Run data quality rule", "description": "Run the data quality rule with the given identifier.\n", "operationId": "execute_rule", "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" }, "Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRuleExecution" }, "examples": { "RuleExecution": { "$ref": "#/components/examples/DataQualityRuleExecution" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to run the data quality rule in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality rule cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rule cannot be run.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleId" } ] }, "/data_quality/v3/projects/{project_id}/execute_rules": { "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/import_rule": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/catalogs/{catalog_id}/import_rule": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId1" } ] }, "/data_quality/v3/projects/{project_id}/rules/{id}/export": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleId" }, { "$ref": "#/components/parameters/DataQualityIncludeExecutions" } ] }, "/data_quality/v3/catalogs/{catalog_id}/rules/{id}/export": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId1" }, { "$ref": "#/components/parameters/DataQualityRuleId" } ] }, "/data_quality/v3/projects/{project_id}/migrate_rule_stage": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/projects/{project_id}/test_rule": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/projects/{project_id}/rules/{rule_id}/executions": { "get": { "tags": [ "Data quality rule execution" ], "summary": "List history of all data quality rule run results or a subset of them", "description": "Gets the list of data quality rule runs.\nBy default, the runs are sorted newest to oldest.\n", "operationId": "list_rule_executions", "parameters": [ { "$ref": "#/components/parameters/DataQualityStartQuery1" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityRuleExecutionSort" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRuleExecutionCollection" }, "examples": { "RuleExecution": { "$ref": "#/components/examples/DataQualityRuleExecutionCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the data quality rule history in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rule history could not be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleIdQualified" } ] }, "/data_quality/v3/projects/{project_id}/rules/{rule_id}/executions/{id}": { "get": { "tags": [ "Data quality rule execution" ], "summary": "Get the data quality rule run", "description": "Gets the data quality rule run result with the given identifier.\n", "operationId": "get_rule_execution", "parameters": [ { "$ref": "#/components/parameters/DataQualityRuleIdQualified" }, { "$ref": "#/components/parameters/DataQualityExecutionId" }, { "$ref": "#/components/parameters/DataQualityProjectId1" } ], "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRuleExecution" }, "examples": { "RuleExecution": { "$ref": "#/components/examples/DataQualityRuleExecution" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the data quality rule run result in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The result of data quality rule run could not be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/rules/{id}/mark_last_outstanding_execution_failed": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleId" } ] }, "/data_quality/v3/projects/{project_id}/rules/{rule_id}/output_records": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleIdQualified" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityOffsetQuery" }, { "$ref": "#/components/parameters/DataQualityPaginationQuery" } ] }, "/data_quality/v3/projects/{project_id}/rules/{rule_id}/export_output_records_csv": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityRuleIdQualified" } ] }, "/data_quality/v3/projects/{project_id}/definitions": { "get": { "tags": [ "Data quality definition" ], "summary": "List all data quality definitions or a subset of them", "description": "Gets the list of all data quality definitions.\n", "operationId": "list_definitions", "parameters": [ { "$ref": "#/components/parameters/DataQualityStartQuery1" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityDefinitionIds" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinitionCollection" }, "examples": { "DefinitionCollection": { "$ref": "#/components/examples/DataQualityDefinitionCollection" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the list of data quality definitions in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The list of data quality definitions cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "post": { "tags": [ "Data quality definition" ], "summary": "Create data quality definition", "description": "Creates a data quality definition in the specified project.\n", "operationId": "create_rule_definition", "requestBody": { "description": "Data quality definition to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinitionPrototype" }, "examples": { "DefinitionPrototype": { "$ref": "#/components/examples/DataQualityDefinitionPrototype" } } } }, "required": true }, "responses": { "201": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" }, "Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinition" }, "examples": { "Definition": { "$ref": "#/components/examples/DataQualityDefinition" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to create a definition in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The definition was not created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "delete": { "tags": [ "Data quality definition" ], "summary": "Delete data quality definitions", "description": "Delete the data quality definitions with the given identifiers.\n", "operationId": "delete_rule_definitions", "parameters": [ { "$ref": "#/components/parameters/DataQualityDefinitionIdsRequired" } ], "responses": { "204": { "description": "Success." }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to delete the data quality definitions in the specified project or catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definitions cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/projects/{project_id}/import_definition": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/catalogs/{catalog_id}/import_definition": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId1" } ] }, "/data_quality/v3/projects/{project_id}/definitions/{id}/export": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityDefinitionId" } ] }, "/data_quality/v3/catalogs/{catalog_id}/definitions/{id}/export": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId1" }, { "$ref": "#/components/parameters/DataQualityDefinitionId" } ] }, "/data_quality/v3/projects/{project_id}/validate_definition": { "post": { "tags": [ "Data quality definition" ], "summary": "Validate data quality definition expression", "description": "\nValidate the specified definition expression.\n", "operationId": "validate_definition", "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityPartialExpression" } ], "requestBody": { "description": "Data quality definition to validate.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinitionPrototype" }, "examples": { "DefinitionPrototype": { "$ref": "#/components/examples/DataQualityDefinitionPrototype" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinitionValidation" }, "examples": { "DefinitionValidation": { "$ref": "#/components/examples/DataQualityDefinitionValidation" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to validate the data quality definition in the specified project or catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definitions could not be validated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/retrieve_definition_variables": { "servers": [ { "url": "/" } ] }, "/data_quality/v3/catalogs/{catalog_id}/retrieve_definition_variables": { "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/definitions/{id}": { "get": { "tags": [ "Data quality definition" ], "summary": "Get data quality definition", "description": "Gets the data quality definition with the given identifier.\n", "operationId": "get_definition", "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinition" }, "examples": { "Definition": { "$ref": "#/components/examples/DataQualityDefinition" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the data quality definition with the given ID from the specified project or catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality definition cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definition with the given identifier could not be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "put": { "tags": [ "Data quality definition" ], "summary": "Replace data quality definition", "description": "Replace a data quality definition.\n", "operationId": "replace_definition", "requestBody": { "description": "Data quality definition to replace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinitionPrototype" }, "examples": { "DefinitionPrototype": { "$ref": "#/components/examples/DataQualityDefinitionPrototype" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinition" }, "examples": { "Definition": { "$ref": "#/components/examples/DataQualityDefinition" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to update data quality definitions in the specified project or catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definition was not updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "delete": { "tags": [ "Data quality definition" ], "summary": "Delete data quality definition", "description": "Delete the data quality definition with the given identifier.\n", "operationId": "delete_definition", "responses": { "204": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to delete the data quality definition from the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality definition cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definition cannot be deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "patch": { "tags": [ "Data quality definition" ], "summary": "Update data quality definition", "description": "Updates a data quality definition as specified in the payload details of the update definition request.\nThe updates must be specified by using the JSON patch format, described in RFC 6902.

The following attributes can be patched.\n - name (value can only be replaced)\n - description (value can be added, removed, or replaced)\n - expression (value can only be replaced)\n - dimension (value can be added, removed, or replaced)\n", "operationId": "update_definition", "requestBody": { "description": "The updates to make in the data quality definition.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" }, "examples": { "JSONResourcePatchRequestModel": { "$ref": "#/components/examples/DataQualityJSONResourcePatchRequestModel1" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinition" }, "examples": { "Definition": { "$ref": "#/components/examples/DataQualityDefinition" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to update the data quality definition in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality definition cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definition was not updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } }, "x-codegen-request-body-name": "resource_patch_request_model" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityDefinitionId" } ] }, "/data_quality/v3/projects/{project_id}/dimensions": { "get": { "tags": [ "Data quality dimension" ], "summary": "List all data quality dimensions", "description": "Gets the list of all data quality dimensions\n", "operationId": "get_dimensions", "parameters": [ { "$ref": "#/components/parameters/DataQualityStartQuery1" }, { "$ref": "#/components/parameters/DataQualityLimitQuery" }, { "$ref": "#/components/parameters/DataQualityProjectId1" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDimensionCollection" }, "examples": { "DimensionCollection": { "$ref": "#/components/examples/DataQualityDimensionCollection1" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You are not permitted to get data quality dimensions of\n the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The list of data quality dimensions cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } }, "deprecated": true }, "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/settings": { "get": { "tags": [ "Project data quality settings" ], "summary": "Get project settings for data quality rules", "description": "Gets the project settings for data quality rules.\n", "operationId": "get_settings", "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySettings" }, "examples": { "Settings": { "$ref": "#/components/examples/DataQualitySettings" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the data quality rule settings in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The project settings for data quality rules could not be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "put": { "tags": [ "Project data quality settings" ], "summary": "Replace project settings for data quality rules", "description": "Replace project settings for data quality rules.\n", "operationId": "replace_settings", "requestBody": { "description": "Project settings for data quality rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySettingsPrototype" }, "examples": { "SettingsPrototype": { "$ref": "#/components/examples/DataQualitySettingsPrototype" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualitySettings" }, "examples": { "Settings": { "$ref": "#/components/examples/DataQualitySettings" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to define project settings for data quality rules in the specified project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The project settings for data quality rules were not created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/version": { "servers": [ { "url": "/" } ] }, "/data_quality/v3/projects/{project_id}/convert_definition_to_blockly": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" }, { "$ref": "#/components/parameters/DataQualityPartialExpression" } ] }, "/data_quality/v3/projects/{project_id}/validate_sql": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/projects/{project_id}/validate_task_credentials": { "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityProjectId1" } ] }, "/data_quality/v3/catalogs/{catalog_id}/rules/{id}": { "get": { "tags": [ "Data quality rule" ], "summary": "Get data quality rule from catalog", "description": "Gets the data quality rule from catalog with the given identifier.\n", "operationId": "get_rule_from_catalog", "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/catalogs/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityRule" }, "examples": { "Rule": { "$ref": "#/components/examples/DataQualityRule" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the data quality rule with the given identifier from the specified catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality rule cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality rule with the given identifier cannot be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId1" }, { "$ref": "#/components/parameters/DataQualityRuleId" } ] }, "/data_quality/v3/catalogs/{catalog_id}/definitions/{id}": { "get": { "tags": [ "Data quality definition" ], "summary": "Get data quality definition from catalog", "description": "Gets the data quality definition from catalog with the given identifier.\n", "operationId": "get_definition_from_catalog", "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/catalogs/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinition" }, "examples": { "Definition": { "$ref": "#/components/examples/DataQualityDefinition" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to get the data quality definition with the given ID from the specified project or catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality definition cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definition with the given identifier could not be returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } } }, "patch": { "tags": [ "Data quality definition" ], "summary": "Update data quality definition in catlog", "description": "Updates a data quality definition as specified in the payload details of the update definition request.\nThe updates must be specified by using the JSON patch format, described in RFC 6902.

The following attributes can be patched.\n - dimension (value can be added, removed, or replaced)\n", "operationId": "update_definition_in_catalog", "requestBody": { "description": "The updates to make in the data quality definition.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" }, "examples": { "JSONResourcePatchRequestModel": { "$ref": "#/components/examples/DataQualityJSONResourcePatchRequestModel1" } } } }, "required": true }, "responses": { "200": { "description": "Success.", "headers": { "Content-Location": { "description": "The URL of the resource.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityContentLocation1" }, "example": "https://cloud.ibm.com/data_quality/v3/catlogs/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityDefinition" }, "examples": { "Definition": { "$ref": "#/components/examples/DataQualityDefinition" } } } } }, "401": { "description": "Your authorization to access this method is missing, invalid, or expired.", "headers": { "WWW-Authenticate": { "description": "The authentication scheme.", "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityWWWAuthenticate" }, "example": "bearer" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "403": { "description": "You do not have permission to update the data quality definition in the specified catalog.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "404": { "description": "The data quality definition cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } }, "500": { "description": "An error occurred. The data quality definition was not updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" }, "examples": { "ErrorContainer": { "$ref": "#/components/examples/DataQualityErrorContainer" } } } } } }, "x-codegen-request-body-name": "resource_patch_request_model" }, "servers": [ { "url": "/" } ], "parameters": [ { "$ref": "#/components/parameters/DataQualityCatalogId1" }, { "$ref": "#/components/parameters/DataQualityDefinitionId" } ] }, "/data_quality/v3/input_binding_datasource_types": { "servers": [ { "url": "/" } ] }, "/data_quality/v3/input_sql_datasource_types": { "servers": [ { "url": "/" } ] }, "/data_quality/v3/output_database_datasource_types": { "servers": [ { "url": "/" } ] }, "/v2/environments": { "get": { "tags": [ "Environments" ], "operationId": "environments_list", "summary": "List environments.", "description": "Returns a list of environments filtered by type, language or spark version in a project or space.\n\nIf no filter is provided, it returns all environments in the project or space, which includes all\ndefault environments that are available in every project or space and custom environments created\nby users.\n\nYou need to specify either `project_id` or `space_id`.\n", "parameters": [ { "name": "project_id", "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "types", "required": false, "in": "query", "description": "Comma-separated list of environment types. Defaults to list of all types.", "example": "notebook,wml_flow", "schema": { "type": "string" } }, { "name": "exclude_types", "required": false, "in": "query", "description": "Comma-separated list of environment types. Takes precedence over types. Defaults to empty list.", "example": "notebook,wml_flow", "schema": { "type": "string" } }, { "name": "exclude_languages", "required": false, "in": "query", "description": "Comma-separated list of kernel languages. Defaults to empty list.", "example": "python2,python3", "schema": { "type": "string" } }, { "name": "spark_versions", "required": false, "in": "query", "description": "Comma-separated list of Spark versions. If provided, Spark environments will be filtered by these versions. Defaults to list of all default environments with supported Spark versions and all custom environments.", "example": "2.3,2.4", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsEnvironmentsListResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "post": { "tags": [ "Environments" ], "operationId": "environments_create", "summary": "Create a new environment.", "description": "Returns a new environment with the provided parameters.\n\nYou need to specify either `project_id` or `space_id`.\n\nRequired body parameters vary dependent on environment types:\n- notebook: `type`, `name`, `display_name`, `hardware_specification`, `software_specification`, `tools_specification`, `runtime_definition`\n- datastage: `type`, `name`, `display_name`, `hardware_specification`\n- other types: `type`, `name`, `display_name`, `hardware_specification`, `software_specification`", "parameters": [ { "name": "project_id", "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsEnvironmentCreateBody" }, "responses": { "201": { "$ref": "#/components/responses/EnvironmentsEnvironmentCreateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" }, "429": { "$ref": "#/components/responses/EnvironmentsHTTP429Response" } } } }, "/v2/environments/{environment_guid}": { "parameters": [ { "name": "environment_guid", "in": "path", "required": true, "description": "The guid of the environment.", "example": "a1da1d73-5eb5-4dfb-808e-174eb153c20e", "schema": { "type": "string" } } ], "get": { "tags": [ "Environments" ], "operationId": "environments_get", "summary": "Retrieve an environment.", "description": "Returns an environment of a given ID. You need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "project_id", "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "response_format", "required": false, "in": "query", "description": "Format the response. Defaults to none.", "example": "default_spark", "schema": { "type": "string" } }, { "name": "embed_package_content", "required": false, "in": "query", "description": "Whether to include conda_yml file content of custom package extensions in the response. Defaults to false.", "example": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsEnvironmentRetrieveResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "delete": { "tags": [ "Environments" ], "operationId": "environments_delete", "summary": "Delete an environment.", "description": "Deletes an environment of a given ID. You need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "project_id", "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsEnvironmentDeleteResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "patch": { "tags": [ "Environments" ], "operationId": "environments_update", "summary": "Update an environment.", "description": "Updates an environment of a given ID with the provided parameters. Returns the environment with updated properties. Only custom environments can be updated.", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsEnvironmentUpdateBody" }, "responses": { "200": { "$ref": "#/components/responses/EnvironmentsEnvironmentUpdateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/hardware_specifications": { "get": { "tags": [ "Hardware Specifications" ], "operationId": "hardware_specifications_list", "summary": "List hardware specifications.", "description": "Returns a list of hardware specifications.\n1. If neither `project_id` nor `space_id` is given, it returns all global hardware specifications.\n2. If `project_id` or `space_id` is given, it returns all global and scoped hardware specifications. In this case, you need to specify either `project_id` or `space_id`.\n", "parameters": [ { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "The name of the hardware specification.\nIf specified, each of the hardware specification in the returned list will have the specified name.\n", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsHardwareSpecificationsListResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "post": { "tags": [ "Hardware Specifications" ], "operationId": "hardware_specifications_create", "summary": "Create a new hardware specification.", "description": "Returns a hardware specification created with provided parameters.\n\n1. To create a global custom hardware specification, `project_id` or `space_id` is not required.\nGlobal custom hardware specifications can be only created with the credentials of the `wdp-service-id`.\n\n2. To create a scoped hardware specification, you need to specify either `project_id` or `space_id`.\n\nYou can only provide exactly one of `nodes`, `spark` or `datastage` in the request body.", "parameters": [ { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsHardwareSpecificationCreateBody" }, "responses": { "201": { "$ref": "#/components/responses/EnvironmentsHardwareSpecificationCreateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" }, "409": { "$ref": "#/components/responses/EnvironmentsHTTP409Response" } } } }, "/v2/hardware_specifications/{hardware_specification_guid}": { "parameters": [ { "name": "hardware_specification_guid", "in": "path", "required": true, "description": "The guid of the hardware specification.", "example": "a1da1d73-5eb5-4dfb-808e-174eb153c20e", "schema": { "type": "string" } } ], "get": { "tags": [ "Hardware Specifications" ], "operationId": "hardware_specifications_get", "summary": "Retrieve a hardware specification.", "description": "Returns a hardware specification of a given ID.\n1. To retrieve a global hardware specification, `project_id` or `space_id` is not required.\n2. To retrieve a scoped hardware specification that is scoped to a project or a space, you need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsHardwareSpecificationRetrieveResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "delete": { "tags": [ "Hardware Specifications" ], "operationId": "hardware_specifications_delete", "summary": "Delete a hardware specification.", "description": "Deletes a hardware specification of a given ID.\nGlobal built-in hardware specifications cannot be deleted through the API.\n\n1. To delete a global custom hardware specification, `project_id` or `space_id` is not required.\nGloabl custom hardware specifications can be only deleted with the credentials of the `wdp-service-id`.\n\n2. To delete a scoped hardware specification that is scoped to a project or a space,\nyou need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsHardwareSpecificationDeleteResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "patch": { "tags": [ "Hardware Specifications" ], "operationId": "hardware_specifications_update", "summary": "Update a hardware specification.", "description": "Updates a hardware specification of a given ID with the provided parameters.\nGlobal built-in hardware specifications cannot be updated through the API.\n\n1. To update a global custom hardware specification, `project_id` or `space_id` is not required.\nGloabl custom hardware specifications can be only updated with the credentials of the `wdp-service-id`.\n\n2. To update a scoped hardware specification that is scoped to a project or a space,\nyou need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "The guid of the project.", "example": "92ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsHardwareSpecificationUpdateBody" }, "responses": { "204": { "$ref": "#/components/responses/EnvironmentsHardwareSpecificationUpdateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/software_specifications": { "get": { "tags": [ "Software Specifications" ], "operationId": "software_specifications_list", "summary": "List software specifications.", "description": "Returns a list of software specifications.\n1. If neither `project_id` nor `space_id` is given, it returns all base software specifications.\n2. If `project_id` or `space_id` is given, it returns all base and derived software specifications. In this case, you need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } }, { "name": "include_packages", "required": false, "in": "query", "description": "String of comma-separated package names that refers to the packages that a software specification should contain.\nIf specified, each of the software specification in the returned list will contain all of the packages specified in the query.\n", "example": "pytorch,scikit-learn", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "The name of the software specification.\nIf specified, each of the software specification in the returned list will have the specified name.\n", "schema": { "type": "string" } }, { "name": "purpose", "x-internal": "cpd", "required": false, "in": "query", "description": "The purpose of the software specification.\nIf specified, each of the software specification in the returned list will have the specified purpose. Only supports a single purpose.\n", "example": "notebook", "schema": { "type": "string" } }, { "name": "life_cycle.deprecated", "x-internal": "cpd", "required": false, "in": "query", "description": "Whether the software specification is deprecated or not.\nSoftware specifications without this property will be regarded as NOT deprecated by default.\n", "schema": { "type": "boolean" } }, { "name": "life_cycle.constricted", "x-internal": "cpd", "required": false, "in": "query", "description": "Whether the software specification is constricted or not.\nSoftware specifications without this property will be regarded as NOT constricted by default.\n", "schema": { "type": "boolean" } }, { "name": "life_cycle.retired", "x-internal": "cpd", "required": false, "in": "query", "description": "Whether the software specification is retired or not.\nSoftware specifications without this property will be regarded as NOT retired by default.\n", "schema": { "type": "boolean" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsSoftwareSpecificationsListResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "post": { "tags": [ "Software Specifications" ], "operationId": "software_specifications_create", "summary": "Create a new software specification.", "description": "Returns a software specification created with provided parameters.\n\nIf a software specification has the purpose `wml`, its name should be unique.\n\n1. To create a base custom software specification:\n\n- `project_id` or `space_id` is not required.\n- Base custom software specifications can be only created with the credentials of the `wdp-service-id`.\n- The parameters `name` and `software_configuration` are required in the request body.\n\n2. To create a derived software specification that is scoped to a project or a space:\n\n- you need to specify either `project_id` or `space_id`.\n- The parameters `name` and `base_software_specification` are required in the request body.\n- You can customize the software specification by adding any number of package extensions.\n- The parameters `purpose` and `life_cycle` cannot be specified when you create a derived software specification, because a derived software specification will inherit both attributes from its base software specification.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project in which to create the software specification.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsSoftwareSpecificationCreateBody" }, "responses": { "201": { "$ref": "#/components/responses/EnvironmentsSoftwareSpecificationCreateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" }, "409": { "$ref": "#/components/responses/EnvironmentsHTTP409Response" } } } }, "/v2/software_specifications/{software_specification_guid}": { "parameters": [ { "name": "software_specification_guid", "required": true, "in": "path", "description": "A UUID v4 identifying the software specification.", "example": "c82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } } ], "patch": { "tags": [ "Software Specifications" ], "operationId": "software_specifications_update", "summary": "Update a software specification.", "description": "Updates a software specification of a given ID with the provided parameters.\n\nUpdatable fields are `name`, `description`, `display_name` and `package_extensions`.\nBase built-in software specifications cannot be updated through the API.\n\n1. To update a base custom software specification, `project_id` or `space_id` is not required.\nBase custom software specifications can be only updated with the credentials of the `wdp-service-id`.\n\n2. To update a derived software specification that is scoped to a project or a space,\nyou need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsSoftwareSpecificationUpdateBody" }, "responses": { "204": { "$ref": "#/components/responses/EnvironmentsSoftwareSpecificationUpdateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "get": { "tags": [ "Software Specifications" ], "operationId": "software_specifications_get", "summary": "Retrieve a software specification.", "description": "Returns a software specification of a given ID.\n1. To retrieve a base software specification, `project_id` or `space_id` is not required.\n2. To retrieve a derived software specification that is scoped to a project or a space, you need to specify either `project_id` or `space_id`.\nWhen a derived software specification is retrieved, the return value shows the software configuration inherited from the base software specification instead of the ID of the base software specification.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsSoftwareSpecificationRetrieveResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "delete": { "tags": [ "Software Specifications" ], "operationId": "software_specifications_delete", "summary": "Delete a software specification.", "description": "Deletes a software specification of a given ID.\nBase built-in software specifications cannot be deleted through the API.\n\n1. To delete a base software specification, `project_id` or `space_id` is not required.\nBase custom software specifications can be only deleted with the credentials of the `wdp-service-id`.\n\n2. To delete a derived software specification that is scoped to a project or a space,\nyou need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.\nThe deleted software specification must be scoped to the specified project.\n", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsSoftwareSpecificationDeleteResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/software_specifications/{software_specification_guid}/package_extensions/{package_extension_guid}": { "parameters": [ { "name": "software_specification_guid", "required": true, "in": "path", "description": "A UUID v4 identifying the software specification.", "example": "c82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } }, { "name": "package_extension_guid", "required": true, "in": "path", "description": "A UUID v4 identifying the package extension.", "example": "b82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } } ], "put": { "tags": [ "Software Specifications" ], "operationId": "software_specifications_add_package_extensions", "summary": "Add a package extension to a software specification.", "description": "When successful, the specified package extension is **appended** to the array `entity.software_specification.package_extensions`. It is then the last package extension in that array. \n\nYou need to specify either `project_id` or `space_id`.\n\nThe request is valid if and only if: \n 1. The software specification identified by `software_specification_guid` and the package extension identified by `package_extension_guid` exist in the same scope (either project or space). \n 2. A successful POST `/v2/package_extensions/{package_extension_guid}/upload_complete` has been\n called before this request is initiated. I.e., the upload of the referenced `pip_zip` or `conda_yml` file\n has been indicated to have been successful. \n 3. The user is authorized to update the software specification asset.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsSoftwareSpecificationAddPackageExtensionResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" }, "409": { "description": "Conflict. The software specification already references this package extension." } } }, "delete": { "tags": [ "Software Specifications" ], "operationId": "software_specifications_remove_package_extensions", "summary": "Remove a package extension from a software specification.", "description": "When successful, the specified package extension is **removed** from the array `entity.software_specification.package_extensions`.\n\nYou need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsSoftwareSpecificationRemovePackageExtensionResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/package_extensions": { "get": { "tags": [ "Package Extensions" ], "operationId": "package_extensions_list", "summary": "List package extensions.", "description": "Returns all package extensions within the given project or space. You need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "Returning only those package extensions that have a particular name.", "example": "my Package Extension", "schema": { "type": "string" } }, { "name": "type", "required": false, "in": "query", "description": "Returning only those package extensions that have a particular type.", "example": "conda_yml or pip_zip", "schema": { "type": "string", "enum": [ "conda_yml", "pip_zip" ] } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsPackageExtensionsListResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "post": { "tags": [ "Package Extensions" ], "operationId": "package_extensions_create", "summary": "Create a new package extension.", "description": "Returns the new package extension created in the given project or space. You need to specify either `project_id` or `space_id`.\n\nFor uploading the pip_zip or conda_yml, once you have created a package extension, the response also contains a pre-signed URL which allows you to upload its contents. When the upload is complete, you **must** call `POST /v2/package_extensions/{package_extension_guid}/upload_complete` to indicate to the API that the package extension is usable. If the `/upload_complete` returns successfully, the package extension is usable, i.e., can be assigned to a software specification.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project in which to create the package extension.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsPackageExtensionCreateBody" }, "responses": { "201": { "$ref": "#/components/responses/EnvironmentsPackageExtensionCreateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/package_extensions/{package_extension_guid}/upload_complete": { "post": { "tags": [ "Package Extensions" ], "operationId": "package_extensions_upload_complete", "summary": "Mark file upload complete.", "description": "Indicates that the upload of the library file attached to the package extension is complete and this package extension is usable. You need to specify either `project_id` or `space_id`.\n", "parameters": [ { "name": "package_extension_guid", "required": true, "in": "path", "description": "A UUID v4 identifying the package extension.", "example": "b82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } }, { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsPackageExtensionUploadCompleteResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/package_extensions/{package_extension_guid}": { "parameters": [ { "name": "package_extension_guid", "required": true, "in": "path", "description": "A UUID v4 identifying the package extension.", "example": "b82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } } ], "patch": { "tags": [ "Package Extensions" ], "operationId": "package_extensions_update", "summary": "Update a package extension.", "description": "Updates a package extension of a given ID with the provided parameters.", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsPackageExtensionUpdateBody" }, "responses": { "204": { "$ref": "#/components/responses/EnvironmentsPackageExtensionUpdateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "get": { "tags": [ "Package Extensions" ], "operationId": "package_extensions_get", "summary": "Retrieve a package extension.", "description": "Retrieves a package extension of a given ID. You need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsPackageExtensionRetrieveResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "delete": { "tags": [ "Package Extensions" ], "operationId": "package_extensions_delete", "summary": "Delete a package extension.", "description": "Deletes a package extension of a given ID. You need to specify either `project_id` or `space_id`.", "parameters": [ { "name": "space_id", "required": false, "in": "query", "description": "The guid of the space.", "example": "82ae0e27-9b11-4de9-a646-d46ca3c183d4", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsPackageExtensionDeleteResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/runtime_definitions": { "x-internal": "cpd", "get": { "tags": [ "Runtime Definitions" ], "operationId": "runtime_definitions_list", "summary": "List runtime definitions.", "description": "Returns a list of runtime definitions.\n1. If `project_id` is not given, it returns all default runtime definitions.\n2. If `project_id` is given, it returns all default runtime definitions and all runtime definitions scoped to that project.\n", "parameters": [ { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } }, { "name": "runtime_type", "required": false, "in": "query", "description": "The runtime type of the runtime definitions.", "example": "notebook", "schema": { "type": "string" } }, { "name": "include", "required": false, "in": "query", "description": "Opt-in more details to return. Possible value is 'launch_configuration'; when specified, the request must be sent by cluster admins.\n", "example": "launch_configuration", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsRuntimeDefinitionsListResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "post": { "tags": [ "Runtime Definitions" ], "operationId": "runtime_definitions_create", "summary": "Create a new runtime definition.", "description": "Returns a new runtime definition with the provided parameters.\n1. If `project_id` is given, this runtime definition is scoped to that particular project only.\n2. If `project_id` is not given, this runtime definition is scoped to all projects within the cluster.\n Global runtime definitions can be only created by cluster admins.\n\nYou can retrieve an existing runtime definition, patch the content in the entity to your own data and use it as the body parameters for this endpoint.\n", "parameters": [ { "name": "account_id", "required": false, "in": "query", "description": "The guid of the account in which to create the runtime definition. \n", "example": "121d632a-20b3-4fab-848e-8550707df287", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "The guid of the project in which to create the runtime definition.", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsRuntimeDefinitionCreateBody" }, "responses": { "201": { "$ref": "#/components/responses/EnvironmentsRuntimeDefinitionCreateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v2/runtime_definitions/{runtime_definition_guid}": { "x-internal": "cpd", "get": { "tags": [ "Runtime Definitions" ], "operationId": "runtime_definitions_get", "summary": "Retrieve a runtime definition.", "description": "Retrieves a runtime definition of a given ID.\n", "parameters": [ { "name": "runtime_definition_guid", "required": true, "in": "path", "description": "The UUID v4 identifying the runtime definition.", "example": "c82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "Required for a project scoped runtime definition. The guid of the project the runtime definition is queried for.\n", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } }, { "name": "include", "required": false, "in": "query", "description": "Opt-in more details to return. Possible value is 'launch_configuration'; when specified, the request must be sent by cluster admins.\n", "example": "launch_configuration", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/EnvironmentsRuntimeDefinitionRetrieveResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" }, "404": { "$ref": "#/components/responses/EnvironmentsHTTP404Response" } } }, "put": { "tags": [ "Runtime Definitions" ], "operationId": "runtime_definitions_update", "summary": "Update a runtime definition.", "description": "Updates a runtime definition of a given ID. Runtime definitions can be only updated by cluster admins.\n", "parameters": [ { "name": "runtime_definition_guid", "required": true, "in": "path", "description": "A UUID v4 identifying the runtime definition.", "example": "c82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "Required for a project scoped runtime definition. The guid of the project the runtime definition is queried for.\n", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/EnvironmentsRuntimeDefinitionUpdateBody" }, "responses": { "200": { "$ref": "#/components/responses/EnvironmentsRuntimeDefinitionUpdateResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } }, "delete": { "tags": [ "Runtime Definitions" ], "operationId": "runtime_definitions_delete", "summary": "Delete a runtime definition.", "description": "Deletes a runtime definition of a given ID. Runtime definitions can be only deleted by cluster admins.\n", "parameters": [ { "name": "runtime_definition_guid", "required": true, "in": "path", "description": "The UUID v4 identifying the runtime definition.", "example": "c82b95df-fc3e-4273-98f7-473d62a03c2b", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "Required for a project scoped runtime definition. The guid of the project the runtime definition is queried for.\n", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e", "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/EnvironmentsRuntimeDefinitionDeleteResponse" }, "400": { "$ref": "#/components/responses/EnvironmentsHTTP400Response" }, "401": { "$ref": "#/components/responses/EnvironmentsHTTP401Response" }, "403": { "$ref": "#/components/responses/EnvironmentsHTTP403Response" } } } }, "/v3/search/update_by_query": { "post": { "tags": [ "Bulk Service" ], "summary": "A update operation allowing you to update artifacts based on a simple query.", "description": "Execute an operation to update artifacts using a simple query for one or more specified microservices (provider_ids).", "operationId": "updateByQuery", "parameters": [ { "name": "Run-as-Tenant", "in": "header", "description": "The Tenant id (which is the BSS Account ID) within which this query is being run. Note you can also use the header name account_id for this purpose.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchRelationshipUpdateBody" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "206": { "description": "Partial Content" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal error. Try again later." }, "503": { "description": "Service Unavailable" }, "default": { "description": "Success response content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchBulkUpdateResponseContent" } } } } } } }, "/v3/search/sss_heartbeat": { "get": { "tags": [ "Heartbeat" ], "summary": "Test if sss is up.", "operationId": "heartbeat_0", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal error. Try again later." } } } }, "/v3/search": { "get": { "tags": [ "Search" ], "summary": "Execute a query based on the Lucene Syntax", "description": "Execute a query and pass in a selection of words to search for or pass in a Lucene query. Your Lucene query can be as simple or as sophisticated as you like. Beware, however. If you plan on passing in a query directly from user input, make sure to set the 'isSimple' parameter to 'true' (the default is 'false'). Otherwise, Global Search will use the underlying query_string function that enforces a strict Lucene query syntax, and your query may return an exception if the user input includes reserved Lucene tokens or symbols that are used incorrectly. When the 'isSimple' parameter is set to true, Global Search will the ElasticSearch simple_query_string function that uses a modified Lucene syntax as follows:

 + = AND operation
 | = OR operation
 - = NOT
 \\\" wraps a phrase
 * is a wildcard (you can't use it at the beginning of a word but you can use it alone to signify match all)
 ( and ) evaluates tokens inside brackets with higher precedence

To use one of these characters literally, escape it with a preceding backslash.

Global Search allows users to search for assets and artifacts on the platform. The number of documents for all search results is limited to 10000.

Please notice that the response shows all possible fields, which are not applicable for all types. For example \"custom_attributes\" are only applicable to assets currently, and even then only to certain custom attributes depending how they have been defined. Likewise, \"categories\" are only applicable to artifacts, etc.
\n", "operationId": "simpleSearch", "parameters": [ { "name": "Run-as-Tenant", "in": "header", "description": "The Tenant id (which is the BSS Account ID) within which this query is being run. Note: you can also use the header name \"account_id\" for this purpose.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "default": "999" } }, { "name": "query", "in": "query", "description": "The Search Query. Add a list of words being sought or use a Lucene query. Your Lucene query can be as simple or as sophisticated as you like.", "required": true, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The maximum number of items to return", "required": false, "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32" }, "example": "100" }, { "name": "isSimple", "in": "query", "description": "Use simple query string syntax", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, { "name": "role", "in": "query", "description": "For governance artifacts limited by zone, limit with this role access.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "default": "viewer", "enum": [ "viewer", "editor" ] } }, { "name": "auth_cache", "in": "query", "description": "Use cached authorization info for building ACL filters.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, { "name": "auth_scope", "in": "query", "description": "The ACL filters applied to the query.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "default": "all", "enum": [ "all", "catalog", "project", "space", "category", "ibm_watsonx_governance_catalog", "ibm_data_product_catalog" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchSampleSearchResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal error. Try again later." } } }, "post": { "tags": [ "Search" ], "summary": "Execute a query and pass in a structured query conforming to the Elasticsearch Domain Specific Language.", "description": "Execute a query and pass in a structured query based on the Elasticsearch Domain Specific Language
\nFor example:
{
    \\\"query\\\": {
        \\\"match_all\\\": {}
    }
}
\n
You can also use this API to execute the Global Search user search function as follows:
\n{
    \\\"query\\\": {
        \\\"gs_user_query\\\": {
            \\\"search_string\\\": \\\"the quick red fox jumped over the lazy brown dog\\\",
            \\\"search_fields\\\": [\\\"metadata.name\\\", \\\"metadata.description\\\"],
            \\\"nlq_analyzer_enabled\\\": true,
            \\\"nested\\\": false
        }
    }
}
\n
Global Search allows users to search for assets and artifacts on the platform. The number of documents for all search results is limited to 10000.
\n
When search fields are specified, the search will be restricted to the specified fields. If no search fields are specified, the search will run across all fields in the configuration.\n
When the natural language analyzer is enabled, words which are not relevant to the search will be ignored, and common phrases will be prioritized.
\n
When semantic search is enabled, search strings containing a business term name or abbreviation will also include results for synonym, child and related business terms.\n ,Knowledge graph installation is required for semantic search.
\n\n
Please notice that the response shows all possible fields, which are not applicable for all types. For example \"custom_attributes\" are only applicable to assets currently, and even then only to certain custom attributes depending how they have been defined. Likewise, \"categories\" are only applicable to artifacts, etc.
\n
For more information regarding how to use this function, consult the Getting Started section of this guide.\n", "operationId": "search", "parameters": [ { "name": "Run-as-Tenant", "in": "header", "description": "The Tenant id (which is the BSS Account ID) within which this query is being run.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "default": "999" } }, { "name": "role", "in": "query", "description": "For governance artifacts limited by zone, limit with this role access.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "default": "viewer", "enum": [ "viewer", "editor" ] } }, { "name": "auth_cache", "in": "query", "description": "Use cached authorization info for building ACL filters.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, { "name": "auth_scope", "in": "query", "description": "The ACL filters applied to the query.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "default": "all", "enum": [ "all", "catalog", "project", "space", "category", "ibm_watsonx_governance_catalog", "ibm_data_product_catalog" ] } } ], "requestBody": { "description": "A string representing a query. The query must conform to Elasticsearch Domain Specific Language. For more details, read the Search section in the getting started guide.", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchSampleSearchResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal error. Try again later." } } } }, "/v3/search/search_facet": { "get": { "tags": [ "SearchFacet" ], "summary": "This API will return all available pre search filters", "description": "This API will return all available pre search filters", "operationId": "filter", "parameters": [ { "name": "Run-as-Tenant", "in": "header", "description": "The Tenant id (which is the BSS Account ID) within which this query is being run.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "default": "999" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchSampleSearchResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal error. Try again later." } } } }, "/v3/categories": { "post": { "description": "This method can be used to create a new category in the glossary.", "operationId": "create_category", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewCategoryEntity" } } } }, "responses": { "201": { "content": { "application/json": { "example": { "resources": [ { "href": "/v3/categories/285b7b78-3d64-48e6-a9b6-e02f4c32295f", "artifact_id": "285b7b78-3d64-48e6-a9b6-e02f4c32295f", "version_id": "12e37d76-f28b-4dc9-a35e-0c3e30f9f8ea_0", "global_id": "18091466-981e-4113-8943-2ddf162bff6d_285b7b78-3d64-48e6-a9b6-e02f4c32295f", "entity_type": "category" } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3CategoryResponse" } } }, "description": "The category has been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "UniqueConstraintViolation - category with given name and parent already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates a category in the glossary", "tags": [ "Categories" ] } }, "/v3/categories/collaborators/bootstrap": { "post": { "description": "Assigns default owners and view permissions for root categories without any role assignments set", "operationId": "start_boostrap", "responses": { "202": { "content": { "application/json": { "examples": { "IN_PROGRESS": { "description": "IN_PROGRESS", "summary": "Bootstrap in progress", "value": { "status": "IN_PROGRESS", "current_step": "Bootstrapping category e39ada11-8338-3704-90e3-681a71e7c839", "completed_records": 0, "total_records": 3 } } }, "schema": { "$ref": "#/components/schemas/GlossaryV3BootstrapStatus" } } }, "description": "The boostrap process started successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The boostrap is already in progress" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Start category boostrap process", "tags": [ "Categories" ] } }, "/v3/categories/collaborators/bootstrap/status": { "get": { "description": "Get status of category bootstrap process", "operationId": "get_bootstrap_status", "responses": { "200": { "content": { "application/json": { "examples": { "IN_PROGRESS": { "description": "IN_PROGRESS", "summary": "Bootstrap in progress", "value": { "status": "IN_PROGRESS", "current_step": "Bootstrapping category e39ada11-8338-3704-90e3-681a71e7c839", "completed_records": 0, "total_records": 3 } }, "NEW": { "description": "NEW", "summary": "Bootstrap new", "value": { "status": "NEW", "current_step": "Initializing role assignment bootstrap process", "completed_records": 0 } }, "NOT_STARTED": { "description": "NOT_STARTED", "summary": "Bootstrap not started", "value": { "status": "NOT_STARTED" } }, "SUCCEEDED": { "description": "SUCCEEDED", "summary": "Bootstrap succeeded", "value": { "status": "SUCCEEDED", "completion_message": "Bootstrap process completed", "completed_records": 3, "total_records": 3 } } }, "schema": { "$ref": "#/components/schemas/GlossaryV3BootstrapStatus" } } }, "description": "Bootstrap status fetched successfully" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get status of category bootstrap process", "tags": [ "Categories" ] } }, "/v3/categories/collaborators/bootstrap/status/history": { "get": { "description": "Get history status of category bootstrap process", "operationId": "get_bootstrap_status_history", "responses": { "200": { "content": { "application/json": { "examples": { "SUCCEEDED": { "description": "SUCCEEDED", "summary": "Bootstrap succeeded", "value": { "bootstrap_status_history": [ { "status": "SUCCEEDED", "completion_message": "No categories requiring bootstrap process", "completed_records": 0, "total_records": 0 }, { "status": "SUCCEEDED", "completion_message": "Bootstrap process completed", "completed_records": 3, "total_records": 3 } ] } } }, "schema": { "$ref": "#/components/schemas/GlossaryV3BootstrapStatusHistoryResponse" } } }, "description": "Bootstrap status history fetched successfully" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get history status of category bootstrap process", "tags": [ "Categories" ] } }, "/v3/categories/hierarchy": { "get": { "description": "This method can be used for retrieving hierarchy paths of categories", "operationId": "get_hierarchy_paths", "parameters": [ { "description": "The id of the category whose path is fetched", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "category_id", "schema": { "type": "array", "items": { "type": "string", "maxLength": 100, "minLength": 1, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "maxLength": 100, "minLength": 1, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "content": { "application/json": { "example": { "category_hierarchy_paths": [ { "category_id": "b50f0822-eff3-4912-932e-aa61e5e7ac9a", "category_hierarchy_path": [ { "artifact_id": "4c4b18ae-010c-4986-a308-93c6f22095d6", "name": "category name 1", "user_access": true }, { "artifact_id": "fedc7149-5504-4ea9-aca7-3ad025be6f7d", "name": "category name 2", "user_access": true } ] } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3CategoryHierarchyResponse" } } }, "description": "The hierarchy paths of categories have been retrieved successfully" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves category hierarchy paths for given artifact ids of categories", "tags": [ "Categories" ] }, "post": { "description": "This method can be used for retrieving hierarchy paths of categories", "operationId": "get_hierarchy_paths_top_down", "parameters": [ { "description": "The maximum number of categories to return - must be at least 1 and cannot exceed 1000. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 1000, "minimum": 1 } }, { "description": "The index of the first matching category to include in the result.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "example": { "resources": [ { "artifact_id": "2b9bb7cf-502e-43a2-9ecc-645e909cba33" } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceList" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "resources": [ { "metadata": { "artifact_type": "category", "artifact_id": "2b9bb7cf-502e-43a2-9ecc-645e909cba33", "version_id": "5b6a662e-10d5-47fd-b485-655521ee491a_0", "source_repository_id": "2513bb40-5ce0-440e-9aa7-f473d1c22f9f", "source_repository_name": "WKC_BG_2513bb40-5ce0-440e-9aa7-f473d1c22f9f", "global_id": "2513bb40-5ce0-440e-9aa7-f473d1c22f9f_2b9bb7cf-502e-43a2-9ecc-645e909cba33", "created_by": "System", "created_at": "2023-11-13T06:50:09.240Z", "modified_by": "System", "modified_at": "2023-11-13T06:50:09.240Z", "revision": "0", "name": "child of child2 category", "short_description": "child of child2-sd", "state": "PUBLISHED", "tags": [], "read_only": false }, "entity": { "parent_category_id": "b02920a4-09ae-4a62-a25f-03a2d7ba0507", "reporting_authorized": false, "long_description": "child of child2-ld", "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false } } ], "offset": 0, "last": { "href": "/v3/categories/hierarchy?limit=10&offset=0", "offset": "0" }, "set_uri": false, "limit": 10, "count": 1, "first": { "href": "/v3/categories/hierarchy?limit=10&offset=0", "offset": "0" } }, "schema": { "$ref": "#/components/schemas/GlossaryV3CategoryHierarchyResponse" } } }, "description": "The hierarchy paths of categories have been retrieved successfully" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves category hierarchy paths for given artifact ids of categories", "tags": [ "Categories" ], "x-codegen-request-body-name": "request" } }, "/v3/categories/uncategorized": { "get": { "description": "This method can be used for retrieving details of the special [uncategorized] category, which is a default one for all artifacts.", "operationId": "uncategorized_category", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3CategoryV3" } } }, "description": "The category has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves the special [uncategorized] category", "tags": [ "Categories" ] } }, "/v3/categories/{category_id}": { "delete": { "description": "This method can be used to delete a category.
Note! The category must be empty. It can contain neither child categories nor artifacts.", "operationId": "delete_category", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryArchiveResponse" } } }, "description": "The category has been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes the category with a given guid", "tags": [ "Categories" ] }, "get": { "description": "This method can be used for retrieving details of a category.", "operationId": "get_category", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "deprecated": true, "description": "When set to true fetch category relationships user has access to. It returns at most 1000 relationships. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.
Deprecated, functionality will be replaced by new one introduced in the feature releases.", "in": "query", "name": "include_relationships", "schema": { "type": "boolean", "default": true } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3CategoryV3" } } }, "description": "The category has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves category with given guid", "tags": [ "Categories" ] }, "patch": { "description": "This method can be used to update a category with given id.
It may be an update of its name, description, etc..", "operationId": "update_category", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatableCategoryEntity" } } }, "description": "Category to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:

{"description" : "short desc updated"}
", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3CategoryV3" } } }, "description": "The category has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with given {guid} does not exist in the glossary." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category was modified by another user." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates category with given id", "tags": [ "Categories" ] } }, "/v3/categories/{category_id}/artifacts/{artifact_id}": { "delete": { "description": "It can be used to remove a secondary category assignment for an artifact. It does not allow to remove an artifact from a primary category as a primary category assignment is obligatory.", "operationId": "delete_artifact_from_category", "parameters": [ { "description": "The artifact ID or the global ID of a category", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The artifact ID or the global ID of an artifact to be removed from a (secondary) category", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "204": { "description": "A secondary category assignment removed." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Attempt to remove an artifact from its primary category failed, because a primary category assignment is mandatory." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with the given {category_id} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Removes an artifact from its secondary category", "tags": [ "Categories" ], "x-codegen-request-body-name": "request" }, "put": { "description": "It can be used to set a primary category for an artifact (replacing an old primary category assignment if existed) as well as to add an artifact to a secondary category.", "operationId": "replace_artifact_for_category", "parameters": [ { "description": "The artifact ID or the global ID of a category", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The artifact ID or the global ID of an artifact to be added to the category", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewCategoryAssignment" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewCategoryAssignment" } } }, "description": "An existing category assignment updated (e.g. changed from secondary to primary)." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewCategoryAssignment" } } }, "description": "A new category assignment created." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with the given {category_id} or the artifact with the given {artifact_id} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Adds an artifact to a category", "tags": [ "Categories" ], "x-codegen-request-body-name": "request" } }, "/v3/categories/{category_id}/collaborators": { "get": { "description": "Single collaborator is an users with assigned roles in context of given category. A role comes with rights to access the category, its sub-categories and artifacts and potential responsibilities.", "operationId": "list_collaborators", "parameters": [ { "description": "The artifact ID or the global ID of a category", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If this parameter is true, the returned list contains collaborators not only for given category, but also for all parent categories, up to root category.", "in": "query", "name": "include_inherited", "schema": { "type": "boolean", "default": true } }, { "description": "If set then the returned list will be reduced to collaborators with given roles only. Maximum allowed number of roles is 100", "in": "query", "name": "role", "schema": { "type": "array", "items": { "type": "string", "maxLength": 100, "minLength": 1, "pattern": ".*" }, "maxLength": 100, "minLength": 1, "pattern": ".*" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RoleAssignmentResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves collaborators for given artifact id of a category", "tags": [ "Categories" ] }, "post": { "description": "To create collaborator one needs to provide id of the collaborating user and the name of the role he will be permitted. Collaborator is effective for given category and whole tree of its subcategories.", "operationId": "create_collaborator", "parameters": [ { "description": "The artifact ID or the global ID of a category", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewRoleAssignment" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Collaborator" } } }, "description": "The collaborator has been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "UniqueConstraintViolation - collaborator with the same role and user id already exists for given category." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates single collaborator for given category", "tags": [ "Categories" ] } }, "/v3/categories/{category_id}/collaborators/{collaborator_id}": { "delete": { "description": "Collaborator represents single user together with single role that gives him certain privileges in context of given category.", "operationId": "delete_collaborator", "parameters": [ { "description": "The artifact ID or the global ID of a category", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The id of the collaborator.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "collaborator_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "204": { "description": "The collaborator has been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The collaborator with given id does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes single collaborator", "tags": [ "Categories" ] } }, "/v3/categories/{category_id}/relationships": { "get": { "description": "If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.", "operationId": "list_category_relationships", "parameters": [ { "description": "The artifact ID of the category.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_category
has_types_category
is_a_parent_category_for
grouped_assets
owned_by
classifications
custom
all

Note: all does not return category hierarchy.", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^(((is_a_type_of_category|has_types_category|is_a_parent_category_for|grouped_assets|owned_by|classifications|custom),?)+)|all$" } }, { "description": "Custom relationship definition Id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "ca_definition_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Is custom relationship reversed?", "in": "query", "name": "is_reversed", "schema": { "type": "boolean", "default": false } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean", "default": false } }, { "description": "Retrieves target parent category name of the relationship entity.", "in": "query", "name": "include_target_parent_category_name", "schema": { "type": "boolean", "default": false } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RelationshipsResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "List the relationships of the given type for the specified category", "tags": [ "Categories" ] } }, "/v3/categories/{category_id}/relationships/{relationship_id}": { "delete": { "description": "Currently we support a custom relationship removal from category by relationship ID.", "operationId": "delete_relationship_from_category", "parameters": [ { "description": "The artifact ID of the category to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "category_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "204": { "description": "A relationship has been removed." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Remove a relationship from category", "tags": [ "Categories" ] } }, "/v3/category_role_statistics": { "get": { "description": "Get list of roles assigned in glossary, along with number of categories where specific role is used.", "operationId": "get_category_role_statistics", "responses": { "200": { "content": { "application/json": { "examples": { "SUCCEEDED": { "description": "SUCCEEDED", "value": { "role_assignment_statistics": [ { "role": "custom_role1", "number_of_categories": 1 }, { "role": "custom_role2", "number_of_categories": 2 }, { "role": "owner", "number_of_categories": 2 }, { "role": "viewer", "number_of_categories": 2 } ] } } }, "schema": { "$ref": "#/components/schemas/GlossaryV3CategoryRoleStatisticsList" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get role usage statistics", "tags": [ "Category role statistics" ] } }, "/v3/category_statistics": { "get": { "description": "Category statistics", "operationId": "get_category_statistics_by_role", "parameters": [ { "description": "Role for which statistics are to be retrieved", "in": "query", "name": "role", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "SUCCEEDED": { "description": "SUCCEEDED", "value": { "offset": 0, "last": { "href": "v3/category_statistics?offset=0&role=custom_role2", "offset": 0 }, "set_uri": false, "resources": [ { "category_artifact_id": "788e7609-5d1d-4f5f-a2e2-0011f8c726cf", "category_name": "Example category", "category_hierarchy_path": [ { "artifact_id": "4562a011-563d-40c2-ae28-80f64cd8d934", "name": "Parent of example category", "user_access": true }, { "artifact_id": "e6abcaba-203f-4f43-8bc3-f4f25aa96f19", "name": "Root category", "user_access": true } ], "users_assignments_count": 2, "groups_assignments_count": 1 } ], "limit": 10, "count": 1, "first": { "href": "v3/category_statistics?offset=0&role=custom_role2", "offset": 0 } } } }, "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedCategoryStatisticItemList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Returns list of categories which has specific role assigned, along with number of assignments for users and groups", "tags": [ "Category statistics" ], "x-codegen-request-body-name": "request" } }, "/v3/classifications": { "post": { "description": "This method is used to create a classification in the glossary.", "operationId": "create_classification", "parameters": [ { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewClassificationEntity" } } } }, "responses": { "201": { "content": { "application/json": { "example": { "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates a classification in the glossary", "tags": [ "Classifications" ] } }, "/v3/classifications/{artifact_id}/versions": { "get": { "description": "This method can be used for retrieving details of an ACTIVE classification. Only ACTIVE is supported", "operationId": "list_classification_by_artifact_id", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Filter by classification status.
Available statuses:
DRAFTartifacts which are being created or modified and not in use
PUBLISHEDartifacts which are in published state (does not takes effective dates into account)
ACTIVEartifacts which are published, and which effective date period includes current datetime
", "in": "query", "name": "status", "schema": { "type": "string", "default": "PUBLISHED", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_classification
has_types_classifications
has_types_classifications_hierarchy
categories
parent_category
terms
data_classes
policies
rules
reference_data
related_categories
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedArtifactList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves classification with given guid and status", "tags": [ "Classifications" ] } }, "/v3/classifications/{artifact_id}/versions/{version_id}": { "delete": { "description": "If the artifact state is DRAFT, then the draft version is deleted.

If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .

If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.

If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.

Administrator role is required.", "operationId": "delete_classification", "parameters": [ { "description": "The guid of the classification to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the classification to delete.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "A draft version has been successfully created for deleting the published artifact." }, "204": { "description": "The artifact has been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes a draft or published version of an artifact", "tags": [ "Classifications" ] }, "get": { "description": "This method can be used for retrieving details of an ACTIVE or DRAFT classification.", "operationId": "get_classification_by_version_id", "parameters": [ { "description": "The artifact id of the classification to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the classification to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_classification
has_types_classifications
has_types_classifications_hierarchy
categories
parent_category
terms
data_classes
policies
rules
reference_data
related_categories
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseClassification" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves classification with given guid", "tags": [ "Classifications" ] }, "patch": { "description": "If a published version is updated, a draft version is created from the published version and the draft version is updated with the requested changes and returned.If any relationships of the artifact are updated, then the updated relationships are returned as a paginated list limited by the give limit parameter. The relationships that are not updated are not returned.", "operationId": "update_classification_by_version_id", "parameters": [ { "description": "The artifact id of the classification to be updated.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the classification to be updated.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatableClassificationEntity" } } }, "description": "The classification to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}
", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseClassification" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates a draft or published artifact", "tags": [ "Classifications" ] } }, "/v3/classifications/{artifact_id}/versions/{version_id}/relationships": { "get": { "description": "If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.", "operationId": "list_classification_relationships", "parameters": [ { "description": "The artifactId of the classification", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The versionId of the classification", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_classification
has_types_classifications
has_types_classifications_hierarchy
categories
parent_category
terms
data_classes
policies
rules
reference_data
related_categories
custom
all
", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Custom relationship definition Id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "ca_definition_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Is custom relationship reversed?", "in": "query", "name": "is_reversed", "schema": { "type": "boolean" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "Retrieves target parent category name of the relationship entity.", "in": "query", "name": "include_target_parent_category_name", "schema": { "type": "boolean" } }, { "description": "The maximum number of associations to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RelationshipsResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "List the associations of the given type for the specified classification", "tags": [ "Classifications" ] }, "post": { "description": "If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.", "operationId": "create_classification_relationships", "parameters": [ { "description": "The artifact id of the classification to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the classification to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ClassificationRelationshipsRequest" } } }, "description": "Relationships to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Create relationships for an artifact in the glossary", "tags": [ "Classifications" ] } }, "/v3/classifications/{artifact_id}/versions/{version_id}/relationships/{relationship_id}": { "delete": { "description": "If it is a published version, it creates a draft from the published version and deletes the relationship from the draft version. And, it returns the details of the draft version.", "operationId": "delete_classification_relationship", "parameters": [ { "description": "The artifact id of the classification to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the classification to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryArchiveResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes relationships for an artifact in the glossary", "tags": [ "Classifications" ] } }, "/v3/data_classes": { "get": { "description": "This method is used to retrieve the data classes that the user have permissions and they match specified parameters.", "operationId": "list_data_classes", "parameters": [ { "description": "Comma-separated list of dataclass statuses.
Available statuses:
PUBLISHEDartifacts which are in published state (does not takes effective dates into account)
ACTIVEartifacts which are published, and which effective date period includes current datetime
DELETEDartifacts which have been deleted
", "in": "query", "name": "status", "schema": { "type": "string", "default": "PUBLISHED", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "To filter data classes based on enabled property. The enabled query parameter accepts (Yes, No, Both) where Yes is the default value. This option is not applicable for format=xml.", "in": "query", "name": "enabled", "schema": { "type": "string", "default": "Both" } }, { "description": "If this parameter is set to true, then Dataclass' xml definitions are returned. If parameter is not set its default value is 'true'", "in": "query", "name": "include_xml_definitions", "schema": { "type": "boolean", "default": true } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'false'.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "A filter to artifacts that have been created / updated / deleted since the given timestamp in this format: [yyyy-MM-ddTHH:mm:ss.SSSZ]", "in": "query", "name": "since", "schema": { "type": "string", "maxLength": 24, "minLength": 24, "pattern": "^\\d{4}(-\\d\\d(-\\d\\d(T\\d\\d:\\d\\d(:\\d\\d)?(\\.\\d+)?(([+-]\\d\\d:\\d\\d)|Z)?)?)?)?$" } }, { "description": "The maximum number of data_classes to return - must be at least 1 and cannot exceed 1000. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 1000, "minimum": 1 } }, { "description": "The index of the first matching data_class to include in the result.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedDataClassList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedDataClassList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves the data classes matching specified parameters.", "tags": [ "Data classes" ] }, "post": { "description": "This method is used to create a draft data class in the glossary. If the effective start date of selected reference data set is a future date, then effective start date of data class will be same as that of selected reference data set effective start date.", "operationId": "create_data_class", "parameters": [ { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewDataClassEntity" } } }, "description": "Data class to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates a draft data class in the glossary", "tags": [ "Data classes" ] } }, "/v3/data_classes/{artifact_id}/versions": { "get": { "description": "This method can be used for retrieving details of an ACTIVE or DRAFT data class. Only ACTIVE is allowed as status right now ", "operationId": "list_data_class_by_artifact_id", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Filter by dataclass status.
Available statuses:
DRAFTartifacts which are being created or modified and not in use
PUBLISHEDartifacts which are in published state (does not takes effective dates into account)
ACTIVEartifacts which are published, and which effective date period includes current datetime
", "in": "query", "name": "status", "schema": { "type": "string", "default": "PUBLISHED", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_data_class
has_types_data_classes
has_types_data_class_hierarchy
parent_category
categories
terms
classifications
policies
rules
reference_data
custom
all

Note: all does not return data class hierarchy.", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedArtifactList" } } }, "description": "The data class has been retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The data class with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves data class with given guid and status", "tags": [ "Data classes" ] } }, "/v3/data_classes/{artifact_id}/versions/{version_id}": { "delete": { "description": "If the artifact state is DRAFT, then the draft version is deleted.

If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .

If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.

If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.

Administrator role is required.", "operationId": "delete_data_class", "parameters": [ { "description": "The artifact id of the dataclass to delete.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the dataclass to delete.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "A draft version has been successfully created for deleting the published artifact." }, "204": { "description": "The artifact has been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes a draft or published version of an artifact", "tags": [ "Data classes" ] }, "get": { "description": "This method can be used for retrieving details of an ACTIVE or DRAFT data class.", "operationId": "get_data_class_by_version_id", "parameters": [ { "description": "The artifact ID of the data class to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the data class to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_data_class
has_types_data_classes
has_types_data_class_hierarchy
parent_category
categories
terms
classifications
policies
rules
reference_data
custom
all

Note: all does not return data class hierarchy.", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3DataClass" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves data class with given guid", "tags": [ "Data classes" ] }, "patch": { "description": "If a published version is updated, a draft version is created from the published version and the draft version is updated with the requested changes and returned.If any relationships of the artifact are updated, then the updated relationships are returned as a paginated list limited by the give limit parameter. The relationships that are not updated are not returned.", "operationId": "update_data_class_by_version_id", "parameters": [ { "description": "The artifact id of the data class to be updated.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the data class to be updated.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatableDataClassEntity" } } }, "description": "The data class to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}
If the effective start date of selected reference data set is a future date, then effective start date of data class will be same as that of selected reference data set effective start date.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3DataClass" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates a draft or published artifact", "tags": [ "Data classes" ] } }, "/v3/data_classes/{artifact_id}/versions/{version_id}/relationships": { "get": { "description": "If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.", "operationId": "list_data_class_relationships", "parameters": [ { "description": "The artifact ID of the data class to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the data class to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_data_class
has_types_data_classes
has_types_data_class_hierarchy
parent_category
categories
terms
classifications
policies
rules
reference_data
custom
all

Note: all does not return data class hierarchy.", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Custom relationship definition Id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "ca_definition_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Is custom relationship reversed?", "in": "query", "name": "is_reversed", "schema": { "type": "boolean" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "Retrieves target parent category name of the relationship entity.", "in": "query", "name": "include_target_parent_category_name", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RelationshipsResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "List the relationships of the given type for the specified data class", "tags": [ "Data classes" ] }, "post": { "description": "If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.", "operationId": "create_data_class_relationships", "parameters": [ { "description": "The artifact ID of the data class to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the data class to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3DataClassRelationshipsRequest" } } }, "description": "Relationships to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Create relationships for an artifact in the glossary", "tags": [ "Data classes" ] } }, "/v3/data_classes/{artifact_id}/versions/{version_id}/relationships/{relationship_id}": { "delete": { "description": "If it is a published version, it creates a draft from the published version and deletes the relationship from the draft version. And, it returns the details of the draft version.", "operationId": "delete_dataclass_relationship", "parameters": [ { "description": "The artifact ID of the data class to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the data class to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryArchiveResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes relationships for an artifact in the glossary", "tags": [ "Data classes" ] } }, "/v3/glossary_status/heartbeat": { "get": { "description": "Returns the build details and health of the dependent services", "operationId": "get_heartbeat_status", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ServerInfoV3" } } }, "description": "Success" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Business Glossary Heartbeat", "tags": [ "Business Glossary status" ] } }, "/v3/glossary_status/tenant_init": { "post": { "description": "Checks tenant init status (and initialize if necessary), blocks until init is done", "operationId": "tenant_init", "responses": { "204": { "description": "Success" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Requested data are not available, try again later." } }, "summary": "Tenant init and status", "tags": [ "Business Glossary status" ] } }, "/v3/glossary_status/tenant_init_status": { "get": { "description": "Checks tenant init status, returns immediately (initialization if required is performed in background)", "operationId": "tenant_init_status", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3TenantInitStatus" } } }, "description": "Success" } }, "summary": "Tenant init and status", "tags": [ "Business Glossary status" ] } }, "/v3/glossary_terms": { "post": { "description": "If the unique constraint on the name or display name of the term is violated, the method fails with 409 Conflict response.", "operationId": "create_terms", "parameters": [ { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlossaryV3NewTermEntityV3" } } } }, "description": "Terms to be created. The terms array must contain at least 1 term, and cannot exceed 100 terms.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates draft terms in the glossary", "tags": [ "Business terms" ], "x-codegen-request-body-name": "request" } }, "/v3/glossary_terms/{artifact_id}/versions": { "get": { "description": "Retrieval of the versions of ACTIVE state is supported.", "operationId": "list_term_by_artifact_id", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Filter by term status.
Available statuses:
DRAFTartifacts which are being created or modified and not in use
PUBLISHEDartifacts which are in published state (does not takes effective dates into account)
ACTIVEartifacts which are published, and which effective date period includes current datetime
", "in": "query", "name": "status", "schema": { "type": "string", "default": "PUBLISHED", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_terms
has_type_terms
has_types_term_hierarchy
synonym_terms
related_terms
data_classes
is_of_terms
has_terms
categories
parent_category
classifications
policies
rules
reference_data
reference_data_values
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedArtifactList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves versions of a term for the given artifact_id and status", "tags": [ "Business terms" ] } }, "/v3/glossary_terms/{artifact_id}/versions/{version_id}": { "delete": { "description": "If the artifact state is DRAFT, then the draft version is deleted.

If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .

If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.

If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.

Administrator role is required.", "operationId": "delete_term", "parameters": [ { "description": "The artifact id of the term to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the term to delete.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "A draft version has been successfully created for deleting the published artifact." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes a draft or published version of an artifact", "tags": [ "Business terms" ] }, "get": { "description": "This method can be used for retrieving details of an ACTIVE or DRAFT term.", "operationId": "get_term_by_version_id", "parameters": [ { "description": "The artifact id of the term to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The version id of the term to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_terms
has_type_terms
has_types_term_hierarchy
synonym_terms
related_terms
data_classes
is_of_terms
has_terms
categories
parent_category
classifications
policies
rules
reference_data
reference_data_values
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseGlossaryTerm" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Gets the term in the glossary with a given version id", "tags": [ "Business terms" ] }, "patch": { "description": "If a published version is updated, a draft version is created from the published version and the draft version is updated with the requested changes and returned.If any relationships of the artifact are updated, then the updated relationships are returned as a paginated list limited by the give limit parameter. The relationships that are not updated are not returned.", "operationId": "update_term_by_version_id", "parameters": [ { "description": "The artifact id of the term to be updated.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the term to be updated.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatableTermEntity" } } }, "description": "The business term to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out. If a relationship of the term is updated, then the updated relationship as returned as a paginated list limited by the give limit parameter. Relationships that are not updated are not returned.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseGlossaryTerm" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates a draft or published artifact", "tags": [ "Business terms" ] } }, "/v3/glossary_terms/{artifact_id}/versions/{version_id}/relationships": { "get": { "description": "If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.", "operationId": "list_terms_relationships", "parameters": [ { "description": "The guid of the Term", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The versionID of the Term", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
is_a_type_of_terms
has_type_terms
has_types_term_hierarchy
synonym_terms
related_terms
data_classes
is_of_terms
has_terms
categories
parent_category
classifications
policies
rules
reference_data
reference_data_values
custom
all
", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Custom relationship definition Id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "ca_definition_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Is custom relationship reversed?", "in": "query", "name": "is_reversed", "schema": { "type": "boolean" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "Retrieves target parent category name of the relationship entity.", "in": "query", "name": "include_target_parent_category_name", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RelationshipsResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "List the relationships for the specified term", "tags": [ "Business terms" ] }, "post": { "description": "If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.", "operationId": "create_terms_relationships", "parameters": [ { "description": "The artifact ID of the term to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the term to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3TermRelationshipsRequest" } } }, "description": "Relationships to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Create relationships for an artifact in the glossary", "tags": [ "Business terms" ] } }, "/v3/glossary_terms/{artifact_id}/versions/{version_id}/relationships/{relationship_id}": { "delete": { "description": "If it is a published version, it creates a draft from the published version and deletes the relationship from the draft version. And, it returns the details of the draft version.", "operationId": "delete_terms_relationships", "parameters": [ { "description": "The artifact ID of the term to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the term to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes relationships for an artifact in the glossary", "tags": [ "Business terms" ] } }, "/v3/governance_artifact_types/custom_attribute_definitions/export": { "post": { "description": "This method can be used to export custom attribute definitions to a json file.", "operationId": "custom_attribute_definition_export", "parameters": [ { "description": "The comma-separated list of supported custom attribute types. Allowed values are text, date, number, enum, relationship, all, all_without_relationship.", "example": "text,date", "in": "query", "name": "types", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact type which a custom attribute definition applies to. Allowed values are category, glossary_term, data_class, policy, rule, classification, reference_data", "example": "glossary_term,policy", "in": "query", "name": "artifact_types", "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The related artifact type which a custom attribute definition for relationship applies to. Allowed values are category, glossary_term, data_class, policy, rule, classification, reference_data", "example": "glossary_term,policy", "in": "query", "name": "related_artifact_types", "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } } ], "requestBody": { "content": { "application/json": { "examples": { "Resources with ids for custom attribute definitions": { "description": "An example for resources with ids for custom attribute definitions", "summary": "An example for resources with ids for custom attribute definitions", "value": { "resources": [ { "artifact_id": "455b7b78-3d64-48e6-a9b6-e02f4c32295f" } ] } } }, "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceList" } } }, "description": "The list of custom attribute definitions artifact ids to be exported." }, "responses": { "200": { "content": { "application/octet-stream": { "schema": { "type": "string" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Exports custom attribute definitions to a json file", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/custom_attribute_definitions/import": { "post": { "description": "This method can be used to import values custom attribute definitions from specified json file.", "operationId": "custom_attribute_definitions_import", "parameters": [ { "description": "Determines if only custom properties or custom relationships or both types will be imported. Allowed values: ALL, PROPERTY, RELATIONSHIP.", "in": "query", "name": "subtype", "schema": { "type": "string", "default": "ALL", "enum": [ "ALL", "PROPERTY", "RELATIONSHIP" ] } }, { "description": "If async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code.", "in": "query", "name": "async_mode", "schema": { "type": "boolean" } } ], "requestBody": { "$ref": "#/components/requestBodies/GlossaryV3file_json" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryImportStatus" } } }, "description": "Import of assets has been completed" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryImportStatus" } } }, "description": "Import of assets has been started" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Import values for custom attribute definitions from specified json file", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/export": { "get": { "description": "This method can be used to export values of all supported types to a ZIP file.", "operationId": "zipped_artifact_export", "parameters": [ { "description": "This specifies if artifact ID numbers should be included in exported files, or not. Possible values: \"always\", artifact ID numbers are included for artifacts, and \"never\", not included at all.", "example": "always", "in": "query", "name": "artifact_id_mode", "schema": { "type": "string", "default": "always", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The comma-separated list of supported artifact types. Allowed values are all, category, classification, data_class, glossary_term, policy, rule, reference_data and role_assignment.", "example": "category,glossary_term", "in": "query", "name": "artifact_types", "schema": { "type": "string", "default": "all", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "The comma-separated list of categories ID numbers, or \"all_top_level\", which means all top-level categories.", "example": "e39ada11-8338-3704-90e3-681a71e7c839,c305c9fe-3223-48a0-b146-228a782bc7e4", "in": "query", "name": "category_ids", "schema": { "type": "string", "default": "all_top_level", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If parameter \"include_custom_attribute_definitions\" is set to true, information about suitable custom attribute definitions will be included in zip", "in": "query", "name": "include_custom_attribute_definitions", "schema": { "type": "boolean", "default": false } }, { "description": "If parameter \"include_development_log\" is set to true, development log content will be included in zip", "in": "query", "name": "include_development_log", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "content": { "application/zip": { "schema": { "type": "string", "format": "byte" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Export values of all supported types to a ZIP file", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/import": { "post": { "description": "This method can be used to import values from specified ZIP file.", "operationId": "zipped_artifact_import", "parameters": [ { "description": "Import merge option, valid values:
all - imported values will replace existing values in catalog
specified - imported values that are not empty replace existing values in catalog
empty - imported values replace only empty values in catalog.", "example": "specified", "in": "query", "name": "merge_option", "schema": { "type": "string", "default": "specified", "maxLength": 32, "minLength": 1, "pattern": ".*" } } ], "requestBody": { "$ref": "#/components/requestBodies/GlossaryV3file_zip" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryImportStatus" } } }, "description": "Import of assets has been completed" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryImportStatus" } } }, "description": "Import of assets has been started" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Import values from specified ZIP file", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/import/cleanup/{process_id}": { "post": { "description": "This method can be used to cleanup specified stalled ZIP import process that crashed or hanged. Note: This feature is experimental - the API and scope are subject to change. Should not be used on imports that are alive or pending as it can lead to unpredictable results.", "operationId": "update_zipped_import_cleanup", "parameters": [ { "description": "Import process id", "example": "67c6dab6-c3ee-441e-8445-fff2f7259514", "in": "path", "name": "process_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Cleanup ZIP import process", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/import/status/{process_id}": { "get": { "description": "Import of assets status", "operationId": "get_import_status", "parameters": [ { "description": "Import process id", "in": "path", "name": "process_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryImportStatus" } } }, "description": "Import status available" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Import of assets status", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}": { "get": { "description": "This method can be used for retrieving artifacts of given type that are:
  • published,
  • drafts matching specified criteria (starts_with, substring, workflow_status, created_by, modified_by, enabled).
", "operationId": "get_artifacts", "parameters": [ { "description": "The artifact type. Allowed values are all, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "First character of artifact, applicable only for draft artifact search.", "example": "Tes", "in": "query", "name": "starts_with", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Filter on substring, applicable only for draft artifact search.", "example": "est", "in": "query", "name": "sub_string", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Filter by workflow status.
Available statuses (if no status is specified, all drafts are retrieved):
published
Publishing (applicable only for draft artifact search)
Publish failed (applicable only for draft artifact search)
Not started (applicable only for draft artifact search)
", "example": "NOT_STARTED", "in": "query", "name": "workflow_status", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Filter by creator of artifact, applicable only for draft artifact search.", "example": "IBMid-1234567ABC", "in": "query", "name": "created_by", "schema": { "type": "string", "maxLength": 73, "minLength": 1, "pattern": ".*" } }, { "description": "Filter by editor of artifact, applicable only for draft artifact search.", "example": "IBMid-1234567ABC", "in": "query", "name": "modified_by", "schema": { "type": "string", "maxLength": 73, "minLength": 1, "pattern": ".*" } }, { "description": "Filter Results based on enabled flag for dataclass, `yes` will give enabled dataclass, `no` will give disabled and `both` shall return all, applicable only for draft artifact search.", "example": true, "in": "query", "name": "enabled", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } }, { "description": "Value on which results need to be sorted, valid sort parameters are NAME, MODIFIED, CREATED, TYPE.Prefix hyphen (-) for descending order, applicable only for draft artifact search.", "example": "-NAME", "in": "query", "name": "sort", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedSearchArtifactsList" } } }, "description": "Artifacts have been retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get artifacts of given type that are either published or drafts matching specified criteria", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions": { "get": { "description": "This method can be used for retrieving details of custom attribute definitions.", "operationId": "list_custom_attribute_definitions", "parameters": [ { "description": "The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Is the artifact type defined as related artifact type or not, in case of \"RELATIONSHIP\" type only!", "in": "query", "name": "is_related_artifact_type", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefinition" } } }, "description": "The custom attribute definitions have been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The custom attribute definition with given {artifact_id} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves custom attribute definitions with given artifact type", "tags": [ "Governance artifact types" ] }, "post": { "description": "This method can be used to create custom attribute definition in the glossary.", "operationId": "create_custom_attribute_definitions", "parameters": [ { "description": "The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewCustomAttributeDefinitionEntity" } } }, "description": "Custom attribute definition to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The custom attribute definition has been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "UniqueConstraintViolation - custom attribute definition with given name already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates custom attribute definition in the glossary", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/custom_attribute_definitions/{custom_attribute_definition_artifact_id}": { "delete": { "description": "This method is used to delete the custom attribute definition with a given artifact_id (guid).", "operationId": "delete_custom_attribute_definition", "parameters": [ { "description": "The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact_id of the custom attribute definition to be purged.", "example": "990e33f5-3108-4d45-a530-030745831313", "in": "path", "name": "custom_attribute_definition_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryArchiveResponse" } } }, "description": "The custom attribute definition has been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The custom attribute definition with given {artifact_id} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes the custom attribute definition with a given artifact_id", "tags": [ "Governance artifact types" ] }, "get": { "description": "This method can be used for retrieving details of a custom attribute definition.", "operationId": "get_custom_attribute_definition", "parameters": [ { "description": "The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact_id of the custom attribute definition to fetch.", "example": "d4a5e6e1-a6c0-4580-afbb-6898303adf34", "in": "path", "name": "custom_attribute_definition_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefinition" } } }, "description": "The custom attribute definition has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The custom attribute definition with given {artifact_id} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves custom attribute definition with given artifact_id", "tags": [ "Governance artifact types" ] }, "patch": { "description": "This method is used to update custom attribute definition with given artifact_id.", "operationId": "update_custom_attribute_definition", "parameters": [ { "description": "The artifact type. Allowed values are all, category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact_id of the custom attribute definition to be updated.", "in": "path", "name": "custom_attribute_definition_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatableCustomAttributeDefinitionEntity" } } }, "description": "Custom attribute definition to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"business_description" : "business desc updated"}
", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefinition" } } }, "description": "The custom attribute definition has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The custom attribute definition with given {artifact_id} does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The custom attribute definition was modified by another user." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates custom attribute definition with given artifact_id", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/delete": { "post": { "description": "If the artifact state is DRAFT, then the draft version is deleted.

If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .

If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.

If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.

Administrator role is required.", "operationId": "artifact_delete", "parameters": [ { "description": "The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "If async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code.", "in": "query", "name": "async_mode", "schema": { "type": "boolean" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } }, { "description": "If someone has already created a draft for deleting or updating an artifact, then the artifact will be ignored.", "in": "query", "name": "skip_if_draft_exists", "schema": { "type": "boolean" } }, { "description": "If specified asset does does not exist, it is skipped.", "in": "query", "name": "skip_if_not_exists", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceIdentifierList" } } }, "description": "The list of artifacts to be deleted. All the artifacts must be either in published state or draft state, but mix of draft and published state is not allowed.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "A draft version has been successfully created for deleting the published artifact." }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Task" } } }, "description": "If async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code." }, "204": { "description": "The artifacts have been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Delete a list of draft or published versions of given artifact_type", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/export": { "get": { "description": "This method can be used to export values of a specified type to a csv file.", "operationId": "artifact_export", "parameters": [ { "description": "The artifact type. Allowed values are category, glossary_term, data_class, policy, rule, classification", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifactId of the parent category", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "category_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Whether to include the parent category. This applies to category (as asset type) export only, and is ignored for other asset types. The special [uncategorized] category is not included.", "in": "query", "name": "include_category", "schema": { "type": "boolean" } }, { "description": "Whether to include assets from subcategories", "in": "query", "name": "include_subcategories", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "text/csv": { "schema": { "type": "string" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The category with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Exports values of a specified type to a csv file", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/import": { "post": { "description": "This method can be used to import values from specified csv file.", "operationId": "create_artifact_import", "parameters": [ { "description": "The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Import merge option, valid values:
all - imported values will replace existing values in catalog
specified - imported values that are not empty replace existing values in catalog
empty - imported values replace only empty values in catalog.", "example": "all", "in": "query", "name": "merge_option", "schema": { "type": "string", "default": "empty", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "If async_mode is true, then the method starts an asynchronous process to execute the given action and returns with ACCEPTED 202 status code.", "in": "query", "name": "async_mode", "schema": { "type": "boolean" } } ], "requestBody": { "$ref": "#/components/requestBodies/GlossaryV3file_csv" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryImportStatus" } } }, "description": "Import of assets has been completed" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryImportStatus" } } }, "description": "Import of assets has been started" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Import values from specified csv file", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/search": { "post": { "description": "This method can be used for retrieving draft artifacts.", "operationId": "artifact_search", "parameters": [ { "description": "The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceList" } } }, "description": "The list of draft artifacts to be retrieved. If drafts exist, then they are returned.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The drafts have been retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Search for a list of drafts of given artifact_type", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/{artifact_id}": { "get": { "description": "This method can be used for getting the latest published version of the specified artifact.", "operationId": "get_published_artifact_by_id", "parameters": [ { "description": "The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Artifact ID or global ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Comma-separated list of relationship types.
Relationship TypesArtifact Types
categoryclassificationdata_classglossary_termpolicyreference_datarule
all+++++++
categories-++++++
child-----+-
classifications+-+++++
custom+++++++
data_classes-+-++++
data_location_rules----+--
data_protection_rules----+--
grouped_assets+------
has_terms---+---
has_type_terms---+---
has_types_category+------
has_types_classifications-+-----
has_types_classifications_hierarchy-+-----
has_types_data_class_hierarchy--+----
has_types_data_classes--+----
has_types_term_hierarchy---+---
is_a_parent_category_for+------
is_a_type_of_category+------
is_a_type_of_classification-+-----
is_a_type_of_data_class--+----
is_a_type_of_terms---+---
is_of_terms---+---
multi_value_mappings-----+-
owned_by+------
parent-----+-
parent_category-++++++
parent_hierarchy-----+-
parent_policy----+--
policies-+++--+
reference_data-+++--+
reference_data_values---+---
related_categories-+-----
related_terms---+---
replaced_by_terms---+---
replaces_terms---+---
rules-++++++
single_value_mappings-----+-
sub_policies----+--
synonym_terms---+---
terms-++-+++
value_mappings-----+-
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'false'.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.
This parameter is ignored when artifact type is category.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.
This parameter is ignored when artifact type is category.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3WdpApiModeledObject" } } }, "description": "The latest published version of the specified artifact has been retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get the latest published version of the specified artifact", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/{artifact_id}/move": { "post": { "description": "This method can be used to change given artifact parent. Or make it root-level, in case of category.
Note: change of collaborators access may take longer to complete", "operationId": "move_artifact", "parameters": [ { "description": "The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Artifact ID or global ID of the artifact", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 73, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3MoveTargetCategory" } } }, "description": "Target category (to become a parent of this artifact)", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3WdpApiModeledObject" } } }, "description": "The artifact has been moved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Published artifact not found for given guid" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Either the artifact was modified by another user, or the same artifact already exists with the same new parent category" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Changes the parent category of a published artifact with given id", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/aggregated_logs": { "get": { "description": "Get development logs & Comments for a draft artifact version", "operationId": "list_artifact_aggregated_logs", "parameters": [ { "description": "The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } }, { "description": "Time zone offset based on which the day wise grouping is to be performed. The offset will be of format [+-]hh:mm where hh stands for hour digit and mm for minute digit.
e.g. +05:30 indicates IST. If [+-] is not provided by default + will be appended. e.g 05:30 indicates +05:30.
If hour digit is single like +h:mm provided, then it will be considered as +0h:mm. e.g. +5:30 indicates +05:30.
The range of offsets is restricted to -17:59 to +17:59 inclusive.", "in": "query", "name": "time_zone_offset", "schema": { "type": "string", "maxLength": 6, "minLength": 1, "pattern": "^([+-]?)(0[0-9]|1[0-7]|[0-9]):([0-5][0-9])$" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedAssetAggregatedCommentsList" } } }, "description": "Development logs & Comments retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Draft artifact version not found for given version_id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get development logs & Comments for a draft artifact version", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/aggregated_logs/{mod_id}": { "get": { "description": "Get development logs & Comments for a draft artifact version with development log id", "operationId": "get_artifact_aggregated_logs_id", "parameters": [ { "description": "The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id.", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The development log id.", "in": "path", "name": "mod_id", "required": true, "schema": { "type": "string", "maxLength": 73, "minLength": 1, "pattern": ".*" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedAssetCommentsModificationDetails" } } }, "description": "Development logs & Comments retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Draft artifact version not found for given version_id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get development logs & Comments for a draft artifact version with development log id", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/comments": { "post": { "description": "Add a comment for a draft artifact version", "operationId": "add_log_user_comment", "parameters": [ { "description": "The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3AssetCommentUserEntity" } } }, "description": "The user comment.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3AssetCommentUserEntity" } } }, "description": "Comment added successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Draft artifact version not found for given version_id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Add a comment for a draft artifact version", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/comments/{comment_id}": { "delete": { "description": "Delete a comment on a draft artifact version", "operationId": "delete_artifact_logs", "parameters": [ { "description": "The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact id.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The comment id.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "comment_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "204": { "description": "Comment deleted successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Draft artifact version not found for given version_id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Delete a comment on a draft artifact version", "tags": [ "Governance artifact types" ] }, "patch": { "description": "Update a comment on a draft artifact version", "operationId": "update_artifact_comments", "parameters": [ { "description": "The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact id.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The comment id.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "comment_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3AssetCommentUserEntity" } } }, "description": "The user comment.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3AssetCommentUserEntity" } } }, "description": "Comment updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Draft artifact version not found for given version_id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Update a comment on a draft artifact version", "tags": [ "Governance artifact types" ] } }, "/v3/governance_artifact_types/{artifact_type}/{artifact_id}/versions/{version_id}/logs": { "get": { "description": "Get development logs & Comments for a draft artifact version", "operationId": "get_artifact_logs", "parameters": [ { "description": "The artifact type. Allowed values are glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "path", "name": "artifact_type", "required": true, "schema": { "type": "string", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact id.", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id.", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedAssetCommentList" } } }, "description": "Development logs & Comments retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Draft artifact version not found for given version_id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get development logs & Comments for a draft artifact version", "tags": [ "Governance artifact types" ] } }, "/v3/policies": { "post": { "description": "Creates a policy in the glossary", "operationId": "create_policy", "parameters": [ { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewPolicyEntity" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The policy has been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "UniqueConstraintViolation - policy with given name already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates a policy in the glossary", "tags": [ "Policies" ], "x-codegen-request-body-name": "request" } }, "/v3/policies/{artifact_id}/versions": { "get": { "description": "Retrieval of the versions of ACTIVE state is supported.", "operationId": "list_policy_by_artifact_id", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Filter by policy status.
Available statuses:
DRAFTartifacts which are being created or modified and not in use
PUBLISHEDartifacts which are in published state (does not takes effective dates into account)
ACTIVEartifacts which are published, and which effective date period includes current datetime
", "in": "query", "name": "status", "schema": { "type": "string", "default": "PUBLISHED", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
parent_policy
sub_policies
parent_category
categories
terms
classifications
rules
data_location_rules
data_protection_rules
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedArtifactList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves versions of a policy for the given artifact_id and status", "tags": [ "Policies" ] } }, "/v3/policies/{artifact_id}/versions/{version_id}": { "delete": { "description": "If the artifact state is DRAFT, then the draft version is deleted.

If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .

If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.

If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.

Administrator role is required.", "operationId": "delete_by_artifact_and_version_ids", "parameters": [ { "description": "The artifact ID of the policy.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the policy to delete or to create mark-for-delete draft copy.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The artifact has been deleted successfully." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponsePolicy" } } }, "description": "A draft version has been successfully created for deleting the published artifact." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Policy with sub-policies cannot be deleted. Try again after re-parenting sub-policies." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Policy with given artifact and version ids does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes a draft or published version of an artifact", "tags": [ "Policies" ] }, "get": { "description": "Retrieval of the versions of ACTIVE state is supported.", "operationId": "get_policy_by_version_id", "parameters": [ { "description": "The artifact ID of the policy to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the policy to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
parent_policy
sub_policies
parent_category
categories
terms
classifications
rules
data_location_rules
data_protection_rules
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponsePolicy" } } }, "description": "The policy has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The policy with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves versions of a policy for the given artifact_id and status", "tags": [ "Policies" ] }, "patch": { "description": "Updates policy with given artifact id and version id. If the policy is in published state then first creates a draft and applies the changes to the newly created draft.", "operationId": "update_policy_by_version_id", "parameters": [ { "description": "The artifact id of the policy to be updated.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the policy to be updated.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatablePolicyEntity" } } }, "description": "The policy to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}
", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponsePolicy" } } }, "description": "The policy has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The policy with given {guid} does not exist in the glossary." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The policy was modified by another user." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates policy with given artifact id and version id", "tags": [ "Policies" ] } }, "/v3/policies/{artifact_id}/versions/{version_id}/data_protection_rules": { "patch": { "deprecated": true, "description": "Updates DPR rule relationships of a published policy using its artifact id and version id
Deprecated, functionality will be replaced by new one introduced in the feature releases.", "operationId": "update_policy_rule_relationships", "parameters": [ { "description": "The artifact id of the policy to be updated.", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the policy to be updated.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponsePolicy" } } }, "description": "The policy has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The policy with given {guid} does not exist in the glossary." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The policy was modified by another user." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates DPR rule relationships of a published policy using its artifact id and version id", "tags": [ "Policies" ], "x-codegen-request-body-name": "request" } }, "/v3/policies/{artifact_id}/versions/{version_id}/relationships": { "get": { "description": "If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.", "operationId": "list_policies_relationships", "parameters": [ { "description": "The guid of the Policy", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The versionID of the Policy", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
parent_policy
sub_policies
parent_category
categories
terms
classifications
rules
data_location_rules
data_protection_rules
custom
all
", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Custom relationship definition Id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "ca_definition_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Is custom relationship reversed?", "in": "query", "name": "is_reversed", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "Retrieves target parent category name of the relationship entity.", "in": "query", "name": "include_target_parent_category_name", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RelationshipsResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "List the relationships for the specified policy", "tags": [ "Policies" ] }, "post": { "description": "If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.", "operationId": "create_policy_relationships", "parameters": [ { "description": "The artifact ID of the term to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the term to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PolicyRelationshipsRequest" } } }, "description": "Relationships to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unique constraint violated because of optimistic locking or some other constraint." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Create relationships for an artifact in the glossary", "tags": [ "Policies" ] } }, "/v3/policies/{artifact_id}/versions/{version_id}/relationships/{relationship_id}": { "delete": { "description": "Deletes a relationship from a draft policy", "operationId": "delete_policy_relationships", "parameters": [ { "description": "The artifact ID of the policy to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the policy to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes a relationship from a draft policy", "tags": [ "Policies" ] } }, "/v3/relationships": { "get": { "description": "For a given artifact type, a set of predefined relationship attributes with associated artifacts are included for every relationship.", "operationId": "getRelationships", "parameters": [ { "description": "The artifact type. Allowed values are category, glossary_term, classification, data_class, reference_data, policy, rule", "example": "glossary_term", "in": "query", "name": "artifact_type", "required": true, "schema": { "type": "string" } }, { "description": "The id of artifact that is a part of the requested relationship.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of artifact that is a part of the requested relationship.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "query", "name": "artifact_version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Relationship TypesArtifact Types
categoryclassificationdata_classglossary_termpolicyreference_datarule
all+++++++
categories-++++++
child-----+-
classifications+-+++++
custom+++++++
data_classes-+-++++
data_location_rules----+--
data_protection_rules----+--
grouped_assets+------
has_terms---+---
has_type_terms---+---
has_types_category+------
has_types_classifications-+-----
has_types_classifications_hierarchy-+-----
has_types_data_class_hierarchy--+----
has_types_data_classes--+----
has_types_term_hierarchy---+---
is_a_parent_category_for+------
is_a_type_of_category+------
is_a_type_of_classification-+-----
is_a_type_of_data_class--+----
is_a_type_of_terms---+---
is_of_terms---+---
multi_value_mappings-----+-
owned_by+------
parent-----+-
parent_category-++++++
parent_hierarchy-----+-
parent_policy----+--
policies-+++--+
reference_data-+++--+
reference_data_values---+---
related_categories-+-----
related_terms---+---
replaced_by_terms---+---
replaces_terms---+---
rules-++++++
single_value_mappings-----+-
sub_policies----+--
synonym_terms---+---
terms-++-+++
value_mappings-----+-
", "in": "query", "name": "relationship_type", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "A filter to artifacts that have been created / updated / deleted since the given timestamp in this format: [yyyy-MM-ddTHH:mm:ss.SSSZ]", "in": "query", "name": "since", "schema": { "type": "string", "maxLength": 24, "minLength": 24, "pattern": "^\\d{4}(-\\d\\d(-\\d\\d(T\\d\\d:\\d\\d(:\\d\\d)?(\\.\\d+)?(([+-]\\d\\d:\\d\\d)|Z)?)?)?)?$" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedLightweightSearchRelationshipWithArtifactsList" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves relationships for a given artifact type, artifact_id and artifact version_id ", "tags": [ "Relationships" ] } }, "/v3/rules": { "post": { "description": "This method is used to create a new rule.", "operationId": "create_rule", "parameters": [ { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewRuleEntity" } } }, "description": "Rule to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The rule has been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "UniqueConstraintViolation - rule with given name already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates a rule in the glossary", "tags": [ "Rules" ] } }, "/v3/rules/{artifact_id}/versions": { "get": { "description": "This method can be used for retrieving details of an ACTIVE, PUBLISHED or DRAFT rule.", "operationId": "list_rule_by_artifact_id", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Filter by rule status.
Available statuses:
DRAFTartifacts which are being created or modified and not in use
PUBLISHEDartifacts which are in published state (does not takes effective dates into account)
ACTIVEartifacts which are published, and which effective date period includes current datetime
", "in": "query", "name": "status", "schema": { "type": "string", "default": "PUBLISHED", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
parent_category
categories
terms
rules
reference_data
policies
classifications
data_classes
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "example": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3PaginatedArtifactList" } } }, "description": "The rule has been retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The rule with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves rule with given artifact_id and status", "tags": [ "Rules" ] } }, "/v3/rules/{artifact_id}/versions/{version_id}": { "delete": { "description": "If the artifact state is DRAFT, then the draft version is deleted.

If the artifact state is PUBLISHED, a draft version with marked_for_deletion is created .

If the artifact state is PUBLISHED and workflow is skipped, then the published version is deleted.

If a draft artifact already exists for deletion for a published artifact, then the draft artifact is simply skipped.

Administrator role is required.", "operationId": "delete_rule", "parameters": [ { "description": "The artifact id of the rule to delete.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the rule to delete.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "201": { "content": { "application/json": { "example": { "resources": [ { "href": "v3/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "A draft version has been successfully created for deleting the published artifact." }, "204": { "description": "The artifact has been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Draft version for the given version ID does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes a draft or published version of an artifact", "tags": [ "Rules" ] }, "get": { "description": "This method can be used for retrieving details of an PUBLISHED or DRAFT rule.", "operationId": "get_rule_by_version_id", "parameters": [ { "description": "The artifact ID of the rule to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the rule to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
parent_category
categories
terms
rules
reference_data
policies
classifications
data_classes
custom
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^(parent_category|categories|terms|classifications|data_classes|reference_data|policies|rules|custom|all)(,(parent_category|categories|terms|classifications|data_classes|reference_data|policies|rules|custom|all))*$" } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'true'. This is deprecated and default will be change to 'false' in first major 2022 release.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": true } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseRule" } } }, "description": "The rule has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The rule with given {guid} does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieves rule with given guid", "tags": [ "Rules" ] }, "patch": { "description": "This method is used to update rule with given id.", "operationId": "update_rule_by_version_id", "parameters": [ { "description": "The artifact id of the rule to be updated.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the rule to be updated.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatableRuleEntity" } } }, "description": "The rule to be updated.
Fields omitted will be unchanged, and fields set to null explicitly will be nulled out.
For multi-valued attributes & relationships, the complete list will be replaced by the given list of values.
Additional Example:
{"description" : "description updated"}
", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseRule" } } }, "description": "The rule has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The rule with given {guid} does not exist in the glossary." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The rule was modified by another user." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Updates rule with given id", "tags": [ "Rules" ] } }, "/v3/rules/{artifact_id}/versions/{version_id}/relationships": { "get": { "description": "If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.", "operationId": "list_rule_relationships", "parameters": [ { "description": "The artifact ID of the rule to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the rule to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "Comma-separated list of relationship types.
Available types:
parent_category
categories
terms
rules
reference_data
policies
classifications
data_classes
custom
all
", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Custom relationship definition Id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "ca_definition_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Is custom relationship reversed?", "in": "query", "name": "is_reversed", "schema": { "type": "boolean" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } }, { "description": "Retrieves target parent category name of the relationship entity.", "in": "query", "name": "include_target_parent_category_name", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RelationshipsResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "List the relationships of the given type for the specified rule", "tags": [ "Rules" ] }, "post": { "description": "If it is a published version, it creates a draft from the published version and adds the relationship to the draft version. And, it returns the details of the draft version.", "operationId": "create_rule_relationships", "parameters": [ { "description": "The artifact ID of the rule to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the rule to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RuleRelationshipsRequest" } } }, "description": "Relationships to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The relationship(s) have been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "UniqueConstraintViolation - This Relationships is already exist" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Create relationships for an artifact in the glossary", "tags": [ "Rules" ] } }, "/v3/rules/{artifact_id}/versions/{version_id}/relationships/{relationship_id}": { "delete": { "description": "This method can be used for deleting a relationship of a rule artifact.", "operationId": "delete_rule_relationship", "parameters": [ { "description": "The artifact ID of the rule to fetch.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version ID of the rule to fetch.", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The relationship of the rule artifact was successfully deleted." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The relationship for the given GUID does not exist in the glossary." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Deletes a relationship of a rule artifact", "tags": [ "Rules" ] } }, "/v4/reference_data_sets": { "post": { "description": "Create a reference data set", "operationId": "create_reference_data_set_1", "parameters": [ { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewReferenceDataSetEntityV4" } } } }, "responses": { "201": { "content": { "application/json": { "example": { "href": "/v4/reference_data_sets/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The reference data set has been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Reference data set with given name already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Create a reference data set", "tags": [ "Reference data sets" ] } }, "/v4/reference_data_sets/{artifact_id}/versions": { "get": { "description": "This method can be used for retrieving details of an ACTIVE, PUBLISHED or DRAFT reference data set.", "operationId": "list_reference_dataset_by_artifact_id_1", "parameters": [ { "description": "Artifact ID or global ID of the artifact", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Filter by reference data set status.
Available statuses:
DRAFTartifacts which are being created or modified and not in use
PUBLISHEDartifacts which are in published state (does not takes effective dates into account)
ACTIVEartifacts which are published, and which effective date period includes current datetime
", "in": "query", "name": "status", "schema": { "type": "string", "default": "PUBLISHED", "maxLength": 32, "minLength": 1, "pattern": ".*" } }, { "description": "Fetch only the first page of every requested relationship.\nSize of the page is defined by limit.\nTo fetch other relationship pages call: /v4/reference_data_sets/{artifact_id}/versions/{version_id}/relationships.\nComma-separated list of relationship types.
Available types:
parent_category
categories
terms
classifications
data_classes
rules
child
parent
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "description": "Text value", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Fetch custom relationships definitions for reference data set with relationships count.", "in": "query", "name": "include_custom_relationships_definitions", "schema": { "type": "boolean", "default": false } }, { "description": "Fetch Custom Column definition for reference dataset.", "in": "query", "name": "include_custom_column_def", "schema": { "type": "boolean", "default": false } }, { "description": "Fetch composite key for reference dataset.", "in": "query", "name": "include_composite_key", "schema": { "type": "boolean", "default": false } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'false'.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": false } }, { "description": "The maximum number of artifacts to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "versions": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "classifications": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent_category": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "parent_id": "303ed1d2-0885-473e-9050-40f9223549d5", "parent_global_id": "TEMPLATE_303ed1d2-0885-473e-9050-40f9223549d5", "parent_name": "name_example", "parent_href": "/v3/categories/303ed1d2-0885-473e-9050-40f9223549d5", "parent_enabled": true, "child_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_global_id": "TEMPLATE_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_category_id": "303ed1d2-0885-473e-9050-40f9223549d5", "child_name": "rds_name1", "child_href": "/v4/reference_data/0d6412d5-fce8-4bb7-90c9-891bc3de5c4b/versions?status=ACTIVE", "relationship_type": "parent_category", "source_type": "reference_data", "target_type": "category", "description": "parent example", "reference_copy": false } } ] }, "categories": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "custom_relationships": [ { "definition_id": "44764021-0473-4e53-9653-802e5d705afb", "artifact_id": "51d324a5-d806-48e6-a3bc-472e8c854153", "name": "custom rel ", "related_artifact_types": [ "policy" ], "description": "description custom rel", "is_reversed": false, "read_only": false, "total_count": 10 } ], "custom_columns": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ], "composite_key": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ], "rds_values_total_counts": 1, "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataSetResponseListV4" } } }, "description": "The reference data set has been retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set with given {guid} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieve a reference data set with given artifact_id and status", "tags": [ "Reference data sets" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}": { "delete": { "description": "Delete the reference data set with a given artifact_id and version_id. If the artifact is published then a workflow will be started with a draft created with label marked for deletion which on approval will result in a actual delete. If the artifact is a draft copy then the draft copy will be deleted from the system.", "operationId": "delete_reference_data_set_by_id_1", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } }, { "description": "Specify new reference data parent artifact_id for children of reference data that is to be removed. If move_child_to is not set all reference data children become root objects.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "move_child_to", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "content": { "application/json": { "example": { "href": "/v4/reference_data_sets/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3Resource" } } }, "description": "The reference data set has been deleted successfully if workflow is disabled.
A draft version has been successfully created for deleting the published artifact." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set with given {guid} does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set is currently used in catalog assets, catalog asset columns, data governance rules or data governance policies." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Delete a reference data set with given artifact_id and version_id", "tags": [ "Reference data sets" ] }, "get": { "description": "This method will retrieve details of the specified reference data set.", "operationId": "get_reference_dataset_by_version_id", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "Fetch only the first page of every requested relationship.\nSize of the page is defined by limit.\nTo fetch other relationship pages call: /v4/reference_data_sets/{artifact_id}/versions/{version_id}/relationships.\nComma-separated list of relationship types.
Available types:
parent_category
categories
terms
classifications
data_classes
rules
child
parent
all
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "description": "Text value", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Fetch custom relationships definitions for reference data set with relationships count.", "in": "query", "name": "include_custom_relationships_definitions", "schema": { "type": "boolean", "default": false } }, { "description": "Fetch Custom Column definition for reference dataset.", "in": "query", "name": "include_custom_column_def", "schema": { "type": "boolean", "default": false } }, { "description": "Fetch composite key for reference dataset.", "in": "query", "name": "include_composite_key", "schema": { "type": "boolean", "default": false } }, { "description": "If this parameter is set to true, then all artifact custom attributes are returned. If parameter is not set its default value is 'false'.", "in": "query", "name": "include_custom_attributes", "schema": { "type": "boolean", "default": false } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "classifications": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent_category": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "parent_id": "303ed1d2-0885-473e-9050-40f9223549d5", "parent_global_id": "TEMPLATE_303ed1d2-0885-473e-9050-40f9223549d5", "parent_name": "name_example", "parent_href": "/v3/categories/303ed1d2-0885-473e-9050-40f9223549d5", "parent_enabled": true, "child_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_global_id": "TEMPLATE_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "child_category_id": "303ed1d2-0885-473e-9050-40f9223549d5", "child_name": "rds_name1", "child_href": "/v4/reference_data/0d6412d5-fce8-4bb7-90c9-891bc3de5c4b/versions?status=ACTIVE", "relationship_type": "parent_category", "source_type": "reference_data", "target_type": "category", "description": "parent example", "reference_copy": false } } ] }, "categories": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "parent": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "resources": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "relationship_type": "related, value_to_term, etc", "reference_copy": false } } ] }, "custom_relationships": [ { "definition_id": "44764021-0473-4e53-9653-802e5d705afb", "artifact_id": "51d324a5-d806-48e6-a3bc-472e8c854153", "name": "custom rel ", "related_artifact_types": [ "policy" ], "description": "description custom rel", "is_reversed": false, "read_only": false, "total_count": 10 } ], "custom_columns": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ], "composite_key": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ], "rds_values_total_counts": 1, "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } }, "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseReferenceDataSetV4" } } }, "description": "The reference data set has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set with given {guid} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieve a reference data set with given artifact_id and version_id", "tags": [ "Reference data sets" ] }, "patch": { "description": "Update a reference data set with given artifact id and version id
To remove description please specify: \"long_description\": null.\n", "operationId": "update_reference_data_set_1", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdatableReferenceDataSetEntityV4" } } }, "description": "The reference data set to be updated.
Fields omitted will be unchanged. For multi-valued attributes, like values and relationships, use the respective endpoints.", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "type, rule_type, etc": "TEXT, Governance, etc", "long_description": "string", "is_removed_long_description": false, "state": "PUBLISHED", "default_locale_id": "en-US", "reference_copy": false, "custom_attributes": [] } }, "schema": { "$ref": "#/components/schemas/GlossaryV3ResponseReferenceDataSetV4" } } }, "description": "The reference data set has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set with given {guid} does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set was modified by another user." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Update a reference data set with given artifact id and version id", "tags": [ "Reference data sets" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/custom_columns": { "post": { "description": "Create Custom Column definitions
\n
    \n
  • Allowed Custom Column definitions types: NUMBER, TEXT, DATE.
    • \n
  • If a column is a composite key, it must be mandatory.
    • \n
  • For NUMBER and TEXT types the default values for max_characters_count:\n
      \n
    • for a composite key column: 200,
      • \n
    • for a normal column: 2000.
      • \n
    \n
  • validator_rds_id must be an artifact id of a published RDS.
    • \n
\n", "operationId": "create_custom_column_definitions", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnsCreateRequest" } } } }, "responses": { "201": { "content": { "application/json": { "example": { "custom_columns": [ { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3CustomColumnCreateResponse" } } }, "description": "The Custom Column(s) have been created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "UniqueConstraintViolation - Custom Column definition with given name already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Create Custom Column definitions", "tags": [ "Reference data sets" ], "x-codegen-request-body-name": "request" } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/custom_columns/{column_id}": { "delete": { "description": "Delete a Custom Column definition by column_id", "operationId": "delete_custom_column_definition", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The column id associated with Custom Column definition.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "column_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "204": { "description": "The Custom Column definition has been deleted successfully with specified column_id." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Delete a Custom Column definition by column_id", "tags": [ "Reference data sets" ] }, "get": { "description": "Retrieve a Custom Column definition with given column_id", "operationId": "get_custom_column_definitions_by_id", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The column id associated with Custom Column definition.", "in": "path", "name": "column_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "id": "8b047b17-8e31-4382-be19-e873d46d32a8", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "created_at": "2017-02-15T02:30:32.000Z", "created_by": "IBMid-1234567ABC", "revision": "0" }, "entity": { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false } }, "schema": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnsGetResponse" } } }, "description": "Custom Column definition with given column_id has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The Custom Column definition with given {column_id} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieve a Custom Column definition with given column_id", "tags": [ "Reference data sets" ] }, "patch": { "description": "Update Custom Column properties with given column_id
To remove RDS validator please specify: \"validator_rds_id\": null.\n
To remove description please specify: \"description\": null.\n", "operationId": "update_custom_column_definition", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The column id associated with Custom Column definition.", "in": "path", "name": "column_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnUpdatableEntity" } } }, "description": "Custom Column properties to be updated.
Properties mandatory, max_character_count and validator_rds_id can be changed only when owner (reference data) has no values assigned yet.", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "id": "a98edac9-4953-431e-9f8e-d9f1507454d8", "revision": "0", "name": "Custom_Column_Name", "description": "This is a Custom Column", "type": "TEXT", "max_character_count": 2000, "mandatory": true, "composite_key": true, "owner_rds_id": "9ec35f22-db7f-56c9-8a05-25983e485adc", "validator_rds_id": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "hidden": false }, "schema": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnResponse" } } }, "description": "The Custom Column definition has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The Custom Column definition with given {column_id} does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The Custom Column was modified by another user." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Update Custom Column properties with given column_id", "tags": [ "Reference data sets" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/relationships": { "get": { "description": "If the result set is larger than the limit parameter, it returns the first limit number of relationships.
To retrieve the next set of relationships, call the method again by using the URI in the property next returned by this method.", "operationId": "list_relationships_for_reference_data_set_1", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The relationship type for reference data set.
Available types:
parent_category
categories
terms
classifications
data_classes
rules
child
parent
custom
all
", "in": "query", "name": "type", "schema": { "type": "string", "default": "all", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "Custom relationship definition Id.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "ca_definition_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Is custom relationship reversed?", "in": "query", "name": "is_reversed", "schema": { "type": "boolean", "default": false } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Index of the beginning of the page. The offset value can be 0 (zero) or a multiple of limit value.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } }, { "description": "If this parameter is set, then all ancestors in the hierarchy are returned. You can use this parameter to build complete ancestor path.", "in": "query", "name": "all_parents", "schema": { "type": "boolean", "default": false } }, { "description": "Retrieves target parent category name of the relationship entity.", "in": "query", "name": "include_target_parent_category_name", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "content": { "application/json": { "example": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_global_id": "867907bd-4c80-458d-9e75-c5683e013533_6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "target_parent_category_id": "e39ada11-8338-3704-90e3-681a71e7c839", "target_parent_category_name": "parent_category_name_example", "target_name": "name_example", "target_effective_start_date": "2022-02-14T13:16:49.355Z", "target_effective_end_date": "2022-02-15T14:16:49.355Z", "source_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "source_type": "reference_data,reference_data_value, etc", "target_type": "glossary_term, reference_data, category, etc", "description": "string", "type": "parent_category", "reference_copy": false } } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "List the relationships of the given type for the specified reference data set", "tags": [ "Reference data sets" ] }, "post": { "description": "Associate Reference data set identified by artifact_id and version_id with other governance artifacts", "operationId": "create_relationships_to_reference_data_set", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataSetRelationshipsV4" } } }, "description": "list of relationships that need to created for reference data set", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "terms": [ { "relationship_id": "fdbf64ed-8d72-43b8-8752-8b765db51e01", "target_id": "4ce5b4d5-611e-4607-8e18-e2a7d9abbfe7" } ], "classifications": [], "categories": [ { "relationship_id": "eca11f9e-ff14-4692-ad93-35eb364f9f23", "target_id": "166a5f6b-3f42-4706-b868-92f622d5094a" } ], "child": [ { "relationship_id": "382c8bfa-5c2f-4daf-ac6e-b625119b1c6f", "target_id": "eec1c2a4-8bc1-40a6-a557-49af6ab2675d" } ], "parent": [], "parent_category": { "relationship_id": "18d9732c-f1b9-4325-bbf6-7d318e093263", "target_id": "4cdd7c5f-bc32-4d94-bb75-0344a6f93052" }, "href": "string", "artifact_id": "0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "version_id": "cf6243fb-7d5c-4aba-9f50-887919bf08be", "workflow_id": "52f149f8-c15c-40a9-a7ec-7e1d2635a1a1", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0d6412d5-fce8-4bb7-90c9-891bc3de5c4b", "entity_type": "reference_data", "custom_relationships": { "custom_relationship_definition_id": [ { "relationship_id": "fdbf64ed-8d72-43b8-8752-8b765db51e01", "target_id": "4ce5b4d5-611e-4607-8e18-e2a7d9abbfe7" } ] } }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateRelationshipResponseV4" } } }, "description": "Relationships created for reference data set" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Relationships conflicting for reference data set" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Associate Reference data set identified by artifact_id and version_id with other governance artifacts", "tags": [ "Reference data sets" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/relationships/{relationship_id}": { "delete": { "description": "Delete the relationship associated to reference data set with specified artifact_id and version_id", "operationId": "delete_reference_data_set_relationship", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "href": "/v4/reference_data_sets/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryResource" } } }, "description": "The reference data set relationship has been deleted successfully if workflow is disabled.
A draft version has been successfully created for deleting the published artifact." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "relationship not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Delete the relationship associated to reference data set with specified artifact_id and version_id", "tags": [ "Reference data sets" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_imports": { "post": { "description": "Import reference data values from csv file to the reference data set with specified artifact_id and version_id
To check the current status\nof the import please use the endpoint GET /v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_imports/{import_id}.\n", "operationId": "add_imported_values_to_reference_data_set", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/GlossaryV3RDVImportRequest" } } }, "description": "Input data for reference data value import: import file and parameters.", "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "value_import": { "href": "Url value", "import_id": "d3516e0e-3775-498c-ba32-ce8fb0863376", "import_state": "SUCCEEDED, CANCELLED, IN_PROGRESS, etc", "import_message": "Import Completed, Import Cancelled, Import in progress, etc", "values_count": 1000, "values_processed": 1000, "values_skipped": 0, "values_inserted": 1000, "rels_values_processed": 1000, "rels_processed": 412, "rels_inserted": 400, "rels_skipped": 2, "rels_deleted": 10, "started_by": "IBMid-1234567ABC", "start_time": "2021-02-18T02:30:32.000Z", "warnings_count": 2, "warnings": [ { "row": 3, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code IT and artifactId ca72921f-1064-4aa4-b4bd-bc66405cdde4 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by CAN that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] }, { "row": 4, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code AUS and artifactId 6e3fe150-c648-4d8f-8519-2298379ea777 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by PAK that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] } ] }, "href": "v4/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3RDVImportInfoResponseV4" } } }, "description": "The reference data values import has been initiated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Import reference data values from csv file to the reference data set with specified artifact_id and version_id", "tags": [ "Reference data values" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_imports/{import_id}": { "delete": { "description": "Request cancellation of a ongoing reference data values import process with specified import_id", "operationId": "delete_import_values_to_reference_data_set", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The import id for the reference data values import process.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "import_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "204": { "description": "Cancel Request Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Request cancellation of a ongoing reference data values import process with specified import_id", "tags": [ "Reference data values" ] }, "get": { "description": "Get current state of reference data values import process with specified import_id", "operationId": "get_status_of_import_values_to_reference_data_set", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The import id for the reference data values import process.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "import_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } ], "responses": { "200": { "content": { "application/json": { "example": { "value_import": { "href": "Url value", "import_id": "d3516e0e-3775-498c-ba32-ce8fb0863376", "import_state": "SUCCEEDED, CANCELLED, IN_PROGRESS, etc", "import_message": "Import Completed, Import Cancelled, Import in progress, etc", "values_count": 1000, "values_processed": 1000, "values_skipped": 0, "values_inserted": 1000, "rels_values_processed": 1000, "rels_processed": 412, "rels_inserted": 400, "rels_skipped": 2, "rels_deleted": 10, "started_by": "IBMid-1234567ABC", "start_time": "2021-02-18T02:30:32.000Z", "warnings_count": 2, "warnings": [ { "row": 3, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code IT and artifactId ca72921f-1064-4aa4-b4bd-bc66405cdde4 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by CAN that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] }, { "row": 4, "info": [ "WKCBG3092E: Cannot create a relationship between reference data value with code AUS and artifactId 6e3fe150-c648-4d8f-8519-2298379ea777 that is associated with reference data set with id e4256b89-dfc6-4b53-bffa-ee72f4c4a93d and reference data value represented by PAK that is associated with reference data set with versionId e378b0cb-89cb-4b3b-a9aa-006c914ae427. The latter reference data value does not exist." ] } ] }, "href": "v4/reference_data/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3RDVImportInfoResponseV4" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Get current state of reference data values import process with specified import_id", "tags": [ "Reference data values" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_relationships": { "post": { "description": "Creates relationships for reference data values", "operationId": "create_relationships_to_reference_data_values", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValuesRelationshipsRequestV4" } } } }, "responses": { "201": { "content": { "application/json": { "example": { "value_relationships": [ { "artifact_id": "1f492a25-b3c2-5d73-b0c0-a6133d985bb3", "terms": [ { "relationship_id": "d5e5ba23-ee69-47f1-beb3-b09d29374455", "target_id": "6a8f8630-5cff-4c42-a8f9-1f24371ad80c" } ], "child": [ "1f492a25-b3c2-5d73-b0c0-a6133d985bb5" ] } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateRdvRelationshipsResponseV4" } } }, "description": "Relationships created for reference data values" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Relationships conflicting for reference data value" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates relationships for reference data values", "tags": [ "Reference data values" ], "x-codegen-request-body-name": "request" } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_relationships/{rdv_artifact_id}": { "get": { "description": "Retrieve a reference data value relationships with given reference data set artifact_id and version_id and reference data value artifact_id", "operationId": "get_rdv_relationships", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": ".*" } }, { "description": "The artifact id of reference data value.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "rdv_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Only one relationship type can be selected.
Available types:
terms
parent_hierarchy
child
single_value_mappings
multi_value_mappings
value_mappings
", "in": "query", "name": "type", "required": true, "schema": { "type": "string", "enum": [ "terms", "parent_hierarchy", "child", "single_value_mappings", "multi_value_mappings", "value_mappings" ] } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "The index of the first matching relationship to include in the result.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json": { "example": { "parent": { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] }, "parent_hierarchy": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ], "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ] }, "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "single_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "multi_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] } }, "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueDetailsV4" } } }, "description": "The reference data value relationships has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set with given {guid} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieve a reference data value relationships with given reference data set artifact_id and version_id and reference data value artifact_id", "tags": [ "Reference data values" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/value_search": { "post": { "description": "Search for reference data value(s) details with given RDS artifact_id and version_id using specific code or text value filter
Possible values for code_filter: CODE_EQUALS, CODE_OR_VALUE_CONTAINS,\nCODE_STARTS_WITH.
\nThe include_relationships is a comma-separated list of relationship types for reference data value
\n
Available types:
terms
parent_hierarchy
child
single_value_mappings
multi_value_mappings
value_mappings
", "operationId": "search_reference_data_values", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RDVSearchParameters" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "value_search": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_columns_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "parent": { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] }, "parent_hierarchy": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ], "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ] }, "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "single_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "multi_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] } } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValuesSearchResponseListV4" } } }, "description": "The reference data value(s) details have been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set with given {guid} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Search for reference data value(s) details with given RDS artifact_id and version_id using specific code or text value filter", "tags": [ "Reference data values" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/values": { "get": { "description": "Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids", "operationId": "list_reference_data_values", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "Comma-separated list of artifact ids of reference data values. If not provided, all values of given reference data set will be returned.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4,3b5da5ed-8049-423f-848a-3844a6d88ff8", "in": "query", "name": "rdv_artifact_ids", "schema": { "type": "string", "maxLength": 5120, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" } }, { "description": "Comma-separated list of relationship types for reference data value.
Available types:
terms
parent_hierarchy
child
single_value_mappings
multi_value_mappings
value_mappings
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "enum": [ "terms", "parent_hierarchy", "child", "single_value_mappings", "multi_value_mappings", "value_mappings" ] } }, { "description": "Fetch parent reference data details for reference data set values.", "in": "query", "name": "include_parent_value_details", "schema": { "type": "boolean" } }, { "description": "Fetch custom column values for reference data set values.", "in": "query", "name": "include_custom_column_values", "schema": { "type": "boolean" } }, { "description": "Fetch root values (values with no parent assigned) for reference data set.", "in": "query", "name": "roots_only", "schema": { "type": "boolean" } }, { "description": "The maximum number of hierarchy children to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "The index of the first matching hierarchy children to include in the result.", "in": "query", "name": "offset", "schema": { "type": "integer", "format": "int32" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "relationship_limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } }, { "description": "Value on which results need to be sorted, currently only CODE is supported.Prefix hyphen (-) for descending order, applicable only for reference data values search.", "example": "-CODE", "in": "query", "name": "sort", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": ".*" } } ], "responses": { "200": { "content": { "application/json": { "example": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "values": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_columns_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "parent": { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] }, "parent_hierarchy": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ], "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ] }, "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "single_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "multi_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] } } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValuesGetResponseListV4" } } }, "description": "The reference data value(s) details have been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set or value with given id does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids", "tags": [ "Reference data values" ] }, "patch": { "description": "Remove or update reference data values for the specified reference data set", "operationId": "update_or_delete_values_in_reference_dataset", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GlossaryV3RdvJsonPatch" } } }, "description": "Valid Json-patch body with either delete or replace operations.
Note: Precision will be lost if long value has more than 15-16 digits as JSON parser will map to double type regardless of whether it is used for integer, long or floating-point numbers. To Preserve all digits pass the value as a string.", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "values": [ { "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_column_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "code": "example", "value": "string", "description": "This is an RDS Value example", "revision": "0", "parent_value_artifact_id": "4a236376-6426-423f-82ba-b02201e82238", "artifact_id": "4a236376-6426-423f-82ba-b02201e8223b" } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateUpdateMultipleRDVsResponseV4" } } }, "description": "The reference data value(s) have been added and/or updated and/or deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Reference data value with given code already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Remove or update reference data values for the specified reference data set", "tags": [ "Reference data values" ] }, "post": { "description": "Add reference data value to the specified reference data set", "operationId": "create_reference_data_value", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3NewReferenceDataValueEntityV4" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "value": { "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_column_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "code": "example", "value": "string", "description": "This is an RDS Value example", "revision": "0", "parent_value_artifact_id": "4a236376-6426-423f-82ba-b02201e82238", "artifact_id": "4a236376-6426-423f-82ba-b02201e8223b" }, "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateUpdateMultipleRDVsResponseV4" } } }, "description": "The reference data value(s) have been added successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Reference data value with given composite key already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Add reference data value to the specified reference data set", "tags": [ "Reference data values" ] }, "put": { "description": "Add or update reference data values for the specified reference data set", "operationId": "create_update_reference_data_values", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3CreateUpdateReferenceDataValuesListV4" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "values": [ { "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_column_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "code": "example", "value": "string", "description": "This is an RDS Value example", "revision": "0", "parent_value_artifact_id": "4a236376-6426-423f-82ba-b02201e82238", "artifact_id": "4a236376-6426-423f-82ba-b02201e8223b" } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateUpdateMultipleRDVsResponseV4" } } }, "description": "The reference data values have been added and/or updated successfully." }, "201": { "content": { "application/json": { "example": { "values": [ { "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_column_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "code": "example", "value": "string", "description": "This is an RDS Value example", "revision": "0", "parent_value_artifact_id": "4a236376-6426-423f-82ba-b02201e82238", "artifact_id": "4a236376-6426-423f-82ba-b02201e8223b" } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateUpdateMultipleRDVsResponseV4" } } }, "description": "The reference data value(s) have been added successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Reference data value with given composite key already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Add or update reference data values for the specified reference data set", "tags": [ "Reference data values" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/export": { "get": { "description": "Exports values of a specified reference data set with specified artifact_id and version_id to a csv file
Only Code, Value and Composite Key columns will be exported by default, use parameters to export additional properties.", "operationId": "export_reference_data_set_values_csv_by_id", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "Export reference data values code and composite key only. Note: If composite key is not defined, only code will be exported.", "in": "query", "name": "composite_key_only", "schema": { "type": "boolean", "default": false } }, { "description": "Export reference data value description.", "in": "query", "name": "include_description", "schema": { "type": "boolean", "default": false } }, { "description": "Comma-separated list of custom column definition artifact ids. Use all to export all custom column definition values.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4,3b5da5ed-8049-423f-848a-3844a6d88ff8", "in": "query", "name": "include_custom_column_def_artifact_ids", "schema": { "type": "string", "maxLength": 5120, "minLength": 36, "pattern": "(^all$|(([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*))" } }, { "description": "Export reference data value parent.", "in": "query", "name": "include_parent_value", "schema": { "type": "boolean", "default": false } }, { "description": "Comma-separated list of relationship types for reference data value.
Available types:
terms
value_mappings
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "enum": [ "terms", "value_mappings" ] } }, { "description": "Export additional column representing reference data physical key (code + composite key values), columns are delimited with '|'.", "in": "query", "name": "include_physical_key", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "content": { "application/octet-stream": { "example": "\"code\",\"value\",\"description\",\"parent\",\"related terms\",\"is_multi_mapped_to_rds02\",is_multi_mapped_to_rds03\",\"is_single_mapped_to_rds01\"\n\"CODE_EXAMPLE_005B\",\"value B\",\"string\",,,,,\n\"CODE_EXAMPLE_005C\",\"value C\",\"string\",\"CODE_EXAMPLE_005B\",\" >> myterm001\",\"CODE_EXAMPLE_002|CC1\",\"CODE_EXAMPLE_003|CC2\",\"CODE_EXAMPLE_001\"\n\"CODE_EXAMPLE_005A\",\"value A\",\"string\",\"CODE_EXAMPLE_005C\",,,,", "schema": { "type": "string", "format": "binary", "description": "Schema for reference data values" } } }, "description": "The reference data set has been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set with given {guid} does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Exports values of a specified reference data set with specified artifact_id and version_id to a csv file", "tags": [ "Reference data values" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id}": { "delete": { "description": "Delete the reference data value identified by its artifact id in the Reference Data Set with specified artifact_id and version_id. If the reference data set is published then a workflow will be started with a draft created from which the value will be deleted. If the artifact is a draft copy then the value from the draft copy will be removed.", "operationId": "delete_reference_data_value", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The artifact id of reference data value.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "rdv_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Specifies behavior when deleted reference data value has children. Options are:
  • root - make them root values
  • immediate_parent - move them to the parent of deleted value
  • other_value - move them to specified value (you have to specify it in target_value_artifact_id parameter)
", "in": "query", "name": "move_child_to", "schema": { "type": "string", "enum": [ "immediate_parent", "root", "other_value" ] } }, { "description": "Target reference data value (to become parent for children of deleted one) artifact id (note: it has to \"belong\" to same reference data set as deleted value", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "query", "name": "target_value_artifact_id", "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "href": "/v4/reference_data_sets/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryResource" } } }, "description": "The reference data value has been deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set or value with given id does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data value is currently used in catalog assets, catalog asset columns, data governance rules or data governance policies." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Delete the reference data value identified by its artifact id in the Reference Data Set with specified artifact_id and version_id", "tags": [ "Reference data values" ] }, "get": { "description": "Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids", "operationId": "get_reference_data_value", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The artifact id of reference data value.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "rdv_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "Fetch custom column values for reference data set values.", "in": "query", "name": "include_custom_column_values", "schema": { "type": "boolean" } }, { "description": "Comma-separated list of relationship types for reference data value.
Available types:
terms
parent_hierarchy
child
single_value_mappings
multi_value_mappings
value_mappings
", "in": "query", "name": "include_relationship", "schema": { "type": "string", "enum": [ "terms", "parent_hierarchy", "child", "single_value_mappings", "multi_value_mappings", "value_mappings" ] } }, { "description": "Fetch parent reference data details for reference data set values.", "in": "query", "name": "include_parent_value_details", "schema": { "type": "boolean" } }, { "description": "The maximum number of relationship to return - must be at least 1 and cannot exceed 200. The default value is 10.", "in": "query", "name": "relationship_limit", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 200, "minimum": 1 } } ], "responses": { "200": { "content": { "application/json": { "example": { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_columns_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "parent": { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] }, "parent_hierarchy": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ], "child": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "code": "0011", "description": "Forestry, Fishing and Hunting", "value": "Agriculture", "parent_value_artifact_id": "9622cd91-838c-5cb7-8fce-e7f0407d0440", "has_children": true, "revision": "0", "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ] } ] }, "terms": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "single_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "multi_value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] }, "value_mappings": { "offset": 90, "last": { "href": "string", "offset": 270 }, "prev": { "href": "string", "offset": 60 }, "set_uri": true, "limit": 30, "count": 300, "first": { "href": "string", "offset": 0 }, "next": { "href": "string", "offset": 120 }, "relationships": [ { "metadata": { "artifact_type": "glossary_term", "artifact_id": "d109503d-06c3-46b2-b1e7-95482a143d0a", "version_id": "58cfecc6-7182-4665-9dc5-4f030238c106_0", "source_repository_id": "867907bd-4c80-458d-9e75-c5683e013533", "source_repository_name": "repository name", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_d109503d-06c3-46b2-b1e7-95482a143d0a", "workflow_id": "d3a36017-f4b3-4488-b49c-85b08fdce499", "draft_ancestor_id": "971798d5-7d11-4b4f-833c-f1dbac63b126", "effective_start_date": "2021-07-26T12:37:03.919Z", "effective_end_date": "2021-07-29T10:37:03.919Z", "created_by": "IBMid-1234567ABC", "created_at": "2017-02-15T02:30:32.000Z", "modified_by": "IBMid-1234567ABC", "modified_at": "2017-02-15T02:30:32.000Z", "revision": "0", "name": "artifact name", "state": "PUBLISHED", "tags": [ "tag1", "tag2" ], "steward_ids": [ "IBMid-1234567ABC" ], "workflow_state": "DRAFT", "read_only": false, "remove_start_date": false, "remove_end_date": false }, "entity": { "target_id": "6d5b4c71-18f5-416f-bb4f-4929d2d48c4f", "additional_info": { "rds_id": "1a4db093-9305-433b-bc22-ca2373131acc", "rds_value": "{string}", "rds_version_id": "ac0543b3-4fd6-4480-8885-64471811ee1e", "rds_value_description": "string" }, "source_id": "b710c60f-4c29-5f48-bb99-431aad664cc3", "relationship_type": "is_multi_mapped_to, is_single_mapped_to, is_child_of", "source_type": "reference_data_value", "target_type": "reference_data_value", "reference_copy": false } } ] } }, "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueDetailsV4" } } }, "description": "The reference data value(s) details have been retrieved successfully." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "The reference data set or value with given id does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Retrieve reference data value(s) details with given RDS artifact_id and version_id and for specific reference data value artifact_ids", "tags": [ "Reference data values" ] }, "patch": { "description": "Update reference data value in the specified reference data set
\nTo remove parent RDV please specify: \"parent_value_artifact_id\": null.\n", "operationId": "update_reference_data_value_1", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The artifact id of reference data value.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "rdv_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3UpdateReferenceDataValueEntityV4" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "value": { "composite_key_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "custom_column_values": [ { "id": "c10eb10f-3ab7-4307-a791-bfd10efe0aa3", "value": "custom column value" } ], "code": "example", "value": "string", "description": "This is an RDS Value example", "revision": "0", "parent_value_artifact_id": "4a236376-6426-423f-82ba-b02201e82238", "artifact_id": "4a236376-6426-423f-82ba-b02201e8223b" }, "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateUpdateMultipleRDVsResponseV4" } } }, "description": "The reference data value has been updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Reference data value with given composite key already exists." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Update reference data value in the specified reference data set", "tags": [ "Reference data values" ] } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id}/value_relationships": { "post": { "description": "Creates relationships for reference data value", "operationId": "create_relationships_to_reference_data_value", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The artifact id of reference data value.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "rdv_artifact_id", "required": true, "schema": { "type": "string", "description": "Text value", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, { "description": "If workflow template configuration permits, the artifact will be created in the published state by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "example": { "child": [ "1f492a25-b3c2-5d73-b0c0-a6133d985bb" ], "multi_value_mappings": [ { "rds_artifact_id": "990e33f5-3108-4d45-a530-0307458362d4", "rdv_artifact_ids": [ "4fb86a70-7035-4b3e-8825-137c7b9b1687" ] } ], "single_value_mappings": [ { "rds_artifact_id": "990e33f5-3108-4d45-a530-0307458362d4", "rdv_artifact_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687" } ], "terms": [ { "id": "1f492a25-b3c2-5d73-b0c0-a6133d985bb3" } ] }, "schema": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueRelationshipsRequestV4" } } } }, "responses": { "201": { "content": { "application/json": { "example": { "value_relationships": [ { "artifact_id": "1f492a25-b3c2-5d73-b0c0-a6133d985bb3", "terms": [ { "relationship_id": "d5e5ba23-ee69-47f1-beb3-b09d29374455", "target_id": "6a8f8630-5cff-4c42-a8f9-1f24371ad80c" } ], "child": [ "1f492a25-b3c2-5d73-b0c0-a6133d985bb5" ] } ], "href": "string", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3CreateRdvRelationshipsResponseV4" } } }, "description": "Relationships created for reference data value" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Relationships conflicting for reference data set" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Creates relationships for reference data value", "tags": [ "Reference data values" ], "x-codegen-request-body-name": "request" } }, "/v4/reference_data_sets/{artifact_id}/versions/{version_id}/values/{rdv_artifact_id}/value_relationships/{relationship_id}": { "delete": { "description": "Delete the relationship associated to reference data value identified by its artifact id in the Reference Data Set with specified artifact_id and version_id", "operationId": "delete_reference_data_value_relationship_1", "parameters": [ { "description": "The artifact id of the reference data set.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The version id of the reference data set or specify ACTIVE (it represents a current active published version) or PUBLISHED (it represents a published version that is active now or will be active in the future).", "example": "990e33f5-3108-4d45-a530-0307458362d4_0", "in": "path", "name": "version_id", "required": true, "schema": { "type": "string", "maxLength": 40, "minLength": 6, "pattern": "^(([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?|CURRENT|PUBLISHED|ACTIVE)$" } }, { "description": "The artifact id of reference data value.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "rdv_artifact_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "The artifact ID of the relationship to be deleted.", "example": "aa0e33f5-3108-4d45-a530-0307458362d4", "in": "path", "name": "relationship_id", "required": true, "schema": { "type": "string", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, { "description": "If workflow template configuration permits, the published artifact will be deleted by skipping the workflow. For details refer to documentation.", "in": "query", "name": "skip_workflow_if_possible", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "example": { "href": "/v4/reference_data_sets/0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6/versions/4fb86a70-7035-4b3e-8825-137c7b9b1687", "artifact_id": "0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "version_id": "4fb86a70-7035-4b3e-8825-137c7b9b1687", "workflow_id": "56b82aa1-0f3c-4e2c-84bf-bee619c84c7f", "global_id": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "entity_type": "reference_data" }, "schema": { "$ref": "#/components/schemas/GlossaryV3GlossaryResource" } } }, "description": "Deleted the relationship" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "relationship not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryV3ErrorContainerV3" } } }, "description": "Internal Server Error" } }, "summary": "Delete the relationship associated to reference data value identified by its artifact id in the Reference Data Set with specified artifact_id and version_id", "tags": [ "Reference data values" ] } }, "/v2/jobs": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "get": { "tags": [ "Jobs" ], "summary": "Get list of jobs under a project or a space.", "description": "Lists the jobs in the specified project or space (either project_id or space_id must be set).", "operationId": "jobs_list", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "asset_ref", "in": "query", "description": "Optionally get all jobs associated with a particular asset.", "schema": { "type": "string" } }, { "name": "asset_ref_type", "in": "query", "description": "Optionally get all jobs associated with the particular asset ref type.", "schema": { "type": "string" } }, { "name": "run_id", "in": "query", "description": "The ID of the job run. Can be used to search parent job of a job run", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limit of the number of items to return, for example limit=50. If not specified a default of 100 will be used.", "schema": { "type": "integer", "format": "int64", "default": 100 } }, { "name": "next", "in": "query", "description": "The optional 'next' field from the response in string format, can be used to get the next batch.\nThe response can contain up to 200 results in a batch, if there are more results, a 'next' field is returned in the response which can be used to get the next batch.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsListJobResponse" } } } }, "400": { "description": "Bad request. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "The resources you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Jobs" ], "summary": "Create a new job.", "description": "Creates a new job in the specified project or space (either project_id or space_id must be set).", "operationId": "jobs_create", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } } ], "requestBody": { "description": "The job to be created. Note: either asset_ref or asset_ref_type must be provided, not both.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJobPostBody" } } }, "required": true }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJob" } } } }, "400": { "description": "Bad request. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "x-codegen-request-body-name": "body" } }, "/v2/jobs/{job_id}": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "get": { "tags": [ "Jobs" ], "summary": "Get the information of job identified by the ID.", "description": "Gets the info for a single job associated from the specified project or space (either project_id or space_id must be set).", "operationId": "jobs_get", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJob" } } } }, "400": { "description": "Bad request. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "The resources you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "Jobs" ], "summary": "Delete a specific job.", "description": "Deletes a specific job in a project or space (either project_id or space_id must be set).\nIf the deletion of the job and its runs will take some time to finish, then a 202 response will be returned and the deletion will continue asynchronously. All the jobs runs associated with the job will also be deleted.\nIf the job is still running, it will not be deleted.", "operationId": "jobs_delete", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The requested operation completed successfully.", "content": {} }, "400": { "description": "Bad request. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "The resources you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "patch": { "tags": [ "Jobs" ], "summary": "Update information of a job.", "description": "Updates specific attributes of a job in the specified project or space (either project_id or space_id must be set).\nYou must specify the updates by using the JSON patch format, described in RFC 6902.", "operationId": "jobs_update", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updates to make to the job run.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJSONJobPatchModel" } } }, "required": true }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJob" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "The resources you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "x-codegen-request-body-name": "body" } }, "/v2/jobs/serving_name/{serving_name}": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "get": { "tags": [ "Jobs" ], "summary": "Get the availability of a given serving_name", "description": "Gets the availability of a given serving_name, as serving_name must be globally unique. serving_name must be a combination of alphanumeric and underscore characters, and must be between 1 and 36 characters.", "operationId": "jobs_serving_name", "parameters": [ { "name": "serving_name", "in": "path", "description": "The serving_name value of the job to be used in place of the job ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsServingName" } } } }, "400": { "description": "Bad request. See the error message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/v2/jobs/{job_id}/runs": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "get": { "tags": [ "Job Runs" ], "summary": "Get list of runs of a job.", "description": "Lists the job runs for a specific job in the specified project or space (either project_id or space_id must be set).\nOnly the metadata and certain elements of the entity component of each run are returned.", "operationId": "job_runs_list", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "description": "The optional 'next' field from the response in string format, can be used to get the next batch.\nThe response can contain up to 200 results in a batch, if there are more results, a 'next' field is returned in the response which can be used to get the next batch.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limit of the number of items to return, for example limit=50. If not specified a default of 100 will be used.", "schema": { "type": "integer", "format": "int64", "default": 100 } }, { "name": "states", "in": "query", "description": "A list of comma-separated job run states.\nAvailble values: Completed, Failed, Canceled, Starting, Running, Queued, Canceling, Paused, Resuming, CompletedWithWarnings, CompletedWithErrors", "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobsJobRunState" } } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsListJobRunResponse" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Job Runs" ], "summary": "Start a run for a job.", "description": "Starts the specified job contained in a project or space (either project_id or space_id must be set).", "operationId": "job_runs_create", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The configuration of the job run to use. If not provided, use the configuration of the associated job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJobRunPostBody" } } }, "required": true }, "responses": { "201": { "description": "The requested operation completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJobRun" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "x-codegen-request-body-name": "body" } }, "/v2/jobs/{job_id}/runs/{run_id}": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "get": { "tags": [ "Job Runs" ], "summary": "Get a specific run of a job.", "description": "Gets the info for a single job run from the specified project or space (either project_id or space_id must be set).", "operationId": "job_runs_get", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "in": "path", "description": "The ID of the job run.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsJobRun" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "Job Runs" ], "summary": "Delete a run.", "description": "Delete the specified job run in a project or space (either project_id or space_id must be set).", "operationId": "job_runs_delete", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "in": "path", "description": "The ID of the job run.", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "The requested operation is in progress.", "content": {} }, "204": { "description": "The requested operation completed successfully.", "content": {} }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "404": { "description": "The resources you specified cannot be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/v2/jobs/{job_id}/runs/{run_id}/logs": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "get": { "tags": [ "Job Runs" ], "summary": "Retrieve runtime log of a run.", "description": "Gets the logs for a job run in the specified project or space (either project_id or space_id must be set)", "operationId": "job_runs_logs", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "in": "path", "description": "The ID of the job run.", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The limit of the number of lines to return, for example limit=50. If not specified, all log will be returned.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsLogsResponse" } } } }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/v2/jobs/{job_id}/runs/{run_id}/cancel": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "post": { "tags": [ "Job Runs" ], "summary": "Cancel a run.", "description": "Cancels a job run that is in the running state.", "operationId": "job_runs_cancel", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "in": "path", "description": "The ID of the job run.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "An empty body.", "content": { "application/json": { "schema": { "type": "object", "example": {} } } }, "required": true }, "responses": { "204": { "description": "The requested operation completed successfully.", "content": {} }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "x-codegen-request-body-name": "body" } }, "/v2/jobs/{job_id}/runs/{run_id}/pause": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "post": { "tags": [ "Job Runs" ], "summary": "Pause a run.", "description": "Pauses a job run that is in the running state.", "operationId": "job_runs_pause", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "in": "path", "description": "The ID of the job run.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "An empty body.", "content": { "application/json": { "schema": { "type": "object", "example": {} } } }, "required": true }, "responses": { "204": { "description": "The requested operation completed successfully.", "content": {} }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "x-codegen-request-body-name": "body" } }, "/v2/jobs/{job_id}/runs/{run_id}/resume": { "parameters": [ { "$ref": "#/components/parameters/Jobsuserfs" } ], "post": { "tags": [ "Job Runs" ], "summary": "Resume a run.", "description": "Resumes a job run that is in the paused state.", "operationId": "job_runs_resume", "parameters": [ { "name": "project_id", "in": "query", "description": "The ID of the project to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "space_id", "in": "query", "description": "The ID of the space to use. project_id or space_id is required.", "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "The ID of the job to use. Each job has a unique ID. Alternatively, the serving_name value can be used.", "required": true, "schema": { "type": "string" } }, { "name": "run_id", "in": "path", "description": "The ID of the job run.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "An empty body.", "content": { "application/json": { "schema": { "type": "object", "example": {} } } }, "required": true }, "responses": { "204": { "description": "The requested operation completed successfully.", "content": {} }, "401": { "description": "You are not authorized to access the service. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "403": { "description": "You are not permitted to perform this action. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "default": { "description": "An error occurred. See response for more information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } }, "x-codegen-request-body-name": "body" } }, "/v1/knowledge_accelerators/asset_assign_terms/status/{process_id}": { "get": { "tags": [ "Knowledge Accelerators" ], "summary": "Gets the status of assigning terms to the asset", "description": "Returns the high level status of the assignments made between a Model in a Catalog, e.g. a Logical Data Model, and Business Terms, including the total number of assignments to be done. The process may still be in progress and in that case a summary of how many assignments have been added will be returned", "operationId": "get_mappings_added", "parameters": [ { "name": "process_id", "in": "path", "description": "The process id returned by the corresponding POST endpoint.", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 40, "minLength": 30, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsProcessInfo" }, "examples": { "example": { "value": "{\"status\":\"in_progress\",\"process_id\":\"119b2ce9-3fff-4adb-ab8b-2c1a259daf50\",\"process_type\":\"asset_assign_terms\",\"tenant_id\":\"f8ddad357e47454eb562484f2f2f3c34\",\"user_name\":\"myname@mydomain.com\",\"start_time\":\"2023-11-08T09:34:56.171328500\",\"input_params\":{\"strategy\":\"industrymodel_ldm\",\"asset_id\":\"30ba5f82-13fb-4e68-977d-01a1f4e4fc58\",\"category_ids\":[],\"ldm_type\":\"bfmdw_awm\",\"term_matching_method\":\"id\",\"catalog_id\":\"e955a953-d57c-4d18-b2d3-220e24e2201a\"},\"log_messages\":[{\"level\":\"INFO\",\"message\":\"Getting entities and attributes for the logical model named Atomic Warehouse Model\"}]}" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -k -X GET 'https://{cpd_cluster_host}/v1/knowledge_accelerators/asset_assign_terms/status/{process_id}' -H 'accept: application/json' -H 'Authorization: Bearer {token}'" ] } ] } ] } } } }, "/v1/knowledge_accelerators/asset_assign_terms": { "post": { "tags": [ "Knowledge Accelerators" ], "summary": "Assigns terms to the asset using the specified strategy, for example industrymodels_ldm", "description": "For the Model in the Catalog specified by the user, this endpoint adds assignments between the Entities and Attributes in the model and the Business Terms that are supported by the assignments strategy.", "operationId": "post_add_assignment", "requestBody": { "description": "imput parameters in JSON format in Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsIndustryModelsLdmStrategy" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsNewProcessResponse" }, "examples": { "example": { "value": "{\"message\":\"The Business Term assignment on the asset has been submitted, check below process for update state\",\"process_href\":\"/v1/knowledge_accelerators/asset_assign_terms/status/019b2ce9-3fff-4adb-ab8b-2c1a259daf50\",\"process_id\":\"019b2ce9-3fff-4adb-ab8b-2c1a259daf50\"}" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "409": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-operations": " {\n \"request-examples\": {\n \"curl\": [\n {\n \"name\": \"Example request\",\n \"example\": [\n {\n \"type\": \"code\",\n \"source\": [\n\"curl -k -X POST 'https://{cpd_cluster_host}/v1/knowledge_accelerators/asset_assign_terms' -H 'accept: application/json' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{\n\"strategy\": {strategy},\n\"asset_id\": {asset_id},\n\"category_ids\": [{category1_id},{category2_id},{...}],\n\"ldm_type\": {ldm_type},\n\"term_matching_method\": {term_matching_method},\n\"catalog_id\": {catalog_id}\n}'\"\n ]\n }\n ]\n }\n ]\n }\n }\n" } }, "/v1/knowledge_accelerators/{ka_id}/copy_items": { "post": { "tags": [ "Knowledge Accelerators" ], "summary": "Copy Knowledge Accelerator items into project", "description": "Copy the specified Knowledge Accelerator items into specified IKC project. ", "operationId": "copy_ka_into_ikc", "parameters": [ { "name": "ka_id", "in": "path", "description": "The Knowledge Accelerator id", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 7, "minLength": 4, "type": "string" } }, { "name": "ids", "in": "query", "description": "A comma separated list of the item ids of the Knowledge Accelerator to copy.", "required": true, "style": "form", "explode": false, "schema": { "maxLength": 200, "minLength": 2, "type": "string" } }, { "name": "project_id", "in": "query", "description": "The id of the project where the items are copied to", "required": true, "style": "form", "explode": false, "schema": { "maxLength": 100, "minLength": 10, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKACopyResponse" }, "examples": { "example": { "value": "{\"message\":\"The copy has been executed, please check details below for status\",\"knowledge_accelerator\":\"https://api.dataplatform.cloud.ibm.com/v1/knowledge_accelerators/kaeu20\",\"items\":[{\"item_id\":\"base\",\"data_assets\":[{\"name\":\"kaeu20-base-2.0.20230726.zip\",\"url\":\"https://api.dataplatform.cloud.ibm.com/v2/data_assets/b43ddf6d-bb52-4df2-9d55-c7713a2bbadd?project_id=e304ce63-8e2a-4597-8251-0876d20c2a24\",\"status\":\"copied\"}]}]}" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -k -X POST 'https://{cpd_cluster_host}/v1/knowledge_accelerators/{ka_id}/copy_items?ids={ids}&project_id={project_id}' -H 'accept: application/json' -H 'Authorization: Bearer {token}' -d ''" ] } ] } ] } } } }, "/v1/knowledge_accelerators/{id}": { "get": { "tags": [ "Knowledge Accelerators" ], "summary": "Get a specific Knowledge Accelerator", "description": "Supply a Knowledge Accelerator id, in order to get detailed information, including contained items that can be imported, statistics and dependencies", "operationId": "get_ka_by_id", "parameters": [ { "name": "id", "in": "path", "description": "The Knowledge Accelerator id", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 7, "minLength": 4, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAArtifact" }, "examples": { "example": { "value": "{\"id\":\"kaeu20\",\"name\":\"Knowledge Accelerators\",\"definition\":\"A category that ..etc.\",\"type\":\"knowledge_accelerator\",\"format\":\"wkc_glossary\",\"version\":\"2.0.20231004\",\"stats\":{\"terms\":11425,\"categories\":502,\"policy\":57,\"rule\":30,\"reference_data\":297,\"reference_data_value\":2292,\"data_class\":284}}" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -k -X GET 'https://{cpd_cluster_host}/v1/knowledge_accelerators/{ka_id}' -H 'accept: application/json' -H 'Authorization: Bearer {token}'" ] } ] } ] } } } }, "/v1/knowledge_accelerators/{ka_id}/import_items": { "post": { "tags": [ "Knowledge Accelerators" ], "summary": "Import specified Knowledge Accelerator items into the glossary", "description": "Import the specified Knowledge Accelerator items into glossary. By default this will import all dependent items", "operationId": "import_ka_into_ikc", "parameters": [ { "name": "ka_id", "in": "path", "description": "The Knowledge Accelerator id", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 7, "minLength": 4, "type": "string" } }, { "name": "ids", "in": "query", "description": "The ids of the Knowledge Accelerator items to import, for example 'base'. Use the comma delimiter when listing multiple item ids, for example 'ccpa,gdpr'. Only one item allowed if item is of type glossary_scope", "required": true, "style": "form", "explode": false, "schema": { "maxLength": 200, "minLength": 2, "type": "string" } }, { "name": "merge_option", "in": "query", "description": "The merge option to be used when importing into the glossary, valid values:

all - imported values will replace existing values in catalog
specified - imported values that are not empty replace existing values in catalog
empty - imported values replace only empty values in catalog
", "required": true, "style": "form", "explode": false, "schema": { "maxLength": 12, "minLength": 3, "type": "string" } }, { "name": "dependencies", "in": "query", "description": "Indicates which dependencies of the item ids specified should also be imported, valid values:

all - imports the specified items that the user selects, imports all the items that the selected item depends on, irrespective of whether they already exist in glossary (Note, this may overwrite user made changes in the glossary).
necessary - imports specified items that the user selects, imports items that are considered mandatory for the specified item, and imports other related items the specified items depend on that are not already imported.
mandatory - imports the specified items that the user selects, and items that are considered mandatory for the specified item.
", "required": false, "style": "form", "explode": false, "schema": { "maxLength": 12, "minLength": 3, "type": "string", "default": "necessary" } }, { "name": "do_import", "in": "query", "description": "Indicates whether the import should be done, valid values:

false - will do all the logic checking and indicate what is going to be imported, useful for checking in advance of actually doing the import
true - at the end of logic checking will trigger the import and return a process id to the user
", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAImportResponse" }, "examples": { "example": { "value": "{\"message\":\"The import has been submitted. To check the status ...\",\"process_id\":\"b3ae3db2-6da1-447d-aaf7-4dde46dcbd1d\",\"import_evaluation\":{\"knowledge_accelerator\":\"kain20\",\"items\":[{\"id\":\"base\",\"evaluation\":\"import\",\"reason\":\"user_selected\"}]}}" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -k -X POST 'https://{cpd_cluster_host}/v1/knowledge_accelerators/{ka_id}/import_items?ids={ids}&merge_option={merge_option}&dependencies={dependencies}&do_import={do_import}' -H 'accept: application/json' -H 'Authorization: Bearer {token}' -d ''" ] } ] } ] } } } }, "/v1/knowledge_accelerators/import_items": { "get": { "tags": [ "Knowledge Accelerators" ], "summary": "Get what Knowledge Accelerator items are currently imported into glossary", "description": "Information on what Knowledge Accelerator items are imported into glossary if any; this will include information as to whether imported version is current", "operationId": "get_ka_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAGetImportResponse" }, "examples": { "example": { "value": "{\"message\":\"KA008I: The following knowledge accelerator items are imported\",\"import_evaluation\":[{\"knowledge_accelerator\":\"kain20\",\"items\":[{\"id\":\"base\",\"evaluation\":\"imported\"}]}]}" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -k -X GET 'https://{cpd_cluster_host}/v1/knowledge_accelerators/import_items' -H 'accept: application/json' -H 'Authorization: Bearer {token}'" ] } ] } ] } } } }, "/v1/knowledge_accelerators": { "get": { "tags": [ "Knowledge Accelerators" ], "summary": "Get all Knowledge Accelerators", "description": "Detailed information on each Knowledge Accelerator, including contained items that can be imported, statistics and dependencies", "operationId": "list_kas", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAArtifactListing" }, "examples": { "example": { "value": "{\"count\":1,\"knowledge_accelerators\":[{\"id\":\"kahc20\",\"name\":\"Knowledge Accelerator for Healthcare\",\"definition\":\"IBM Knowledge Accelerator for ...etc..\",\"type\":\"knowledge_accelerator\",\"format\":\"wkc_glossary\",\"version\":\"2.0.20230726\",\"stats\":{\"terms\":22385,\"categories\":1071,\"policy\":32,\"rule\":10,\"reference_data\":1169,\"reference_data_value\":22624,\"data_class\":208}}]}" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -k -X GET 'https://{cpd_cluster_host}/v1/knowledge_accelerators' -H 'accept: application/json' -H 'Authorization: Bearer {token}'" ] } ] } ] } } } }, "/v3/enforcement/governance_types": { "get": { "tags": [ "Enforcement Governance Types" ], "summary": "list all governance types", "description": "Lists all governance types. A governance type groups like operations together. For example, the Access governance type groups operations related to access of assets.", "operationId": "getAllGovernanceTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/governance_types/{governance_type_name}": { "get": { "tags": [ "Enforcement Governance Types" ], "summary": "retrieve a governanceType", "description": "Retrieves detailed information on a governance type. This includes all of the operations defined for the governance type and the allowed and default outcomes of each operation. ", "operationId": "getGovernanceType", "parameters": [ { "name": "governance_type_name", "in": "path", "description": "the name of the governance type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/lhs/udp": { "get": { "tags": [ "Rule Predicate Terms" ], "summary": "list user defined rule predicate terms", "description": "List all user defined left hand side terms defined in the policy engine. ", "operationId": "getUDPTerms", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3UDPTermListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "post": { "tags": [ "Rule Predicate Terms" ], "summary": "create user defined left hand side term", "description": "Create a left hand side term to be used in rules defined in the policy engine. ", "operationId": "createUDPTerm", "requestBody": { "description": "LHS RuleTerm JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3LHSTermRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3UDPTermResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/lhs/udp/{lhsTermId}": { "get": { "tags": [ "Rule Predicate Terms" ], "summary": "get a user defined left hand side term", "description": "Get the user defined left hand side term in the term cache of the policy engine. ", "operationId": "getUDPTerm", "parameters": [ { "name": "lhsTermId", "in": "path", "description": "ID of the LHS term to get", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3UDPTermResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "delete": { "tags": [ "Rule Predicate Terms" ], "summary": "delete a user defined left hand side term", "description": "Delete a left hand side term in the term cache of the policy engine. This cache is maintained for performance and is used for evaluating policies. It is refreshed periodically from technical terms maintained in the glossary.", "operationId": "deleteUDPTerm", "parameters": [ { "name": "lhsTermId", "in": "path", "description": "ID of the custom LHS to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content (OK)" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/policy_metrics/analysis/3d": { "get": { "tags": [ "Enforcement Policy Metrics" ], "summary": "retrieve and aggregate policy related metrics", "description": "This API retrieves policy enforcement metrics based on query parameters, which include metric type, date range, policy, user, rule, governanceType, outcome, host type, cached, context operation, context location, asset type and asset location. It then sums these metrics according to a specified aggregation type.", "operationId": "analysisMetrics3DGet", "parameters": [ { "name": "metrics_type", "in": "query", "description": "The type of metrics to return", "required": true, "schema": { "type": "string", "enum": [ "enforcements", "denials", "operational_policies", "operational_rules" ] } }, { "name": "aggregation_type_1", "in": "query", "description": "The type of aggregation to perform on the selected metrics (days, months, years, policies, rules, users, governanceTypes, outcomes)", "required": true, "schema": { "type": "string", "enum": [ "days", "months", "years", "policies", "rules", "users", "outcomes", "governance_type", "pep_host_types", "is_pep_cache", "context_operations", "context_locations", "asset_types", "asset_locations" ] } }, { "name": "aggregation_type_2", "in": "query", "description": "The type of aggregation to perform on the selected metrics (days, months, years, policies, rules, users, governanceTypes, outcomes)", "required": true, "schema": { "type": "string", "enum": [ "days", "months", "years", "policies", "rules", "users", "outcomes", "governance_type", "pep_host_types", "is_pep_cache", "context_operations", "context_locations", "asset_types", "asset_locations" ] } }, { "name": "start_time", "in": "query", "description": "ISO 8601 date/time specifying the starting time to return metrics data", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "end_time", "in": "query", "description": "ISO 8601 date/time specifying the ending time to return metrics data", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "policy_id", "in": "query", "description": "The policy to return metrics of, or all policies if not specified", "schema": { "type": "string" } }, { "name": "rule_id", "in": "query", "description": "The rule to return metrics of, or all rules if not specified", "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "The user to return metrics about, or all users if not specified", "schema": { "type": "string" } }, { "name": "governance_type", "in": "query", "description": "The governanceType to return metrics about, or all governanceTypes if not specified", "schema": { "type": "string", "enum": [ "Access", "Classification", "Curation", "Lifecycle", "ResourceControl", "DMR", "AIGovernance", "DLR" ] } }, { "name": "outcome", "in": "query", "description": "The enforcement outcome to return metrics about, or all outcomes if not specified", "schema": { "type": "string" } }, { "name": "pep_host_type", "in": "query", "description": "The PEP host type to return metrics about, or all PEP host types if not specified", "schema": { "type": "string" } }, { "name": "is_pep_cache", "in": "query", "description": "Metrics on decisions retrieved from cache versus from server, or both if not specified", "schema": { "type": "boolean" } }, { "name": "context_operation", "in": "query", "description": "The context operation to return metrics about, or all context operations if not specified", "schema": { "type": "string" } }, { "name": "context_location", "in": "query", "description": "The context location to return metrics about, or all context locations if not specified", "schema": { "type": "string" } }, { "name": "asset_type", "in": "query", "description": "The asset type to return metrics about, or all asset types if not specified", "schema": { "type": "string" } }, { "name": "asset_location", "in": "query", "description": "The asset location to return metrics about, or all asset locations if not specified", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The order to sort the metrics. The following values are allowed:\n- aggregate, -aggregate -- ascending or descending order by the aggregate\n- count, -count -- ascending or descending order by enforcement count", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyMetricsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/policy_metrics": { "get": { "tags": [ "Enforcement Policy Metrics" ], "summary": "retrieve and aggregate policy related metrics", "description": "This API retrieves policy enforcement metrics based on query parameters, which include metric type, date range, policy, user, rule, governanceType, outcome, host type, cached, context operation, context location, asset type and asset location. It then sums these metrics according to a specified aggregation type.", "operationId": "metricsGeneralGet", "parameters": [ { "name": "metrics_type", "in": "query", "description": "The type of metrics to return", "required": true, "schema": { "type": "string", "enum": [ "enforcements", "denials", "operational_policies", "operational_rules" ] } }, { "name": "aggregation_type", "in": "query", "description": "The type of aggregation to perform on the selected metrics (days, months, years, policies, rules, users, governanceTypes, outcomes)", "required": true, "schema": { "type": "string", "enum": [ "days", "months", "years", "policies", "rules", "users", "outcomes", "governance_type", "pep_host_types", "is_pep_cache", "context_operations", "context_locations", "asset_types", "asset_locations" ] } }, { "name": "start_time", "in": "query", "description": "ISO 8601 date/time specifying the starting time to return metrics data", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "end_time", "in": "query", "description": "ISO 8601 date/time specifying the ending time to return metrics data", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "policy_id", "in": "query", "description": "The policy to return metrics of, or all policies if not specified", "schema": { "type": "string" } }, { "name": "rule_id", "in": "query", "description": "The rule to return metrics of, or all rules if not specified", "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "The user to return metrics about, or all users if not specified", "schema": { "type": "string" } }, { "name": "governance_type", "in": "query", "description": "The governanceType to return metrics about, or all governanceTypes if not specified", "schema": { "type": "string", "enum": [ "Access", "Classification", "Curation", "Lifecycle", "ResourceControl", "DMR", "AIGovernance", "DLR" ] } }, { "name": "outcome", "in": "query", "description": "The enforcement outcome to return metrics about, or all outcomes if not specified", "schema": { "type": "string" } }, { "name": "pep_host_type", "in": "query", "description": "The PEP host type to return metrics about, or all PEP host types if not specified", "schema": { "type": "string" } }, { "name": "is_pep_cache", "in": "query", "description": "Metrics on decisions retrieved from cache versus from server, or both if not specified", "schema": { "type": "boolean" } }, { "name": "context_operation", "in": "query", "description": "The context operation to return metrics about, or all context operations if not specified", "schema": { "type": "string" } }, { "name": "context_location", "in": "query", "description": "The context location to return metrics about, or all context locations if not specified", "schema": { "type": "string" } }, { "name": "asset_type", "in": "query", "description": "The asset type to return metrics about, or all asset types if not specified", "schema": { "type": "string" } }, { "name": "asset_location", "in": "query", "description": "The asset location to return metrics about, or all asset locations if not specified", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The order to sort the metrics. The following values are allowed:\n- aggregate, -aggregate -- ascending or descending order by the aggregate\n- count, -count -- ascending or descending order by enforcement count", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyMetricsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/roles": { "get": { "tags": [ "Roles Permissions" ], "summary": "list all roles in policy engine.", "description": "Lists all roles of the policy engine.", "operationId": "getAllRoles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRoleListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "post": { "tags": [ "Roles Permissions" ], "summary": "create a custom role", "description": "Creates a cusotm role. This will include a list of existing permissions to be associated with the role. Maximum length allowed for 'name' parameter: 80 characters, maximum length allowed for 'description' parameter: 1000 characters.\nAllowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter).", "operationId": "createRole", "requestBody": { "description": "Role Permission Request json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRolePermissionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRoleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/roles/{role_id}": { "get": { "tags": [ "Roles Permissions" ], "summary": "retrieve a role", "description": "Retrieves detailed information on a role given the role's identifier. This includes a list of permissions associated with this role.", "operationId": "getRole", "parameters": [ { "name": "role_id", "in": "path", "description": "role ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRoleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "put": { "tags": [ "Roles Permissions" ], "summary": "update a custom category role", "description": "Updates a custom category role. This API is also used to add and remove permissions from the custom category role. The permissions should be passed as an array of string that has permissions ids.Maximum length allowed for 'name' parameter: 80 characters, maximum length allowed for 'description' parameter: 1000 characters.\nIf the parameter 'name' is modified, allowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter).", "operationId": "updateRole", "parameters": [ { "name": "role_id", "in": "path", "description": "role ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "role json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRolePermissionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRoleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "delete": { "tags": [ "Roles Permissions" ], "summary": "delete a custom category role", "description": "Deletes a cusotm category role. ", "operationId": "deleteRole", "parameters": [ { "name": "role_id", "in": "path", "description": "role ID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content (OK)" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/roles/permissions": { "get": { "tags": [ "Roles Permissions" ], "summary": "list all permissions in policy engine.", "description": "Lists all permissions of the policy engine.", "operationId": "getAllPermissions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyPermissionListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/rules/sync/{rule_id}": { "put": { "tags": [ "Data Protection Rules" ], "summary": "Sync a rule", "description": "Syncs a rule in DPS with its global search index. If rule is found in DPS, its global search index is updated. If rule is not found in DPS, its global search index is removed. ", "operationId": "RuleSync", "parameters": [ { "name": "rule_id", "in": "path", "description": "Rule ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/rules/{rule_id}": { "get": { "tags": [ "Data Protection Rules" ], "summary": "retrieve a rule", "description": "Retrieves detailed information on a rule given the rule's identifier.", "operationId": "getRule", "parameters": [ { "name": "rule_id", "in": "path", "description": "Rule ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "put": { "tags": [ "Data Protection Rules" ], "summary": "update a rule", "description": "Updates a rule. Maximum length allowed for 'name' parameter: 80 characters, maximum length allowed for 'description' parameter: 1000 characters.\nIf the parameter 'name' is modified, allowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter). The governance_type_id cannot be modified.", "operationId": "RuleUpdate", "parameters": [ { "name": "rule_id", "in": "path", "description": "Rule ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Rule json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "delete": { "tags": [ "Data Protection Rules" ], "summary": "delete a rule", "description": "Deletes a rule. A rule can only be deleted if it is not currently associated with any policy (in any state).", "operationId": "deleteRule", "parameters": [ { "name": "rule_id", "in": "path", "description": "Rule ID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content (OK)" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/rules": { "get": { "tags": [ "Data Protection Rules" ], "summary": "list all rules", "description": "Lists all defined rules. This includes all rules associated with policies and rules not associated with any policy. \nWhen more than one filter criteria is specified, the resulting collection satisfies all the criteria.", "operationId": "getAllrules", "parameters": [ { "name": "name", "in": "query", "description": "Specify name of the rule to search for or use filter of the form 'contains:xx' to search for rules containing provided phrase as part of name or use filter of the form 'exact:xx' to search for rules with exact name.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Specify description of the rule to search for or use filter of the form 'contains:xx' to search for rules containing provided phrase as part of description.", "schema": { "type": "string" } }, { "name": "trigger", "in": "query", "description": "If specified, only rules with a matching trigger expression will be returned.", "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "If specified, only rules with a matching action will be returned.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "If specified, only rules in the matching state will be returned.", "schema": { "type": "string", "enum": [ "draft", "active", "archived" ] } }, { "name": "governance_type", "in": "query", "description": "If speficied, only rules with the matching governance type/types will be returned.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The order to sort the rules. The following values are allowed:\n- name, -name -- ascending or descending order by the name\n- modified_date, -modified_date -- ascending or descending order by modified date", "schema": { "type": "string", "description": "sort", "enum": [ "name", "-name", "modified_date", "-modified_date" ] } }, { "name": "limit", "in": "query", "description": "The maximum number of Rules to return. The default value is 50.", "schema": { "type": "string", "default": "50" } }, { "name": "offset", "in": "query", "description": "The index of the first matching Rule to include in the result. The default value is 0.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "post": { "tags": [ "Data Protection Rules" ], "summary": "create a rule", "description": "Creates a rule. A rule has two key properties: \n1) a trigger defining when the rule should be enforced, and \n2) an action describing what operations to perform or outcome to enforce. \n \nTrigger\n \nA trigger is a boolean expression represented using nested arrays. The following describes the syntax: \n \n Expression: \n [ -conditions- ] \n \n Conditions: \n -predicate- \n \"NOT\", -predicate- \n -predicate-, \"AND\"|\"OR\", -conditions- \n \"NOT\", -predicate-, \"AND\"|\"OR\", -conditions- \n \n Predicate: \n [ \"$-term-\", \"EXISTS\" ] \n [ \"$-term-\", \"EQUALS\"|\"LESS_THAN\"|\"GREATER_THAN\"|\"CONTAINS\", \"#-literal-\"|\"$-term-\" ] \n -expression- \n\n \nwhere:\n- -term- is a technical term defined in the term glossary. \n- -literal- is a literal. For numerics a string representation of the number should be specified. For times, milliseconds are used (from Unix epoch). For boolean, #true and #false are used.\n\nThe definition of the operators in a predicate:\n - EXISTS -- means that the term has a value of some kind. \n - EQUALS -- evaluates to true if the left and right sides are equal. \n - LESS_THAN -- evaluates to true if the left is less in numeric value than the right.\n - GREATER_THAN -- evaluates to true if the left is greater in numeric value than the right.\n - CONTAINS -- is meant to test an array term (such as Asset.Tags) with a single value. It evaluates to true if the value on the right side equals one of the values on the array on the left side. \nHowever it will also supports a single value on the left, in which case it behaves just like EQUALS -- regular expressions or wildcards are not supported.\n \nFor all of the operators (except EXISTS), if the right hand side evaluates to an array, each value of the array is compared to the left side, according to the operator definition, and if any comparison is true then the result of the evaluation is true.\n\nExamples: \n \n [[\"$Asset.Type\", \"EQUALS\", \"#Project\"]] \n [\"NOT\", [\"$Asset.Tags\", \"CONTAINS\", \"#sensitive\"], \"AND\", [\"NOT\", \"$Asset.Tags\", \"CONTAINS\", \"#confidential\"]] \n [[\"$User.Name\", \"EQUALS\", \"$Asset.Owner\"]] \n\n \nAction\n \nThe action is an name with optional parameters or subaction describing an operation to perform. \nFor simple actions like Deny, only the action name will be provided. For actions such as Transform, a subaction with parameters describing the type of transform is also provided. \nThe allowed actions depends on the governance type. \n\nExamples: \n\n {\"name\": \"Deny\"} \n {\"name\": \"Transform\", \"subaction\": {\"name\": \"anonymizeColumns\", \"parameters\": [{\"name\": \"column_name\", \"value\": \"CCN\"}]}} \n\n \nThe maximum length allowed for 'name' parameter is 80 characters, maximum length allowed for 'description' parameter: 1000 characters.\nAllowed characters for the 'name' parameter: letters from any language, numbers in any script, space, dot, underscore, hyphen. Strings with characters other than these are rejected (only for the name parameter).", "operationId": "createRule", "requestBody": { "description": "Rule json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleRequest" } } }, "required": true }, "responses": { "200": { "description": "Merged with an existing 'ResourceControl' rule.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleResponse" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/rules/export": { "get": { "tags": [ "Data Protection Rules" ], "summary": "export all rules", "description": "Export all defined rules as JSON.This includes all rules associated with policies and rules not associated with any policy.", "operationId": "exportAllrules", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of Rules to return. The default value is 50.", "schema": { "type": "string", "default": "50" } }, { "name": "offset", "in": "query", "description": "The index of the first matching Rule to include in the result. The default value is 0.", "schema": { "type": "string", "default": "0" } }, { "name": "external_export", "in": "query", "description": "For export between two different systems. If specified as true, the ids in rules will be converted to names and added as export_components in the exported file", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/rules/{rule_id}/terms": { "get": { "tags": [ "Data Protection Rules" ], "summary": "retrieve terms used in a rule", "description": "Retrieves the names of all terms used in a rule.", "operationId": "getRuleTerms", "parameters": [ { "name": "rule_id", "in": "path", "description": "Rule ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleTermListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/rules/import": { "post": { "tags": [ "Data Protection Rules" ], "summary": "import rules", "description": "Imports rules using content recieved as application/octet-stream media type. \nAssumes content to be in UTF-8 charset. \nExpects \"rules\" JSON array contained in a JSON objects. Ignores other fields. \nRule GUID is prerserved. \nRetruns JSON array containing GUIDs of newly imported rules.", "operationId": "importrules", "parameters": [ { "name": "external_import", "in": "query", "description": "For import between two different systems. If specified as true, the names in export_components of the import file will be matched and converted to the target system's ids.", "schema": { "type": "boolean", "default": false } }, { "name": "commit", "in": "query", "description": "For external imports, if specified as true, the whole import will fail if there are any rules that fail to match ids in the target system. If specified as false, an analysis report will be returned.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The input stream for reading imported terms", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3ImportRuleResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "413": { "description": "Content cannot be more than 1MB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v3/enforcement/settings": { "get": { "tags": [ "Rule Enforcement Settings" ], "summary": "retrieve tenant settings", "description": "Retrieves governance information and settings about a particular tenant given the tenant identifier. ", "operationId": "getTenant", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3TenantSettingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } }, "put": { "tags": [ "Rule Enforcement Settings" ], "summary": "update tenant settings", "description": "Updates governance information and settings for the given tenant. ", "operationId": "updateTenant", "requestBody": { "description": "governedTenant json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3PolicySettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliciesV3TenantSettingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorContainer" } } } } } } }, "/v2/projects": { "get": { "tags": [ "Projects" ], "summary": "List projects", "description": "Returns a list of projects filtered by the specified query parameters. By default, only projects that the authenticated user is a member of are returned. In IBM Cloud Pak for Data (CPD), all projects in the cluster are returned (regardless of project membership) if the authenticated user is assigned either the \"Manage projects\" or \"Monitor project workloads\" CPD permission. In IBM Cloud Pak for Data (CPDaaS), all projects associated with an IBM Cloud Account are returned (regardless of project membership) if the authenticated user is added to the IBM Cloud Account and assigned the IAM \"Manager\" role.", "operationId": "projects_list", "parameters": [ { "$ref": "#/components/parameters/ProjectsBSSAccountIDParameter" }, { "$ref": "#/components/parameters/ProjectsTypeParameter" }, { "$ref": "#/components/parameters/ProjectsMemberParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsRolesParameter" }, { "$ref": "#/components/parameters/ProjectsTagNamesParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsNameParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsMatchParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsIDsParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsIncludeParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsLimitParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsBookmarkParameter" }, { "$ref": "#/components/parameters/ProjectsListProjectsSkipParameter" }, { "$ref": "#/components/parameters/ProjectsIncludePermissionsParameter" } ], "responses": { "200": { "$ref": "#/components/responses/ProjectsGetProjectsResponse" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429QueryResponse" } } } }, "/v2/projects/total": { "get": { "tags": [ "Projects" ], "summary": "Get project total", "description": "Returns the total number of projects associated with the authenticated user in a BSS account. In IBM Cloud Pak for Data (CPDaaS), specifying the BSS account ID is required. In IBM Cloud Pak for Data (CPD), specifying the BSS account ID is optional. Default is \"999\". The maximum total number of projects returned will be capped at 2,000 projects (for database performance reasons).", "operationId": "project_total_get", "parameters": [ { "$ref": "#/components/parameters/ProjectsBSSAccountIDParameter" }, { "$ref": "#/components/parameters/ProjectsTypeParameter" }, { "$ref": "#/components/parameters/ProjectsMemberParameter" }, { "$ref": "#/components/parameters/ProjectsTagNamesParameter" }, { "$ref": "#/components/parameters/ProjectsIncludePermissionsParameter" } ], "responses": { "200": { "$ref": "#/components/responses/ProjectsGetProjectTotalResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429ReadResponse" } } } }, "/v2/projects/{project_id}": { "get": { "tags": [ "Projects" ], "summary": "Get project", "description": "Returns the metadata for a target project specified by ID.", "operationId": "project_get", "x-cli-command": "get", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsGetProjectIncludeParameter" } ], "responses": { "200": { "$ref": "#/components/responses/ProjectsGetProjectResponse" }, "204": { "$ref": "#/components/responses/ProjectsHTTP204Response" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429ReadResponse" } } }, "patch": { "tags": [ "Projects" ], "summary": "Update project", "description": "Partially updates the project with only a subset of properties.", "operationId": "project_update", "x-cli-command": "update", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/ProjectsUpdateProjectBody" }, "responses": { "200": { "$ref": "#/components/responses/ProjectsGetProjectResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } } }, "/v2/projects/{project_id}/members": { "get": { "tags": [ "Project Members" ], "summary": "List members", "description": "Returns the list of project members.", "operationId": "members_list", "x-cli-command": "list", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsListMembersRolesParameter" }, { "$ref": "#/components/parameters/ProjectsGetMemberUserNamesParameter" } ], "responses": { "200": { "$ref": "#/components/responses/ProjectsGetMembersResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429ReadResponse" } } }, "post": { "tags": [ "Project Members" ], "summary": "Create members", "description": "Adds new project members with the provided roles. A project must always have at least one admin.", "operationId": "members_create", "x-cli-command": "create", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsIncludePermissionsParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/ProjectsCreateMembersBody" }, "responses": { "200": { "$ref": "#/components/responses/ProjectsGetMembersResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } }, "delete": { "tags": [ "Project Members" ], "summary": "Delete members", "description": "Deletes members from the project that match the provided usernames.", "operationId": "members_delete", "x-cli-command": "delete", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsDeleteMemberUserNamesParameter" } ], "responses": { "204": { "$ref": "#/components/responses/ProjectsHTTP204Response" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } }, "patch": { "tags": [ "Project Members" ], "summary": "Update members", "description": "Change project member roles in a batch.", "operationId": "members_update", "x-cli-command": "update", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsIncludePermissionsParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/ProjectsUpdateMembersBody" }, "responses": { "200": { "$ref": "#/components/responses/ProjectsGetMembersResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } } }, "/v2/projects/{project_id}/members/{user_name}": { "get": { "tags": [ "Project Members" ], "summary": "Get member", "description": "Returns the project member with the specified 'user_name' if any.", "operationId": "member_get", "x-cli-command": "get", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsMemberUserNameParameter" }, { "$ref": "#/components/parameters/ProjectsResolveGroupsParameter" } ], "responses": { "200": { "$ref": "#/components/responses/ProjectsGetMemberResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429ReadResponse" } } }, "delete": { "tags": [ "Project Members" ], "summary": "Delete member", "description": "Deletes a member with a given user name from a project with the given username.", "operationId": "member_delete", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsMemberUserNameParameter" } ], "responses": { "204": { "$ref": "#/components/responses/ProjectsHTTP204Response" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } }, "x-sdk-exclude": true } }, "/v2/projects/{project_id}/tags": { "get": { "tags": [ "Project Tags" ], "summary": "List tags", "description": "Returns the list of project tags.", "operationId": "tags_list", "x-cli-command": "list", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" } ], "responses": { "200": { "$ref": "#/components/responses/ProjectsListTagsResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429ReadResponse" } } }, "post": { "tags": [ "Project Tags" ], "summary": "Create tags", "description": "Adds new tags to a project.", "operationId": "tags_create", "x-cli-command": "create", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/ProjectsCreateTagsBody" }, "responses": { "201": { "$ref": "#/components/responses/ProjectsCreateTagsResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "422": { "$ref": "#/components/responses/ProjectsHTTP422Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } }, "delete": { "tags": [ "Project Tags" ], "summary": "Delete tags", "description": "Delete existing tags in a project. If no 'tag_names' are specified, then delete all existing tags in a project.", "operationId": "tags_delete", "x-cli-command": "delete", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsTagNamesParameter" } ], "responses": { "204": { "$ref": "#/components/responses/ProjectsHTTP204Response" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } }, "patch": { "tags": [ "Project Tags" ], "summary": "Update tags", "description": "Adds new tags and removes existing tags from a project via a single bulk update operation.", "operationId": "tags_update", "x-cli-command": "update", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/ProjectsUpdateTagsBody" }, "responses": { "200": { "$ref": "#/components/responses/ProjectsUpdateTagsResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "422": { "$ref": "#/components/responses/ProjectsHTTP422Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } } }, "/v2/projects/{project_id}/tags/{tag_name}": { "post": { "tags": [ "Project Tags" ], "summary": "Create tag", "description": "Add a new tag to a project.", "operationId": "tag_create", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsTagNameParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/ProjectsCreateTagBody" }, "responses": { "201": { "$ref": "#/components/responses/ProjectsCreateTagsResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "422": { "$ref": "#/components/responses/ProjectsHTTP422Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } }, "x-sdk-exclude": true }, "delete": { "tags": [ "Project Tags" ], "summary": "Delete tag", "description": "Delete an existing tag in a project.", "operationId": "tag_delete", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" }, { "$ref": "#/components/parameters/ProjectsTagNameParameter" } ], "responses": { "204": { "$ref": "#/components/responses/ProjectsHTTP204Response" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } }, "x-sdk-exclude": true } }, "/v2/projects/{project_id}/settings/folders": { "get": { "tags": [ "Project Settings" ], "summary": "Get folders settings", "description": "Get folders settings.", "operationId": "settings_folders_get", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" } ], "responses": { "200": { "$ref": "#/components/responses/ProjectsGetFoldersResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429ReadResponse" } } }, "put": { "tags": [ "Project Settings" ], "summary": "Update folders settings", "description": "Update folders settings.", "operationId": "settings_folders_update", "parameters": [ { "$ref": "#/components/parameters/ProjectsProjectIDParameter" } ], "requestBody": { "$ref": "#/components/requestBodies/ProjectsUpdateFoldersBody" }, "responses": { "200": { "$ref": "#/components/responses/ProjectsGetFoldersResponse" }, "400": { "$ref": "#/components/responses/ProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/ProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/ProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/ProjectsHTTP404Response" }, "429": { "$ref": "#/components/responses/ProjectsHTTP429WriteResponse" } } } }, "/transactional/v2/projects": { "post": { "tags": [ "Transactional Projects" ], "summary": "Create project as a transaction", "description": "Creates a new project with the provided parameters, including all the storage and credentials in a single transaction. This endpoint will create a new COS bucket using generated unique name, all credentials, asset container and call all the required atomic APIs to fully configure a new project. Attempts to use the duplicate project names will result in an error. NOTE: when creating projects programmatically, always use this endpoint, not /v2/projects.


This endpoint can also be used to create a project from an exported Watson Studio .zip file. In this case, a new transaction is initiated to create assets under the project. A Transaction ID along with a URL is returned as a response of this API. As this transaction can take time, you can view the current status of the transaction using the returned URL.
NOTE: This feature is only available in the private cloud.", "operationId": "transactional_post_project", "x-codegen-request-body-name": "new_body_name", "x-cli-command": "create", "x-cli-generate-adapter-method": true, "parameters": [ { "in": "query", "name": "verify_unique_name", "description": "If enabled, the transaction fails if the project name is not unique.", "required": false, "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectCreate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectCreateImport" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/TransactionalProjectsCreateTransactionProjectResponse" }, "202": { "$ref": "#/components/responses/TransactionalProjectsCreateImportTransactionProjectResponse" }, "400": { "$ref": "#/components/responses/TransactionalProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/TransactionalProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/TransactionalProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/TransactionalProjectsHTTP404Response" }, "500": { "$ref": "#/components/responses/TransactionalProjectsHTTP500Response" } } } }, "/transactional/v2/projects/{project_id}": { "delete": { "tags": [ "Transactional Projects" ], "summary": "Delete project as a transaction", "description": "Deletes a project with a given ID, deletes COS bucket and all the files in it, all credentials and asset container in the order reverse from the project creation transaction. When deleting projects programmatically, always use this endpoint, not /v2/projects/{project_id}.", "operationId": "transactional_delete_project", "x-cli-command": "delete", "parameters": [ { "name": "project_id", "in": "path", "description": "The ID of the project to be deleted.", "required": true, "schema": { "$ref": "#/components/schemas/TransactionalProjectsProjectIDParameter" }, "x-cli-flag-shorthand": "i" } ], "responses": { "204": { "description": "No Content" }, "400": { "$ref": "#/components/responses/TransactionalProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/TransactionalProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/TransactionalProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/TransactionalProjectsHTTP404Response" }, "500": { "$ref": "#/components/responses/TransactionalProjectsHTTP500Response" } } } }, "/transactional/v2/projects/{project_id}/transactions/{transaction_id}": { "get": { "tags": [ "Transactional Projects" ], "summary": "Get status of import transaction", "description": "Status of import transaction created using create project as a transaction API", "operationId": "transactional_import_status", "parameters": [ { "$ref": "#/components/parameters/TransactionalProjectsStatusProjectIDParameter" }, { "$ref": "#/components/parameters/TransactionalProjectsStatusTransactionIDParameter" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsTransactionStatusItem" } } } }, "400": { "$ref": "#/components/responses/TransactionalProjectsHTTP400Response" }, "401": { "$ref": "#/components/responses/TransactionalProjectsHTTP401Response" }, "403": { "$ref": "#/components/responses/TransactionalProjectsHTTP403Response" }, "404": { "$ref": "#/components/responses/TransactionalProjectsHTTP404Response" }, "500": { "$ref": "#/components/responses/TransactionalProjectsHTTP500Response" } }, "x-sdk-exclude": true } }, "/v3/workflows": { "get": { "tags": [ "Workflows" ], "summary": "Get all available workflows", "operationId": "listWorkflows", "parameters": [ { "name": "offset", "in": "query", "description": "Return results starting at this offset", "required": false, "schema": { "type": "string", "enum": [ "range[0, 2147483647]" ] } }, { "name": "limit", "in": "query", "description": "Maximum number of results", "required": false, "schema": { "type": "string", "enum": [ "range[1, 2147483647]" ] } }, { "name": "artifact_id", "in": "query", "description": "Only return workflows related to the artifact with the given artifact id", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "version_id", "in": "query", "description": "Only return workflows related to the artifact with the given version id", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "started_by", "in": "query", "description": "Only return workflows started by the given user id (only administrators can query for users other than themselves)", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "workflow_type_id", "in": "query", "description": "Only return workflows from the given workflow type id(s)", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "max_number_of_artifacts", "in": "query", "description": "Maximum number of artifacts to include in the result", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "include_variables", "in": "query", "description": "Include variables in the result", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "include_user_tasks", "in": "query", "description": "Include user tasks in the result", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "assigned_to", "in": "query", "description": "Only return user tasks assigned to the given user_id (only administrators can specify a different id than their own), requires include_user_tasks=true", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "include_start_form_properties", "in": "query", "description": "Include start form properties in the results", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "return_active_workflows", "in": "query", "description": "Return active workflows", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "return_completed_workflows", "in": "query", "description": "Return completed workflows", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPaginatedResource_Workflow" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/workflows/all/query": { "post": { "tags": [ "Workflows" ], "summary": "Query available workflows", "operationId": "queryWorkflows", "parameters": [ { "name": "offset", "in": "query", "description": "Return results starting at this offset", "required": false, "schema": { "type": "string", "enum": [ "range[0, 2147483647]" ] } }, { "name": "limit", "in": "query", "description": "Maximum number of results", "required": false, "schema": { "type": "string", "enum": [ "range[1, 2147483647]" ] } }, { "name": "max_number_of_artifacts", "in": "query", "description": "Maximum number of artifacts to include in the result", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "include_variables", "in": "query", "description": "Include variables in the results", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "include_user_tasks", "in": "query", "description": "Include user tasks in the results", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "assigned_to", "in": "query", "description": "Only return user tasks assigned to the given user_id (only administrators can specify a different id than their own), requires include_user_tasks=true", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "include_start_form_properties", "in": "query", "description": "Include start form properties in the results", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowWorkflowQuery" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPaginatedResource_Workflow" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/workflow_user_tasks/{task_id}/actions": { "post": { "tags": [ "Workflow User Tasks" ], "summary": "Update a task", "operationId": "updateUserTask", "parameters": [ { "name": "task_id", "in": "path", "description": "The task id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUserTaskActionPayload" } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "204": { "description": "Action was successful" }, "400": { "description": "Bad request: Parameters are invalid or missing" }, "403": { "description": "Forbidden: User is not a candidate user or the task has been claimed by someone else" }, "404": { "description": "Not found: User task does not exist or has been completed" } } } }, "/v3/workflow_user_tasks/unclaim": { "post": { "tags": [ "Workflow User Tasks" ], "summary": "Unclaim tasks", "operationId": "unclaimUserTasks", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowObjectIdList" } } }, "required": true }, "responses": { "200": { "description": "Some or all individual operations have failed. The response contains a list of failed operations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowMultiOperationResponse" } } } }, "204": { "description": "The action was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowMultiOperationResponse" } } } }, "400": { "description": "Bad request: Parameters are invalid or missing" }, "403": { "description": "Forbidden: You don't have administrator permissions" } } } }, "/v3/workflow_user_tasks/candidates": { "post": { "tags": [ "Workflow User Tasks" ], "summary": "Add candidate users to tasks", "operationId": "addCandidatesToUserTasks", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowModifyCandidatesPayload" } } }, "required": true }, "responses": { "200": { "description": "Some or all individual operations have failed. The response contains a list of failed operations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowMultiOperationResponse" } } } }, "204": { "description": "The action was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowMultiOperationResponse" } } } }, "400": { "description": "Bad request: Parameters are invalid or missing" }, "403": { "description": "Forbidden: You don't have administrator permissions" } } } }, "/v3/workflow_user_tasks/actions": { "post": { "tags": [ "Workflow User Tasks" ], "summary": "Update multiple tasks", "operationId": "updateUserTasks", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUserTaskBulkActionPayload" } } }, "required": true }, "responses": { "200": { "description": "Some or all individual operations have failed. The response contains a list of failed operations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowMultiOperationResponse" } } } }, "204": { "description": "The action was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowMultiOperationResponse" } } } }, "400": { "description": "Bad request: Parameters are invalid or missing" }, "403": { "description": "Forbidden: You don't have administrator permissions" } } } }, "/v3/workflows/{workflow_id}": { "get": { "tags": [ "Workflows" ], "summary": "Get a workflow by id", "operationId": "getWorkflow", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The workflow id", "required": true, "schema": { "type": "string" } }, { "name": "max_number_of_artifacts", "in": "query", "description": "Maximum number of artifacts to include in the result", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "include_variables", "in": "query", "description": "Include variables in the result", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "include_user_tasks", "in": "query", "description": "Include user tasks in the result", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "assigned_to", "in": "query", "description": "Only return user tasks assigned to the given user_id (only administrators can specify a different id than their own), requires include_user_tasks=true", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "include_start_form_properties", "in": "query", "description": "Include start form properties in the result", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/WorkflowWorkflow" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowWorkflow" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Workflow not found", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/WorkflowWorkflow" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowWorkflow" } } } } } } }, "/v3/workflows/{workflow_id}/artifacts": { "get": { "tags": [ "Workflows" ], "summary": "Get artifacts managed by the workflow", "operationId": "getWorkflowArtifacts", "parameters": [ { "name": "workflow_id", "in": "path", "description": "The workflow id", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Return results starting at this offset", "required": false, "schema": { "type": "string", "enum": [ "range[0, 2147483647]" ] } }, { "name": "limit", "in": "query", "description": "Maximum number of results", "required": false, "schema": { "type": "string", "enum": [ "range[1, 2147483647]" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPaginatedResource_Artifact" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/workflow_user_tasks": { "get": { "tags": [ "Workflow User Tasks" ], "summary": "Get all user tasks that involve the current user", "description": "Administrators can see all tasks", "operationId": "listUserTasks", "parameters": [ { "name": "offset", "in": "query", "description": "Return results starting at this offset", "required": false, "schema": { "type": "string", "enum": [ "range[0, 2147483647]" ] } }, { "name": "limit", "in": "query", "description": "Maximum number of results", "required": false, "schema": { "type": "string", "enum": [ "range[1, 2147483647]" ] } }, { "name": "sort", "in": "query", "description": "specify the ordering of returning resources. it can contain any one of the valid sort fields or a combination of these fields. prepend a field with a '+' or '-' character to indicate ascending or descending, if neither of '+' or '-' are provided, ascending is used. e.g. 'field1', '-field1', or '+field1,-field2'.

Valid sort fields are 'created_at', 'due_date' and 'completed_at'.", "required": false, "schema": { "type": "string", "default": "created_at" } }, { "name": "assigned_to", "in": "query", "description": "Only return tasks assigned to the given user ID (only administrators can specify IDs different from their own)", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "unassigned", "in": "query", "description": "Only return tasks not assigned to any user ID (only administrators may specify this filter parameter)", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "completed", "in": "query", "description": "Include completed tasks", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "status", "in": "query", "description": "Only return tasks with the given status (only applies when 'completed' is set to false)", "required": false, "schema": { "type": "string", "enum": [ "created, assigned" ] } }, { "name": "urgency", "in": "query", "description": "Only return tasks with the given urgency (only applies when 'completed' is set to false)", "required": false, "schema": { "type": "string", "enum": [ "overdue, due_soon, due_later" ] } }, { "name": "workflow_type_id", "in": "query", "description": "Only return tasks from the given workflow type id(s)", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "default": [] } }, { "name": "task_category", "in": "query", "description": "Only return tasks of the given task categories", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "default": [] } }, { "name": "artifact_id", "in": "query", "description": "Only return tasks related to the artifact with the given artifact id", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "version_id", "in": "query", "description": "Only return tasks related to the artifact with the given version id", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "due_before", "in": "query", "description": "Only return tasks due before the given date, e.g.: 1979-01-22T01:23:45.000Z", "required": false, "schema": { "type": "string" } }, { "name": "hide_authoring_tasks", "in": "query", "description": "Hide authoring tasks", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "count_only", "in": "query", "description": "Only return the total count", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPaginatedResource_UserTask" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/workflow_user_tasks/{task_id}": { "get": { "tags": [ "Workflow User Tasks" ], "summary": "Get a user task by id", "operationId": "getUserTask", "parameters": [ { "name": "task_id", "in": "path", "description": "The task id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUserTask" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Task not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUserTask" } } } } } } }, "/v3/workflow_templates/all/task_categories_by_type": { "get": { "tags": [ "Workflow Templates" ], "summary": "Get all possible task categories grouped by workflow type", "operationId": "listTaskCategoriesByType", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/WorkflowPlainResourcesListWorkflowTypeInfoWithTaskCategories" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPlainResourcesListWorkflowTypeInfoWithTaskCategories" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/workflow_templates/all/task_categories": { "get": { "tags": [ "Workflow Templates" ], "summary": "Get all possible task categories", "operationId": "listTaskCategories", "parameters": [ { "name": "workflow_type_id", "in": "query", "description": "Only return workflow templates for the given workflow type id(s)", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "default": [] } } ], "responses": { "200": { "description": "Success", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/WorkflowPlainResourcesListString" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowPlainResourcesListString" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/workflow_stats/user_task_status": { "get": { "tags": [ "Statistics" ], "summary": "Get the current user task status (summary by state)", "operationId": "getUserTaskStatus", "parameters": [ { "name": "workflow_type_id", "in": "query", "description": "Only return tasks from the given workflow type id(s)", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "default": [] } }, { "name": "process_variable_name", "in": "query", "description": "(May only be provided in combination with parameter 'process_variable_value'). See description of parameter 'process_variable_value'", "required": false, "schema": { "type": "string" } }, { "name": "process_variable_value", "in": "query", "description": "(May only be provided in combination with parameter 'process_variable_name'). Only return tasks for which the given process variable has the given string as value", "required": false, "schema": { "type": "string" } }, { "name": "hide_authoring_tasks", "in": "query", "description": "Hide authoring tasks", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/hal+json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } } }, "components": { "parameters": { "AssetFilesiam_id": { "name": "iam_id", "required": false, "in": "query", "description": "(Internal use only) Make request relative to the specific iam id. Respected only when 'userfs' is also supplied.", "example": "0000000000", "schema": { "type": "string" } }, "AssetFilesuserfs": { "name": "userfs", "required": false, "in": "query", "description": "The flag for git-based projects.", "example": false, "schema": { "type": "boolean" } }, "AssetFilesspace_id": { "name": "space_id", "required": false, "description": "Make request relative to the specified space.", "example": "00ad857d-44e5-4224-b02f-d6d67bbb97c0", "in": "query", "schema": { "type": "string" } }, "AssetFilesaccount_id": { "name": "account_id", "required": false, "description": "Make request relative to the specified account.", "example": "999", "in": "query", "schema": { "type": "string" } }, "AssetFilescatalog_id": { "name": "catalog_id", "required": false, "description": "Make request relative to the specified catalog.", "example": "3edb984f-df1e-4017-ae30-c1ca42fac19c", "in": "query", "schema": { "type": "string" } }, "AssetFilesproject_id": { "name": "project_id", "required": false, "description": "Make request relative to the specified project.", "example": "7cda791d-fcbc-405a-93f4-4be95d09e4ff", "in": "query", "schema": { "type": "string" } }, "AssetFilesServiceAuthorization": { "name": "Authorization", "in": "header", "description": "(Internal use only) Authorization value should use Basic [token] format where [token] is an opaque access token obtained by authenticating with appropriate auth service.", "schema": { "type": "string", "default": "Basic token" } }, "AssetFilestask_id": { "name": "task_id", "required": false, "description": "Optional paramater, the supplied id will be used in resulting RabbitMQ event.", "in": "query", "schema": { "type": "string" } }, "AssetFilesproject_id_git": { "name": "project_id", "required": true, "description": "Make request relative to the specified project.", "example": "7cda791d-fcbc-405a-93f4-4be95d09e4ff", "in": "query", "schema": { "type": "string" } }, "Connectionsuserfs": { "name": "userfs", "in": "query", "description": "true for a project needs assets managed by the /userfs API, i.e. if it has git integration", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "false" }, "x-sdk-global-param": true }, "Connectionsspace_id": { "name": "space_id", "in": "query", "description": "The ID of the space to use. catalog_id, project_id, or space_id is required.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsproject_id": { "name": "project_id", "in": "query", "description": "The ID of the project to use. catalog_id, project_id, or space_id is required.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionscatalog_id": { "name": "catalog_id", "in": "query", "description": "The ID of the catalog to use. catalog_id, project_id, or space_id is required.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionspersist": { "name": "persist", "in": "query", "description": "Whether to persist assets or changes on assets. If set to false, it makes the service to perform all the actions on the way, execute testing, inject properties (like satellite properties or vault properties), if applicable, and then return the object as it would look like if persisted + with all the usual additioanl elements of response properties returned via Java API (like interaction_properties), but metadata record itself that gets filled with properties from the response from CAMS service is not filled, so it only contains those properties that are set directly from the entity taken from payload.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "true" } }, "Connectionsskip_enforcement": { "name": "Skip-Enforcement", "in": "header", "description": "The indicator whether shared credentials disablement and vault credentials enforcement guards should be disabled for creation and updates", "required": false, "style": "simple", "explode": false, "schema": { "type": "boolean", "default": "false" } }, "Connectionstest": { "name": "test", "in": "query", "description": "Whether to test the connection before saving it. By default an attempt to establish a connection will be made, and the connection will not be saved if the connection cannot be established.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "true" } }, "Connectionsinclude_properties": { "name": "include_properties", "in": "query", "description": "Whether to return information about connection and interaction properties.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "true" } }, "Connectionsdecrypt_secrets": { "name": "decrypt_secrets", "in": "query", "description": "Whether to return decrypted secrets for unrestricted connections.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "true" } }, "Connectionsinteraction_properties": { "name": "interaction_properties", "in": "query", "description": "Whether to return information about source and target interaction properties.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "Connectionsinject_token": { "name": "Inject-Token", "in": "header", "description": "Boolean indicator if cluster username and access token should be injected into connection properties. It has to be ensured that access token is not revealed unintentionally together with connection properties.", "required": false, "style": "simple", "explode": false, "schema": { "type": "boolean", "default": "false" } }, "Connectionsentity_flags": { "name": "entity.flags", "in": "query", "description": "A comma separated list of flags that must be present for the connection to be included in the list. If not provided, only connections with no flags will be returned.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsentity_properties": { "name": "entity.properties", "in": "query", "description": "The properties of the connection that must match for the connection to be included in the list.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsentity_context": { "name": "entity.context", "in": "query", "description": "The context of the connection. Can be one of \"source\", \"target\", or \"source,target\".", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsentity_datasource_type": { "name": "entity.datasource_type", "in": "query", "description": "The data source type of the connection. To specify multiple data source types, use a comma-separated string, such as entity.datasource_type=,.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsentity_name": { "name": "entity.name", "in": "query", "description": "The name of the connection.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsmetadata_creator": { "name": "metadata.creator", "in": "query", "description": "The creator of the connection.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionslimit": { "name": "limit", "in": "query", "description": "The limit of the number of items to return, for example limit=50. If not specified a default of 100 will be used.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": "100" } }, "Connectionsstart": { "name": "start", "in": "query", "description": "The page token indicating where to start paging from.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionssort": { "name": "sort", "in": "query", "description": "The field to sort the results on, including whether to sort ascending (+) or descending (-), for example, sort=-metadata.create_time", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsconnection_id": { "name": "connection_id", "in": "path", "description": "The ID of the connection.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, "Connectionsentity_product": { "name": "entity.product", "in": "query", "description": "Specify the product the data source type must support to be returned. The available products are 'catalog', 'cpd', 'datastage', 'dv', 'igc', 'mdi', 'ml' and 'studio'. If no entity.product is specified, no filtering is applied. To specify multiple products, use a comma-separated string, such as entity.product=catalog,studio.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionscalculate_data_source_definition_searchable": { "name": "calculate_data_source_definition_searchable", "in": "query", "description": "Whether to calculate data_source_definition_searchable property for updated connections.", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "false" } }, "Connectionscalculate_resource_key": { "name": "calculate_resource_key", "in": "query", "description": "Whether to calculate resource keys for updated connections.", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "false" } }, "Connectionsfilters": { "name": "filters", "in": "query", "description": "A JSON object containing a set of properties to define filtering of the assets to be returned.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsproperties": { "name": "properties", "in": "query", "description": "A JSON object containing a set of properties to configure aspects of the asset browsing.", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "x-cli-option-name": "asset-properties" }, "x-cli-option-name": "asset-properties" }, "Connectionsaccept": { "name": "Accept", "in": "header", "description": "Specify whether to return the asset's data in parsed form (application/json) or as raw bytes. This only applies to sources that produce data as a file, document or stream of bytes. To return bytes specify application/octet-stream.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string" } }, "Connectionscontext": { "name": "context", "in": "query", "description": "Specify whether assets are discovered for the purpose of reading (source) or writing (target). If not specified, source is used by default.", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": [ "source", "target" ], "x-cli-option-name": "discovery-context" }, "x-cli-option-name": "discovery-context" }, "Connectionsdetail": { "name": "detail", "in": "query", "description": "Specify whether to return additional asset-specific details. If not specified, these details are not returned.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "Connectionsfetch": { "name": "fetch", "in": "query", "description": "Specify whether to return the asset's metadata, the asset's data, interaction properties, connection properties, or data source type. If not specified, metadata is used by default. This parameter only applies when requesting details about a data set. To specify multiple fetch values, use a comma-separated string, such as fetch=data,metadata,interaction,connection,datasource_type.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsoffset": { "name": "offset", "in": "query", "description": "The 0-based index of the first result to return, for example, offset=200. If not specified, the default offset of 0 is used.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 0, "type": "integer", "default": "0" } }, "Connectionspath": { "name": "path", "in": "query", "description": "Path of the asset.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsdata_asset_space_id": { "name": "data_asset_space_id", "in": "query", "description": "The ID of the space that contains the data asset.", "required": false, "explode": false, "schema": { "type": "string" } }, "Connectionsdata_asset_project_id": { "name": "data_asset_project_id", "in": "query", "description": "The ID of the project that contains the data asset.", "required": false, "explode": false, "schema": { "type": "string" } }, "Connectionsdata_asset_catalog_id": { "name": "data_asset_catalog_id", "in": "query", "description": "The ID of the catalog that contains the data asset.", "required": false, "explode": false, "schema": { "type": "string" } }, "Connectionsdata_asset_id": { "name": "data_asset_id", "in": "query", "description": "The ID of the data asset.", "required": false, "explode": false, "schema": { "type": "string" } }, "Connectionsdata_asset_id_path": { "name": "data_asset_id", "in": "path", "description": "The ID of the data asset.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, "Connectionsaccept_language": { "name": "Accept-Language", "in": "header", "description": "The user's preferred locale identifier.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "default": "en-US" } }, "Connectionsshow_data_source_definitions_only": { "name": "show_data_source_definitions_only", "in": "query", "description": "Whether to filter the list of available datasource types and return only those that have their dataSourceDefinitionId parameter set and its value is the same as the value of the datasource type id. That means that returned are only datasource types which should have proper deep enforcement in Data Privacy Service supported and are the canonical types (not the connectors that use the same engine, but have a different flavor).", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "false" } }, "Connectionsgenerate_transitive_conditions": { "name": "generate_transitive_conditions", "in": "query", "description": "Whether to generate extra conditions in common properties format that will make them behave in a transitive manner under default configuration options of Elyra i.e. when a condition is part of a chain it will enable/disable everything down the chain rather than just hiding the control. Support for this option has been removed. Option itself was not removed to preserve binary compatibility but it no longer has any effect.", "required": false, "deprecated": true, "style": "form", "explode": true, "schema": { "type": "boolean", "default": "false" } }, "Connectionsproduct_selector_scope": { "name": "product_selector_scope", "in": "query", "description": "Scope of ui-only product selector property. Applies to output under common_properties key. Genreated ui contains additional checkbox to switch between first of the requested products and the rest. If only a single one is given it switches between that product and remaining products supported by the data source.", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": [ "global", "context" ] } }, "Connectionsentity.environment": { "name": "entity.environment", "in": "query", "description": "Specify the environment the data source types must support to be included in the returned list. The available environments are 'cloud', 'streams' and 'local'. If no entity.environment is specified, the default for service's deploy environment is used. To specify multiple environments, use a comma-separated string, such as entity.environment=cloud,streams.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "Connectionsactions": { "name": "actions", "in": "query", "description": "Whether to return information about supported actions.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "Connectionsdiscovery": { "name": "discovery", "in": "query", "description": "Whether to return information about discovery capabilities.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "Connectionsconnection_properties": { "name": "connection_properties", "in": "query", "description": "Whether to return information about connection properties.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "Connectionsdatasource_type": { "name": "datasource_type", "in": "path", "description": "The data source type.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, "DataProfilescharge_term_assignment": { "name": "Charge term assignment", "in": "query", "description": "Whether to charge the bulk profiling to include term assignment charges.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataProfilesuse_mde": { "name": "use_mde", "in": "query", "description": "Whether to use Metadata enrichment for profiling. If set to true, Metadata enrichment features are eanbled (will use new Lite services).", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataProfileslite_mode": { "name": "lite_mode", "in": "query", "description": "Include minimum payload for profiling results. If set to true, only minimum required details for DPS are available in the response.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataProfilesinclude_entity": { "name": "include_entity", "in": "query", "description": "Whether to include the entity component. If set to false, only the metadata component is populated in the response.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": true } }, "DataProfilesdataset_id": { "name": "dataset_id", "in": "query", "description": "The ID of the data set to use.", "required": true, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilesproject_id": { "name": "project_id", "in": "query", "description": "The ID of the project to use. catalog_id or project_id is required.", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilescatalog_id": { "name": "catalog_id", "in": "query", "description": "The ID of the catalog to use. catalog_id or project_id is required.", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilesstop_in_progress_profiling_runs": { "name": "stop_in_progress_profiling_runs", "in": "query", "description": "Whether to stop all running profiling processes. Data profiles that are running must be stopped before they can be deleted.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataProfilesprofile_id": { "name": "profile_id", "in": "path", "description": "The profile ID to use.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, "DataProfilesbss_account_ids": { "name": "bss_account_ids", "in": "query", "description": "Comma separated list of the BSS Account IDs to use (restriced usage).", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilescorrelation_id": { "name": "correlation_id", "in": "query", "description": "The ID to be used for tracking end to end flow.", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilestenant_id": { "name": "tenant_id", "in": "query", "description": "The tenant ID to use.", "required": true, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilestaskId": { "name": "taskId", "in": "query", "description": "The ID of the export task ID to use.", "required": true, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilesdataset_id_optional": { "name": "dataset_id", "in": "query", "description": "The ID of the data set to use.(Use comma separated data set Id's for multiple data sets)", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilesall_details": { "name": "all_details", "in": "query", "description": "Fetch complete details of job.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataProfilesjob_type": { "name": "job_type", "in": "query", "description": "The type of the job.", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilesbss_account_id": { "name": "bss_account_id", "in": "query", "description": "The BSS Account ID to use.", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "DataProfilesstop_in_progress_job": { "name": "stop_in_progress_job", "in": "query", "description": "Stop running job.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataProfileshb_task_id": { "name": "hb_task_id", "in": "path", "description": "The ID of the HB task to use.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, "DataQualityProjectId": { "name": "project_id", "in": "query", "description": "The ID of the project to use. A catalog_id or project_id is required.", "required": false, "style": "form", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, "DataQualityCatalogId": { "name": "catalog_id", "in": "query", "description": "The ID of the catalog to use. A catalog_id or project_id is required.", "required": false, "style": "form", "explode": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string" } }, "DataQualityTypeQuery": { "name": "type", "in": "query", "description": "The type of the resource to search. If omitted, filtering on type is not applied", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityTypeIdentity" } }, "DataQualityIncludeChildrenQuery": { "name": "include_children", "in": "query", "description": "If true include the children in the returned resource. If false, only return the resource without its eventual children.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataQualityLimitQuery": { "name": "limit", "in": "query", "description": "The maximum number of resources to return.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityLimit" } }, "DataQualityStartQuery": { "name": "start", "in": "query", "description": "The start token of the resource from where the page should begin. If omitted, begins with first resource.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityStart" } }, "DataQualityAssetId": { "name": "id", "in": "path", "description": "The data quality asset identifier.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityDeleteChildren": { "name": "delete_children", "in": "query", "description": "If true, delete all children recursively. Otherwise, only selected one is deleted.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataQualityWKCAssetId": { "name": "wkc_asset_id", "in": "query", "description": "The IBM Knowledge Catalog asset ID in cams. If omitted, the field is not set.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityNativeIdQuery": { "name": "native_id", "in": "query", "description": "The native id, as known by the DQ producer, of the resource to search. If not provided, other identity parameters must be provided.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityNativeIdentity" } }, "DataQualityCheckId": { "name": "id", "in": "path", "description": "The data quality check identifier.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityTypeQueryRequired": { "name": "type", "in": "query", "description": "The type of the resource to search.", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityTypeIdentity" } }, "DataQualityNativeIdQueryRequired": { "name": "native_id", "in": "query", "description": "The native id, as known by the DQ producer, of the resource to search.", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityNativeIdentity" } }, "DataQualityDimensionId": { "name": "id", "in": "path", "description": "The data quality dimension identifier.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityNameQueryRequired": { "name": "name", "in": "query", "description": "The name of the resource to search or a part of the name of the resources to search.", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityDQResourceName" } }, "DataQualitySortDirectionQuery": { "name": "sort_direction", "in": "query", "description": "The direction to sort with. If omitted, sorting attribute descending is applied", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "example": "asc", "default": "desc", "enum": [ "asc", "desc" ] } }, "DataQualitySortByQuery": { "name": "sort_by", "in": "query", "description": "The issue attribute to sort on. If omitted, sorting on last update time is applied", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "example": "check_name", "default": "updated_at", "enum": [ "check_name", "check_type", "check_dimension_name", "percent_occurrences", "ignored", "updated_at" ] } }, "DataQualityIncludeChildrenQueryWithChildren": { "name": "include_children", "in": "query", "description": "If true include the children in the returned resource. If false, only return the resource without its eventual children.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": true } }, "DataQualityLatestOnlyQuery": { "name": "latest_only", "in": "query", "description": "If true, returns only the latest issue summary of each DQ check. If false, returns the latest and archived issues.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": true } }, "DataQualityDimensionIdsQuery": { "name": "check.dimension.id", "in": "query", "description": "Comma-separated list of data quality dimension identifiers.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentities" } }, "DataQualityCheckNameQuery": { "name": "check.name", "in": "query", "description": "The name or part of the name of data quality check identifier to search issues of. If not provided, filtering on name of check is not applied.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityDQResourceName" } }, "DataQualityCheckNativeIdQuery": { "name": "check.native_id", "in": "query", "description": "Comma-separated list of data quality check native id identifier to search issues of. If not provided, filtering on a check is not applied. Only one of checkId or checkNativeId should be provided; if both are provided, an error will be thrown.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentities" } }, "DataQualityCheckIdentityQuery": { "name": "check.id", "in": "query", "description": "Comma-separated list of data quality check id identifier to search issues of. If not provided, filtering on a check is not applied.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentities" } }, "DataQualityAssetReportedForIdentitiesQuery": { "name": "reported_for.id", "in": "query", "description": "Comma-separated list of data quality asset identifier to search issues of. If not provided, filtering on asset is not applied.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentities" } }, "DataQualityIssueId": { "name": "id", "in": "path", "description": "The data quality issue identifier.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityCheckIdentityQueryRequired": { "name": "check.id", "in": "query", "description": "The data quality check identifier to search issues of.", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityAssetReportedForIdentityQueryRequired": { "name": "reported_for.id", "in": "query", "description": "The data quality asset identifier", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityScoreOlderByDaysQuery": { "name": "score_older_by_days", "in": "query", "description": "Score of asset or dimension that is older by given days.", "required": false, "style": "form", "explode": false, "schema": { "type": "integer", "format": "int32", "example": 0, "default": 0 } }, "DataQualityDimensionIdQuery": { "name": "dimension.id", "in": "query", "description": "The data quality dimension identifier. If not provided, filtering on dimension is not applied.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityAssetIdentityQueryRequired": { "name": "asset.id", "in": "query", "description": "The data quality asset identifier", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityAssetsIdentityQueryRequired": { "name": "asset.ids", "in": "query", "description": "Comma-separated list of data quality assets identifier", "required": true, "style": "form", "explode": false, "schema": { "maxLength": 1000000000, "minLength": 1, "type": "string", "description": "Comma-separated list of resource identifiers.", "example": "b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710" } }, "DataQualitySLAIdentity": { "name": "sla_id", "in": "path", "description": "The data quality Service Level Agreement identifier", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityViolationsFirstQuery": { "name": "violations_first", "in": "query", "description": "Defines whether assessments with violations should be listed first.\nIgnored when an SLA id is provided.\n", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "description": "Defines whether assessments with violations should be listed first", "default": true } }, "DataQualityLatestAssessmentsOnlyQuery": { "name": "latest_only", "in": "query", "description": "If true, returns only the latest assessment for each SLA.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataQualitySLAIdentityQuery": { "name": "sla.id", "in": "query", "description": "The data quality Service Level Agreement identifier", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualitySLAAssessmentIdentity": { "name": "assessment_id", "in": "path", "description": "The data quality SLA assessment identifier", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityViolationLimitQuery": { "name": "violation_limit", "in": "query", "description": "The maximum number of violations to return.", "required": false, "style": "form", "explode": false, "schema": { "maximum": 200, "minimum": 0, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, "DataQualityActiveQuery": { "name": "active", "in": "query", "description": "Whether SLA assessments should be active or inactive", "required": true, "style": "form", "explode": false, "schema": { "type": "boolean" } }, "DataQualityProjectId1": { "name": "project_id", "in": "path", "description": "The identifier of the project to use.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityCancelUnfinishedJobs": { "name": "cancel_unfinished_jobs", "in": "query", "description": "The option to cancel unfinished jobs before deleting or updating data quality rules.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataQualityDeleteOutput": { "name": "delete_output", "in": "query", "description": "The option to delete related output tables when deleting data quality rules.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataQualityRuleIdsRequired": { "name": "id", "in": "query", "description": "Comma-separated list of data quality rule identifiers.", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIds" } }, "DataQualityRuleIds": { "name": "id", "in": "query", "description": "Comma-separated list of data quality rule identifiers.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIds" } }, "DataQualityStartQuery1": { "name": "start", "in": "query", "description": "The start token of the resource from where the page should begin.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityStart" } }, "DataQualityRuleId": { "name": "id", "in": "path", "description": "The data quality rule identifier.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityKeepRuleRelationships": { "name": "keep_rule_relationships", "in": "query", "description": "The option to keep the current data quality rule input binding relationships while updating the data quality rule.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": false } }, "DataQualityCatalogId1": { "name": "catalog_id", "in": "path", "description": "The identifier of the catalog to use.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityIncludeExecutions": { "name": "include_executions", "in": "query", "description": "The number of executions to be included in the Rule export.", "required": false, "style": "form", "explode": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "example": 20 } }, "DataQualityRuleIdQualified": { "name": "rule_id", "in": "path", "description": "The data quality rule identifier.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityRuleExecutionSort": { "name": "sort", "in": "query", "description": "The property name by which the results should be sorted. For descending order, use the hyphen (-) prefix with the value. If you omit this query parameter, the order value is `-started_at`, which means, results are sorted by the `started_at` value in descending order. The allowed fields are `started_at`, `passing_record_count`, `failing_record_count`, `tested_record_count`, `status.state`.", "required": false, "style": "form", "explode": false, "schema": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The fields that can be used for sorting. The allowed fields are `started_at`, `passing_record_count`, `failing_record_count`, `tested_record_count`, `status.state`. For descending order, use the hyphen (-) prefix with the value." } }, "DataQualityExecutionId": { "name": "id", "in": "path", "description": "The run identifier to use.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityPaginationQuery": { "name": "pagination", "in": "query", "description": "The flag indicating to gather the total size of the output for pagination or not.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean", "default": true } }, "DataQualityOffsetQuery": { "name": "offset", "in": "query", "description": "The first index in output.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityOffset" } }, "DataQualityDefinitionIdsRequired": { "name": "id", "in": "query", "description": "Comma separated list of data quality definition identifiers.", "required": true, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIds" } }, "DataQualityDefinitionIds": { "name": "id", "in": "query", "description": "Comma-separated list of data quality definition identifiers.", "required": false, "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIds" } }, "DataQualityDefinitionId": { "name": "id", "in": "path", "description": "The data quality definition identifier.", "required": true, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "DataQualityPartialExpression": { "name": "partial_expression", "in": "query", "description": "True if the expression to validate is an output column expression. False if the expression to validate is a data quality definition expression. Default value is false.", "required": false, "style": "form", "explode": false, "schema": { "type": "boolean" } }, "Jobsuserfs": { "name": "userfs", "in": "query", "description": "Set to true for calls in git-based projects.", "schema": { "type": "boolean", "default": false } }, "ProjectsIncludePermissionsParameter": { "name": "cpdaas-include-permissions", "description": "A CPDaaS specific flag indicating whether to fetch IAM permissions for the authenticated user as part of the request. Used to determine superuser access via the \"manage_project\" permission.", "in": "header", "schema": { "type": "boolean", "default": false } }, "ProjectsListProjectsSkipParameter": { "name": "skip", "description": "Deprecated. Use of this query parameter exhibits poor performance characteristics. Use the more efficient \"bookmark\" query parameter instead. The offset to use to define the starting index of projects to return in the query results. Used for pagination in conjunction with the \"limit\" query parameter.", "deprecated": true, "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 0, "default": 0 }, "x-cli-flag-shorthand": "s" }, "ProjectsListProjectsBookmarkParameter": { "name": "bookmark", "description": "The bookmark is an opaque key returned in the query results set that serves as a reference to the next page of query results. Specify the bookmark on subsquent query requests to retrieve the next page of query results. Used for pagination in conjunction with the \"limit\" query parameter.", "in": "query", "schema": { "$ref": "#/components/schemas/ProjectsBookmark" }, "x-cli-flag-shorthand": "b" }, "ProjectsListProjectsLimitParameter": { "name": "limit", "description": "The limit used to specify the maximum number of projects returned in the query results. Used for pagination in conjunction with the \"bookmark\" query parameter.", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 100, "default": 10 }, "x-cli-flag-shorthand": "l" }, "ProjectsListProjectsIncludeParameter": { "name": "include", "description": "A list of comma-separated project metadata sections to include in the query results.", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "name", "fields", "members", "tags", "settings", "everything", "nothing" ] }, "default": [ "fields" ] }, "x-cli-flag-shorthand": "I" }, "ProjectsListProjectsIDsParameter": { "name": "project_ids", "description": "A list of comma-separated project IDs to use to filter the query results. This query parameter only works in conjunction with the 'member' query parameter.", "in": "query", "style": "form", "explode": false, "schema": { "type": "string", "example": "d122ffba-de9e-4c67-89c4-0091f1610076,deb5b1d8-5fd4-486c-92ef-12e90959dbf1" }, "x-cli-flag-shorthand": "g" }, "ProjectsListProjectsMatchParameter": { "name": "match", "description": "The type of text matching to perform. This query parameter must be used in conjunction with the 'name' query parameter. The 'exact' value will match projects if the specified text matches the exact project name. The 'keyword' value will match projects if the specified text matches any keyword parsed from the project name.", "in": "query", "schema": { "type": "string", "enum": [ "exact", "keyword" ], "default": "exact" }, "x-cli-flag-shorthand": "t" }, "ProjectsListProjectsNameParameter": { "name": "name", "description": "A full or partial project name to use to filter the query results. This query parameter must be used in conjunction with the 'bss_account_id' query parameter. Use the 'match' query parameter to control they type of text matching performed. Project names are not unique and should not be used in place of project IDs.", "in": "query", "schema": { "$ref": "#/components/schemas/ProjectsProjectNameParameter" }, "x-cli-flag-shorthand": "n" }, "ProjectsTagNamesParameter": { "name": "tag_names", "description": "A list of comma-separated tags to use to filter the query results. If multiple tags are specified, the query results will be filtered to show projects matching any of the tags. (e.g. tag1 OR tag2 OR... tagN).", "in": "query", "style": "form", "explode": false, "schema": { "type": "string", "example": "development,test,production" }, "x-cli-flag-shorthand": "e" }, "ProjectsListProjectsRolesParameter": { "name": "roles", "description": "A list of comma-separated project roles to use to filter the query results. Must be used in conjunction with the \"member\" query parameter.", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectsMemberRole" }, "default": [] }, "x-cli-flag-shorthand": "r" }, "ProjectsMemberParameter": { "name": "member", "description": "A project member to use to filter the query results.", "in": "query", "schema": { "$ref": "#/components/schemas/ProjectsMemberUserName" }, "x-cli-flag-shorthand": "m" }, "ProjectsTypeParameter": { "name": "type", "description": "The project type.", "in": "query", "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/ProjectsProjectType" }, "x-cli-flag-shorthand": "T" }, "ProjectsBSSAccountIDParameter": { "name": "bss_account_id", "description": "The BSS Account ID.", "in": "query", "style": "form", "explode": false, "schema": { "$ref": "#/components/schemas/ProjectsBSSAccountID" }, "x-cli-flag-shorthand": "a" }, "ProjectsProjectIDParameter": { "name": "project_id", "description": "The project ID.", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ProjectsProjectID" }, "x-cli-flag-shorthand": "i" }, "ProjectsGetProjectIncludeParameter": { "name": "include", "description": "A list of comma-separated project metadata sections to include in the query results.", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "name", "fields", "members", "tags", "settings", "integrations", "storage", "credentials", "everything", "nothing" ] }, "default": [ "fields" ] }, "x-cli-flag-shorthand": "I" }, "ProjectsDeleteMemberUserNamesParameter": { "name": "user_names", "description": "A list of comma-separated usernames corresponding to project members to remove from the project.", "in": "query", "required": true, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectsMemberUserName" } }, "x-cli-flag-shorthand": "u" }, "ProjectsGetMemberUserNamesParameter": { "name": "user_names", "description": "A list of comma-separated usernames corresponding to project members that are used to filter the query results.", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectsMemberUserName" } }, "x-cli-flag-shorthand": "u" }, "ProjectsListMembersRolesParameter": { "name": "roles", "description": "A list of comma-separated project roles to use to filter the query results.", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectsMemberRole" }, "default": [] }, "x-cli-flag-shorthand": "r" }, "ProjectsMemberUserNameParameter": { "name": "user_name", "description": "The username of the project member.", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ProjectsMemberUserName" }, "x-cli-flag-shorthand": "u" }, "ProjectsResolveGroupsParameter": { "name": "resolve_groups", "description": "A flag indicating whether to return a derived project member based on resolving user groups.", "in": "query", "schema": { "type": "boolean", "default": true }, "x-cli-flag-shorthand": "g" }, "ProjectsTagNameParameter": { "name": "tag_name", "description": "The tag name.", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ProjectsProjectTag" }, "x-cli-flag-shorthand": "t" }, "TransactionalProjectsStatusTransactionIDParameter": { "name": "transaction_id", "in": "path", "description": "The transaction ID provided by create project as a transaction endpoint.", "required": true, "schema": { "$ref": "#/components/schemas/TransactionalProjectsTransactionIDParameter" } }, "TransactionalProjectsStatusProjectIDParameter": { "name": "project_id", "in": "path", "description": "The ID of the project on which transaction was created.", "required": true, "schema": { "$ref": "#/components/schemas/TransactionalProjectsProjectIDParameter" } } }, "securitySchemes": { "CPD": { "type": "http", "scheme": "bearer" } }, "schemas": { "HrefModel": { "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string", "description": "URI of a resource" } } }, "JSONResourcePatchRequestModel": { "type": "array", "description": "Contains updates to an object via a PATCH request, as specified by the JSON patch format in RFC 6902", "items": { "$ref": "#/components/schemas/JSONResourcePatchModel" } }, "JSONResourcePatchModel": { "type": "object", "properties": { "op": { "type": "string", "description": "The operation to be performed", "enum": [ "add", "remove", "replace", "move", "copy", "test" ] }, "path": { "type": "string", "description": "A JSON pointer to the field to update" }, "from": { "type": "string", "description": "A string containing a JSON pointer value" }, "value": { "type": "object", "properties": {} } } }, "ErrorContainer": { "type": "object", "required": [ "errors", "trace" ], "properties": { "trace": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorModel" } } } }, "ErrorModel": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "target": { "$ref": "#/components/schemas/ErrorTargetModel" }, "message": { "type": "string" }, "more_info": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ErrorTargetModel": { "type": "object", "required": [ "name", "type" ], "properties": { "type": { "type": "string", "enum": [ "field", "parameter", "header" ] }, "name": { "type": "string" } } }, "AssetFilesErrorObject": { "type": "object", "properties": { "code": { "type": "integer", "description": "The error code for the operation." }, "error": { "type": "string", "description": "Description for the error code." }, "reason": { "type": "string", "description": "A short reason for why the error occured." }, "message": { "type": "string", "description": "Further information regarding the error." } } }, "AssetFilesDeleteOutcome": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "description": "The path of the resource that the server attempted to delete." }, "deleted": { "type": "boolean", "description": "True if the file/folder was successfully deleted and false otherwise. If false error object will be returned with reason for failure." }, "error": { "$ref": "#/components/schemas/AssetFilesErrorObject" } } } }, "AssetFilesDeleteAssetFiles": { "type": "array", "items": { "type": "string", "description": "The path of a file to delete. If path points to a folder it must be empty or else delete will fail." } }, "AssetFilesAssetFileMetadata": { "type": "object", "properties": { "path": { "type": "string", "description": "The path of the file." }, "etag": { "type": "integer", "description": "ETAG for the resource. Not returned when streaming responses." }, "size": { "type": "integer", "description": "The size in bytes for files. The number of resource for folders." }, "type": { "type": "string", "description": "Either folder or file." }, "mime_type": { "type": "string", "description": "If the resource is a file this will be the mime type of the file. If the mime_type cannot be determined it will not be returned." }, "last_modified": { "type": "string", "description": "Time when the asset was last modified, defaults to create date. Returned in json timestamp format." } } }, "AssetFilesPaginationURL": { "type": "object", "properties": { "href": { "type": "string", "description": "URL to indicated pagination result." } } }, "AssetFilesInflate": { "type": "object", "properties": { "source": { "type": "string", "description": "The relative path to the archive in asset-files" }, "target": { "type": "string", "description": "The relative target location to inflate the file to" } } }, "AssetFilesCopyAssetFile": { "type": "object", "properties": { "source": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the source container." }, "guid": { "type": "string", "description": "The guid of the source container." }, "path": { "type": "string", "description": "The location of the asset being copied" }, "root": { "type": "boolean", "description": "(Internal use only) If set to true the path will be relative to the container root directory. Note, there is one exception. If supplied along with 'userfs' param targetting a project where the user has correct permissions this is also viable'" }, "userfs": { "type": "boolean", "description": "Specify path based on git based project structure.", "default": false } } }, "target": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the source container." }, "guid": { "type": "string", "description": "The guid of the source container." }, "path": { "type": "string", "description": "The location where the asset should be copied" }, "root": { "type": "boolean", "description": "(Internal use only) If set to true the path will be relative to the container root directory. Note, there is one exception. If supplied along with 'userfs' param targetting a project where the user has correct permissions this is also viable'" }, "userfs": { "type": "boolean", "description": "Specify path based on git based project structure.", "default": false } } } } }, "AssetFilesSuccessResponse": { "type": "object", "properties": { "message": { "type": "string" } } }, "AssetFilesaccessToken": { "type": "object", "properties": { "git_host": { "type": "string", "description": "The value for the desired git host.", "enum": [ "github", "github_enterprise", "bitbucket", "bitbucket_enterprise", "gitlab", "gitlab_self_managed" ] }, "token_value": { "type": "string" } }, "required": [ "git_host", "token_value" ] }, "AssetFilesGitSettings": { "type": "object", "properties": { "http": { "type": "object", "properties": { "sslverify": { "type": "string" }, "sslcainfo": { "type": "string" } } } } }, "CatalogArchiveInfo": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ARCHIVE_SCHEDULED", "ARCHIVE_FAILED", "ARCHIVED", "RESTORE_SCHEDULED", "RESTORE_FAILED" ] }, "archive_comment": { "type": "string" }, "archive_file_path": { "type": "string" }, "archive_schedule_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "archive_schedule_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "archive_stop_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "archive_stop_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "restore_schedule_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "restore_schedule_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "restore_stop_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "restore_stop_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "failed_times": { "type": "integer", "description": "The times that the archive/restore process failed for the asset container. Note that a successful archive/restore will reset this field.", "format": "int64" }, "failure": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } }, "CatalogArchiveCatalogRequest": { "type": "object", "properties": { "comment": { "type": "string" } } }, "CatalogErrorContainerModel": { "type": "object", "properties": { "trace": { "type": "string", "description": "Trace (transaction) ID for the failed operation" }, "errors": { "maxItems": 256, "minItems": 0, "type": "array", "description": "Errors thrown during the operation", "items": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "The details of the error." }, "CatalogTargetModel": { "type": "object", "properties": { "type": { "type": "string", "description": "type of error target", "example": "parameter", "enum": [ "field", "parameter", "header" ] }, "name": { "type": "string", "description": "error target name", "example": "catalog_id" } }, "description": "Error target - the specific part of the request which was invalid" }, "CatalogAssetContainerConfiguration": { "type": "object", "properties": { "duplicate_action": { "type": "string", "description": "Action to take if duplicate assets are found for a given asset", "enum": [ "IGNORE", "REJECT", "REPLACE", "UPDATE" ] }, "default_duplicate_strategy": { "type": "string", "description": "Default duplicate detection strategy for assets of types that do not have duplicate detection strategy defined", "enum": [ "DUPLICATE_DETECTION_BY_NAME", "DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY", "DUPLICATE_DETECTION_BY_NAME_AND_FOLDER", "DUPLICATE_DETECTION_BY_RESOURCE_KEY", "DUPLICATE_DETECTION_NOT_APPLICABLE" ] }, "duplicate_strategies": { "type": "array", "description": "Duplicate detection strategies of assets with specified asset types in this catalog/project/space", "items": { "$ref": "#/components/schemas/CatalogAssetTypeDuplicateStrategyConfig" } }, "reporting_authorized": { "type": "boolean", "description": "Authorize reporting in this catalog" }, "default_purge_on_delete": { "type": "boolean", "description": "Whether assets has to be purged on delete" }, "default_purge_after_days": { "type": "integer", "description": "Days after which assets has to be purged after soft delete" } } }, "CatalogAssetTypeDuplicateStrategyConfig": { "type": "object", "properties": { "asset_type": { "type": "string", "description": "The asset type", "example": "data_asset" }, "strategy": { "type": "string", "description": "The duplicate detection strategy to be used for assets of the asset type", "example": "DUPLICATE_DETECTION_BY_NAME", "enum": [ "DUPLICATE_DETECTION_BY_NAME", "DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY", "DUPLICATE_DETECTION_BY_NAME_AND_FOLDER", "DUPLICATE_DETECTION_BY_RESOURCE_KEY", "DUPLICATE_DETECTION_NOT_APPLICABLE" ] } } }, "CatalogAssetListSummary": { "required": [ "created_at", "id", "last_updated_at", "last_updated_by", "name", "state", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the asset list formatted either as a UUID or a special case such as cart_userID.", "readOnly": true, "example": "8509d09e-b3d0-4e8b-9682-726a7b95f69f" }, "asset": { "$ref": "#/components/schemas/CatalogAssetReference" }, "access_control": { "$ref": "#/components/schemas/CatalogAssetListAccessControl" }, "created_at": { "type": "string", "description": "RFC 3339 timestamp when the asset list was created (system managed).", "readOnly": true, "example": "2022-04-22T03:22:32.000Z" }, "last_updated_at": { "type": "string", "description": "RFC 3339 timestamp when the asset list was last updated (system managed).", "readOnly": true, "example": "2022-04-22T03:22:32.000Z" }, "last_updated_by": { "type": "string", "description": "The user who last updated the asset list.", "readOnly": true, "example": "userId" } }, "description": "The Asset list summary API model for retrieval.", "allOf": [ { "$ref": "#/components/schemas/CatalogAssetListBase" } ] }, "CatalogAssetListPrototype": { "required": [ "name", "type" ], "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/CatalogAssetReference" }, "items": { "maxItems": 20, "minItems": 0, "type": "array", "description": "The items in the asset list.", "items": { "$ref": "#/components/schemas/CatalogAssetListItemPrototype" } } }, "description": "The Asset list prototype API model for creation.", "allOf": [ { "$ref": "#/components/schemas/CatalogAssetListBase" } ] }, "CatalogAssetListCollection": { "required": [ "asset_lists", "first", "limit", "total_count" ], "type": "object", "properties": { "asset_lists": { "maxItems": 200, "minItems": 0, "type": "array", "description": "Collection of asset list results.", "items": { "$ref": "#/components/schemas/CatalogAssetListSummary" } } }, "description": "The Asset list collection response API model.", "allOf": [ { "$ref": "#/components/schemas/CatalogBaseCollection" } ] }, "CatalogAssetListBase": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "Asset list name. A name can contain letters, numbers, understores, dashes, spaces or periods. Names are mutable and reusable.", "example": "My wish list" }, "description": { "maxLength": 4000, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "A description of the asset list.", "example": "This list contains assets for project X." }, "type": { "type": "string", "description": "The type of the asset list. Valid types are: ['order', 'cart', 'wishlist']", "example": "order", "enum": [ "cart", "wishlist", "order" ] }, "state": { "type": "string", "description": "The state of the asset list. Valid states are: ['default_state', 'confirmed']. If not specified, the default value will be 'DEFAULT'.", "example": "default_state", "default": "default_state", "enum": [ "default_state", "received", "under_review", "ready_to_deliver", "rejected", "in_progress", "partially_delivered", "succeeded", "failed", "workflow_exception", "cancelled", "redeliver", "reattempt", "rerequest" ] }, "message": { "maxLength": 256, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "A message used for communicating reasons for state changes.", "example": "The reason for the state change." }, "properties": { "$ref": "#/components/schemas/CatalogPropertiesObject" } }, "description": "The Asset list base API model." }, "CatalogAssetListAccessControl": { "required": [ "bss_account_id", "owner" ], "type": "object", "properties": { "owner": { "type": "string", "description": "The user who is the owner of this list.", "example": "userId" }, "bss_account_id": { "type": "string", "description": "The account of the owner of this list.", "example": "a32d7edf96f74bdbb21b5669a9d043x1" } }, "description": "Access control permissions for the asset list." }, "CatalogAssetReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The unique identifier of the asset formatted as a UUID.", "example": "2b0bf220-079c-11ee-be56-0242ac120002" }, "type": { "maxLength": 256, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The type (primary attribute) of the asset", "example": "data_asset" }, "container": { "$ref": "#/components/schemas/CatalogContainerReference" } }, "description": "An asset from a container." }, "CatalogAssetListItemPrototype": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/CatalogAssetReference" }, "properties": { "$ref": "#/components/schemas/CatalogPropertiesObject" } }, "description": "The Asset list item prototype API model for creation." }, "CatalogBaseCollection": { "required": [ "limit", "total_count" ], "type": "object", "properties": { "limit": { "type": "integer", "description": "The limit on the number of results returned.", "readOnly": true, "example": 200, "default": 200 }, "total_count": { "type": "integer", "description": "The total count on the number of results returned, accounting for filtering but not pagination.", "readOnly": true, "example": 50 }, "first": { "$ref": "#/components/schemas/CatalogBaseCollectionPage" }, "next": { "$ref": "#/components/schemas/CatalogBaseCollectionNextPage" } } }, "CatalogPropertiesObject": { "type": "object", "description": "The properties of an asset list item." }, "CatalogContainerReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The id that uniquely identifies the container.", "example": "d29c42eb-7100-4b7a-8257-c196dbcca1cd" }, "type": { "type": "string", "description": "The type of container. Valid values are: ['catalog', 'project', 'space']. If not specified, the default value will be 'CATALOG'.", "example": "catalog", "default": "catalog", "enum": [ "catalog", "project", "space" ] } }, "description": "The container for the asset ('catalog', 'project' or 'space')." }, "CatalogBaseCollectionNextPage": { "required": [ "href", "start" ], "type": "object", "properties": { "start": { "type": "string", "description": "Start token for pagination to the next page in the collection", "readOnly": true, "example": "eyJvZmZzZXQiOjAsImRvbmUiOnRydWV9" } }, "description": "The next page in the collection.", "allOf": [ { "$ref": "#/components/schemas/CatalogBaseCollectionPage" } ] }, "CatalogBaseCollectionPage": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "Link to the first page in the collection.", "readOnly": true, "example": "http://api.example.com/collection?start=eyJvZmZzZXQiOjAsImRvbmUiOnRydWV9" } }, "description": "A page in a pagination collection." }, "CatalogJsonStringPatch": { "type": "object", "properties": { "path": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$&/\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The Json patch path as defined by RFC 6902." }, "from": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$&/\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The Json patch from path as defined by RFC 6902." }, "value": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$&\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The Json patch value." }, "operation": { "type": "string", "description": "The Json patch operation as defined by RFC 6902.", "enum": [ "add", "replace", "remove", "move", "copy", "test" ] } }, "description": "Json patch instruction as defined by RFC 6902." }, "CatalogAssetListItemCollection": { "required": [ "first", "items", "limit", "total_count" ], "type": "object", "properties": { "items": { "maxItems": 200, "minItems": 0, "type": "array", "description": "Collection of asset list item results.", "items": { "$ref": "#/components/schemas/CatalogAssetListItem" } } }, "description": "The Asset list item collection response API model.", "allOf": [ { "$ref": "#/components/schemas/CatalogBaseCollection" } ] }, "CatalogAssetListItem": { "required": [ "asset", "asset_list", "created_at", "id", "last_updated_at", "last_updated_by" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the asset list item formatted as a UUID.", "readOnly": true, "example": "8509d09e-b3d0-4e8b-9682-726a7b95f69f" }, "access_control": { "$ref": "#/components/schemas/CatalogAssetListAccessControl" }, "created_at": { "type": "string", "description": "RFC 3339 timestamp when the asset list item was created (system managed).", "readOnly": true, "example": "2022-04-22T03:22:32.000Z" }, "last_updated_at": { "type": "string", "description": "RFC 3339 timestamp when the asset list item was last updated (system managed).", "readOnly": true, "example": "2022-04-22T03:22:32.000Z" }, "last_updated_by": { "type": "string", "description": "The user who last updated the asset list item.", "readOnly": true, "example": "userId" }, "asset_list": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the asset list item formatted as a UUID.", "readOnly": true, "example": "8509d09e-b3d0-4e8b-9682-726a7b95f69f" } }, "description": "The reference to the asset list to which the item belongs.", "readOnly": true } }, "description": "The Asset list item canonical API model.", "allOf": [ { "$ref": "#/components/schemas/CatalogAssetListItemPrototype" } ] }, "CatalogJsonPatchInstruction": { "type": "object", "properties": { "path": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$&/\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The Json patch path as defined by RFC 6902." }, "from": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\w\\.,:$&/\\(\\)\\s\\-\\_\\^\"]+$", "type": "string", "description": "The Json patch from path as defined by RFC 6902." }, "value": { "type": "object", "description": "The Json patch value." }, "operation": { "type": "string", "description": "The Json patch operation as defined by RFC 6902.", "enum": [ "add", "replace", "remove", "move", "copy", "test" ] } }, "description": "Json patch instruction as defined by RFC 6902." }, "CatalogResponseRelationshipType": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "required": [ "created", "created_at", "creator_id", "relationship_type_id", "tenancy", "updated", "updated_at", "updater_id" ], "type": "object", "properties": { "relationship_type_id": { "type": "string", "description": "Unique ID of the relationship type" }, "creator_id": { "type": "string", "description": "ID of the user that created the relationship type" }, "created": { "type": "integer", "description": "Creation timestamp in milliseconds", "format": "int64" }, "created_at": { "type": "string", "description": "Creation timestamp in yyyy-MM-dd'T'HH:mm:ss.SSSX format" }, "updated": { "type": "integer", "description": "Update timestamp in milliseconds", "format": "int64" }, "updated_at": { "type": "string", "description": "Update timestamp in yyyy-MM-dd'T'HH:mm:ss.SSSX format" }, "updater_id": { "type": "string", "description": "ID of the user that updated the relationship type" }, "tenancy": { "type": "object", "properties": { "tenancy_type": { "type": "string", "enum": [ "GLOBAL", "BSS_ACCOUNT" ] }, "bss_account_id": { "type": "string" } }, "description": "Tenancy of the relationship type" } }, "description": "relationship type metadata" }, "entity": { "required": [ "end1", "end2" ], "type": "object", "properties": { "end1": { "required": [ "default_display_name", "multiplicity", "relationship_name" ], "type": "object", "properties": { "default_display_name": { "type": "string", "description": "Default display name for this end of the relationship. This is what will be shown in the UI." }, "localized_display_name": { "type": "object", "description": "Map of localized display names, keyed on the ISO 639 language code (e.g. \"zh\")", "additionalProperties": { "type": "string" } }, "relationship_name": { "type": "string", "description": "Internal, non-translated, name for this end of the relationship. This becomes part of the path in the APIs for manipulating and querying relationship types." }, "containing_artifact_type": { "type": "string", "description": "Optionally specifies the type of the artifact that contains this relationship. If omitted with containing_artifact_types, any artifact types are allowed." }, "containing_artifact_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the artifacts that contain this relationship. If omitted with containing_artifact_type, any artifact types are allowed.", "items": { "type": "string" } }, "container_id": { "type": "string", "description": "Specifies the catalog, project, or space id that contains the asset type. This is only required if the asset type is scoped to a particular catalog, project, or space. It is not allowed for global asset types, for example data_asset." }, "container_type": { "type": "string", "description": "Specifies the type of the container which contains the asset type. This field is required if the container_id is set. It is ignored if the container_id is unset. Allowed values: 'CATALOG', 'SPACE', 'PROJECT'", "example": "CATALOG", "enum": [ "CATALOG", "PROJECT", "SPACE", "EXTERNAL" ] }, "multiplicity": { "type": "string", "description": "Multiplicity of this end of the relationship. This controls how many targets the relationship can point to.", "enum": [ "ONE", "MANY" ] }, "displayInChild": { "type": "boolean", "description": "Whether the relationship attribute is displayed in child asset.", "enum": [ "true", "false" ] }, "on_delete": { "type": "string", "description": "Determines processing of the relationship target when the source object is deleted. Allowed values: CASCADE - delete the referenced object, IGNORE - do not delete the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_catalog_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned to a target catalog. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_publish": { "type": "string", "description": "Determines processing of the relationship target when the source object is published. Allowed values: CASCADE - publish the referenced object, IGNORE - do not publish the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_promote": { "type": "string", "description": "Determines processing of the relationship target when the source object is promoted. Allowed values: CASCADE - promote the referenced object, IGNORE - do not promote the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "option_overrides": { "uniqueItems": true, "type": "array", "description": "Optionally specifies any override of cascade behavior on `delete, clone, promote and publish` based on specific asset type pairs\nNote: All duplicate elements will be ignored by the option_overrides `Set` when provided via create or patch REST API(s)\n", "items": { "$ref": "#/components/schemas/CatalogRelationshipOptionOverride" } }, "containing_asset_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the assets that contain this relationship. If omitted with containing_asset_type, any asset types are allowed.", "items": { "type": "string" } }, "containing_asset_type": { "type": "string", "description": "Optionally specifies the type of the asset that contains this relationship. If omitted with containing_asset_types, any asset types are allowed." } }, "description": "First relationship type endpoint (order is not important)" }, "end2": { "required": [ "default_display_name", "multiplicity", "relationship_name" ], "type": "object", "properties": { "default_display_name": { "type": "string", "description": "Default display name for this end of the relationship. This is what will be shown in the UI." }, "localized_display_name": { "type": "object", "description": "Map of localized display names, keyed on the ISO 639 language code (e.g. \"zh\")", "additionalProperties": { "type": "string" } }, "relationship_name": { "type": "string", "description": "Internal, non-translated, name for this end of the relationship. This becomes part of the path in the APIs for manipulating and querying relationship types." }, "containing_artifact_type": { "type": "string", "description": "Optionally specifies the type of the artifact that contains this relationship. If omitted with containing_artifact_types, any artifact types are allowed." }, "containing_artifact_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the artifacts that contain this relationship. If omitted with containing_artifact_type, any artifact types are allowed.", "items": { "type": "string" } }, "container_id": { "type": "string", "description": "Specifies the catalog, project, or space id that contains the asset type. This is only required if the asset type is scoped to a particular catalog, project, or space. It is not allowed for global asset types, for example data_asset." }, "container_type": { "type": "string", "description": "Specifies the type of the container which contains the asset type. This field is required if the container_id is set. It is ignored if the container_id is unset. Allowed values: 'CATALOG', 'SPACE', 'PROJECT'", "example": "CATALOG", "enum": [ "CATALOG", "PROJECT", "SPACE", "EXTERNAL" ] }, "multiplicity": { "type": "string", "description": "Multiplicity of this end of the relationship. This controls how many targets the relationship can point to.", "enum": [ "ONE", "MANY" ] }, "displayInChild": { "type": "boolean", "description": "Whether the relationship attribute is displayed in child asset.", "enum": [ "true", "false" ] }, "on_delete": { "type": "string", "description": "Determines processing of the relationship target when the source object is deleted. Allowed values: CASCADE - delete the referenced object, IGNORE - do not delete the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_catalog_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned to a target catalog. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_publish": { "type": "string", "description": "Determines processing of the relationship target when the source object is published. Allowed values: CASCADE - publish the referenced object, IGNORE - do not publish the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_promote": { "type": "string", "description": "Determines processing of the relationship target when the source object is promoted. Allowed values: CASCADE - promote the referenced object, IGNORE - do not promote the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "option_overrides": { "uniqueItems": true, "type": "array", "description": "Optionally specifies any override of cascade behavior on `delete, clone, promote and publish` based on specific asset type pairs\nNote: All duplicate elements will be ignored by the option_overrides `Set` when provided via create or patch REST API(s)\n", "items": { "$ref": "#/components/schemas/CatalogRelationshipOptionOverride" } }, "containing_asset_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the assets that contain this relationship. If omitted with containing_asset_type, any asset types are allowed.", "items": { "type": "string" } }, "containing_asset_type": { "type": "string", "description": "Optionally specifies the type of the asset that contains this relationship. If omitted with containing_asset_types, any asset types are allowed." } }, "description": "Second relationship type endpoint (order is not important)" }, "flags": { "type": "object", "description": "Set of flags. These flags determine the relationship type's behavior", "additionalProperties": { "type": "boolean" } }, "description": { "type": "string", "description": "Description of the relationship type" } }, "description": "relationship type entity" } } }, "CatalogRelationshipTypeEntity": { "required": [ "end1", "end2" ], "type": "object", "properties": { "end1": { "required": [ "default_display_name", "multiplicity", "relationship_name" ], "type": "object", "properties": { "default_display_name": { "type": "string", "description": "Default display name for this end of the relationship. This is what will be shown in the UI." }, "localized_display_name": { "type": "object", "description": "Map of localized display names, keyed on the ISO 639 language code (e.g. \"zh\")", "additionalProperties": { "type": "string" } }, "relationship_name": { "type": "string", "description": "Internal, non-translated, name for this end of the relationship. This becomes part of the path in the APIs for manipulating and querying relationship types." }, "containing_artifact_type": { "type": "string", "description": "Optionally specifies the type of the artifact that contains this relationship. If omitted with containing_artifact_types, any artifact types are allowed." }, "containing_artifact_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the artifacts that contain this relationship. If omitted with containing_artifact_type, any artifact types are allowed.", "items": { "type": "string" } }, "container_id": { "type": "string", "description": "Specifies the catalog, project, or space id that contains the asset type. This is only required if the asset type is scoped to a particular catalog, project, or space. It is not allowed for global asset types, for example data_asset." }, "container_type": { "type": "string", "description": "Specifies the type of the container which contains the asset type. This field is required if the container_id is set. It is ignored if the container_id is unset. Allowed values: 'CATALOG', 'SPACE', 'PROJECT'", "example": "CATALOG", "enum": [ "CATALOG", "PROJECT", "SPACE", "EXTERNAL" ] }, "multiplicity": { "type": "string", "description": "Multiplicity of this end of the relationship. This controls how many targets the relationship can point to.", "enum": [ "ONE", "MANY" ] }, "displayInChild": { "type": "boolean", "description": "Whether the relationship attribute is displayed in child asset.", "enum": [ "true", "false" ] }, "on_delete": { "type": "string", "description": "Determines processing of the relationship target when the source object is deleted. Allowed values: CASCADE - delete the referenced object, IGNORE - do not delete the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_catalog_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned to a target catalog. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_publish": { "type": "string", "description": "Determines processing of the relationship target when the source object is published. Allowed values: CASCADE - publish the referenced object, IGNORE - do not publish the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_promote": { "type": "string", "description": "Determines processing of the relationship target when the source object is promoted. Allowed values: CASCADE - promote the referenced object, IGNORE - do not promote the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "option_overrides": { "uniqueItems": true, "type": "array", "description": "Optionally specifies any override of cascade behavior on `delete, clone, promote and publish` based on specific asset type pairs\nNote: All duplicate elements will be ignored by the option_overrides `Set` when provided via create or patch REST API(s)\n", "items": { "$ref": "#/components/schemas/CatalogRelationshipOptionOverride" } }, "containing_asset_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the assets that contain this relationship. If omitted with containing_asset_type, any asset types are allowed.", "items": { "type": "string" } }, "containing_asset_type": { "type": "string", "description": "Optionally specifies the type of the asset that contains this relationship. If omitted with containing_asset_types, any asset types are allowed." } }, "description": "First relationship type endpoint (order is not important)" }, "end2": { "required": [ "default_display_name", "multiplicity", "relationship_name" ], "type": "object", "properties": { "default_display_name": { "type": "string", "description": "Default display name for this end of the relationship. This is what will be shown in the UI." }, "localized_display_name": { "type": "object", "description": "Map of localized display names, keyed on the ISO 639 language code (e.g. \"zh\")", "additionalProperties": { "type": "string" } }, "relationship_name": { "type": "string", "description": "Internal, non-translated, name for this end of the relationship. This becomes part of the path in the APIs for manipulating and querying relationship types." }, "containing_artifact_type": { "type": "string", "description": "Optionally specifies the type of the artifact that contains this relationship. If omitted with containing_artifact_types, any artifact types are allowed." }, "containing_artifact_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the artifacts that contain this relationship. If omitted with containing_artifact_type, any artifact types are allowed.", "items": { "type": "string" } }, "container_id": { "type": "string", "description": "Specifies the catalog, project, or space id that contains the asset type. This is only required if the asset type is scoped to a particular catalog, project, or space. It is not allowed for global asset types, for example data_asset." }, "container_type": { "type": "string", "description": "Specifies the type of the container which contains the asset type. This field is required if the container_id is set. It is ignored if the container_id is unset. Allowed values: 'CATALOG', 'SPACE', 'PROJECT'", "example": "CATALOG", "enum": [ "CATALOG", "PROJECT", "SPACE", "EXTERNAL" ] }, "multiplicity": { "type": "string", "description": "Multiplicity of this end of the relationship. This controls how many targets the relationship can point to.", "enum": [ "ONE", "MANY" ] }, "displayInChild": { "type": "boolean", "description": "Whether the relationship attribute is displayed in child asset.", "enum": [ "true", "false" ] }, "on_delete": { "type": "string", "description": "Determines processing of the relationship target when the source object is deleted. Allowed values: CASCADE - delete the referenced object, IGNORE - do not delete the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_catalog_clone": { "type": "string", "description": "Determines processing of the relationship target when the source object is cloned to a target catalog. Allowed values: CASCADE - clone the referenced object, IGNORE - do not clone the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_publish": { "type": "string", "description": "Determines processing of the relationship target when the source object is published. Allowed values: CASCADE - publish the referenced object, IGNORE - do not publish the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_promote": { "type": "string", "description": "Determines processing of the relationship target when the source object is promoted. Allowed values: CASCADE - promote the referenced object, IGNORE - do not promote the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "option_overrides": { "uniqueItems": true, "type": "array", "description": "Optionally specifies any override of cascade behavior on `delete, clone, promote and publish` based on specific asset type pairs\nNote: All duplicate elements will be ignored by the option_overrides `Set` when provided via create or patch REST API(s)\n", "items": { "$ref": "#/components/schemas/CatalogRelationshipOptionOverride" } }, "containing_asset_types": { "uniqueItems": true, "type": "array", "description": "Optionally specify the types of the assets that contain this relationship. If omitted with containing_asset_type, any asset types are allowed.", "items": { "type": "string" } }, "containing_asset_type": { "type": "string", "description": "Optionally specifies the type of the asset that contains this relationship. If omitted with containing_asset_types, any asset types are allowed." } }, "description": "Second relationship type endpoint (order is not important)" }, "flags": { "type": "object", "description": "Set of flags. These flags determine the relationship type's behavior", "additionalProperties": { "type": "boolean" } }, "description": { "type": "string", "description": "Description of the relationship type" } } }, "CatalogFindRelationshipTypesResponse": { "required": [ "next", "resources", "total_rows" ], "type": "object", "properties": { "resources": { "type": "array", "description": "relationship types that match the search criteria", "items": { "$ref": "#/components/schemas/CatalogResponseRelationshipType" } }, "total_rows": { "type": "integer", "description": "total number of rows in the search result", "format": "int64" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "readOnly": true }, "bookmark": { "type": "string", "readOnly": true } }, "description": "URL to fetch the next page of search results" } } }, "CatalogRelationshipOptionOverride": { "type": "object", "properties": { "this_asset_type": { "type": "string", "description": "Support for wild cards (*) in this_asset_type is applicable to publish, promote, and clone." }, "other_asset_type": { "type": "string", "description": "Support for wild cards (*) in other_asset_type is applicable to publish, promote, and clone." }, "on_delete": { "type": "string", "enum": [ "CASCADE", "IGNORE" ] }, "on_publish": { "type": "string", "enum": [ "CASCADE", "IGNORE" ] }, "on_clone": { "type": "string", "enum": [ "CASCADE", "IGNORE" ] }, "on_promote": { "type": "string", "enum": [ "CASCADE", "IGNORE" ] }, "on_catalog_clone": { "type": "string", "enum": [ "CASCADE", "IGNORE" ] } } }, "CatalogFindOutgoingRelationshipTypesResponse": { "required": [ "next", "options", "resources", "total_rows" ], "type": "object", "properties": { "options": { "required": [ "artifact_type", "asset_type", "bookmark", "catalog_id", "end_types", "limit", "project_id", "relationship_names", "sort_fields", "space_id" ], "type": "object", "properties": { "catalog_id": { "type": "string", "readOnly": true }, "project_id": { "type": "string", "readOnly": true }, "space_id": { "type": "string", "readOnly": true }, "asset_type": { "uniqueItems": true, "type": "array", "readOnly": true, "items": { "type": "string" } }, "artifact_type": { "uniqueItems": true, "type": "array", "readOnly": true, "items": { "type": "string" } }, "relationship_names": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "end_types": { "type": "array", "readOnly": true, "items": { "type": "string", "enum": [ "ASSET", "ARTIFACT", "COLUMN" ] } }, "sort_fields": { "type": "array", "readOnly": true, "items": { "type": "string", "enum": [ "RELATIONSHIP_NAME_ASC", "RELATIONSHIP_NAME_DESC", "RELATIONSHIP_DISPLAY_NAME_ASC", "RELATIONSHIP_DISPLAY_NAME_DESC", "CREATE_TIME_ASC", "CREATE_TIME_DESC" ] } }, "limit": { "type": "integer", "readOnly": true }, "bookmark": { "type": "string", "readOnly": true } }, "readOnly": true }, "related_artifact_types": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "related_asset_types": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "related_column_types": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "resources": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogOutgoingRelationshipType" } }, "total_rows": { "type": "integer", "format": "int64", "readOnly": true }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "readOnly": true }, "bookmark": { "type": "string", "readOnly": true } }, "readOnly": true } } }, "CatalogOutgoingRelationshipType": { "required": [ "created", "creator_id", "display_name", "multiplicity", "name", "on_delete", "target_artifact_type", "target_artifact_types", "target_asset_types" ], "type": "object", "properties": { "name": { "type": "string", "readOnly": true }, "display_name": { "type": "string", "readOnly": true }, "multiplicity": { "type": "string", "readOnly": true, "enum": [ "ONE", "MANY" ] }, "on_delete": { "type": "string", "readOnly": true, "enum": [ "CASCADE", "IGNORE" ] }, "created": { "type": "integer", "format": "int64", "readOnly": true }, "creator_id": { "type": "string", "readOnly": true }, "target_catalog_id": { "type": "string", "readOnly": true }, "target_asset_type": { "type": "string", "readOnly": true }, "target_asset_types": { "uniqueItems": true, "type": "array", "readOnly": true, "items": { "type": "string" } }, "target_artifact_type": { "type": "string", "readOnly": true }, "target_artifact_types": { "uniqueItems": true, "type": "array", "readOnly": true, "items": { "type": "string" } }, "localized_display_name": { "type": "object", "readOnly": true, "additionalProperties": { "type": "string" } } } }, "CatalogType": { "required": [ "fields", "name" ], "type": "object", "properties": { "description": { "type": "string", "description": "Asset type description", "example": "Connection asset type" }, "fields": { "type": "array", "description": "Fields that are indexed if present in the asset.", "items": { "$ref": "#/components/schemas/CatalogAssetTypeField" } }, "external_asset_preview": { "required": [ "base_client_url" ], "type": "object", "properties": { "base_client_url": { "type": "string", "description": "Base client URL", "example": "https://ibm.com" }, "url_parameters_from_asset_attributes": { "type": "array", "description": "URL parameters", "items": { "type": "string" } }, "url_path_from_asset_attributes": { "type": "string", "description": "URL path", "example": "id" }, "url_parameters_fixed": { "type": "string", "description": "URL parameters fixed", "example": "allow_login_screen=true" } }, "description": "External Asset Preview. Clients can make use of this to render content appropriately for this asset type." }, "relationships": { "type": "array", "description": "Relationship definitions for this asset type.", "items": { "$ref": "#/components/schemas/CatalogAssetTypeRelationship" } }, "properties": { "type": "object", "description": "Provides the IKC UI with information about displaying properties that can be present in the asset", "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetTypeProperty" } }, "localized_metadata_attributes": { "type": "object", "description": "Example \"localized_metadata_attributes\": {\n\"name\": {\n\"default\": \"Data Asset\",\n\"en\": \"Data Asset\",\n\"fr\": \"Data Asset\"\n}\n}", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "decorates": { "type": "array", "description": "List of pointers to types this type can decorate.", "items": { "$ref": "#/components/schemas/CatalogAssetTypePointer" } }, "identity": { "type": "object", "properties": { "strategy": { "type": "string", "description": "The strategy for detecting duplicate asset of the type", "enum": [ "DUPLICATE_DETECTION_BY_NAME", "DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY", "DUPLICATE_DETECTION_BY_NAME_AND_FOLDER", "DUPLICATE_DETECTION_BY_RESOURCE_KEY", "DUPLICATE_DETECTION_NOT_APPLICABLE" ] } }, "description": "Identity definition of the assets of the type" }, "global_search_searchable": { "type": "array", "description": "List of fields made searchable through Global Search functionality", "items": { "type": "string" } }, "attribute_behavior": { "type": "object", "properties": { "remove_on_copy": { "type": "boolean", "description": "Remove the attribute when cloning, publishing or promoting the asset" } }, "description": "Define the behavior only if this asset type is used as an attribute." }, "attribute_only": { "type": "boolean", "description": "If set to true, the type definition will be custom attributes, which can be used to decorate other asset types and cannot create this as a top level asset of this asset type.\nIf set to false, the type definition will be custom asset type, which can be used to create top level assets of this asset type and/or also decorate other asset types.\n" }, "data_protection": { "type": "object", "properties": { "all_fields": { "type": "boolean", "description": "Indicates if all fields of the asset type are protected. If 'all_fields' is true, then 'fields' is ignored.", "enum": [ "true", "false" ] }, "all_attachments": { "type": "boolean", "description": "Indicates if all attachments of the asset type are protected. If 'all_attachments' is true, then 'attachment_types' is ignored.", "enum": [ "true", "false" ] }, "field_search_paths": { "type": "array", "description": "List of json paths that lead to the fields to be protected. e.g., \"scoring.input_data\", \"columns[].name\", \"columns[0].code\", \"*.connection_id\", etc. If 'all_fields' is true, then 'field_search_paths' is ignored.", "example": "columns[].name", "items": { "type": "string" } }, "attachment_types": { "type": "array", "description": "List of types of attachments of the asset type to be protected. If 'all_attachments' is true, then 'attachment_types' is ignored.", "items": { "type": "string", "enum": [ "MANAGED", "REFERENCED", "REMOTE" ] } } }, "description": "Asset type properties and attachments that should be filtered out for users without data access" }, "is_column_custom_attribute": { "type": "boolean", "description": "Set it to true if this is to be used for column custom attributes. Set to false if this is used for asset types or attribute. If true, allow_decorators should be false." }, "can_have_image": { "type": "boolean", "description": "Set it to true if the type is expected to support uploading of images, else set it to false." }, "icon_id": { "type": "string", "description": "Name/id of the svg image to be used as the icon for the to be created asset type." }, "version": { "type": "number", "description": "The version of defined asset type", "format": "double", "example": 1 }, "name": { "type": "string", "description": "Asset type name", "example": "connection" }, "scope": { "type": "string", "description": "The scope of defined asset type. Derived-field. Will be one of GLOBAL, ACCOUNT, CATALOG, PROJECT, or SPACE.", "readOnly": true, "example": "GLOBAL" }, "decorated_by": { "type": "array", "description": "List of pointers to types this type can be decorated by.", "items": { "$ref": "#/components/schemas/CatalogAssetTypePointer" } }, "allow_decorators": { "type": "boolean" } } }, "CatalogCreationType": { "required": [ "fields", "name" ], "type": "object", "properties": { "description": { "type": "string", "description": "Asset type description", "example": "Connection asset type" }, "fields": { "type": "array", "description": "Fields that are indexed if present in the asset.", "items": { "$ref": "#/components/schemas/CatalogAssetTypeField" } }, "external_asset_preview": { "required": [ "base_client_url" ], "type": "object", "properties": { "base_client_url": { "type": "string", "description": "Base client URL", "example": "https://ibm.com" }, "url_parameters_from_asset_attributes": { "type": "array", "description": "URL parameters", "items": { "type": "string" } }, "url_path_from_asset_attributes": { "type": "string", "description": "URL path", "example": "id" }, "url_parameters_fixed": { "type": "string", "description": "URL parameters fixed", "example": "allow_login_screen=true" } }, "description": "External Asset Preview. Clients can make use of this to render content appropriately for this asset type." }, "relationships": { "type": "array", "description": "Relationship definitions for this asset type.", "items": { "$ref": "#/components/schemas/CatalogAssetTypeRelationship" } }, "properties": { "type": "object", "description": "Provides the IKC UI with information about displaying properties that can be present in the asset", "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetTypeProperty" } }, "localized_metadata_attributes": { "type": "object", "description": "Example \"localized_metadata_attributes\": {\n\"name\": {\n\"default\": \"Data Asset\",\n\"en\": \"Data Asset\",\n\"fr\": \"Data Asset\"\n}\n}", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "decorates": { "type": "array", "description": "List of pointers to types this type can decorate.", "items": { "$ref": "#/components/schemas/CatalogAssetTypePointer" } }, "identity": { "type": "object", "properties": { "strategy": { "type": "string", "description": "The strategy for detecting duplicate asset of the type", "enum": [ "DUPLICATE_DETECTION_BY_NAME", "DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY", "DUPLICATE_DETECTION_BY_NAME_AND_FOLDER", "DUPLICATE_DETECTION_BY_RESOURCE_KEY", "DUPLICATE_DETECTION_NOT_APPLICABLE" ] } }, "description": "Identity definition of the assets of the type" }, "global_search_searchable": { "type": "array", "description": "List of fields made searchable through Global Search functionality", "items": { "type": "string" } }, "attribute_behavior": { "type": "object", "properties": { "remove_on_copy": { "type": "boolean", "description": "Remove the attribute when cloning, publishing or promoting the asset" } }, "description": "Define the behavior only if this asset type is used as an attribute." }, "attribute_only": { "type": "boolean", "description": "If set to true, the type definition will be custom attributes, which can be used to decorate other asset types and cannot create this as a top level asset of this asset type.\nIf set to false, the type definition will be custom asset type, which can be used to create top level assets of this asset type and/or also decorate other asset types.\n" }, "data_protection": { "type": "object", "properties": { "all_fields": { "type": "boolean", "description": "Indicates if all fields of the asset type are protected. If 'all_fields' is true, then 'fields' is ignored.", "enum": [ "true", "false" ] }, "all_attachments": { "type": "boolean", "description": "Indicates if all attachments of the asset type are protected. If 'all_attachments' is true, then 'attachment_types' is ignored.", "enum": [ "true", "false" ] }, "field_search_paths": { "type": "array", "description": "List of json paths that lead to the fields to be protected. e.g., \"scoring.input_data\", \"columns[].name\", \"columns[0].code\", \"*.connection_id\", etc. If 'all_fields' is true, then 'field_search_paths' is ignored.", "example": "columns[].name", "items": { "type": "string" } }, "attachment_types": { "type": "array", "description": "List of types of attachments of the asset type to be protected. If 'all_attachments' is true, then 'attachment_types' is ignored.", "items": { "type": "string", "enum": [ "MANAGED", "REFERENCED", "REMOTE" ] } } }, "description": "Asset type properties and attachments that should be filtered out for users without data access" }, "is_column_custom_attribute": { "type": "boolean", "description": "Set it to true if this is to be used for column custom attributes. Set to false if this is used for asset types or attribute. If true, allow_decorators should be false." }, "can_have_image": { "type": "boolean", "description": "Set it to true if the type is expected to support uploading of images, else set it to false." }, "icon_id": { "type": "string", "description": "Name/id of the svg image to be used as the icon for the to be created asset type." }, "version": { "type": "number", "description": "The version of defined asset type", "format": "double", "example": 1 }, "name": { "type": "string", "description": "Asset type name", "example": "connection" }, "allow_decorators": { "type": "boolean" } } }, "CatalogTypesResponse": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogType" } } } }, "CatalogAssetTypePointer": { "type": "object", "properties": { "asset_type_name": { "type": "string" } } }, "CatalogAssetTypeProperty": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the property.", "enum": [ "bool", "integer", "string", "number", "object", "date", "rich_text", "enumeration", "user_group" ] }, "description": { "type": "string", "description": "The description for the property." }, "placeholder": { "type": "string", "description": "An example value for the property." }, "is_array": { "type": "boolean", "description": "Whether the property is an array.", "enum": [ "true", "false" ] }, "required": { "type": "boolean", "description": "Whether the property is required.", "enum": [ "true", "false" ] }, "hidden": { "type": "boolean", "description": "Whether the property should be displayed in a user interface.", "enum": [ "true", "false" ] }, "readonly": { "type": "boolean", "description": "Whether the property is a read-only value.", "enum": [ "true", "false" ] }, "validated": { "type": "boolean", "description": "Whether the property needs to be validated, only works when type is enumeration.", "enum": [ "true", "false" ] }, "displayInChild": { "type": "boolean", "description": "Whether the property is displayed in child asset.", "enum": [ "true", "false" ] }, "restricted": { "type": "boolean", "description": "Whether the property is restricted.", "enum": [ "true", "false" ] }, "default_value": { "type": "object", "description": "The default value for the property if the value is not otherwise specified." }, "values": { "type": "array", "description": "The list of enumerated values that the property can take.", "items": { "type": "object" } }, "minimum": { "type": "object", "description": "The minimum value the property can accept." }, "maximum": { "type": "object", "description": "The maximum value the property can accept." }, "min_length": { "type": "integer", "description": "The minimum length the property can accept." }, "max_length": { "type": "integer", "description": "The maximum length the property can accept." }, "label": { "type": "object", "additionalProperties": { "type": "string" } }, "localized": { "type": "array", "description": "To stores translated information about the content of values field.", "items": { "$ref": "#/components/schemas/CatalogLocalizedProperty" } }, "properties": { "type": "object", "description": "If the property type is object, the properties of the expected object type.", "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetTypeProperty" } }, "localized_metadata_attributes": { "type": "object", "description": "To Store translated information of properties", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "description": "Metadata about properties that can be present in an instance of a custom asset type." }, "CatalogAssetTypeRelationship": { "required": [ "key", "target_asset_type" ], "type": "object", "properties": { "key": { "type": "string", "description": "Path to the JSON attribute containing the asset ID of the target asset", "example": "connection_id" }, "target_asset_type": { "type": "string", "description": "Asset type of target asset", "example": "connection" }, "on_delete_target": { "type": "string", "description": "Determines processing of the source object when a reference target is deleted. Allowed values: CASCADE - delete the object that contains the reference, DISCONNECT - disconnect the reference to the target asset. IGNORE - leave the reference to the target asset unmodified so it continues to point to the deleted asset. This creates a dangling reference. Default: IGNORE", "enum": [ "CASCADE", "DISCONNECT", "IGNORE" ] }, "on_delete": { "type": "string", "description": "Determines processing of the reference target when the source object is deleted. Allowed values: CASCADE - delete the referenced object, IGNORE - do not delete the referenced object. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_clone_target": { "type": "string", "description": "Determines processing of the source object when a reference target is cloned, published, or promoted. Allowed values: CASCADE - clone/publish/promote the object that contains the reference, IGNORE - ignore the reference. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_clone": { "type": "string", "description": "Determines processing of the reference target when the source object is cloned. Allowed values: CASCADE - clone the referenced object, IGNORE - ignore the reference. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_promote": { "type": "string", "description": "Determines processing of the reference target when the source object is promoted. Allowed values: CASCADE - promote the referenced object, IGNORE - ignore the reference. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_publish": { "type": "string", "description": "Determines processing of the reference target when the source object is published. Allowed values: CASCADE - publish the referenced object, IGNORE - ignore the reference. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] }, "on_catalog_clone": { "type": "string", "description": "Determines processing of the reference target when the source object is cloned to a catalog. Allowed values: CASCADE - clone the referenced object, IGNORE - ignore the reference. Default: IGNORE", "enum": [ "CASCADE", "IGNORE" ] } }, "description": "Asset Type Relationship Model" }, "CatalogAssetTypeField": { "required": [ "key", "type" ], "type": "object", "properties": { "key": { "type": "string", "description": "Asset type field key", "example": "host" }, "type": { "type": "string", "description": "Asset type field type", "example": "string" }, "facet": { "type": "boolean", "description": "Asset type field support facet search", "example": false }, "is_array": { "type": "boolean", "example": false, "enum": [ "true", "false" ] }, "search_path": { "type": "string", "description": "A json path that leads to the field to be indexed.", "example": "asset.columns[].*.name" }, "is_searchable_across_types": { "type": "boolean", "description": "indicates whether this field is to be searchable using full-text search", "example": false, "enum": [ "true", "false" ] } }, "description": "Asset Type Field Model" }, "CatalogLocalizedProperty": { "type": "object", "properties": { "locale": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } }, "description": "This is used to store the translated content for the values field of an asset type property" }, "CatalogUpdateType": { "required": [ "fields" ], "type": "object", "properties": { "description": { "type": "string", "description": "Asset type description", "example": "Connection asset type" }, "fields": { "type": "array", "description": "Fields that are indexed if present in the asset.", "items": { "$ref": "#/components/schemas/CatalogAssetTypeField" } }, "external_asset_preview": { "required": [ "base_client_url" ], "type": "object", "properties": { "base_client_url": { "type": "string", "description": "Base client URL", "example": "https://ibm.com" }, "url_parameters_from_asset_attributes": { "type": "array", "description": "URL parameters", "items": { "type": "string" } }, "url_path_from_asset_attributes": { "type": "string", "description": "URL path", "example": "id" }, "url_parameters_fixed": { "type": "string", "description": "URL parameters fixed", "example": "allow_login_screen=true" } }, "description": "External Asset Preview. Clients can make use of this to render content appropriately for this asset type." }, "relationships": { "type": "array", "description": "Relationship definitions for this asset type.", "items": { "$ref": "#/components/schemas/CatalogAssetTypeRelationship" } }, "properties": { "type": "object", "description": "Provides the IKC UI with information about displaying properties that can be present in the asset", "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetTypeProperty" } }, "localized_metadata_attributes": { "type": "object", "description": "Example \"localized_metadata_attributes\": {\n\"name\": {\n\"default\": \"Data Asset\",\n\"en\": \"Data Asset\",\n\"fr\": \"Data Asset\"\n}\n}", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "decorates": { "type": "array", "description": "List of pointers to types this type can decorate.", "items": { "$ref": "#/components/schemas/CatalogAssetTypePointer" } }, "identity": { "type": "object", "properties": { "strategy": { "type": "string", "description": "The strategy for detecting duplicate asset of the type", "enum": [ "DUPLICATE_DETECTION_BY_NAME", "DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY", "DUPLICATE_DETECTION_BY_NAME_AND_FOLDER", "DUPLICATE_DETECTION_BY_RESOURCE_KEY", "DUPLICATE_DETECTION_NOT_APPLICABLE" ] } }, "description": "Identity definition of the assets of the type" }, "global_search_searchable": { "type": "array", "description": "List of fields made searchable through Global Search functionality", "items": { "type": "string" } }, "attribute_behavior": { "type": "object", "properties": { "remove_on_copy": { "type": "boolean", "description": "Remove the attribute when cloning, publishing or promoting the asset" } }, "description": "Define the behavior only if this asset type is used as an attribute." }, "attribute_only": { "type": "boolean", "description": "If set to true, the type definition will be custom attributes, which can be used to decorate other asset types and cannot create this as a top level asset of this asset type.\nIf set to false, the type definition will be custom asset type, which can be used to create top level assets of this asset type and/or also decorate other asset types.\n" }, "data_protection": { "type": "object", "properties": { "all_fields": { "type": "boolean", "description": "Indicates if all fields of the asset type are protected. If 'all_fields' is true, then 'fields' is ignored.", "enum": [ "true", "false" ] }, "all_attachments": { "type": "boolean", "description": "Indicates if all attachments of the asset type are protected. If 'all_attachments' is true, then 'attachment_types' is ignored.", "enum": [ "true", "false" ] }, "field_search_paths": { "type": "array", "description": "List of json paths that lead to the fields to be protected. e.g., \"scoring.input_data\", \"columns[].name\", \"columns[0].code\", \"*.connection_id\", etc. If 'all_fields' is true, then 'field_search_paths' is ignored.", "example": "columns[].name", "items": { "type": "string" } }, "attachment_types": { "type": "array", "description": "List of types of attachments of the asset type to be protected. If 'all_attachments' is true, then 'attachment_types' is ignored.", "items": { "type": "string", "enum": [ "MANAGED", "REFERENCED", "REMOTE" ] } } }, "description": "Asset type properties and attachments that should be filtered out for users without data access" }, "is_column_custom_attribute": { "type": "boolean", "description": "Set it to true if this is to be used for column custom attributes. Set to false if this is used for asset types or attribute. If true, allow_decorators should be false." }, "can_have_image": { "type": "boolean", "description": "Set it to true if the type is expected to support uploading of images, else set it to false." }, "icon_id": { "type": "string", "description": "Name/id of the svg image to be used as the icon for the to be created asset type." }, "allow_decorators": { "type": "boolean" } } }, "CatalogAssetSearchResponse": { "type": "object", "properties": { "next": { "$ref": "#/components/schemas/CatalogCatalogSearch" }, "total_rows": { "type": "integer", "format": "int64" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSearchResponseAsset" } } } }, "CatalogCatalogSearch": { "required": [ "query" ], "type": "object", "properties": { "query": { "type": "string", "description": "Lucene query", "example": "*:*" }, "limit": { "type": "integer" }, "counts": { "type": "array", "description": "Returns the number of query results for each unique value of each named field.", "example": [ "asset.tags", "asset.asset_type" ], "items": { "type": "string" } }, "drilldown": { "type": "array", "description": "Restrict results to documents with a dimension equal to the specified label. Note that, multiple values for a single key in a drilldown means an OR relation between them and there is an AND relation between multiple keys.", "example": [ { "asset.tags": [ "tag1", "untagged" ], "asset.asset_type": [ "data_asset", "job" ] } ], "items": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "bookmark": { "type": "string", "description": "Bookmark of the query result" }, "sort": { "type": "string", "description": "Sort order for the query", "example": "asset.name" }, "include": { "type": "string", "description": "entity", "example": "entity" } }, "description": "Catalog Search Model" }, "CatalogSearchResponseAsset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "href": { "type": "string" } } }, "CatalogResponseAssetMetadata": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "asset_type": { "type": "string" }, "origin_country": { "type": "string" }, "resource_key": { "type": "string" }, "identity_key": { "type": "string" }, "delete_processing_state": { "type": "string", "enum": [ "pending", "complete", "failed" ] }, "delete_reason": { "type": "string" }, "rating": { "type": "number", "format": "double" }, "total_ratings": { "type": "integer", "format": "int64" }, "catalog_id": { "type": "string" }, "created": { "type": "integer", "format": "int64" }, "created_at": { "type": "string" }, "size": { "type": "integer", "format": "int64" }, "version": { "type": "number", "format": "double" }, "asset_id": { "type": "string" }, "source_asset": { "$ref": "#/components/schemas/CatalogSourceAsset" }, "asset_category": { "type": "string", "enum": [ "SYSTEM", "USER" ] }, "source_system": { "$ref": "#/components/schemas/CatalogCLSourceSystem" }, "child_source_systems": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogCLSourceSystem" } }, "source_system_history": { "type": "array", "description": "History of external repository assets that were the source of an imported/synced/rehomed asset.", "items": { "$ref": "#/components/schemas/CatalogSourceSystemHistoryRecord" } }, "commit_info": { "$ref": "#/components/schemas/CatalogCLCommitInfo" }, "number_of_shards": { "type": "integer" }, "project_id": { "type": "string" }, "space_id": { "type": "string" }, "usage": { "$ref": "#/components/schemas/CatalogAssetUsage" }, "number_of_conflicts": { "type": "integer" }, "is_primary_attachment_downloadable": { "type": "boolean" }, "rov": { "$ref": "#/components/schemas/CatalogResponseAssetRov" }, "attributes": { "type": "array", "items": { "type": "string" } }, "source_asset_of_request": { "$ref": "#/components/schemas/CatalogSourceAsset" }, "creator_id": { "type": "string" }, "owner": { "type": "string", "description": "This field is no longer populated. It used to contain the username of the asset owner" }, "owner_id": { "type": "string", "description": "The owner of the asset. This field is deprecated. The list of owners should be extracted from metadata.rov.member_roles" } } }, "CatalogSourceAsset": { "type": "object", "properties": { "action": { "type": "string" }, "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "asset_id": { "type": "string" }, "revision_id": { "type": "integer", "format": "int64" }, "bss_account_id": { "type": "string" }, "asset_name": { "type": "string" }, "source_url": { "type": "string" }, "resource_key": { "type": "string" }, "identityKey": { "type": "string" } } }, "CatalogResponseAssetRov": { "type": "object", "properties": { "mode": { "type": "integer" }, "collaborator_ids": { "type": "object", "description": "Deprecated list of collaborator ids. Use member_roles instead.", "example": { "IBMid-220234BP3V": { "user_iam_id": "IBMid-220234BP3V" }, "IBMid-576483WF2K": { "user_iam_id": "IBMid-576483WF2K" } }, "additionalProperties": { "$ref": "#/components/schemas/CatalogIamId" } }, "member_roles": { "type": "object", "example": { "IBMid-220234BP3V": { "user_iam_id": "IBMid-220234BP3V", "roles": [ "OWNER" ] }, "AccessGroupId-4B814d82-5fa0-2458-bf56-23ffe06dd923": { "access_group_id": "AccessGroupId-4B814d82-5fa0-2458-bf56-23ffe06dd923", "roles": [ "EDITOR" ] } }, "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetMember" } } } }, "CatalogAssetUsage": { "type": "object", "properties": { "last_updated_at": { "type": "string" }, "last_updater_id": { "type": "string" }, "last_updater": { "type": "string" }, "last_update_time": { "type": "integer", "format": "int64" }, "last_accessed_at": { "type": "string" }, "last_access_time": { "type": "integer", "format": "int64" }, "last_accessor": { "type": "string" }, "last_accessor_id": { "type": "string" }, "access_count": { "type": "integer" } } }, "CatalogCLCommitInfo": { "type": "object", "properties": { "previous_revision": { "type": "integer", "format": "int64" }, "committed_at": { "type": "string" }, "commit_message": { "type": "string" }, "reason": { "type": "string" }, "duplicate_source": { "$ref": "#/components/schemas/CatalogSourceAsset" } } }, "CatalogSourceSystemHistoryRecord": { "type": "object", "properties": { "source_created": { "type": "integer", "description": "Source asset creation timestamp", "format": "int64", "example": 1669707290930 }, "source_modified": { "type": "integer", "description": "Source asset modification timestamp", "format": "int64", "example": 1669707290930 }, "asset_id": { "type": "string", "description": "Unique identifier of the source asset", "example": "b1c497ce.54bd3a08.20mo9ghr8.lh0m3se.l5bnoq.5lso1kspn6cdcga4qnl9g" }, "source_type": { "type": "string", "description": "Source asset type/class", "example": "OMRS_COHORT_RelationalTable" }, "system_id": { "type": "string", "description": "Unique identifier of the source system", "example": "92a90143-9108-4861-8623-1ae8b77dbb62" }, "channel": { "type": "string", "description": "Channel that imported/synced/rehomed the target asset", "example": "omrs" }, "source_created_by_id": { "type": "string", "description": "User id which created the source", "example": "IBMid-220234BP3V" }, "source_created_by_name": { "type": "string", "description": "User name which created the source", "example": "abc" }, "source_modified_by_id": { "type": "string", "description": "User id which modified the source", "example": "IBMid-220234BP3V" }, "source_modified_by_name": { "type": "string", "description": "User name which modified the source", "example": "abc" } }, "description": "Record of an external repository asset that was the source of an imported/synced/rehomed asset." }, "CatalogCLSourceSystem": { "type": "object", "properties": { "creation_timestamp": { "type": "string" }, "created": { "type": "integer", "format": "int64" }, "last_modification_timestamp": { "type": "string" }, "last_modified": { "type": "integer", "format": "int64" }, "asset_identifier": { "type": "string" }, "source": { "type": "string" }, "source_system_id": { "type": "string" } } }, "CatalogAssetMember": { "type": "object", "properties": { "user_iam_id": { "type": "string" }, "access_group_id": { "type": "string" }, "roles": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "OWNER", "EDITOR", "VIEWER" ] } } } }, "CatalogIamId": { "type": "object", "properties": { "user_iam_id": { "type": "string" } } }, "CatalogAssetTypeStatusResponse": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "description": "Asset Type StatusResponse Model" }, "CatalogCreationResponseAsset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "href": { "type": "string" }, "attachments": { "$ref": "#/components/schemas/CatalogAttachment" }, "asset_id": { "type": "string" } } }, "CatalogAsset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAttachment" } } }, "description": "Asset Model" }, "CatalogAttachment": { "required": [ "asset_type" ], "type": "object", "properties": { "asset_type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "mime": { "type": "string" }, "data_partitions": { "type": "integer" }, "test_doc": { "type": "integer", "format": "int64" }, "private_url": { "type": "boolean" }, "connection_id": { "type": "string" }, "connection_path": { "type": "string" }, "object_key": { "type": "string" }, "object_key_is_read_only": { "type": "boolean" }, "user_data": { "type": "object" }, "is_partitioned": { "type": "boolean" }, "partitions": { "$ref": "#/components/schemas/CatalogAttachmentPartitions" } } }, "CatalogAssetMetadata": { "required": [ "asset_category", "asset_type", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Choose Any Name for your Asset" }, "description": { "type": "string", "description": "A longer description describes an asset." }, "tags": { "type": "array", "items": { "type": "string" } }, "asset_type": { "type": "string", "description": "asset type", "example": "data_asset" }, "origin_country": { "type": "string", "example": "us" }, "resource_key": { "type": "string" }, "identity_key": { "type": "string" }, "rov": { "$ref": "#/components/schemas/CatalogNewAssetAssetRov" }, "asset_category": { "type": "string", "example": "USER" }, "source_system": { "$ref": "#/components/schemas/CatalogSourceSystem" }, "child_source_systems": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSourceSystem" } }, "source_system_history": { "type": "array", "description": "History of external repository assets that were the source of an imported/synced/rehomed asset.", "items": { "$ref": "#/components/schemas/CatalogSourceSystemHistoryRecord" } } }, "description": "AssetMetadata Model" }, "CatalogAttachmentPartitions": { "type": "object", "properties": { "temporal": { "type": "boolean", "description": "Indicate if the partitions are time based.", "example": false }, "hierarchical": { "type": "boolean", "description": "Indicate if the partitions are stored hierarchical or flat." }, "timestamp": { "type": "string", "description": "The timestamp the partition information is collected, in format yyyy-MM-dd'T'HH:mm:ss.SSSX or yyyy-MM-dd'T'HH:mm:ssX", "example": "2023-03-13T15:31:45.234Z" }, "latest_partitions": { "type": "array", "description": "The latest partitions.", "items": { "$ref": "#/components/schemas/CatalogAttachmentPartition" } } } }, "CatalogSourceSystem": { "type": "object", "properties": { "creation_timestamp": { "type": "string", "example": "yyyy-MM-dd'T'HH:mm:ss" }, "created": { "type": "integer", "format": "int64", "example": 1531854592 }, "last_modification_timestamp": { "type": "string", "example": "yyyy-MM-dd'T'HH:mm:ss" }, "last_modified": { "type": "integer", "format": "int64", "example": 1531854592 }, "asset_identifier": { "type": "string", "example": "String" }, "source": { "type": "string", "example": "DASHDB" }, "source_system_id": { "type": "string", "example": "String" } }, "description": "Source System Info" }, "CatalogNewAssetAssetRov": { "type": "object", "properties": { "mode": { "type": "integer" }, "collaborator_ids": { "type": "object", "example": { "IBMid-220234BP3V": { "user_iam_id": "IBMid-220234BP3V" }, "IBMid-576483WF2K": { "user_iam_id": "IBMid-576483WF2K" } }, "additionalProperties": { "$ref": "#/components/schemas/CatalogIamId" } }, "member_roles": { "type": "object", "example": { "IBMid-220234BP3V": { "user_iam_id": "IBMid-220234BP3V", "roles": [ "OWNER" ] }, "AccessGroupId-4B814d82-5fa0-2458-bf56-23ffe06dd923": { "access_group_id": "AccessGroupId-4B814d82-5fa0-2458-bf56-23ffe06dd923", "roles": [ "EDITOR" ] } }, "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetMember" } } } }, "CatalogAttachmentPartition": { "type": "object", "properties": { "location": { "type": "string", "description": "location of the partition file", "example": "SOURCE=Amazon/CATEGORY=Appliances/part-00000-5ed8c140-dacd-410e-8205-9d9e0e71c1c4.c000.snappy.parquet" }, "keys": { "type": "array", "example": [ { "value": "SOURCE=Amazon" }, { "value": "CATEGORY=Appliances" } ], "items": { "$ref": "#/components/schemas/CatalogAttachmentPartitionKey" } } } }, "CatalogAttachmentPartitionKey": { "type": "object", "properties": { "value": { "type": "string", "example": "CATEGORY=Appliances" } } }, "CatalogBulkAssetsDeleteResponse": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogBulkAssetsDeleteResponseEntry" } } } }, "CatalogBulkAssetsResponse": { "required": [ "resources" ], "type": "object", "properties": { "trace": { "type": "string", "readOnly": true }, "resources": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogBulkAssetsResponseEntry" } } } }, "CatalogBulkAssetsDeleteResponseEntry": { "required": [ "assetId" ], "type": "object", "properties": { "assetId": { "type": "string", "readOnly": true }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ErrorModel" } } } }, "CatalogBulkAssetsResponseEntry": { "required": [ "asset_id", "http_status", "status" ], "type": "object", "properties": { "asset_id": { "type": "string", "readOnly": true }, "revision_id": { "type": "string", "readOnly": true }, "status": { "type": "string", "description": "'success' if asset is retrieved successfully otherwise 'failed'", "readOnly": true }, "http_status": { "type": "integer", "description": "200 if no error, 404 if not found, etc.", "readOnly": true }, "asset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "description": "Depending on the API, either asset_attachments or attachments will be present.", "items": { "$ref": "#/components/schemas/CatalogCLAttachment" } }, "href": { "type": "string" }, "asset_id": { "type": "string" } }, "readOnly": true }, "relationship_count": { "type": "integer", "format": "int64", "readOnly": true }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ErrorModel" } } } }, "CatalogCLAttachment": { "required": [ "usage" ], "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "number", "format": "double" }, "name": { "type": "string" }, "description": { "type": "string" }, "mime": { "type": "string" }, "datasource_type": { "type": "string" }, "creator": { "type": "string" }, "creator_id": { "type": "string" }, "size": { "type": "integer", "format": "int64" }, "partitions": { "$ref": "#/components/schemas/CatalogAttachmentPartitions" }, "handle": { "$ref": "#/components/schemas/CatalogCLAttachmentHandle" }, "usage": { "type": "object", "example": { "last_updater_id": "IBMid-220234BP3V", "last_update_time": 1678555223, "last_accessor_id": "IBMid-576483WF2K", "last_access_time": 1678557289 }, "additionalProperties": { "type": "object" } }, "asset_type": { "type": "string" }, "create_time": { "type": "integer", "format": "int64" }, "complete_time_ticks": { "type": "integer", "format": "int64" }, "transfer_complete": { "type": "boolean" }, "connection_id": { "type": "string" }, "connection_path": { "type": "string" }, "connection_resource_key": { "type": "string" }, "object_key": { "type": "string" }, "is_remote": { "type": "boolean" }, "is_managed": { "type": "boolean" }, "is_referenced": { "type": "boolean" }, "is_object_key_read_only": { "type": "boolean" }, "is_user_provided_path_key": { "type": "boolean" }, "user_data": { "type": "object", "properties": { "empty": { "type": "boolean" }, "jsonArray": { "type": "boolean" }, "jsonObject": { "type": "boolean" }, "jsonPrimitive": { "type": "boolean" }, "jsonNull": { "type": "boolean" }, "asJsonObject": { "$ref": "#/components/schemas/CatalogJsonObject" }, "asJsonArray": { "$ref": "#/components/schemas/CatalogJsonArray" }, "asJsonPrimitive": { "$ref": "#/components/schemas/CatalogJsonPrimitive" }, "asJsonNull": { "$ref": "#/components/schemas/CatalogJsonNull" }, "asBoolean": { "type": "boolean" }, "asNumber": { "$ref": "#/components/schemas/CatalogNumber" }, "asString": { "type": "string" }, "asDouble": { "type": "number", "format": "double" }, "asFloat": { "type": "number", "format": "float" }, "asLong": { "type": "integer", "format": "int64" }, "asInt": { "type": "integer" }, "asByte": { "type": "string", "format": "base64" }, "asCharacter": { "type": "string" }, "asBigDecimal": { "type": "number" }, "asBigInteger": { "type": "integer" }, "asShort": { "type": "integer" } }, "example": { "user_field1": "user data", "user_field2": {} } }, "is_partitioned": { "type": "boolean" } } }, "CatalogNumber": { "type": "object" }, "CatalogJsonNull": { "type": "object", "properties": { "jsonArray": { "type": "boolean" }, "jsonObject": { "type": "boolean" }, "jsonPrimitive": { "type": "boolean" }, "jsonNull": { "type": "boolean" }, "asJsonObject": { "$ref": "#/components/schemas/CatalogJsonObject" }, "asJsonArray": { "$ref": "#/components/schemas/CatalogJsonArray" }, "asJsonPrimitive": { "$ref": "#/components/schemas/CatalogJsonPrimitive" }, "asJsonNull": { "$ref": "#/components/schemas/CatalogJsonNull" }, "asBoolean": { "type": "boolean" }, "asNumber": { "$ref": "#/components/schemas/CatalogNumber" }, "asString": { "type": "string" }, "asDouble": { "type": "number", "format": "double" }, "asFloat": { "type": "number", "format": "float" }, "asLong": { "type": "integer", "format": "int64" }, "asInt": { "type": "integer" }, "asByte": { "type": "string", "format": "base64" }, "asCharacter": { "type": "string" }, "asBigDecimal": { "type": "number" }, "asBigInteger": { "type": "integer" }, "asShort": { "type": "integer" } } }, "CatalogJsonPrimitive": { "type": "object", "properties": { "boolean": { "type": "boolean" }, "asBoolean": { "type": "boolean" }, "number": { "type": "boolean" }, "asNumber": { "$ref": "#/components/schemas/CatalogNumber" }, "string": { "type": "boolean" }, "asString": { "type": "string" }, "asDouble": { "type": "number", "format": "double" }, "asBigDecimal": { "type": "number" }, "asBigInteger": { "type": "integer" }, "asFloat": { "type": "number", "format": "float" }, "asLong": { "type": "integer", "format": "int64" }, "asShort": { "type": "integer" }, "asInt": { "type": "integer" }, "asByte": { "type": "string", "format": "base64" }, "asCharacter": { "type": "string" }, "jsonArray": { "type": "boolean" }, "jsonObject": { "type": "boolean" }, "jsonPrimitive": { "type": "boolean" }, "jsonNull": { "type": "boolean" }, "asJsonObject": { "$ref": "#/components/schemas/CatalogJsonObject" }, "asJsonArray": { "$ref": "#/components/schemas/CatalogJsonArray" }, "asJsonPrimitive": { "$ref": "#/components/schemas/CatalogJsonPrimitive" }, "asJsonNull": { "$ref": "#/components/schemas/CatalogJsonNull" } } }, "CatalogJsonArray": { "type": "object", "properties": { "empty": { "type": "boolean" }, "asNumber": { "$ref": "#/components/schemas/CatalogNumber" }, "asString": { "type": "string" }, "asDouble": { "type": "number", "format": "double" }, "asBigDecimal": { "type": "number" }, "asBigInteger": { "type": "integer" }, "asFloat": { "type": "number", "format": "float" }, "asLong": { "type": "integer", "format": "int64" }, "asInt": { "type": "integer" }, "asByte": { "type": "string", "format": "base64" }, "asCharacter": { "type": "string" }, "asShort": { "type": "integer" }, "asBoolean": { "type": "boolean" }, "jsonArray": { "type": "boolean" }, "jsonObject": { "type": "boolean" }, "jsonPrimitive": { "type": "boolean" }, "jsonNull": { "type": "boolean" }, "asJsonObject": { "$ref": "#/components/schemas/CatalogJsonObject" }, "asJsonArray": { "$ref": "#/components/schemas/CatalogJsonArray" }, "asJsonPrimitive": { "$ref": "#/components/schemas/CatalogJsonPrimitive" }, "asJsonNull": { "$ref": "#/components/schemas/CatalogJsonNull" } } }, "CatalogJsonObject": { "type": "object", "properties": { "empty": { "type": "boolean" }, "jsonArray": { "type": "boolean" }, "jsonObject": { "type": "boolean" }, "jsonPrimitive": { "type": "boolean" }, "jsonNull": { "type": "boolean" }, "asJsonObject": { "$ref": "#/components/schemas/CatalogJsonObject" }, "asJsonArray": { "$ref": "#/components/schemas/CatalogJsonArray" }, "asJsonPrimitive": { "$ref": "#/components/schemas/CatalogJsonPrimitive" }, "asJsonNull": { "$ref": "#/components/schemas/CatalogJsonNull" }, "asBoolean": { "type": "boolean" }, "asNumber": { "$ref": "#/components/schemas/CatalogNumber" }, "asString": { "type": "string" }, "asDouble": { "type": "number", "format": "double" }, "asFloat": { "type": "number", "format": "float" }, "asLong": { "type": "integer", "format": "int64" }, "asInt": { "type": "integer" }, "asByte": { "type": "string", "format": "base64" }, "asCharacter": { "type": "string" }, "asBigDecimal": { "type": "number" }, "asBigInteger": { "type": "integer" }, "asShort": { "type": "integer" } } }, "CatalogCLAttachmentHandle": { "type": "object", "properties": { "bucket": { "type": "string" }, "location": { "type": "string" }, "type": { "type": "string" }, "key": { "type": "string" }, "upload_id": { "type": "string" }, "max_part_num": { "type": "integer" }, "async_copies": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFileCopyStatus" } } } }, "CatalogFileCopyStatus": { "type": "object", "properties": { "copy_id": { "type": "string" }, "status": { "type": "string", "enum": [ "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "error": { "$ref": "#/components/schemas/ErrorModel" } } }, "CatalogMemberSet": { "required": [ "members" ], "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogMember" } } } }, "CatalogMember": { "required": [ "access_group_id", "role", "user_iam_id" ], "type": "object", "properties": { "user_id": { "type": "string", "description": "(Deprecated) User id like user email address of the member.", "example": "xyz@ibm.com", "deprecated": true }, "user_iam_id": { "type": "string", "description": "Identity and Access Management ID (IAM) of the member", "example": "IBMid-abcd1234" }, "access_group_id": { "type": "string", "description": "ID of the access group member", "example": "AccessGroupId-abcd1234" }, "role": { "type": "string", "description": "Role of the member in the Catalog", "example": "admin" }, "roles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "href": { "type": "string" }, "create_time": { "type": "string", "description": "Read only - The date and time when the member is added to the catalog" } } }, "CatalogBulkAssetsCopyResponse": { "required": [ "responses" ], "type": "object", "properties": { "copy_task_id": { "type": "string" }, "copy_status_href": { "type": "string" }, "state": { "type": "string", "enum": [ "WAITING", "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "trace": { "type": "string", "readOnly": true }, "responses": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogBulkAssetsCopyResponseEntry" } } } }, "CatalogBulkAssetsCopyRequest": { "required": [ "copy_configurations" ], "type": "object", "properties": { "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "space_id": { "type": "string" }, "rov_mode": { "type": "integer" }, "member_roles": { "type": "object", "description": "To assign owners and other collaborators on newly copied target assets.", "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetMember" } }, "copy_configurations": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogBulkAssetsCopyRequestEntry" } } } }, "CatalogBulkAssetsCopyResponseEntry": { "required": [ "asset_id", "http_status" ], "type": "object", "properties": { "asset_id": { "type": "string", "readOnly": true }, "http_status": { "type": "integer", "description": "Same as 'status' field, included for consistency.", "readOnly": true }, "asset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "description": "Depending on the API, either asset_attachments or attachments will be present.", "items": { "$ref": "#/components/schemas/CatalogCLAttachment" } }, "href": { "type": "string" }, "asset_id": { "type": "string" } }, "readOnly": true }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ErrorModel" } }, "copied_assets": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogCopiedAsset" } }, "copy_errors": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAssetCopyError" } } } }, "CatalogBulkAssetsCopyRequestEntry": { "required": [ "asset_id" ], "type": "object", "properties": { "asset_id": { "type": "string" }, "revision_id": { "type": "string" }, "metadata_overrides": { "$ref": "#/components/schemas/CatalogBulkAssetsCopyMetadataOverrides" } } }, "CatalogAssetCopyError": { "type": "object", "properties": { "asset_id": { "type": "string" }, "error": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } } }, "CatalogCopiedAsset": { "type": "object", "properties": { "source_asset_id": { "type": "string" }, "target_asset_id": { "type": "string" }, "update": { "type": "boolean" } } }, "CatalogBulkAssetsCopyMetadataOverrides": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "CatalogBulkAssetsCreateResponse": { "required": [ "responses" ], "type": "object", "properties": { "trace": { "type": "string", "readOnly": true }, "responses": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogBulkAssetsCreateResponseEntry" } } } }, "CatalogBulkAssetsCreateRequest": { "required": [ "assets" ], "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAsset" } } } }, "CatalogBulkAssetsCreateResponseEntry": { "required": [ "http_status" ], "type": "object", "properties": { "http_status": { "type": "integer", "readOnly": true }, "asset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "href": { "type": "string" }, "attachments": { "$ref": "#/components/schemas/CatalogAttachment" }, "asset_id": { "type": "string" } }, "readOnly": true }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ErrorModel" } } } }, "CatalogBulkAssetsUpdateResponse": { "required": [ "resources" ], "type": "object", "properties": { "trace": { "type": "string", "readOnly": true }, "resources": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogBulkAssetsUpdateResponseEntry" } } } }, "CatalogBulkAssetsUpdateRequest": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogBulkAssetsUpdateRequestEntry" } } } }, "CatalogBulkAssetsUpdateResponseEntry": { "required": [ "asset_id", "http_status", "status" ], "type": "object", "properties": { "asset_id": { "type": "string", "readOnly": true }, "status": { "type": "integer", "description": "HTTP status 200 if patched succefully, 204 if no changes and 400-4xx if failed.", "readOnly": true }, "http_status": { "type": "integer", "description": "Same as 'status' field, included for consistency.", "readOnly": true }, "asset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "description": "Depending on the API, either asset_attachments or attachments will be present.", "items": { "$ref": "#/components/schemas/CatalogCLAttachment" } }, "href": { "type": "string" }, "asset_id": { "type": "string" } }, "readOnly": true }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ErrorModel" } }, "newAttachmentResponseMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CatalogJsonObject" } } } }, "CatalogBulkAssetsUpdateRequestEntry": { "required": [ "asset_id", "operations" ], "type": "object", "properties": { "asset_id": { "type": "string" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogJsonNode" } } } }, "CatalogJsonNode": { "type": "object", "properties": { "empty": { "type": "boolean" }, "valueNode": { "type": "boolean" }, "containerNode": { "type": "boolean" }, "missingNode": { "type": "boolean" }, "array": { "type": "boolean" }, "object": { "type": "boolean" }, "nodeType": { "type": "string", "enum": [ "ARRAY", "BINARY", "BOOLEAN", "MISSING", "NULL", "NUMBER", "OBJECT", "POJO", "STRING" ] }, "pojo": { "type": "boolean" }, "number": { "type": "boolean" }, "integralNumber": { "type": "boolean" }, "floatingPointNumber": { "type": "boolean" }, "short": { "type": "boolean" }, "int": { "type": "boolean" }, "long": { "type": "boolean" }, "float": { "type": "boolean" }, "double": { "type": "boolean" }, "bigDecimal": { "type": "boolean" }, "bigInteger": { "type": "boolean" }, "textual": { "type": "boolean" }, "boolean": { "type": "boolean" }, "null": { "type": "boolean" }, "binary": { "type": "boolean" } } }, "CatalogAssetCopyStatusNew": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/CatalogAssetContainer" }, "target": { "$ref": "#/components/schemas/CatalogAssetContainer" }, "started_at": { "type": "string" }, "start_time": { "type": "integer", "format": "int64" }, "finished_at": { "type": "string" }, "finish_time": { "type": "integer", "format": "int64" }, "expires_at": { "type": "string" }, "expiration_time": { "type": "integer", "format": "int64" }, "state": { "type": "string", "enum": [ "WAITING", "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "error": { "$ref": "#/components/schemas/CatalogErrorContainerModel" }, "status_code": { "type": "integer" }, "transaction_id": { "type": "string" }, "cams_transaction_id": { "type": "string" }, "instance_id": { "type": "string" }, "stack_trace": { "type": "string" }, "responses": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAssetCopyStatusEntry" } } } }, "CatalogAssetCopyStatusEntry": { "type": "object", "properties": { "source_asset_id": { "type": "string" }, "source_asset_rev": { "type": "string" }, "copied_assets": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogCopiedAsset" } }, "copy_errors": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAssetCopyError" } } } }, "CatalogAssetContainer": { "type": "object", "properties": { "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "space_id": { "type": "string" } } }, "CatalogObjectURLReqResp": { "type": "object", "properties": { "asset_id": { "type": "string" }, "asset_type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "mime": { "type": "string" }, "expires_in": { "type": "integer" }, "path": { "type": "string" } } }, "CatalogAssetCopyStatus": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/CatalogAssetContainer" }, "target": { "$ref": "#/components/schemas/CatalogAssetContainer" }, "started_at": { "type": "string" }, "start_time": { "type": "integer", "format": "int64" }, "finished_at": { "type": "string" }, "finish_time": { "type": "integer", "format": "int64" }, "expires_at": { "type": "string" }, "expiration_time": { "type": "integer", "format": "int64" }, "state": { "type": "string", "enum": [ "WAITING", "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "error": { "$ref": "#/components/schemas/CatalogErrorContainerModel" }, "status_code": { "type": "integer" }, "transaction_id": { "type": "string" }, "cams_transaction_id": { "type": "string" }, "instance_id": { "type": "string" }, "stack_trace": { "type": "string" }, "source_asset_id": { "type": "string" }, "source_asset_rev": { "type": "string" }, "copied_assets": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogCopiedAsset" } }, "copy_errors": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAssetCopyError" } }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogCopiedAsset" } } } }, "CatalogBulkSearchDuplicateResponse": { "required": [ "resources" ], "type": "object", "properties": { "trace": { "type": "string", "description": "trace id of the transaction. only avaialbe if any of the request item failed.", "example": "32s0wywr3wdqpsn86b4cfzb4i" }, "resources": { "type": "array", "description": "the responses", "items": { "$ref": "#/components/schemas/CatalogBulkSearchDuplicateResponseEntry" } } } }, "CatalogBulkSearchDuplicateRequest": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "description": "the assets to search duplicates for", "items": { "$ref": "#/components/schemas/CatalogSearchDuplicateRequest" } } } }, "CatalogBulkSearchDuplicateResponseEntry": { "required": [ "http_status" ], "type": "object", "properties": { "results": { "type": "array", "description": "List of matching duplicate assets", "items": { "$ref": "#/components/schemas/CatalogMatchedDuplicateAsset" } }, "best_updatable_duplicate_asset_id": { "type": "string", "description": "The id of the best updatable duplicate asset that would be chosen for updating/overwriting in a real persistence transaction. It is possible that there are matching duplicate assets but this field is null, which indicates the caller does not have permission to update/replace any of the matching duplicate assets", "example": "b81c84f5-a551-43bb-9a6e-c8e7820995f9" }, "total_count": { "type": "integer", "description": "Total number of duplicates", "example": 1 }, "http_status": { "type": "integer", "description": "the status of the response", "readOnly": true, "example": 200 }, "errors": { "type": "array", "description": "indicates the error if the sub-request fails.", "items": { "$ref": "#/components/schemas/ErrorModel" } } } }, "CatalogSearchDuplicateRequest": { "type": "object", "properties": { "catalog_id": { "type": "string", "description": "Id of the catalog the existing asset resides in. You must provide either a catalog id, a project id, or a space id, but not more than one", "example": "b81c84f5-a551-43bb-9a6e-c8e7820995f9" }, "project_id": { "type": "string", "description": "Id of the project the existing asset resides in. You must provide either a catalog id, a project id, or a space id, but not more than one", "example": "814bc4e9-a8e6-4a02-9fb8-096211f09fb5" }, "space_id": { "type": "string", "description": "Id of the space the existing asset resides in. You must provide either a catalog id, a project id, or a space id, but not more than one", "example": "21a374d0-9d04-48d5-884b-0f6cbfc67779" }, "asset_id": { "type": "string", "description": "Id of the existing asset", "example": "c43efbc1-7a65-44b8-bc40-c59f008716a8" }, "revision_id": { "type": "string", "description": "Revision of the existing asset", "example": "1,2,...,latest" }, "asset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAttachment" } } }, "description": "The asset payload, which is the same as the user would provide for creating a new asset." } } }, "CatalogMatchedDuplicateAsset": { "type": "object", "properties": { "asset_id": { "type": "string", "description": "Asset id", "example": "b81c84f5-a551-43bb-9a6e-c8e7820995f9" }, "highest_match_score": { "type": "object", "properties": { "category": { "type": "string", "description": "Category of the duplicate", "example": "ORIGINAL_ASSET", "enum": [ "ORIGINAL_ASSET", "COPY_OF_SAME_ASSET", "ASSET_WITH_SAME_VALUES" ] }, "strategy": { "type": "string", "description": "Strategy used for measuring the match", "example": "DUPLICATE_DETECTION_BY_NAME", "enum": [ "DUPLICATE_DETECTION_BY_NAME", "DUPLICATE_DETECTION_BY_NAME_AND_RESOURCE_KEY", "DUPLICATE_DETECTION_BY_NAME_AND_FOLDER", "DUPLICATE_DETECTION_BY_RESOURCE_KEY", "DUPLICATE_DETECTION_NOT_APPLICABLE" ] }, "match_type": { "type": "string", "description": "Type of matches", "enum": [ "MATCH", "POSSIBLE_MATCH", "NOT_MATCH" ] }, "score": { "type": "number", "description": "Score of the match which describes how closely two objects match each other. Possible values are between 0 (no match) to 100 (perfect match).", "format": "float", "example": 90 } }, "description": "Highest match score" }, "errors": { "type": "array", "description": "Indicates the error if the user cannot access the duplicate aaset", "items": { "$ref": "#/components/schemas/ErrorModel" } }, "asset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "description": "Depending on the API, either asset_attachments or attachments will be present.", "items": { "$ref": "#/components/schemas/CatalogCLAttachment" } }, "href": { "type": "string" }, "asset_id": { "type": "string" } }, "description": "The duplicate asset" } } }, "CatalogSearchDuplicateResponse": { "type": "object", "properties": { "results": { "type": "array", "description": "List of matching duplicate assets", "items": { "$ref": "#/components/schemas/CatalogMatchedDuplicateAsset" } }, "best_updatable_duplicate_asset_id": { "type": "string", "description": "The id of the best updatable duplicate asset that would be chosen for updating/overwriting in a real persistence transaction. It is possible that there are matching duplicate assets but this field is null, which indicates the caller does not have permission to update/replace any of the matching duplicate assets", "example": "b81c84f5-a551-43bb-9a6e-c8e7820995f9" }, "total_count": { "type": "integer", "description": "Total number of duplicates", "example": 1 } } }, "CatalogFindRelatedObjectsResponse": { "required": [ "next", "options", "resources", "total_rows" ], "type": "object", "properties": { "options": { "required": [ "bookmark", "include_source_columns", "include_target_columns", "limit", "lookup_artifact_names", "lookup_asset_names", "lookup_container_names", "relationship_names", "sort_fields" ], "type": "object", "properties": { "bookmark": { "type": "string", "readOnly": true }, "limit": { "type": "integer", "readOnly": true }, "relationship_names": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "sort_fields": { "type": "array", "readOnly": true, "items": { "type": "string", "enum": [ "CREATE_TIME_ASC", "CREATE_TIME_DESC", "UPDATE_TIME_ASC", "UPDATE_TIME_DESC", "CREATOR_ID_ASC", "CREATOR_ID_DESC", "UPDATER_ID_ASC", "UPDATER_ID_DESC" ] } }, "source_asset": { "required": [ "asset_id", "asset_type" ], "type": "object", "properties": { "catalog_id": { "type": "string", "readOnly": true }, "project_id": { "type": "string", "readOnly": true }, "space_id": { "type": "string", "readOnly": true }, "asset_id": { "type": "string", "readOnly": true }, "asset_type": { "type": "string", "readOnly": true }, "qualifiedAssetId": { "$ref": "#/components/schemas/CatalogQualifiedAssetId" } }, "readOnly": true }, "source_artifact": { "required": [ "artifact_id", "artifact_type" ], "type": "object", "properties": { "artifact_id": { "type": "string", "readOnly": true }, "artifact_type": { "type": "string", "readOnly": true }, "qualifiedArtifactId": { "$ref": "#/components/schemas/CatalogQualifiedArtifactId" } }, "readOnly": true }, "target_asset_types": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "target_artifact_types": { "type": "array", "readOnly": true, "items": { "type": "string" } }, "lookup_asset_names": { "type": "boolean", "readOnly": true }, "lookup_artifact_names": { "type": "boolean", "readOnly": true }, "include_target_columns": { "type": "boolean", "readOnly": true }, "include_source_columns": { "type": "boolean", "readOnly": true }, "lookup_container_names": { "type": "boolean", "readOnly": true }, "modified_after": { "type": "string", "readOnly": true }, "modified_before": { "type": "string", "readOnly": true }, "sourceCriteria": { "$ref": "#/components/schemas/CatalogRelationshipSourceCriteria" }, "targetTypes": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogRelationshipTargetType" } }, "dateConstraints": { "$ref": "#/components/schemas/CatalogDateConstraints" }, "catalogIdFilter": { "type": "array", "items": { "type": "string" } } }, "readOnly": true }, "resources": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogRelatedAsset" } }, "total_rows": { "type": "integer", "format": "int64", "readOnly": true }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "readOnly": true }, "bookmark": { "type": "string", "readOnly": true } }, "readOnly": true } } }, "CatalogRelatedAsset": { "required": [ "created", "creator_id", "href", "relationship_display_name", "relationship_name", "updated", "updater_id" ], "type": "object", "properties": { "catalog_id": { "type": "string", "readOnly": true }, "project_id": { "type": "string", "readOnly": true }, "space_id": { "type": "string", "readOnly": true }, "container_name": { "type": "string", "readOnly": true }, "asset_id": { "type": "string", "readOnly": true }, "artifact_id": { "type": "string", "readOnly": true }, "artifact_type": { "type": "string", "readOnly": true }, "artifact_name": { "type": "string", "readOnly": true }, "relationship_name": { "type": "string", "readOnly": true }, "relationship_display_name": { "type": "string", "readOnly": true }, "asset_type": { "type": "string", "readOnly": true }, "asset_name": { "type": "string", "readOnly": true }, "column_name": { "type": "string", "readOnly": true }, "href": { "type": "string", "readOnly": true }, "created": { "type": "integer", "format": "int64", "readOnly": true }, "updated": { "type": "integer", "format": "int64", "readOnly": true }, "creator_id": { "type": "string", "readOnly": true }, "updater_id": { "type": "string", "readOnly": true }, "localized_display_name": { "type": "object", "readOnly": true, "additionalProperties": { "type": "string" } }, "governanceArtifact": { "type": "boolean" }, "columnAsset": { "type": "boolean" }, "assetContainer": { "$ref": "#/components/schemas/CatalogAssetContainer" } } }, "CatalogDateConstraints": { "type": "object", "properties": { "updatedBefore": { "type": "string", "format": "date-time" }, "updatedAfter": { "type": "string", "format": "date-time" } } }, "CatalogRelationshipTargetType": { "type": "object", "properties": { "assetType": { "type": "string" }, "artifactType": { "type": "string" } } }, "CatalogRelationshipSourceCriteria": { "type": "object", "properties": { "container": { "$ref": "#/components/schemas/CatalogAssetContainer" }, "assetId": { "$ref": "#/components/schemas/CatalogQualifiedAssetId" }, "artifactId": { "$ref": "#/components/schemas/CatalogQualifiedArtifactId" } } }, "CatalogQualifiedArtifactId": { "required": [ "artifact_id", "artifact_type" ], "type": "object", "properties": { "artifact_id": { "type": "string" }, "artifact_type": { "type": "string" } } }, "CatalogQualifiedAssetId": { "required": [ "asset_id" ], "type": "object", "properties": { "catalog_id": { "type": "string", "readOnly": true }, "project_id": { "type": "string", "readOnly": true }, "asset_id": { "type": "string", "readOnly": true } } }, "CatalogResponseAsset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "description": "Depending on the API, either asset_attachments or attachments will be present.", "items": { "$ref": "#/components/schemas/CatalogCLAttachment" } }, "href": { "type": "string" }, "asset_id": { "type": "string" } } }, "CatalogPublishAsset": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogPublishAssetMetadata" }, "entity": { "type": "object", "additionalProperties": { "type": "object" } } }, "description": "Publish Asset Model to publish an Asset in project which are actually not created in project" }, "CatalogPublishAssetMetadata": { "required": [ "asset_category", "asset_type", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Choose Any Name for your Asset" }, "description": { "type": "string", "description": "A longer description describes an asset." }, "tags": { "type": "array", "items": { "type": "string" } }, "asset_type": { "type": "string", "description": "asset type", "example": "data_asset" }, "origin_country": { "type": "string", "example": "us" }, "resource_key": { "type": "string" }, "identity_key": { "type": "string" }, "rov": { "$ref": "#/components/schemas/CatalogNewAssetAssetRov" }, "asset_category": { "type": "string", "example": "USER" }, "source_system": { "$ref": "#/components/schemas/CatalogSourceSystem" }, "child_source_systems": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSourceSystem" } }, "source_system_history": { "type": "array", "description": "History of external repository assets that were the source of an imported/synced/rehomed asset.", "items": { "$ref": "#/components/schemas/CatalogSourceSystemHistoryRecord" } }, "published_from": { "$ref": "#/components/schemas/CatalogAssetPublishedFrom" }, "published_to": { "$ref": "#/components/schemas/CatalogAssetPublishedTo" } }, "description": "Publish Asset Metadata" }, "CatalogAssetPublishedTo": { "required": [ "catalog_id" ], "type": "object", "properties": { "catalog_id": { "type": "string" } }, "description": "Asset metadata where it published to" }, "CatalogAssetPublishedFrom": { "required": [ "project_id", "source_url" ], "type": "object", "properties": { "project_id": { "type": "string" }, "source_url": { "type": "string" } }, "description": "Asset metadata where its published from" }, "CatalogCreateRelationshipsResponse": { "required": [ "results" ], "type": "object", "properties": { "results": { "type": "array", "description": "Result(s) of relationship creation operation(s)", "items": { "$ref": "#/components/schemas/CatalogRelationshipCreationResult" } } } }, "CatalogBulkAssetRelationshipsRequest": { "required": [ "relationships" ], "type": "object", "properties": { "relationships": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAssetRelationship" } } } }, "CatalogRelationshipCreationResult": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "integer", "description": "Asset relationship creation status. If the relationship was created successfully, status will be 200.\nOtherwise, status will be some error status (e.g. 400)", "example": 200 }, "error": { "type": "object", "properties": { "trace": { "type": "string", "description": "Trace (transaction) ID for the failed operation" }, "errors": { "maxItems": 256, "minItems": 0, "type": "array", "description": "Errors thrown during the operation", "items": { "maxItems": 0, "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": "invalid_parameter", "enum": [ "request_body_error", "missing_required_value", "invalid_parameter", "does_not_exist", "already_exists", "not_authenticated", "not_authorized", "create_error", "fetch_error", "update_error", "delete_error", "data_error", "database_error", "database_query_error", "constraint_violation", "unable_to_perform", "too_many_requests", "dependent_service_error", "configuration_error", "unexpected_exception", "governance_policy_denial", "database_usage_limits", "inactive_user", "entitlement_enforcement", "deleted" ] }, "message": { "type": "string", "description": "Error message" }, "target": { "$ref": "#/components/schemas/CatalogTargetModel" }, "more_info": { "type": "string", "description": "More info about the error." } }, "description": "Errors thrown during the operation" } } }, "description": "Error information if the creation operation failed. This field is not set if the creation operation succeeded" }, "relationship": { "required": [ "end1", "end2" ], "type": "object", "properties": { "end1": { "required": [ "relationship_name" ], "type": "object", "properties": { "relationship_name": { "type": "string", "description": "Relationship endpoint name, from a relationship type defined on an asset type" }, "catalog_id": { "type": "string", "description": "Catalog ID" }, "project_id": { "type": "string", "description": "Project ID" }, "space_id": { "type": "string", "description": "Space ID" }, "asset_id": { "type": "string", "description": "Asset ID" }, "artifact_id": { "type": "string", "description": "Artifact ID" }, "artifact_type": { "type": "string", "description": "Artifact type" }, "asset_type": { "type": "string", "description": "Asset type" }, "assetName": { "type": "string" }, "columnName": { "type": "string" }, "governanceArtifact": { "type": "boolean" }, "catalogAsset": { "type": "boolean" }, "assetContainer": { "$ref": "#/components/schemas/CatalogAssetContainer" } }, "description": "Relationship endpoint 1" }, "end2": { "required": [ "relationship_name" ], "type": "object", "properties": { "relationship_name": { "type": "string", "description": "Relationship endpoint name, from a relationship type defined on an asset type" }, "catalog_id": { "type": "string", "description": "Catalog ID" }, "project_id": { "type": "string", "description": "Project ID" }, "space_id": { "type": "string", "description": "Space ID" }, "asset_id": { "type": "string", "description": "Asset ID" }, "artifact_id": { "type": "string", "description": "Artifact ID" }, "artifact_type": { "type": "string", "description": "Artifact type" }, "asset_type": { "type": "string", "description": "Asset type" }, "assetName": { "type": "string" }, "columnName": { "type": "string" }, "governanceArtifact": { "type": "boolean" }, "catalogAsset": { "type": "boolean" }, "assetContainer": { "$ref": "#/components/schemas/CatalogAssetContainer" } }, "description": "Relationship endpoint 2" } }, "description": "Asset relationship created. This field is set if the creation operation succeeded" }, "metadata": { "type": "object", "properties": { "empty": { "type": "boolean" }, "jsonArray": { "type": "boolean" }, "jsonObject": { "type": "boolean" }, "jsonPrimitive": { "type": "boolean" }, "jsonNull": { "type": "boolean" }, "asJsonObject": { "$ref": "#/components/schemas/CatalogJsonObject" }, "asJsonArray": { "$ref": "#/components/schemas/CatalogJsonArray" }, "asJsonPrimitive": { "$ref": "#/components/schemas/CatalogJsonPrimitive" }, "asJsonNull": { "$ref": "#/components/schemas/CatalogJsonNull" }, "asBoolean": { "type": "boolean" }, "asNumber": { "$ref": "#/components/schemas/CatalogNumber" }, "asString": { "type": "string" }, "asDouble": { "type": "number", "format": "double" }, "asFloat": { "type": "number", "format": "float" }, "asLong": { "type": "integer", "format": "int64" }, "asInt": { "type": "integer" }, "asByte": { "type": "string", "format": "base64" }, "asCharacter": { "type": "string" }, "asBigDecimal": { "type": "number" }, "asBigInteger": { "type": "integer" }, "asShort": { "type": "integer" } }, "description": "Metadata of the relationship operation" }, "relationshipId": { "type": "string", "description": "Unique id of a relationship operation" } } }, "CatalogAssetRelationship": { "required": [ "relationship_name", "source", "target" ], "type": "object", "properties": { "relationship_name": { "type": "string", "description": "relationship name" }, "source": { "type": "object", "properties": { "catalog_id": { "type": "string", "description": "Catalog ID" }, "project_id": { "type": "string", "description": "Project ID" }, "space_id": { "type": "string", "description": "Space ID" }, "asset_id": { "type": "string", "description": "Asset ID" }, "artifact_type": { "type": "string", "description": "Artifact Type" }, "artifact_id": { "type": "string", "description": "Artifact ID" }, "artifact_name": { "type": "string", "description": "Asset or Artifact Name" } }, "description": "source asset" }, "target": { "type": "object", "properties": { "catalog_id": { "type": "string", "description": "Catalog ID" }, "project_id": { "type": "string", "description": "Project ID" }, "space_id": { "type": "string", "description": "Space ID" }, "asset_id": { "type": "string", "description": "Asset ID" }, "artifact_type": { "type": "string", "description": "Artifact Type" }, "artifact_id": { "type": "string", "description": "Artifact ID" }, "artifact_name": { "type": "string", "description": "Asset or Artifact Name" } }, "description": "target assets/artifacts" } } }, "CatalogDeleteRelationshipsResponse": { "required": [ "results" ], "type": "object", "properties": { "results": { "type": "array", "description": "Result(s) of relationship deletion operation(s)", "items": { "$ref": "#/components/schemas/CatalogRelationshipDeletionResult" } } } }, "CatalogRelationshipDeletionResult": { "required": [ "Asset relationship deletion status" ], "type": "object", "properties": { "Asset relationship deletion status": { "type": "integer", "description": "If the relationship was deleted successfully, status will be 204.\nOtherwise, status will be some error status (e.g. 400)", "example": 204 }, "Error information if the creation operation failed": { "type": "object", "properties": { "trace": { "type": "string", "description": "Trace (transaction) ID for the failed operation" }, "errors": { "maxItems": 256, "minItems": 0, "type": "array", "description": "Errors thrown during the operation", "items": { "maxItems": 0, "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": "invalid_parameter", "enum": [ "request_body_error", "missing_required_value", "invalid_parameter", "does_not_exist", "already_exists", "not_authenticated", "not_authorized", "create_error", "fetch_error", "update_error", "delete_error", "data_error", "database_error", "database_query_error", "constraint_violation", "unable_to_perform", "too_many_requests", "dependent_service_error", "configuration_error", "unexpected_exception", "governance_policy_denial", "database_usage_limits", "inactive_user", "entitlement_enforcement", "deleted" ] }, "message": { "type": "string", "description": "Error message" }, "target": { "$ref": "#/components/schemas/CatalogTargetModel" }, "more_info": { "type": "string", "description": "More info about the error." } }, "description": "Errors thrown during the operation" } } }, "description": "This field is not set if the creation operation succeeded" }, "relationshipId": { "type": "string", "description": "Unique id of a relationship operation" }, "sourceId": { "type": "string", "description": "Id of the incoming source asset/artifact" }, "targetId": { "type": "string", "description": "Id of the incoming target asset/artifact" } } }, "CatalogJsonPatch": { "type": "object", "description": "JSON array of patch operations as defined in RFC 6902" }, "CatalogAttachmentIncRes": { "required": [ "data_partitions" ], "type": "object", "properties": { "data_partitions": { "type": "integer" }, "private_url": { "type": "boolean" } } }, "CatalogAttribute": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "example": "TestAttribute" }, "entity": { "type": "object", "additionalProperties": { "type": "object" } } }, "description": "Attribute Model" }, "CatalogAssetCopyTo": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string" }, "member_roles": { "type": "object", "description": "Optional owners and other collaborators to assign to newly copied target assets", "additionalProperties": { "$ref": "#/components/schemas/CatalogAssetMember" } }, "mode": { "type": "integer", "description": "Set the privacy level mode to be Public (0), Private (8), or Hidden (16)" } }, "description": "Copy Asset Model" }, "CatalogDeleteAssetDocumentConflictsRequest": { "required": [ "revs" ], "type": "object", "properties": { "revs": { "type": "array", "description": "List of conflicting documents revs", "items": { "type": "string" } } }, "description": "Deleting asset document conflicts request model" }, "CatalogAssetDocumentConflictsResponse": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "description": "List of document conflicts", "items": { "$ref": "#/components/schemas/CatalogAssetDocumentConflict" } }, "limit": { "type": "integer", "example": 30 }, "offset": { "type": "integer", "format": "int64", "example": 100 }, "total_count": { "type": "integer", "format": "int64", "example": 300 }, "first": { "$ref": "#/components/schemas/CatalogLink" }, "last": { "$ref": "#/components/schemas/CatalogLink" }, "next": { "$ref": "#/components/schemas/CatalogLink" }, "prev": { "$ref": "#/components/schemas/CatalogLink" } } }, "CatalogLink": { "type": "object", "properties": { "uri": { "type": "string", "format": "uri" }, "uriBuilder": { "$ref": "#/components/schemas/CatalogUriBuilder" }, "rel": { "type": "string" }, "rels": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "type": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CatalogAssetDocumentConflict": { "required": [ "rev" ], "type": "object", "properties": { "rev": { "type": "string", "description": "Rev of the conflicting document" }, "document": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogResponseAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "description": "Depending on the API, either asset_attachments or attachments will be present.", "items": { "$ref": "#/components/schemas/CatalogCLAttachment" } }, "href": { "type": "string" }, "asset_id": { "type": "string" } }, "description": "Content of the conflicting document" } }, "description": "Asset document conflict model" }, "CatalogUriBuilder": { "type": "object" }, "CatalogDeepCopyResponse": { "type": "object", "properties": { "options": { "$ref": "#/components/schemas/CatalogDeepCopyOptions" }, "copy_task_id": { "type": "string" }, "copy_status_href": { "type": "string" }, "copied_asset": { "$ref": "#/components/schemas/CatalogResponseAsset" } } }, "CatalogDeepCopyOptions": { "type": "object", "properties": { "project_id": { "type": "string", "readOnly": true }, "catalog_id": { "type": "string", "readOnly": true }, "asset_id": { "type": "string", "readOnly": true }, "revision_id": { "type": "string", "readOnly": true }, "requested_metadata": { "type": "object", "properties": { "empty": { "type": "boolean" }, "jsonArray": { "type": "boolean" }, "jsonObject": { "type": "boolean" }, "jsonPrimitive": { "type": "boolean" }, "jsonNull": { "type": "boolean" }, "asJsonObject": { "$ref": "#/components/schemas/CatalogJsonObject" }, "asJsonArray": { "$ref": "#/components/schemas/CatalogJsonArray" }, "asJsonPrimitive": { "$ref": "#/components/schemas/CatalogJsonPrimitive" }, "asJsonNull": { "$ref": "#/components/schemas/CatalogJsonNull" }, "asBoolean": { "type": "boolean" }, "asNumber": { "$ref": "#/components/schemas/CatalogNumber" }, "asString": { "type": "string" }, "asDouble": { "type": "number", "format": "double" }, "asFloat": { "type": "number", "format": "float" }, "asLong": { "type": "integer", "format": "int64" }, "asInt": { "type": "integer" }, "asByte": { "type": "string", "format": "base64" }, "asCharacter": { "type": "string" }, "asBigDecimal": { "type": "number" }, "asBigInteger": { "type": "integer" }, "asShort": { "type": "integer" } }, "readOnly": true } } }, "CatalogAssetImage": { "type": "object", "properties": { "id": { "type": "string", "description": "Image id" }, "assetId": { "type": "string", "description": "The asset id of the image" }, "name": { "type": "string", "description": "Image name" }, "mime": { "type": "string", "description": "Image type mime" }, "createdAt": { "type": "string", "description": "Image created at" }, "creatorId": { "type": "string", "description": "Image creator id" }, "url": { "type": "string", "description": "Image download url" } }, "description": "Asset Image Model" }, "CatalogAssetNotesCreationResponse": { "required": [ "results" ], "type": "object", "properties": { "results": { "type": "array", "description": "Result(s) of asset note creation operation(s)", "items": { "$ref": "#/components/schemas/CatalogAssetNoteCreationResult" } } } }, "CatalogAssetNotesCreationRequest": { "required": [ "notes" ], "type": "object", "properties": { "notes": { "type": "array", "description": "notes to be created for an asset and for columns of an asset", "items": { "$ref": "#/components/schemas/CatalogAssetNoteCreationRequestItem" } } } }, "CatalogTokenPaginatedAssetNoteList": { "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAssetNote" } }, "limit": { "type": "integer", "example": 30 }, "count": { "type": "integer", "format": "int64", "example": 300 }, "first": { "$ref": "#/components/schemas/CatalogLink" }, "next": { "$ref": "#/components/schemas/CatalogLink" } } }, "CatalogAssetNoteCreationResult": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "integer", "description": "Asset note creation status. If the note was created successfully, status will be 201.\nOtherwise, status will be some error status (e.g. 400)", "example": 201 }, "note": { "type": "object", "properties": { "metadata": { "required": [ "asset_note_id" ], "type": "object", "properties": { "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "space_id": { "type": "string" }, "asset_note_id": { "type": "string", "description": "system generated unique asset note identifier" }, "asset_id": { "type": "string", "description": "unique Identifier of asset associated with this note", "readOnly": true, "example": "892aaa55-1b0e-438a-b05f-4224246a0f3f" }, "column_name": { "type": "string", "description": "name of the column associated with this note", "readOnly": true, "example": "city" }, "creator_id": { "type": "string", "description": "ID of user that created the asset note (system managed)", "readOnly": true, "example": "IBMid-66100421AN" }, "updater_id": { "type": "string", "description": "ID of user that updated the asset note (system managed)", "readOnly": true, "example": "IBMid-66100421AN" }, "created_at": { "type": "string", "description": "RFC 3339 timestamp (yyyy-MM-dd'T'HH:mm:ss'Z') when the asset note was created (system managed)", "readOnly": true, "example": "2023-05-24T16:34:06.000Z" }, "created_time": { "type": "integer", "description": "Epoch timestamp when the asset note was created (system managed)", "format": "int64", "readOnly": true, "example": 1621874046338 }, "updated_at": { "type": "string", "description": "RFC 3339 timestamp (yyyy-MM-dd'T'HH:mm:ss'Z') when the asset note was updated (system managed)", "readOnly": true, "example": "2023-05-24T16:34:06.000Z" }, "updated_time": { "type": "integer", "description": "Epoch timestamp when the asset note was updated (system managed)", "format": "int64", "readOnly": true, "example": 1621874046338 } }, "description": "Asset note metadata" }, "entity": { "required": [ "note" ], "type": "object", "properties": { "note": { "type": "string", "description": "a note associated with an asset or a column of an asset", "example": "description of a note" } }, "description": "Asset note entity" } }, "description": "Asset note that was successfully created" }, "error": { "type": "object", "properties": { "trace": { "type": "string", "description": "Trace (transaction) ID for the failed operation" }, "errors": { "maxItems": 256, "minItems": 0, "type": "array", "description": "Errors thrown during the operation", "items": { "maxItems": 0, "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": "invalid_parameter", "enum": [ "request_body_error", "missing_required_value", "invalid_parameter", "does_not_exist", "already_exists", "not_authenticated", "not_authorized", "create_error", "fetch_error", "update_error", "delete_error", "data_error", "database_error", "database_query_error", "constraint_violation", "unable_to_perform", "too_many_requests", "dependent_service_error", "configuration_error", "unexpected_exception", "governance_policy_denial", "database_usage_limits", "inactive_user", "entitlement_enforcement", "deleted" ] }, "message": { "type": "string", "description": "Error message" }, "target": { "$ref": "#/components/schemas/CatalogTargetModel" }, "more_info": { "type": "string", "description": "More info about the error." } }, "description": "Errors thrown during the operation" } } }, "description": "Error information if the creation operation failed. This field is not set if the creation operation succeeded" } } }, "CatalogAssetNoteCreationRequestItem": { "required": [ "note" ], "type": "object", "properties": { "note": { "type": "string", "description": "a note associated with an asset or a column of an asset", "example": "Metadata for CUSTOMER table" }, "column_name": { "type": "string", "description": "name of the column associated with this note", "example": "CITY" } } }, "CatalogAssetNote": { "type": "object", "properties": { "metadata": { "required": [ "asset_note_id" ], "type": "object", "properties": { "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "space_id": { "type": "string" }, "asset_note_id": { "type": "string", "description": "system generated unique asset note identifier" }, "asset_id": { "type": "string", "description": "unique Identifier of asset associated with this note", "readOnly": true, "example": "892aaa55-1b0e-438a-b05f-4224246a0f3f" }, "column_name": { "type": "string", "description": "name of the column associated with this note", "readOnly": true, "example": "city" }, "creator_id": { "type": "string", "description": "ID of user that created the asset note (system managed)", "readOnly": true, "example": "IBMid-66100421AN" }, "updater_id": { "type": "string", "description": "ID of user that updated the asset note (system managed)", "readOnly": true, "example": "IBMid-66100421AN" }, "created_at": { "type": "string", "description": "RFC 3339 timestamp (yyyy-MM-dd'T'HH:mm:ss'Z') when the asset note was created (system managed)", "readOnly": true, "example": "2023-05-24T16:34:06.000Z" }, "created_time": { "type": "integer", "description": "Epoch timestamp when the asset note was created (system managed)", "format": "int64", "readOnly": true, "example": 1621874046338 }, "updated_at": { "type": "string", "description": "RFC 3339 timestamp (yyyy-MM-dd'T'HH:mm:ss'Z') when the asset note was updated (system managed)", "readOnly": true, "example": "2023-05-24T16:34:06.000Z" }, "updated_time": { "type": "integer", "description": "Epoch timestamp when the asset note was updated (system managed)", "format": "int64", "readOnly": true, "example": 1621874046338 } }, "description": "Asset note metadata" }, "entity": { "required": [ "note" ], "type": "object", "properties": { "note": { "type": "string", "description": "a note associated with an asset or a column of an asset", "example": "description of a note" } }, "description": "Asset note entity" } } }, "CatalogAssetOwner": { "type": "object", "properties": { "owner": { "type": "string", "example": "test@us.ibm.com" }, "owner_id": { "type": "string", "example": "IBMid-310002980" } } }, "CatalogAssetRov": { "type": "object", "properties": { "mode": { "type": "integer" } } }, "CatalogAssetRating": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogAssetRatingMetadata" }, "entity": { "$ref": "#/components/schemas/CatalogAssetRatingEntity" } } }, "CatalogAssetRatingEntity": { "required": [ "rating" ], "type": "object", "properties": { "rating": { "type": "integer", "description": "user's rating of an asset", "example": 5 }, "review": { "type": "string", "description": "user's review of an asset", "example": "Such an asset!" } } }, "CatalogTokenPaginatedAssetRatingList": { "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAssetRating" } }, "limit": { "type": "integer", "example": 30 }, "count": { "type": "integer", "format": "int64", "example": 300 }, "first": { "$ref": "#/components/schemas/CatalogLink" }, "next": { "$ref": "#/components/schemas/CatalogLink" } } }, "CatalogAssetRatingMetadata": { "required": [ "asset_rating_id" ], "type": "object", "properties": { "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "space_id": { "type": "string" }, "asset_rating_id": { "type": "string", "description": "unique asset rating identifier", "example": "008bdb86-c1c5-488e-9cad-0c154b9965e6_IBMid-2304300" }, "asset_id": { "type": "string", "description": "identifier for asset associated with this rating (system managed)", "readOnly": true, "example": "008bdb86-c1c5-488e-9cad-0c154b9965e6" }, "creator": { "type": "string", "description": "IAM ID of user that creating the asset rating (system managed)", "readOnly": true, "example": "008bdb86-c1c5-488e-9cad-0c154b9965e6" }, "creator_id": { "type": "string" }, "created_at": { "type": "string", "description": "RFC 3339 timestamp when the asset rating was created (system managed)", "readOnly": true, "example": "yyyy-MM-dd'T'HH:mm:ss'Z'" }, "updated_at": { "type": "string", "description": "RFC 3339 timestamp when the asset rating was updated (system managed)", "readOnly": true, "example": "yyyy-MM-dd'T'HH:mm:ss'Z'" }, "revision_id": { "type": "integer", "description": "identifier for asset associated with this rating (system managed)", "format": "int64", "readOnly": true, "example": 1 } }, "description": "AssetRatingMetadata" }, "CatalogAssetRatingStatsResponse": { "type": "object", "properties": { "asset_id": { "type": "string", "description": "identifier for asset", "example": "008bdb86-c1c5-488e-9cad-0c154b9965e6" }, "revision_id": { "type": "integer", "description": "revision for asset", "format": "int64", "example": 1 }, "stats": { "type": "array", "description": "count of ratings for each rating value", "items": { "$ref": "#/components/schemas/CatalogAssetRatingCount" } } } }, "CatalogAssetRatingCount": { "type": "object", "properties": { "rating": { "type": "integer", "description": "rating of an asset", "example": 5 }, "count": { "type": "integer", "description": "number of ratings with rating value", "format": "int64", "example": 12 } } }, "CatalogRelationshipTarget": { "type": "object", "properties": { "catalog_id": { "type": "string", "description": "Catalog ID" }, "project_id": { "type": "string", "description": "Project ID" }, "space_id": { "type": "string", "description": "Space ID" }, "asset_id": { "type": "string", "description": "Asset ID" }, "artifact_type": { "type": "string", "description": "Artifact Type" }, "artifact_id": { "type": "string", "description": "Artifact ID" }, "artifact_name": { "type": "string", "description": "Asset or Artifact Name" } } }, "CatalogRelationshipDeleteResponse": { "type": "object", "properties": { "error_results": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogRelationshipDeleteResult" } }, "source_asset": { "$ref": "#/components/schemas/CatalogQualifiedAssetId" }, "relationship_name": { "type": "string" }, "source_asset_type": { "type": "string" }, "target_asset_type": { "type": "string" }, "target_asset_types": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "target_assets_disconnected": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogQualifiedAssetId" } } } }, "CatalogCreateRelationshipsRequestBody": { "required": [ "relationship_targets" ], "type": "object", "properties": { "relationship_targets": { "type": "array", "description": "target artifacts", "items": { "$ref": "#/components/schemas/CatalogRelationshipTarget" } } } }, "CatalogRelationshipDeleteResult": { "required": [ "Asset relationship deletion status" ], "type": "object", "properties": { "Asset relationship deletion status": { "type": "integer", "description": "If the relationship was deleted successfully, status will be 204.\nOtherwise, status will be some error status (e.g. 400)", "example": 204 }, "Error information if the creation operation failed": { "type": "object", "properties": { "trace": { "type": "string", "description": "Trace (transaction) ID for the failed operation" }, "errors": { "maxItems": 256, "minItems": 0, "type": "array", "description": "Errors thrown during the operation", "items": { "$ref": "#/components/schemas/ErrorModel" } } }, "description": "This field is not set if the creation operation succeeded" }, "targetAssetId": { "type": "string", "description": "AssetId for which deletion operation failed. This field is not set if the deletion operation succeeded" } } }, "CatalogAssetCommitOptions": { "type": "object", "properties": { "commit_message": { "type": "string" } }, "description": "Asset Commit Options" }, "CatalogListAssetRevisionsResponse": { "type": "object" }, "CatalogRepairIndexesResponse": { "type": "object", "properties": { "options": { "type": "object", "properties": { "sleep_time_mins": { "type": "integer", "description": "If rate liming is enabled, the number of minute to sleep between creating batches of cache entries", "readOnly": true }, "sleep_every": { "type": "integer", "description": "Number of created cache entries between pauses, if rate limiting is enabled", "readOnly": true }, "catalog_ids": { "type": "array", "description": "The configured list of catalogs to process, if there is one", "readOnly": true, "items": { "type": "string" } }, "thread_count": { "type": "integer", "description": "The number of threads processing the catalogs", "readOnly": true }, "preview_only": { "type": "boolean", "description": "Whether preview mode is enabled", "readOnly": true }, "max_cache_entries_to_create": { "type": "integer", "description": "The number maximum number of cache entries to create", "readOnly": true } }, "description": "The options being used for the indexing repair task.", "readOnly": true }, "status_link": { "type": "string", "description": "Link that can be used to get the status of the indexing repair task.", "readOnly": true }, "task_id": { "type": "string", "description": "The id of the indexing repair task that was created.", "readOnly": true } } }, "CatalogIndexRepairStatusResponse": { "type": "object", "properties": { "options": { "type": "object", "properties": { "sleep_time_mins": { "type": "integer", "description": "If rate liming is enabled, the number of minute to sleep between creating batches of cache entries", "readOnly": true }, "sleep_every": { "type": "integer", "description": "Number of created cache entries between pauses, if rate limiting is enabled", "readOnly": true }, "catalog_ids": { "type": "array", "description": "The configured list of catalogs to process, if there is one", "readOnly": true, "items": { "type": "string" } }, "thread_count": { "type": "integer", "description": "The number of threads processing the catalogs", "readOnly": true }, "preview_only": { "type": "boolean", "description": "Whether preview mode is enabled", "readOnly": true }, "max_cache_entries_to_create": { "type": "integer", "description": "The number maximum number of cache entries to create", "readOnly": true } }, "description": "The options being used for the indexing repair task.", "readOnly": true }, "state": { "type": "string", "description": "The current state of the repair task.", "readOnly": true, "enum": [ "QUEUED", "RUNNING", "FINISHED", "FAILED" ] }, "start_time": { "type": "string", "description": "The time when the task started.", "readOnly": true }, "elapsed_time": { "type": "string", "description": "The amount of time the repair task has been running.", "readOnly": true }, "percent_complete": { "type": "number", "description": "The percentage of the databases that have been processed.", "format": "double", "readOnly": true }, "estimated_end_time": { "type": "string", "description": "The estimated time when the processing will be complete.", "readOnly": true }, "end_time": { "type": "string", "description": "The time when the processing completed.", "readOnly": true }, "estimated_remaining_time": { "type": "string", "description": "The estimated amount of processing time remaining.", "readOnly": true }, "databases_processed": { "type": "integer", "description": "The number of databases that have been processed so far.", "format": "int64", "readOnly": true }, "total_databases_to_process": { "type": "integer", "description": "The total number of databases that need to be processed.", "format": "int64", "readOnly": true }, "stuck_design_docs": { "type": "integer", "description": "The number of stuck temporary design documents that have been found.", "readOnly": true }, "stuck_design_doc_ids": { "type": "array", "description": "The stuck temporary design documents that have been found.", "readOnly": true, "items": { "type": "string" } }, "stuck_design_docs_repaired": { "type": "integer", "description": "The number of stuck temporary design documents that have been repaired so far.", "format": "int64", "readOnly": true }, "temp_design_docs_processed": { "type": "integer", "description": "The number of temporary design documents that have been processed so far.", "format": "int64", "readOnly": true }, "failed_catalog_ids": { "type": "array", "description": "The ids of any catalogs that were unable to be processed.", "readOnly": true, "items": { "type": "string" } }, "failure_message": { "type": "string", "description": "The error message if the processing failed.", "readOnly": true } } }, "CatalogUserAccessMetricsResponse": { "required": [ "limit", "total_count" ], "type": "object", "properties": { "limit": { "type": "integer", "description": "The limit on the number of results returned.", "readOnly": true, "example": 200, "default": "200" }, "total_count": { "type": "integer", "description": "The total count on the number of results returned, accounting for filtering but not pagination.", "readOnly": true, "example": 50 }, "first": { "$ref": "#/components/schemas/CatalogBaseCollectionPage" }, "next": { "$ref": "#/components/schemas/CatalogBaseCollectionNextPage" }, "resources": { "type": "array", "description": "Collection of user access statistics", "items": { "$ref": "#/components/schemas/CatalogUserAccessStatistics" } } }, "description": "The user access metrics response API model." }, "CatalogUserAccessStatistics": { "type": "object", "properties": { "bss_account_id": { "type": "string", "description": "The ID of the BSS account", "example": "2bd4aae3134bdd0a627bf6454f012c5a" }, "catalog_id": { "type": "string", "description": "The ID of the catalog", "example": "0d45d610-b634-4123-9d40-f1dc5a7fdff2" }, "number_of_users": { "type": "integer", "description": "The number of users", "format": "int64", "example": 234 } } }, "CatalogCatalog": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "guid": { "type": "string", "description": "GUID of the Catalog instance", "readOnly": true }, "url": { "type": "string", "description": "URL of the Catalog instance", "readOnly": true }, "creator_id": { "type": "string", "readOnly": true, "example": "ibmid-50h088ud1b" }, "create_time": { "type": "string", "description": "Created time", "readOnly": true }, "update_time": { "type": "string" }, "archive_info": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ARCHIVE_SCHEDULED", "ARCHIVE_FAILED", "ARCHIVED", "RESTORE_SCHEDULED", "RESTORE_FAILED" ] }, "archive_comment": { "type": "string" }, "archive_file_path": { "type": "string" }, "archive_schedule_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "archive_schedule_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "archive_stop_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "archive_stop_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "restore_schedule_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "restore_schedule_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "restore_stop_time": { "type": "string", "example": "2023-05-19T01:45:20.000Z" }, "restore_stop_time_ticks": { "type": "integer", "format": "int64", "example": 1684460720000 }, "failed_times": { "type": "integer", "description": "The times that the archive/restore process failed for the asset container. Note that a successful archive/restore will reset this field.", "format": "int64" }, "failure": { "$ref": "#/components/schemas/CatalogErrorContainerModel" } }, "description": "Information about archiving the catalog", "readOnly": true } }, "description": "Metadata of the Catalog instance", "readOnly": true }, "entity": { "required": [ "generator", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Catalog instance" }, "description": { "type": "string", "description": "Description of the Catalog instance" }, "generator": { "type": "string", "description": "Generator of the Catalog instance" }, "project_id": { "type": "string", "description": "Project id" }, "space_id": { "type": "string", "description": "Space id" }, "bss_account_id": { "type": "string", "description": "Account ID" }, "capacity_limit": { "type": "integer", "description": "Capacity Limit", "format": "int64" }, "is_governed": { "type": "boolean", "description": "Indicates if the assets in the Catalog are governed. if not specified, it defaults to false. For private catalogs, 'false' should be always passed, because private catalogs can not be governed." }, "auto_profiling": { "type": "boolean", "description": "Indicates if the assets in the Catalog are allowed for profiling. if not specified" }, "saml_instance_name": { "type": "string", "description": "SAML instance type" }, "uid": { "type": "string", "description": "UID" }, "subtype": { "type": "string" }, "configurations": { "$ref": "#/components/schemas/CatalogAssetContainerConfiguration" } }, "description": "Entity of the Catalog instance" }, "href": { "type": "string", "description": "URL of the Catalog instance", "readOnly": true } } }, "CatalogCatalogEntityWithBucket": { "required": [ "generator", "name" ], "type": "object", "properties": { "bucket": { "$ref": "#/components/schemas/CatalogCatalogBucket" } }, "description": "Schema for catalogEntity with bucket details", "allOf": [ { "$ref": "#/components/schemas/CatalogCatalogEntity" } ] }, "CatalogCatalogSet": { "type": "object", "properties": { "catalogs": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogCatalog" } }, "nextBookmark": { "type": "string", "readOnly": true }, "nextSkip": { "type": "integer", "readOnly": true }, "totalCount": { "type": "integer", "readOnly": true } } }, "CatalogCatalogEntity": { "required": [ "generator", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Catalog instance" }, "description": { "type": "string", "description": "Description of the Catalog instance" }, "generator": { "type": "string", "description": "Generator of the Catalog instance" }, "project_id": { "type": "string", "description": "Project id" }, "space_id": { "type": "string", "description": "Space id" }, "bss_account_id": { "type": "string", "description": "Account ID" }, "capacity_limit": { "type": "integer", "description": "Capacity Limit", "format": "int64" }, "is_governed": { "type": "boolean", "description": "Indicates if the assets in the Catalog are governed. if not specified, it defaults to false. For private catalogs, 'false' should be always passed, because private catalogs can not be governed." }, "auto_profiling": { "type": "boolean", "description": "Indicates if the assets in the Catalog are allowed for profiling. if not specified" }, "saml_instance_name": { "type": "string", "description": "SAML instance type" }, "uid": { "type": "string", "description": "UID" }, "subtype": { "type": "string" }, "configurations": { "$ref": "#/components/schemas/CatalogAssetContainerConfiguration" } } }, "CatalogCatalogBucket": { "required": [ "bucket_name" ], "type": "object", "properties": { "bucket_name": { "type": "string", "description": "Bucket Name" }, "bucket_location": { "type": "string" }, "endpoint_url": { "type": "string" }, "role_arn": { "type": "string", "description": "The ARN of the AWS role for accessing S3 bucket. Only applicable to buckets of type aws_s3 and is mandatory in which case." }, "shared": { "type": "boolean", "description": "Indicate if the bucket is shared by more than one asset containers. Only applicable to buckets of type aws_s3. Default to false." }, "resource_instance_id": { "type": "string", "description": "Bluemix COS Resource Instance ID " }, "credentials_rw": { "$ref": "#/components/schemas/CatalogCredentials" }, "bluemix_cos_credentials": { "type": "object", "properties": { "viewer": { "type": "object", "properties": { "api_key": { "type": "string", "description": "Api key" }, "service_id": { "type": "string", "description": "Service ID" }, "access_key_id": { "type": "string", "description": "HMAC access key id for associated cloud object storage and specific user role" }, "secret_access_key": { "type": "string", "description": " HMAC secret access key for associated cloud object storage and specific user role" } }, "description": "Bluemix COS Viewer Credentials " }, "editor": { "type": "object", "properties": { "api_key": { "type": "string", "description": "Api key" }, "service_id": { "type": "string", "description": "Service ID" }, "access_key_id": { "type": "string", "description": "HMAC access key id for associated cloud object storage and specific user role" }, "secret_access_key": { "type": "string", "description": " HMAC secret access key for associated cloud object storage and specific user role" } }, "description": "Bluemix COS Editor Credentials " }, "admin": { "type": "object", "properties": { "api_key": { "type": "string", "description": "Api key" }, "service_id": { "type": "string", "description": "Service ID" }, "access_key_id": { "type": "string", "description": "HMAC access key id for associated cloud object storage and specific user role" }, "secret_access_key": { "type": "string", "description": " HMAC secret access key for associated cloud object storage and specific user role" } }, "description": "Bluemix COS Admin Credentials " } }, "description": "Bluemix COS Credentials" }, "location_definition": { "type": "object", "properties": { "physical_location_code": { "type": "string", "description": "physical_location_code" }, "physical_location_code_assigned_by": { "type": "string" }, "physical_location_code_rds_id": { "type": "string" }, "physical_location_code_rds_version": { "type": "string" }, "physical_location_code_assignment_method": { "type": "string", "enum": [ "MANUAL", "INFERRED" ] }, "sovereign_location_code_assigned_by": { "type": "string" }, "sovereign_location_code_rds_id": { "type": "string" }, "sovereign_location_code_rds_version": { "type": "string" }, "physical_location_code_added_on": { "type": "string" }, "sovereign_location_code_added_on": { "type": "string" }, "sovereign_location_code_assignment_method": { "type": "string", "enum": [ "MANUAL", "INFERRED" ] }, "sovereign_location_code": { "type": "string", "description": "sovereign_location_code" } }, "description": "location_definition" } } }, "CatalogCredentials": { "required": [ "access_key_id", "secret_access_key" ], "type": "object", "properties": { "access_key_id": { "type": "string", "description": "Access key" }, "secret_access_key": { "type": "string", "description": "Secret key" } }, "description": "Bucket Credentials" }, "CatalogCreateDefaultCatalogResponse": { "type": "object", "properties": { "catalog": { "$ref": "#/components/schemas/CatalogCatalog" } }, "description": "Response from creating the default catalog" }, "CatalogCreateDefaultCatalogRequest": { "type": "object", "properties": { "catalog": { "$ref": "#/components/schemas/CatalogCatalogEntityWithBucket" } }, "description": "Request for creating the default catalog" }, "CatalogResponse": { "type": "object", "properties": { "status": { "type": "integer" }, "statusInfo": { "$ref": "#/components/schemas/CatalogStatusType" }, "entity": { "type": "object" }, "mediaType": { "$ref": "#/components/schemas/CatalogMediaType" }, "language": { "$ref": "#/components/schemas/CatalogLocale" }, "length": { "type": "integer" }, "allowedMethods": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "cookies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CatalogNewCookie" } }, "entityTag": { "$ref": "#/components/schemas/CatalogEntityTag" }, "date": { "type": "string", "format": "date-time" }, "lastModified": { "type": "string", "format": "date-time" }, "location": { "type": "string", "format": "uri" }, "links": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/CatalogLink" } }, "metadata": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "headers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "stringHeaders": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "CatalogEntityTag": { "type": "object", "properties": { "value": { "type": "string" }, "weak": { "type": "boolean" } } }, "CatalogNewCookie": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "version": { "type": "integer" }, "path": { "type": "string" }, "domain": { "type": "string" }, "comment": { "type": "string" }, "maxAge": { "type": "integer" }, "expiry": { "type": "string", "format": "date-time" }, "secure": { "type": "boolean" }, "httpOnly": { "type": "boolean" } } }, "CatalogLocale": { "type": "object", "properties": { "language": { "type": "string" }, "script": { "type": "string" }, "country": { "type": "string" }, "variant": { "type": "string" }, "extensionKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleAttributes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "iso3Language": { "type": "string" }, "iso3Country": { "type": "string" }, "displayLanguage": { "type": "string" }, "displayScript": { "type": "string" }, "displayCountry": { "type": "string" }, "displayVariant": { "type": "string" }, "displayName": { "type": "string" } } }, "CatalogMediaType": { "type": "object", "properties": { "type": { "type": "string" }, "subtype": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "wildcardType": { "type": "boolean" }, "wildcardSubtype": { "type": "boolean" } } }, "CatalogStatusType": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "family": { "type": "string", "enum": [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "reasonPhrase": { "type": "string" } } }, "CatalogTemporaryCredentials": { "required": [ "access_key_id", "expires_at", "secret_access_key", "session_token" ], "type": "object", "properties": { "access_key_id": { "type": "string", "description": "AWS access key, used to identify the user interacting with AWS" }, "secret_access_key": { "type": "string", "description": "AWS secret access key, used to authenticate the user interacting with AWS" }, "session_token": { "type": "string", "description": "AWS session token. This token is retrieved from an AWS token service, and is used for authenticating that this user has received temporary permission to access some resource." }, "session_policy": { "type": "string", "description": "Session policy applied on the role session created for the temporary credentials. The field is only available in development environment and not in production environment for performance reason." }, "expires_at": { "type": "integer", "description": "The epoch timestamp when the credentials will expire.", "format": "int64" } } }, "CatalogTemporaryCredentialsRequest": { "required": [ "bucket_name", "catalog_id", "external_id", "min_duration_seconds", "role_arn", "shared" ], "type": "object", "properties": { "catalog_id": { "type": "string", "description": "Catalog id" }, "role_arn": { "type": "string", "description": "ARN of the AWS integration role" }, "external_id": { "type": "string", "description": "External id for AWS integration" }, "bucket_name": { "type": "string", "description": "Name of the bucket" }, "shared": { "type": "boolean", "description": "Indicate if the bucket is shared by multiple asset containers" }, "min_duration_seconds": { "type": "integer", "description": "Minimum duration (in seconds) that the credentials should be valid for. The value cannot be greater than 3600 seconds. If not supplied, cached credentials that have the same requested permission can be returned." } } }, "CatalogCatalogCollectionResponse": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogCollectionMetadata" }, "collection_id": { "type": "string" }, "name": { "type": "string" }, "application_label": { "type": "string" }, "created_at": { "type": "string" }, "last_updated_at": { "type": "string" }, "Scope": { "type": "string", "readOnly": true, "enum": [ "USER", "CATALOG" ] }, "assets": { "type": "array", "items": { "type": "string" } }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "assets_metadata": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogCollectionAsset" } } }, "description": "Catalog Collection Response Model" }, "CatalogCollection": { "type": "object", "properties": { "name": { "type": "string" }, "application_label": { "type": "string" }, "assets": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } } }, "description": "Collection Model" }, "CatalogCollectionAsset": { "type": "object", "properties": { "asset_id": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/CatalogAssetMetadata" } } }, "CatalogCollectionMetadata": { "type": "object", "properties": { "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "space_id": { "type": "string" } } }, "CatalogMemberSetPartialResult": { "required": [ "members" ], "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogMember" } }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogMemberError" } }, "trace": { "type": "string" } }, "description": "MemberSet with partial success result" }, "CatalogMemberSearchResult": { "required": [ "members", "total_results" ], "type": "object", "properties": { "total_results": { "type": "integer", "format": "int64" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogMember" } }, "nextBookmark": { "type": "string" } } }, "CatalogMemberError": { "required": [ "access_group_id", "user_iam_id" ], "type": "object", "properties": { "user_iam_id": { "type": "string", "description": "Identity and Access Management ID (IAM) of the member", "example": "IBMid-abcd1234" }, "access_group_id": { "type": "string", "description": "ID of the access group member", "example": "AccessGroupId-abcd1234" }, "reason": { "$ref": "#/components/schemas/ErrorModel" } }, "description": "Member Error" }, "CatalogBulkMembersDeleteResponse": { "required": [ "responses" ], "type": "object", "properties": { "responses": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/CatalogBulkMembersDeleteResponseEntry" } } } }, "CatalogBulkMembersDeleteResponseEntry": { "required": [ "http_status", "memberId" ], "type": "object", "properties": { "http_status": { "type": "integer", "description": "204 if no error, 404 if not found, etc.", "readOnly": true }, "memberId": { "type": "string", "readOnly": true }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ErrorModel" } } } }, "CatalogMemberRole": { "type": "object", "properties": { "role": { "type": "string" } } }, "CatalogCatalogStateResponse": { "type": "object", "properties": { "catalogId": { "type": "string" }, "state": { "type": "string", "enum": [ "predelete", "deleted", "active", "expiring", "expired", "suspended" ] } } }, "CatalogDataAsset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogAssetMetadata" }, "entity": { "type": "object", "example": { "data_asset": { "mime_type": "text/csv", "dataset": false } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAttachment" } } }, "description": "Data Asset Model" }, "CatalogFolderAsset": { "required": [ "entity" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/CatalogAssetMetadata" }, "entity": { "type": "object", "example": { "folder_asset": { "connection_id": "f1fea17c-a7e5-49e4-9f8e-23cef3e11ed5", "connection_path": "/bucket1/folder1/folder1.1" } }, "additionalProperties": { "type": "object" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogAttachment" } } }, "description": "Folder Asset Model" }, "CatalogGetTrashContentsResponse": { "type": "object" }, "CatalogTrashedAssetCountResponse": { "type": "object", "properties": { "trashed_assets_count": { "type": "integer", "description": "Count of trashed assets", "format": "int64", "example": 2 } }, "description": "Trashed Assets Count Response Model" }, "ConnectionsConnection": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/ConnectionsConnectionAssetSystemMetadata" }, "entity": { "$ref": "#/components/schemas/ConnectionsConnectionEntity" } }, "description": "A connection." }, "ConnectionsConnectionEntity": { "required": [ "datasource_type", "name" ], "type": "object", "properties": { "datasource_type": { "type": "string", "description": "The id or the name of the data source type to connect to. For example \"cfdcb449-1204-44ba-baa6-9a8a878e6aa7\" or \"db2\".", "x-cli-option-name": "datasource-type" }, "data_source_definition_asset_id": { "type": "string", "description": "The id of the data source definition asset related to connection. For example \"cfdcb449-1204-44ba-baa6-9a8a878e6aa7\".", "x-cli-option-name": "data_source_definition_asset_id" }, "data_source_definition_asset_name": { "type": "string", "description": "The name of the data source definition asset related to connection. For example \"Data privacy profile for DB2\".", "x-cli-option-name": "data_source_definition_asset_name" }, "data_source_definition_searchable": { "type": "string", "description": "The concatenation of values of conection properties identified as data source definition asset identity properties. For example \"host1.fyre.ibm.com|12212|BLUEDB\".", "x-cli-option-name": "data_source_definition_searchable" }, "derived_properties": { "$ref": "#/components/schemas/ConnectionsDerivedProperties" }, "description": { "type": "string", "description": "The description of the connection.", "x-cli-option-name": "description" }, "directory_asset": { "$ref": "#/components/schemas/ConnectionsDirectoryAsset" }, "name": { "type": "string", "description": "The name of the connection.", "x-cli-option-name": "name" }, "ref_catalog_id": { "type": "string", "description": "The ID of the catalog that this connection refers to for properties values.", "x-cli-option-name": "ref-catalog-id" }, "ref_asset_id": { "type": "string", "description": "The ID of the connection in reference catalog that this connection refers to for properties values.", "x-cli-option-name": "ref-asset-id" }, "gateway_id": { "type": "string", "description": "The id of the secure gateway to use with the connection. A Secure Gateway is needed when connecting to an on-premises data source. This is the id of the Secure Gateway created with the SecureGateway Service. Your Secure Gateway Client running on-premises must be connected to the gateway with this Id. For example, \"E9oXGRIhv1e_prod_ng\".", "x-cli-option-name": "gateway-id" }, "flags": { "type": "array", "description": "Specifies how a connection is to be treated internally.", "items": { "type": "string", "enum": [ "restricted", "internal_use_only", "personal_credentials", "parameterized" ] }, "x-cli-option-name": "flags" }, "origin_country": { "type": "string", "description": "Country which data originated from. - ISO 3166 Country Codes.", "x-cli-option-name": "origin-country" }, "owner_id": { "type": "string", "description": "Owner or creator of connection. Provided when a service ID token is used to create connection.", "x-cli-option-name": "owner-id" }, "rov": { "$ref": "#/components/schemas/ConnectionsConnectionRov" }, "properties": { "$ref": "#/components/schemas/ConnectionsConnectionProperties" }, "interaction_properties": { "$ref": "#/components/schemas/ConnectionsConnectionInteractionProperties" }, "source_system": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" }, "source_system_history": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" }, "x-cli-option-name": "source-system-history" }, "asset_category": { "type": "string", "description": "The asset category", "enum": [ "user", "system" ], "x-cli-option-name": "asset-category" }, "child_source_systems": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" }, "x-cli-option-name": "child-source-systems" }, "tags": { "type": "array", "items": { "type": "string" }, "x-cli-option-name": "tags" }, "location_definition": { "$ref": "#/components/schemas/ConnectionsLocationDefinition" } }, "description": "The connection definition." }, "ConnectionsConnectionCollection": { "type": "object", "properties": { "resources": { "type": "array", "description": "List of connections", "items": { "$ref": "#/components/schemas/ConnectionsConnection" } }, "first": { "$ref": "#/components/schemas/HrefModel" }, "prev": { "$ref": "#/components/schemas/HrefModel" }, "next": { "$ref": "#/components/schemas/HrefModel" }, "last": { "$ref": "#/components/schemas/HrefModel" }, "offset": { "type": "integer", "description": "The number of assets skipped before this page." }, "total_count": { "type": "integer", "description": "The total number of assets available." } }, "description": "A page from a collection of connections." }, "ConnectionsConnectionAssetSystemMetadata": { "type": "object", "properties": { "asset_id": { "type": "string", "description": "The ID of the asset" }, "asset_type": { "type": "string", "description": "The type of the asset" }, "asset_category": { "type": "string", "description": "The asset category (\"USER\" or \"SYSTEM\")" }, "catalog_id": { "type": "string", "description": "The ID of the catalog which contains the asset. catalog_id, project_id or spaceid is required." }, "create_time": { "type": "string", "description": "The timestamp when the asset was created (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339)", "format": "date-time" }, "creator_id": { "type": "string", "description": "The IAM ID of the user that created the asset" }, "href": { "type": "string", "description": "URL that can be used to get the asset." }, "owner_id": { "type": "string", "description": "The IAM ID of the user that owns the asset" }, "project_id": { "type": "string", "description": "The ID of the project which contains the asset. catalog_id, project_id or spaceid is required." }, "space_id": { "type": "string", "description": "The ID of the space which contains the asset. catalog_id, project_id or spaceid is required." }, "resource_key": { "type": "string", "description": "Optional external unique key for assets that supports it" }, "source_system": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" }, "source_system_history": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" } }, "child_source_systems": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" } }, "tags": { "type": "array", "items": { "type": "string" } }, "usage": { "required": [ "last_modification_time", "last_modifier_id", "last_access_time", "last_accessor_id", "access_count" ], "type": "object", "properties": { "last_modification_time": { "type": "string", "description": "The timestamp when the asset was last modified (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339)", "format": "date-time" }, "last_modifier_id": { "type": "string", "description": "The IAM ID of the user that last modified the asset" }, "last_access_time": { "type": "string", "description": "The timestamp when the asset was last accessed (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339)", "format": "date-time" }, "last_accessor_id": { "type": "string", "description": "The IAM ID of the user that last accessed the asset" }, "access_count": { "type": "integer", "description": "Number of times this asset has been accessed" } }, "description": "Metadata usage information about an asset" } }, "description": "System metadata about an asset" }, "ConnectionsLocationDefinition": { "type": "object", "properties": { "physical_location_code": { "type": "string", "description": "The code of the physical location." }, "sovereign_location_code": { "type": "string", "description": "The code of the sovereign location." } }, "description": "Indicates the location used by this connection." }, "ConnectionsCommonCustomObject": { "type": "object", "description": "Custom data to be associated with a given object", "additionalProperties": { "type": "object" } }, "ConnectionsConnectionInteractionProperties": { "type": "object", "properties": { "source": { "type": "array", "description": "The properties that can be set for a source interaction.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } }, "target": { "type": "array", "description": "The properties that can be set for a target interaction.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } } }, "description": "Interaction properties allowed for a connection.", "x-cli-option-name": "interaction-properties" }, "ConnectionsConnectionProperties": { "type": "object", "description": "Connection properties.", "additionalProperties": { "type": "object", "properties": {} }, "x-cli-option-name": "properties" }, "ConnectionsConnectionRov": { "type": "object", "properties": { "mode": { "type": "integer", "description": "The Rules of Visibility mode. Value can be:\n\n| mode | description|\n| 0 | Connection is searchable and viewable by everyone with access to the catalog or project associated with this connection |\n| 8 | Connection is searchable by everyone and cannot be viewed unless the user has proper view permissions |\n| 16 | Connection is searchable by users with proper view permissions |\n" }, "member_roles": { "type": "object", "description": "Contains map of key as user_iam_id and value as member_roles", "additionalProperties": { "type": "object", "properties": { "user_iam_id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "EDITOR", "OWNER", "VIEWER" ] } } }, "description": "Member roles and id" } } }, "description": "Rules of visibility for connections.", "x-cli-option-name": "rov" }, "ConnectionsDirectoryAsset": { "type": "object", "properties": { "path": { "type": "string", "description": "Folder ID that the connection asset lives in." } }, "description": "Folder that the connection asset lives in." }, "ConnectionsDerivedProperties": { "type": "object", "properties": { "data_source_definition_id": { "maxLength": 36, "minLength": 36, "pattern": "([a-z0-9]{8})-([a-z0-9]{4})-([a-z0-9]{4})-([a-z0-9]{4})-([a-z0-9]{12})", "type": "string", "description": "Id of an assigned Data Source Definition Asset" }, "data_source_identity_properties": { "$ref": "#/components/schemas/ConnectionsIdentityProperties" }, "data_source_identity_mapping": { "type": "object", "description": "Mapping of connection properties to CAMS query parameters.", "additionalProperties": { "type": "object", "properties": {} }, "x-cli-option-name": "identity-mapping" } }, "description": "Properties that are not stored and obtained from CAMS, but calculated/derived on-the-fly by reading operation" }, "ConnectionsDatasourceTypeProperty": { "type": "object", "properties": { "name": { "type": "string", "description": "The property name." }, "type": { "type": "string", "description": "The type of the property.", "enum": [ "boolean", "enum", "integer", "string" ] }, "label": { "type": "string", "description": "The label for the property." }, "description": { "type": "string", "description": "The description for the property." }, "placeholder": { "type": "string", "description": "An example value for the property." }, "descriptionHasLink": { "type": "boolean", "description": "Whether property description contains link." }, "required": { "type": "boolean", "description": "Whether the property is required." }, "masked": { "type": "boolean", "description": "Whether the property should be masked. For example, when the property is a password." }, "hidden": { "type": "boolean", "description": "Whether the property should be displayed in a user interface." }, "readonly": { "type": "boolean", "description": "Whether the property is a read-only value." }, "uiOnly": { "type": "boolean", "description": "Whether the property is a UI-only value." }, "multiline": { "type": "boolean", "description": "Whether the property should be displayed in a multi-line field." }, "multichoice": { "type": "boolean", "description": "Whether the property should be displayed in a multi-choice field. WARNING - not yet implemented" }, "default_value": { "type": "string", "description": "The default value for the property if the value is not otherwise specified." }, "default_from_env": { "type": "string", "description": "The environment variable assigned to a property." }, "default_value_conditions": { "type": "array", "description": "Conditional default values.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexValueCondition" } }, "values": { "type": "array", "description": "If the property type is enum, the list of enumerated values that the property can take.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyValues" } }, "tags": { "type": "array", "description": "Tags associated with a property.", "items": { "type": "string" } }, "group": { "type": "string", "description": "A classification group for the property." }, "displayGroup": { "type": "string", "description": "Display group to which the property belongs. Affects the common properties UI." }, "displayOrdinal": { "type": "integer", "description": "Determines the order within a display group." }, "supported_environments": { "type": "array", "description": "The list of environments where this property may be used.", "items": { "type": "string" } }, "supported_products": { "type": "array", "description": "The list of products for which this property may be used.", "items": { "type": "string" } }, "user_defined": { "type": "boolean", "description": "Whether the property is to be defined by the user creating a custom datasource type." }, "aliases": { "type": "array", "description": "List of alias names for this property.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyAlias" } } }, "description": "Definition of a data source property." }, "ConnectionsIdentityProperties": { "maxItems": 20, "minItems": 0, "type": "array", "description": "Identity properties that consititute id of the assigned datasource_type.", "items": { "$ref": "#/components/schemas/ConnectionsIdentityNameValue" }, "x-cli-option-name": "identity_properties" }, "ConnectionsDatasourceTypePropertyAlias": { "type": "object", "properties": { "name": { "type": "string", "description": "The alias name." }, "supported_products": { "type": "array", "description": "The list of products for which this alias may be used.", "items": { "type": "string" } } }, "description": "An alias name for a property." }, "ConnectionsDatasourceTypePropertyValues": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the property that should be set if this enumeration is chosen." }, "label": { "type": "string", "description": "A localized string that is the displayable value for the enumeration. A user interface should display this string rather than the value." }, "supported_environments": { "type": "array", "description": "The list of environments where this value may be used.", "items": { "type": "string" } }, "supported_products": { "type": "array", "description": "The list of products for which this value may be used.", "items": { "type": "string" } } }, "description": "Valid value for an enumerated data source property." }, "ConnectionsDatasourceTypeComplexValueCondition": { "type": "object", "properties": { "value": { "type": "string", "description": "The value to be enabled based on these conditions." }, "evaluate": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexCondition" } }, "description": "Definition of a value enablement condition." }, "ConnectionsIdentityNameValue": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "pattern": "\\S+", "type": "string", "description": "Name of the identity property" }, "value": { "maxLength": 200, "minLength": 1, "pattern": "\\S+", "type": "string", "description": "Value of the identity property" } }, "description": "Pair of property name and value" }, "ConnectionsDatasourceTypeComplexCondition": { "type": "object", "properties": { "property_name": { "type": "string", "description": "the name of the property used by this condition." }, "condition": { "type": "string", "description": "the condition to validate between owning property and this property.", "enum": [ "contains", "endswith", "equals", "in", "matches", "not_contains", "not_endswith", "not_equals", "not_in", "not_matches", "not_set", "not_startswith", "set", "startswith" ] }, "values": { "type": "array", "description": "the values to use in checking the condition.", "items": { "type": "string" } }, "uiOnly": { "type": "boolean", "description": "Whether this condition applies only to generated common properties UI." }, "or": { "type": "array", "description": "disjunction of conditions. If populated the rest of the properties are null.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexCondition" } }, "and": { "type": "array", "description": "conjunction of conditions. If populated the rest of the properties are null.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexCondition" } } }, "description": "A condition to be applied to a property. Can be a specific condition, a conjunction(AND) or a disjunction(OR)." }, "ConnectionsConnectionUpgradeResponse": { "type": "object", "description": "Result of connection upgrade request.", "additionalProperties": { "type": "object", "properties": {} } }, "ConnectionsDiscoveredAssetCollection": { "type": "object", "properties": { "description": { "type": "string", "description": "A page from a collection of discovered assets." }, "path": { "type": "string", "description": "The path of the asset." }, "id": { "type": "string", "description": "An ID for the asset." }, "properties": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetsProperties" }, "asset_types": { "type": "array", "description": "Discovered types", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetType" } }, "assets": { "type": "array", "description": "Discovered assets", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveredAsset" } }, "fields": { "type": "array", "description": "Discovered fields", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetField" } }, "datasource_type": { "$ref": "#/components/schemas/ConnectionsDatasourceType" }, "connection_properties": { "$ref": "#/components/schemas/ConnectionsConnectionProperties" }, "interaction_properties": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetInteractionProperties" }, "extended_metadata": { "type": "array", "description": "Extended metadata properties", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetExtendedMetadataProperty" } }, "data": { "type": "object", "properties": {}, "description": "The data returned when the fetch parameter contains the value \"data\"." }, "details": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetDetails" }, "first": { "$ref": "#/components/schemas/HrefModel" }, "prev": { "$ref": "#/components/schemas/HrefModel" }, "next": { "$ref": "#/components/schemas/HrefModel" }, "last": { "$ref": "#/components/schemas/HrefModel" }, "offset": { "type": "integer", "description": "The number of assets skipped before this page." }, "total_count": { "type": "integer", "description": "The total number of assets available." }, "logs": { "type": "array", "description": "Log events created during the discovery of the assets.", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveryLog" } } }, "description": "A page from a collection of discovered assets." }, "ConnectionsDiscoveryLog": { "type": "object", "properties": { "severity": { "type": "string", "description": "The severity of the log item.", "enum": [ "error", "warning", "info" ] }, "message": { "type": "string", "description": "The description of the log item event." }, "details": { "$ref": "#/components/schemas/ConnectionsDiscoveryLogDetails" } }, "description": "A log item for an event during the discovery of an asset." }, "ConnectionsDiscoveredAssetDetails": { "type": "object", "description": "Details about a discovered asset.", "additionalProperties": { "type": "object", "properties": {} } }, "ConnectionsDiscoveredAssetExtendedMetadataProperty": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of additional metadata" }, "value": { "type": "object", "properties": {}, "description": "Additional metadata content" } }, "description": "Additional metadata found for an asset." }, "ConnectionsDiscoveredAssetInteractionProperties": { "type": "object", "description": "The interaction properties needed to find the asset.", "additionalProperties": { "type": "object", "properties": {} } }, "ConnectionsDatasourceType": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/ConnectionsConnectionAssetSystemMetadata" }, "entity": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeEntity" } }, "description": "The definition of a data source type." }, "ConnectionsDiscoveredAssetField": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of this field." }, "description": { "type": "string", "description": "A description of this field." }, "type": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetFieldType" } }, "description": "The metadata for a field of a discovered asset." }, "ConnectionsDiscoveredAsset": { "type": "object", "properties": { "id": { "type": "string", "description": "An ID for the asset." }, "type": { "type": "string", "description": "The type of the asset, such as SCHEMA, TABLE, FILE, or FOLDER." }, "name": { "type": "string", "description": "A name for the asset." }, "description": { "type": "string", "description": "A description of the asset." }, "tags": { "type": "array", "description": "Tags associated with the asset.", "items": { "type": "string" } }, "path": { "type": "string", "description": "The path for the object which can be used to discover child assets." }, "has_children": { "type": "boolean", "description": "True if it is known that the asset has children. False if it is known that the asset does not have children. If it is not known, or it is too expensive to determine this, then this property will not be returned." }, "details": { "$ref": "#/components/schemas/ConnectionsDiscoveredAssetDetails" } }, "description": "A discovered asset." }, "ConnectionsDiscoveredAssetType": { "type": "object", "properties": { "type": { "type": "string", "description": "The name of the asset type." }, "dataset": { "type": "boolean", "description": "Whether the asset can be a source of data or whether it can be written to. To illustrate by example, a database table is a data set, but a schema is not. Likewise, a file is a data set, but a folder/directory is not." }, "dataset_container": { "type": "boolean", "description": "Whether an asset can be created in this asset. To illustrate by example, a schema is a data set container, as is a folder/directory." } }, "description": "An asset type definition." }, "ConnectionsDiscoveredAssetsProperties": { "type": "object", "description": "Properties defining the returned assets.", "additionalProperties": { "type": "object", "properties": {} } }, "ConnectionsDiscoveryLogDetails": { "type": "object", "description": "Additional details for the log item captured during the discovery of an asset.", "additionalProperties": { "type": "object", "properties": {} } }, "ConnectionsDatasourceTypeEntity": { "type": "object", "properties": { "name": { "type": "string", "description": "A unique name, such as \"dashdb\"." }, "label": { "type": "string", "description": "A localized, displayable label such as, \"IBM dashDB\"." }, "description": { "type": "string", "description": "A localized, displayable description of the data source." }, "type": { "type": "string", "description": "The type of the data source.", "enum": [ "database", "file", "generic" ] }, "allowed_as_source": { "type": "boolean", "description": "Whether the data source can be accessed as a source of data. That is, data can be read from the data source." }, "allowed_as_target": { "type": "boolean", "description": "Whether the data source can be accessed as a target. That is, data can be written to the data source." }, "allowed_for_discovery_only": { "type": "boolean", "description": "Whether the data source can be used only for asset discovery." }, "allowed_as_source_lookup": { "type": "boolean", "description": "Whether the data source can be accessed as a source with a data exchange (lookup)." }, "data_shape": { "type": "string", "description": "The shape of the data.", "enum": [ "rectangular", "structured", "unstructured" ] }, "data_source_definition_status": { "type": "string", "description": "The status of the data source support of Data Source Definition Asset feature.", "enum": [ "active", "inactive", "pending" ] }, "auto_discovery": { "type": "boolean", "description": "Whether the data source supports metadata discovery." }, "discovery": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeDiscovery" }, "secure_gateway": { "type": "string", "description": "Whether a gateway_id is optional, required, or not_applicable.", "enum": [ "optional", "required", "not_applicable" ] }, "properties": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperties" }, "common_properties": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeCommonProperties" }, "tags": { "type": "array", "description": "Tags associated with a data source type.", "items": { "type": "string" } }, "actions": { "type": "array", "description": "The actions supported for the data source.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeAction" } }, "supported_environments": { "type": "array", "description": "The list of environments where this data source type may be used.", "items": { "type": "string" } }, "supported_plans": { "type": "array", "description": "The list of plans for which this data source is supported.", "items": { "type": "string" } }, "supported_products": { "type": "array", "description": "The list of products for which this data source is supported.", "items": { "type": "string" } }, "status": { "type": "string", "description": "The status of the data source.", "enum": [ "active", "deprecated", "inactive", "internal", "pending", "system" ] }, "origin_country": { "type": "string", "description": "Country which data originated from. - ISO 3166 Country Codes." }, "owner_id": { "type": "string", "description": "Owner or creator of connection. Provided when a service ID token is used to create connection." }, "rov": { "$ref": "#/components/schemas/ConnectionsConnectionRov" }, "source_system": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" }, "source_system_history": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" } }, "child_source_systems": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" } }, "extensible": { "type": "boolean", "description": "Whether this datasource type can be used as a base for a user defined datasource type." }, "base_datasource_type": { "type": "string", "description": "The id of the base datasource type if this is a user defined datasource type." }, "data_source_definition_id": { "maxLength": 50, "minLength": 2, "pattern": "^[a-zA-Z0-9 ]+$", "type": "string", "description": "The id of the datasource type that is used as a connection engine, for example \"db2\"." }, "data_source_identity_properties": { "maxItems": 10, "minItems": 0, "type": "array", "description": "The properties that build objects unique id.", "items": { "type": "string" } }, "data_source_identity_mapping": { "type": "object", "description": "Mapping of connection properties to CAMS query parameters.", "additionalProperties": { "type": "object", "properties": {} } }, "flight_info": { "$ref": "#/components/schemas/ConnectionsCustomFlightServiceInfo" } }, "description": "The definition of a data source type." }, "ConnectionsDiscoveredAssetFieldType": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the field." }, "length": { "type": "integer", "description": "The precision (or length) of the field." }, "scale": { "type": "integer", "description": "The scale of the field if the type is decimal." }, "nullable": { "type": "boolean", "description": "Whether the field accepts null values." }, "signed": { "type": "boolean", "description": "Whether an integer field holds signed or unsigned values." }, "native_type": { "type": "string", "description": "The name that the data source uses to describe the type." } }, "description": "The type description of a discovered asset field." }, "ConnectionsCustomFlightServiceInfo": { "type": "object", "properties": { "flight_uri": { "type": "string", "description": "The URI of the Arrow Flight service." }, "ssl_certificate": { "type": "string", "description": "The SSL certificate of the Flight service." }, "ssl_certificate_validation": { "type": "boolean", "description": "Validate that the SSL certificate returned by the Flight service is trusted." } }, "description": "Information needed to connect to a custom Arrow Flight service." }, "ConnectionsDatasourceTypeAction": { "type": "object", "properties": { "name": { "type": "string", "description": "The action name." }, "description": { "type": "string", "description": "A description of the action." }, "properties": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeActionProperties" } }, "description": "The definition of a data source type action." }, "ConnectionsDatasourceTypeCommonProperties": { "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesParameterDefs" }, "source": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesParameterDefs" }, "target": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesParameterDefs" }, "filter": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesParameterDefs" } }, "description": "Definitions of the properties, in the Common Properties format, that are supported for the data source." }, "ConnectionsDatasourceTypeProperties": { "type": "object", "properties": { "connection": { "type": "array", "description": "The connection properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } }, "source": { "type": "array", "description": "The properties that can be set for a source interaction.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } }, "target": { "type": "array", "description": "The properties that can be set for a target interaction.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } }, "filter": { "type": "array", "description": "The filter properties that can be set for a discovery interaction.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } }, "conditions": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyConditions" }, "complexConditions": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexPropertyConditions" }, "displayGroups": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeDisplayGroups" } }, "description": "Definitions of the properties that are supported for the data source." }, "ConnectionsDatasourceTypeDiscovery": { "type": "object", "properties": { "top_level_filters": { "type": "array", "description": "Top level filters", "items": { "type": "string" } }, "asset_types": { "type": "array", "description": "Asset types", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveryAssetType" } }, "path_properties": { "type": "array", "description": "Path properties", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveryPathProperty" } } }, "description": "The definition of the discovery features of the data source type." }, "ConnectionsDatasourceTypeActionProperties": { "type": "object", "properties": { "input": { "type": "array", "description": "The input properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } }, "output": { "type": "array", "description": "The properties of the action result.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeProperty" } } }, "description": "Definitions of the properties that are supported for a data source type action." }, "ConnectionsCommonPropertiesParameterDefs": { "type": "object", "properties": { "titleDefinition": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesTitleDefinition" }, "current_parameters": { "type": "object", "properties": {}, "description": "Current parameter set upon input. Keys are parameter names, values are their values." }, "parameters": { "type": "array", "description": "List of parameters", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesParameterDefinition" } }, "uihints": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesUIHints" }, "conditions": { "type": "array", "description": "List of conditions that enable or make properties visible", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesConditionDefinition" } }, "resources": { "type": "object", "description": "Map of string resources.", "additionalProperties": { "type": "string" } } }, "description": "Watson Data Platform Property Definition Schema for the Common Properties editor" }, "ConnectionsDatasourceTypeDisplayGroups": { "type": "object", "properties": { "connection": { "type": "array", "description": "Display groups for connection properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeDisplayGroup" } }, "source": { "type": "array", "description": "Display groups for source properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeDisplayGroup" } }, "target": { "type": "array", "description": "Display groups for target properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeDisplayGroup" } }, "filter": { "type": "array", "description": "Display groups for filter properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeDisplayGroup" } } }, "description": "Groups that couple together properties in common properties UI" }, "ConnectionsDatasourceTypeComplexPropertyConditions": { "type": "object", "properties": { "connection": { "type": "array", "description": "Complex conditions related to connection properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexPropertyCondition" } }, "source": { "type": "array", "description": "Complex conditions related to source properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexPropertyCondition" } }, "target": { "type": "array", "description": "Complex conditions related to target properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexPropertyCondition" } }, "filter": { "type": "array", "description": "Complex conditions related to filter properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexPropertyCondition" } } }, "description": "Conditions to be used to validate properties." }, "ConnectionsDatasourceTypePropertyConditions": { "type": "object", "properties": { "connection": { "type": "array", "description": "Conditions related to connection properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyCondition" } }, "source": { "type": "array", "description": "Conditions related to source properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyCondition" } }, "target": { "type": "array", "description": "Conditions related to target properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyCondition" } }, "filter": { "type": "array", "description": "Conditions related to filter properties.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyCondition" } } }, "description": "Conditions to be used to validate properties. Deprecated - use DatasourceTypeComplexPropertyConditions under complexConditions key of DatasourceTypeProperties instead." }, "ConnectionsDiscoveryPathProperty": { "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the path property." }, "segments": { "type": "array", "description": "The segments of the path property.", "items": { "$ref": "#/components/schemas/ConnectionsDiscoveryPathSegment" } } }, "description": "The definition of a Discovery path property." }, "ConnectionsDiscoveryAssetType": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the asset type." }, "label": { "type": "string", "description": "The label of the asset type." }, "next_level_filters": { "type": "array", "description": "The filters which can be used to discover the next level of assets.", "items": { "type": "string" } } }, "description": "The definition of a Discovery asset type." }, "ConnectionsCommonPropertiesConditionDefinition": { "type": "object", "properties": { "visible": { "required": [ "evaluate", "parameter_refs" ], "type": "object", "properties": { "evaluate": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesEvaluateDefinition" }, "parameter_refs": { "minItems": 1, "uniqueItems": true, "type": "array", "description": "Array of parameter names affected by this operation", "items": { "type": "string" } }, "group_refs": { "uniqueItems": true, "type": "array", "description": "Array of group names affected by this operation", "items": { "type": "string" } }, "values": { "minItems": 1, "uniqueItems": true, "type": "array", "description": "Optional array of enumeration item names to operate upon", "items": { "type": "string" } } }, "description": "Visibility test. Hides controls if evaluate is false." }, "enabled": { "required": [ "evaluate", "parameter_refs" ], "type": "object", "properties": { "evaluate": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesEvaluateDefinition" }, "parameter_refs": { "minItems": 1, "uniqueItems": true, "type": "array", "description": "Array of parameter names affected by this operation", "items": { "type": "string" } }, "group_refs": { "uniqueItems": true, "type": "array", "description": "Array of group names affected by this operation", "items": { "type": "string" } }, "values": { "minItems": 1, "uniqueItems": true, "type": "array", "description": "Optional array of enumeration item names to operate upon", "items": { "type": "string" } } }, "description": "Enablement test. Disables controls if evaluate is false." }, "enum_filter": { "type": "object", "properties": { "target": { "type": "object", "properties": { "parameter_ref": { "type": "string", "description": "The enumeration parameter affected by this operation" }, "values": { "minItems": 1, "uniqueItems": true, "type": "array", "description": "Array of available enumeration options when the condition evaluates to 'true'", "items": { "type": "string" } } }, "description": "The target parameter information" }, "evaluate": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesEvaluateDefinition" } }, "description": "Allows filtering of available enumeration options" }, "default_value": { "type": "object", "properties": { "parameter_ref": { "type": "string", "description": "Parameter of which the default value is to be set" }, "value": { "type": "object", "description": "The default value of parameter_ref if condition evaluates to true" }, "evaluate": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesEvaluateDefinition" } }, "description": "Allows providing default values conditionally. Only evaluated during initialization." } }, "description": "Definition of a condition. Only one of 'visible', 'enabled', 'enum_filter' and 'default_value' is set at the same time." }, "ConnectionsCommonPropertiesUIHints": { "required": [ "id" ], "type": "object", "properties": { "description": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesResourceDefinition" }, "id": { "type": "string", "description": "Operator identifier" }, "label": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesResourceDefinition" }, "parameter_info": { "type": "array", "description": "List of parameter definitions.", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesUIParameterDefinition" } }, "ui_parameters": { "type": "array", "description": "List of UI parameter definitions.", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesParameterDefinition" } }, "group_info": { "type": "array", "description": "List of group definitions.", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesGroupDefinition" } } }, "description": "WDP UI Hints schema" }, "ConnectionsCommonPropertiesParameterDefinition": { "type": "object", "properties": { "default": { "type": "object", "properties": {}, "description": "default value based on type of parameter" }, "enum": { "type": "array", "description": "List of valid values. Can be used instead of specifying type.", "items": { "type": "string" } }, "id": { "type": "string", "description": "A unique name for the parameter." }, "required": { "type": "boolean", "description": "Indication whether parameter is required or optional", "default": "false" }, "role": { "type": "string", "description": "Role of parameter", "enum": [ "column", "new_column", "expression" ] }, "type": { "type": "string", "description": "Field type. Can be a primitive type (string, integer, double, date, time, timestamp, or custom), an array, or map containing those types(note arrays and maps can contain complex_types)" } }, "description": "Operator parameters definition" }, "ConnectionsCommonPropertiesTitleDefinition": { "type": "object", "properties": { "title": { "type": "string", "description": "Title string" }, "editable": { "type": "boolean", "description": "True if the title can be edited. False if the title should be readonly." } }, "description": "Title definition" }, "ConnectionsDatasourceTypeDisplayGroup": { "type": "object", "properties": { "label": { "type": "string", "description": "Group label." }, "description": { "type": "string", "description": "Group description." }, "name": { "type": "string", "description": "Name that uniquely identifies a group." }, "displayOrdinal": { "type": "integer", "description": "Determines the order of groups." }, "gridType": { "type": "string", "description": "Determines the layout. Properties can be rendered in single column, in two columns, just in the left one or just in the right one.", "enum": [ "single", "double", "left", "right" ] }, "conditionEvaluate": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexCondition" } }, "description": "Couples properties and displays its label at the top of them in common properties UI." }, "ConnectionsDatasourceTypeComplexPropertyCondition": { "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property to be enabled based on these conditions." }, "evaluate": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeComplexCondition" } }, "description": "Definition of a property enablement condition." }, "ConnectionsDatasourceTypePropertyCondition": { "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property to be enabled based on these conditions." }, "conditions": { "type": "array", "description": "the conditions to apply to the property.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeCondition" } }, "all_conditions_required": { "type": "boolean", "description": "Whether all conditions must be satisfied to enable this property." } }, "description": "Definition of a property enablement condition. Deprecated." }, "ConnectionsDiscoveryPathSegment": { "type": "object", "properties": { "asset_types": { "type": "string", "description": "The asset type associated with the path segment." }, "repeatable": { "type": "boolean", "description": "Whether the path segment is repeatable." } }, "description": "The definition of a Discovery path segment." }, "ConnectionsCommonPropertiesEvaluateDefinition": { "type": "object", "properties": { "and": { "type": "array", "description": "The 'and' condition. All sub-conditions evaluate to true. Can nest any number of additional conditional types.", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesEvaluateDefinition" } }, "or": { "type": "array", "description": "The 'or' condition. Any sub-condition evaluates to true. Can nest any number of additional conditional types.", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesEvaluateDefinition" } }, "condition": { "required": [ "op", "parameter_ref" ], "type": "object", "properties": { "op": { "type": "string", "description": "A single operator for the properties of the condition.", "enum": [ "isEmpty", "isNotEmpty", "greaterThan", "lessThan", "equals", "notEquals", "contains", "notContains", "matches", "notMatches" ] }, "parameter_ref": { "type": "string", "description": "The primary parameter - must be present" }, "value": { "type": "object", "description": "Optional value against which to compare the primary parameter value" } }, "description": "The condition that is evaluated" } }, "description": "Container for property conditions and their aggregate 'or' and 'and' operations. Only one of 'and', 'or' and 'conditions' is set at a given time." }, "ConnectionsCommonPropertiesGroupDefinition": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for this group (Required)" }, "type": { "type": "string", "description": "The group type to be displayed", "enum": [ "controls", "tabs", "subtabs", "panels", "columnSelection", "columnSelectionRecursive", "panelSelector", "customPanel", "summaryPanel", "actionPanel", "textPanel", "twistyPanel", "columnPanel" ] }, "label": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesResourceDefinition" }, "description": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesResourceDefinition" }, "depends_on_ref": { "type": "string", "description": "Parameter name this group depends upon. Valid for panelSelector groups only." }, "insert_panels": { "type": "boolean", "description": "Indicates whether panels, contained with a panelSelector, should be inserted between the radio buttons of a radio button set indicated by the depends_on_ref parameter." }, "parameter_refs": { "type": "array", "description": "List of parameters to be displayed", "items": { "type": "string" } }, "action_refs": { "type": "array", "description": "List of actions to be displayed. Used with an actionPanel", "items": { "type": "string" } }, "group_info": { "type": "array", "description": "List of group definitions.", "items": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesGroupDefinition" } }, "data": { "type": "object", "properties": {}, "description": "Data passed to custom panel when group type is 'customPanel'" } }, "description": "Group hints" }, "ConnectionsCommonPropertiesUIParameterDefinition": { "required": [ "parameter_ref" ], "type": "object", "properties": { "control": { "type": "string", "description": "Which control to use. In most cases the control gets to be determined and should not be set", "enum": [ "readonly", "textfield", "passwordfield", "textarea", "numberfield", "oneofselect", "multiselect", "hidden" ] }, "description": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesDescriptionDefinition" }, "label": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesResourceDefinition" }, "label_visible": { "type": "boolean", "description": "Whether to display the label or not. If not displayed, the label can still be used by screen readers", "default": "true" }, "orientation": { "type": "string", "description": "Determines how the control is displayed", "enum": [ "vertical", "horizontal" ] }, "parameter_ref": { "type": "string", "description": "Parameter reference to base operator parameter definition" }, "place_holder_text": { "$ref": "#/components/schemas/ConnectionsCommonPropertiesResourceDefinition" }, "resource_key": { "type": "string", "description": "Used as a key for enum value labels" } }, "description": "Operator parameters hints" }, "ConnectionsCommonPropertiesResourceDefinition": { "required": [ "resource_key" ], "type": "object", "properties": { "default": { "type": "string", "description": "Default value" }, "resource_key": { "type": "string", "description": "Id of the description that can be referenced in other definitions" } }, "description": "Localizable string resource" }, "ConnectionsDatasourceTypeCondition": { "type": "object", "properties": { "property_name": { "type": "string", "description": "the name of the property used by this condition." }, "condition": { "type": "string", "description": "the condition to validate between owning property and this property.", "enum": [ "contains", "endswith", "equals", "in", "matches", "not_contains", "not_endswith", "not_equals", "not_in", "not_matches", "not_set", "not_startswith", "set", "startswith" ] }, "values": { "type": "array", "description": "the values to use in checking the condition.", "items": { "type": "string" } } }, "description": "A specific condition to be applied to a property." }, "ConnectionsCommonPropertiesDescriptionDefinition": { "required": [ "resource_key" ], "type": "object", "properties": { "default": { "type": "string", "description": "Default value" }, "resource_key": { "type": "string", "description": "Id of the description that can be referenced in other definitions" }, "placement": { "type": "string", "description": "Optional placement context for the text", "default": "as_tooltip", "enum": [ "as_tooltip", "on_panel" ] }, "link": { "$ref": "#/components/schemas/ConnectionsLinkDefinition" } }, "description": "Description of parameter with optional placement context" }, "ConnectionsLinkDefinition": { "required": [ "id" ], "type": "object", "properties": { "data": { "type": "object", "description": "Callback data received from tooltipLinkHandler" }, "id": { "type": "string", "description": "Operator identifier" }, "propertyId": { "$ref": "#/components/schemas/ConnectionsNameDefinition" } }, "description": "Optional link in description" }, "ConnectionsNameDefinition": { "type": "object", "properties": { "name": { "type": "string", "description": "A unique name, propertyId." } }, "description": "The definition of referenced property name." }, "ConnectionsConnectionActions": { "type": "object", "properties": { "actions": { "type": "array", "description": "The actions supported for the data source.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeAction" } } }, "description": "Connection actions." }, "ConnectionsConnectionActionResponse": { "type": "object", "description": "Results of a connection perform action request.", "additionalProperties": { "type": "object", "properties": {} } }, "ConnectionsConnectionActionConfiguration": { "type": "object", "description": "Connection perform action configuration.", "additionalProperties": { "type": "object", "properties": {} } }, "ConnectionsConnectionMigratedCollection": { "type": "object", "properties": { "resources": { "type": "array", "description": "List of migrated connections", "items": { "$ref": "#/components/schemas/ConnectionsConnectionMigrated" } }, "total_count": { "type": "integer", "description": "The number of assets available." }, "log_file": { "type": "string", "description": "The name of the log with migration process logging." }, "exceptions": { "type": "array", "description": "List of exceptions encountered durring the migration process.", "items": { "type": "string" } } }, "description": "A page from a collection of migrated connections." }, "ConnectionsConnectionFileCollection": { "type": "object", "properties": { "resources": { "type": "array", "description": "List of uploaded files", "items": { "$ref": "#/components/schemas/ConnectionsConnectionFile" } }, "offset": { "type": "integer", "description": "The number of assets skipped before this page." }, "total_count": { "type": "integer", "description": "The total number of assets available." } }, "description": "A page from a collection of uploaded files." }, "ConnectionsConnectionMigrated": { "type": "object", "properties": { "id": { "type": "string", "description": "Asset id of a migrated connection." }, "name": { "type": "string", "description": "Name of a migrated connection." }, "container_info": { "type": "string", "description": "Name and id of catalog/project/space of a connection." }, "jar_uris": { "type": "string", "description": "New value of jar_uris property." }, "jar_uris_patch": { "type": "string", "description": "Patch to be applied on jar_uris property." } }, "description": "A migrated connection info." }, "ConnectionsConnectionFile": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "Date of creation of the file." }, "url": { "type": "string", "description": "Signed URL of the file." }, "hash": { "type": "string", "description": "Hash of the file." }, "digest": { "type": "string", "description": "Digest of the file." }, "fileName": { "type": "string", "description": "Name of the file to be used by connections." } } }, "ConnectionsCustomDatasourceTypes": { "type": "object", "properties": { "datasource_types": { "type": "array", "description": "List of data source types", "items": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceType" } } }, "description": "A collection of custom data source types." }, "ConnectionsCustomDatasourceTypeEntity": { "type": "object", "properties": { "flight_info": { "$ref": "#/components/schemas/ConnectionsCustomFlightServiceInfo" }, "base_datasource_type": { "type": "string", "description": "The UUID of the base datasource type for this custom datasource type" }, "name": { "type": "string", "description": "A unique name, such as \"dashdb\"." }, "label": { "type": "string", "description": "A localized, displayable label such as, \"IBM dashDB\"." }, "description": { "type": "string", "description": "A localized, displayable description of the data source." }, "allowed_as_source": { "type": "boolean", "description": "Whether the data source can be accessed as a source of data. That is, data can be read from the data source." }, "allowed_as_target": { "type": "boolean", "description": "Whether the data source can be accessed as a target. That is, data can be written to the data source." }, "discovery": { "$ref": "#/components/schemas/ConnectionsDatasourceTypeDiscovery" }, "properties": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" }, "property_definitions": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeProperty" } }, "status": { "type": "string", "description": "The status of the data source.", "enum": [ "active", "deprecated", "inactive", "internal", "pending", "system" ] }, "child_source_systems": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" } }, "origin_country": { "type": "string", "description": "Country which data originated from. - ISO 3166 Country Codes." }, "owner_id": { "type": "string", "description": "Owner or creator of connection. Provided when a service ID token is used to create connection." }, "rov": { "$ref": "#/components/schemas/ConnectionsConnectionRov" }, "source_system": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" }, "source_system_history": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsCommonCustomObject" } }, "tags": { "type": "array", "description": "Tags associated with a data source type.", "items": { "type": "string" } }, "actions": { "type": "array", "description": "The actions supported for the data source.", "items": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeAction" } } }, "description": "The definition of a custom data source type." }, "ConnectionsDatasourceTypeCollection": { "type": "object", "properties": { "resources": { "type": "array", "description": "List of data source types", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceType" } }, "first": { "$ref": "#/components/schemas/HrefModel" }, "prev": { "$ref": "#/components/schemas/HrefModel" }, "next": { "$ref": "#/components/schemas/HrefModel" }, "last": { "$ref": "#/components/schemas/HrefModel" }, "offset": { "type": "integer", "description": "The number of assets skipped before this page." }, "total_count": { "type": "integer", "description": "The total number of assets available." } }, "description": "A page from a collection of data source types." }, "ConnectionsCustomDatasourceType": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/ConnectionsConnectionAssetSystemMetadata" }, "entity": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeEntity" } }, "description": "The definition of a custom data source type." }, "ConnectionsCustomDatasourceTypeAction": { "type": "object", "properties": { "name": { "type": "string", "description": "The action name." }, "description": { "type": "string", "description": "A description of the action." }, "properties": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeActionProperties" } }, "description": "The definition of a custom data source type action." }, "ConnectionsCustomDatasourceTypeProperty": { "type": "object", "properties": { "name": { "type": "string", "description": "The property name." }, "type": { "type": "string", "description": "The type of the property.", "enum": [ "boolean", "enum", "integer", "string" ] }, "label": { "type": "string", "description": "The label for the property." }, "description": { "type": "string", "description": "The description for the property." }, "placeholder": { "type": "string", "description": "An example value for the property." }, "required": { "type": "boolean", "description": "Whether the property is required." }, "masked": { "type": "boolean", "description": "Whether the property should be masked. For example, when the property is a password." }, "multiline": { "type": "boolean", "description": "Whether the property should be displayed in a multi-line field." }, "hidden": { "type": "boolean", "description": "Whether the property should be displayed." }, "default_value": { "type": "string", "description": "The default value for the property if the value is not otherwise specified." }, "values": { "type": "array", "description": "If the property type is enum, the list of enumerated values that the property can take.", "items": { "$ref": "#/components/schemas/ConnectionsDatasourceTypePropertyValues" } }, "group": { "type": "string", "description": "A classification group for the property." } }, "description": "Definition of a data source property for a custom datasource type." }, "ConnectionsCustomDatasourceTypeActionProperties": { "type": "object", "properties": { "input": { "type": "array", "description": "The input properties.", "items": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeProperty" } }, "output": { "type": "array", "description": "The properties of the action result.", "items": { "$ref": "#/components/schemas/ConnectionsCustomDatasourceTypeProperty" } } }, "description": "Definitions of the properties that are supported for a custom data source type action." }, "DataDiscoveriesMetadataEnrichmentArea": { "description": "An object containing information about a metadata enrichment area asset", "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaMetadata" }, { "description": "" } ] }, "entity": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaEntity" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaRequest": { "description": "Properties of the request to create metadata enrichment area asset.", "required": [ "name", "objective" ], "type": "object", "properties": { "name": { "description": "name of the metadata enrichment asset", "type": "string", "example": "Sample enrichment", "nullable": false }, "description": { "description": "description of the metadata enrichment area asset", "type": "string", "example": "This is a description for my sample metadata enrichment." }, "target_catalog_id": { "description": "Id of the catalog to metadata enrichment area assets into", "type": "string", "example": "342b07da-fbe5-4a0a-94ee-ab89696975d5" }, "job": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentJobEdit" }, { "description": "" } ] }, "publish_job": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesPublishJobEdit" }, { "description": "" } ] }, "data_scope": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaDataScope" }, { "description": "" } ] }, "objective": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjective" }, { "description": "", "nullable": false } ] }, "tags": { "description": "list of tags", "type": "array", "items": { "type": "string" } } } }, "DataDiscoveriesMetadataEnrichmentAreaEntity": { "description": "Properties of the metadata enrichment area asset.", "required": [ "name" ], "type": "object", "properties": { "description": { "description": "description of the metadata enrichment area asset", "type": "string", "example": "Enrichment of assets" }, "name": { "description": "name of the metadata enrichmentarea asset", "type": "string", "example": "my_emrichment", "nullable": false }, "target_catalog_id": { "description": "Id of the catalog to meetadata enrichment area assets into", "type": "string", "example": "342b07da-fbe5-4a0a-94ee-ab89696975d5" }, "job": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentJobInfo" }, { "description": "" } ] }, "data_asset_summary": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaDataAssetSummary" }, { "description": "" } ] }, "objective": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjective" }, { "description": "" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesStatusEnum5" }, { "description": "", "enum": [ "READY, UPDATING, DELETING, FAILED" ] } ] }, "publish_job": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesPublishJobEdit" }, { "description": "" } ] }, "data_scope_processing": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaEntityDataScopeProcessing" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaMetadata": { "description": "Metadata about a metadata enrichment area asset. Set by system, not changeable by the user.", "type": "object", "properties": { "asset_id": { "description": "The metadata enrichment area id assigned by the system. Read-only", "type": "string", "example": "4412e9b2-3661-11e7-a919-92ebcb67fe33" }, "asset_type": { "description": "The type of the asset", "type": "string", "example": "metadata_enrichment_area" }, "creator_id": { "description": "The IAM ID of the user that created the asset", "type": "string", "example": "IBMid-550000FRA0" }, "created_at": { "format": "int64", "description": "Timestamp representing creation datetime of metadata enrichment area asset *read-only*", "type": "integer", "example": 1631089384058 }, "project_id": { "description": "The ID of the project which contains the asset.", "type": "string", "example": "487084de-de8d-4981-9205-952732a90b3d" }, "usage": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaUsage" }, { "description": "" } ] }, "tags": { "description": "list of tags", "type": "array", "items": { "type": "string" } } } }, "DataDiscoveriesMetadataEnrichmentAreaObjective": { "description": "Enrichment Objective", "type": "object", "properties": { "enrichment_options": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveEnrichmentOptions" }, { "description": "" } ] }, "governance_scope": { "description": "Required when creating and optional when updating.", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveGovernanceScope" } }, "sampling": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveSampling" }, { "description": "" } ] }, "datascope_of_reruns": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesDatascopeOfRerunsEnum" }, { "description": "Data scope of reruns", "enum": [ "DELTA, ALL" ] } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaDataScope": { "type": "object", "properties": { "enrichment_assets": { "description": "IDs of assets to enrich metadata", "type": "array", "items": { "type": "string" } }, "container_assets": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaContainerAssets" }, { "description": "" } ] } } }, "DataDiscoveriesPublishJobEdit": { "description": "metadata enrichment area publish job", "type": "object", "properties": { "id": { "description": "Id of the metadata publish job", "type": "string", "example": "330c6256-3661-11e7-a919-92ebcb67fe33" }, "name": { "description": "Name of the MDE area publish job", "type": "string", "example": "My MDE area publish Job" }, "schedule": { "description": "A cron string defining when the job should be run. This is going to be always empty as publish is not scheduled to run.", "type": "string" } } }, "DataDiscoveriesMetadataEnrichmentJobEdit": { "description": "metadata enrichment job", "type": "object", "properties": { "name": { "description": "Name of the metadata enrichment job", "type": "string", "example": "My Enrichment Job" }, "schedule": { "description": "A cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.", "type": "string", "example": "0 3 21 13 1 ? 2019" }, "schedule_info": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentJobEditScheduleInfo" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaEntityDataScopeProcessing": { "type": "object", "properties": { "heartbeat_timestamp": { "format": "int64", "description": "", "type": "integer", "example": 1631089384058 }, "retry_interval": { "format": "int64", "description": "If not null, retrys after this interval in millisecond.", "type": "integer", "example": 8000 }, "error": { "description": "Error messages while setting data scope", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaEntityDataScopeProcessingError" } } } }, "DataDiscoveriesStatusEnum5": { "enum": [ "DELETING", "FAILED", "READY", "UPDATING" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentAreaDataAssetSummary": { "description": "Summary of data assets to enrich. Included only when is include_summary is true in the get request", "type": "object", "properties": { "structured": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaDataAssetSummaryStructured" }, { "description": "" } ] }, "unstructured": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaDataAssetSummaryUnstructured" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentJobInfo": { "description": "metadata enrichment job", "type": "object", "properties": { "id": { "description": "Id of the metadata enrichment job", "type": "string", "example": "330c6256-3661-11e7-a919-92ebcb67fe33" }, "name": { "description": "Name of the metadata enrichment job", "type": "string", "example": "My Enrichment Job" }, "schedule": { "description": "A cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.", "type": "string", "example": "0 3 21 13 1 ? 2019" }, "schedule_info": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentJobEditScheduleInfo" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaUsage": { "type": "object", "properties": { "last_updated_at": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_updater_id": { "description": "", "type": "string", "example": "IBMid-550000FRA0" }, "last_update_time": { "format": "int64", "description": "", "type": "integer", "example": 1547578689512 }, "last_accessed_at": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_access_time": { "format": "int64", "description": "", "type": "integer", "example": 1547578689512 }, "last_accessor_id": { "description": "", "type": "string", "example": "IBMid-550000FRA0" }, "access_count": { "format": "int64", "description": "", "type": "integer", "example": 0 } } }, "DataDiscoveriesDatascopeOfRerunsEnum": { "enum": [ "ALL", "DELTA" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveSampling": { "description": "sampling options. Required when creating and optional when updating.", "type": "object", "properties": { "structured": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructured" }, { "description": "" } ] }, "unstructured": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingUnstructured" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveGovernanceScope": { "description": "governance artifact.", "required": [ "type", "id" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesTypeEnum8" }, { "description": "governance artifact type", "enum": [ "CATEGORY, BUSINESS_TERM, DATA_CLASS" ], "nullable": false } ] }, "id": { "description": "Id of the governance artifact", "type": "string", "example": "10e64285-bf37-4d5d-b759-bc6a46589bd8", "nullable": false } } }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveEnrichmentOptions": { "description": "enrichment options. Required when creating and optional when updating.", "type": "object", "properties": { "structured": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveEnrichmentOptionsStructured" }, { "description": "" } ] }, "unstructured": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveEnrichmentOptionsUnstructured" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaContainerAssets": { "type": "object", "properties": { "metadata_import": { "description": "", "type": "array", "items": { "type": "string" } } } }, "DataDiscoveriesMetadataEnrichmentJobEditScheduleInfo": { "type": "object", "properties": { "repeat": { "description": "Indicate a repeated job", "type": "boolean", "example": true }, "startOn": { "format": "int64", "description": "A timestamp in epoch time, the scheduled job will be triggered after this timestamp.", "type": "integer", "example": 1547578689512 }, "endOn": { "format": "int64", "description": "A timestamp in epoch time, the scheduled job will be triggered before this timestamp.", "type": "integer", "example": 1547578689512 } } }, "DataDiscoveriesTypeEnum": { "enum": [ "FIELD", "HEADER", "PARAMETER" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentAreaEntityDataScopeProcessingError": { "type": "object", "properties": { "message": { "description": "Error message", "type": "string" }, "asset_id": { "description": "Id of the asset failed to process", "type": "string", "example": "30bc8c7a-ef65-4383-b9c6-d304bc191e26" } } }, "DataDiscoveriesMetadataEnrichmentAreaDataAssetSummaryUnstructured": { "type": "object", "properties": { "count": { "format": "int32", "description": "Number of unstructured data assets", "type": "integer", "example": 890 } } }, "DataDiscoveriesMetadataEnrichmentAreaDataAssetSummaryStructured": { "type": "object", "properties": { "count": { "format": "int32", "description": "Number of structured data assets", "type": "integer", "example": 1203 } } }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingUnstructured": { "description": "sampling options for unstructured data assets", "type": "object", "properties": { "method": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMethodEnum" }, { "description": "sampling method", "enum": [ "RANDOM" ] } ] }, "sample_size": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingUnstructuredSampleSize" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructured": { "description": "sampling options for structured data assets. Required when creating and optional when updating.", "type": "object", "properties": { "project_default_settings": { "description": "Set true to apply project level default settings to this metadata enrichment area.", "type": "boolean" }, "method": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMethodEnum1" }, { "description": "Sampling method for this metadata enrichment area. The value is respected when project_default_settings is false.", "enum": [ "TOP, RANDOM" ] } ] }, "analysis_method": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesAnalysisMethodEnum" }, { "description": "Analysis method to use when sampling data. Either sample a `FIXED` number of rows or a given `PERCENTAGE` of all table rows. The value is respected when project_default_settings is false. Providing this attribute is optional, if not specified, the analysis method defaults to `FIXED`.", "enum": [ "FIXED, PERCENTAGE" ] } ] }, "sample_size": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructuredSampleSize" }, { "description": "" } ] } } }, "DataDiscoveriesTypeEnum8": { "enum": [ "BUSINESS_TERM", "CATEGORY", "DATA_CLASS" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveEnrichmentOptionsUnstructured": { "description": "enrichment options for unstructured data assets", "required": [ "profile", "assign_terms" ], "type": "object", "properties": { "profile": { "description": "always true as profile is always enabled for unstructured data", "type": "boolean", "nullable": false }, "assign_terms": { "description": "true if assign terms is enabled for unstructured data", "type": "boolean", "nullable": false } } }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveEnrichmentOptionsStructured": { "description": "enrichment options for structured data assets. Required when creating and optional when updating.", "type": "object", "properties": { "profile": { "description": "true if profile is enabled for structured data. Required when creating and optional when updating.", "type": "boolean" }, "assign_terms": { "description": "true if assign terms is enabled for structured data. Required when creating and optional when updating.", "type": "boolean" }, "analyze_quality": { "description": "true if analyze quality is enabled for structured data. Required when creating and optional when updating.", "type": "boolean" } } }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingUnstructuredSampleSize": { "description": "sample size", "required": [ "name" ], "type": "object", "properties": { "name": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesNameEnum" }, { "description": "", "enum": [ "BASIC, MODERATE, COMPREHENSIVE" ], "nullable": false } ] } } }, "DataDiscoveriesMethodEnum": { "enum": [ "RANDOM" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructuredSampleSize": { "description": "Sample size for this metadata enrichment area. The value is respected when project_default_settings is false. Required when creating metadata enrichment area and project_default_settings is false.", "required": [ "name" ], "type": "object", "properties": { "name": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesNameEnum1" }, { "description": "", "enum": [ "BASIC, MODERATE, COMPREHENSIVE, CUSTOM" ], "nullable": false } ] }, "options": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructuredSampleSizeOptions" }, { "description": "" } ] }, "percentage_options": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructuredSampleSizePercentageOptions" }, { "description": "" } ] } } }, "DataDiscoveriesAnalysisMethodEnum": { "enum": [ "FIXED", "PERCENTAGE" ], "type": "string" }, "DataDiscoveriesMethodEnum1": { "enum": [ "RANDOM", "TOP" ], "type": "string" }, "DataDiscoveriesNameEnum": { "enum": [ "BASIC", "COMPREHENSIVE", "MODERATE" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructuredSampleSizePercentageOptions": { "description": "option parameters to be evaluated, when analysis_method `PERCENTAGE` is selected.", "required": [ "decimal_value", "row_number_min", "row_number_max", "classify_value_number" ], "type": "object", "properties": { "decimal_value": { "format": "double", "description": "Percentage of rows to enrich, as decimal", "type": "number", "example": 0.8, "nullable": false }, "row_number_min": { "format": "int64", "description": "Minimum number of rows to include in sampling", "type": "integer", "example": 100, "nullable": false }, "row_number_max": { "format": "int64", "description": "Maximum number of rows to include in sampling", "type": "integer", "example": 100, "nullable": false }, "classify_value_number": { "format": "int64", "description": "Classify based on # values/columns.", "type": "integer", "example": 10, "nullable": false } } }, "DataDiscoveriesMetadataEnrichmentAreaObjectiveSamplingStructuredSampleSizeOptions": { "description": "option parameters to be evaluated, when analysis_method `FIXED' is selected.", "required": [ "row_number", "classify_value_number" ], "type": "object", "properties": { "row_number": { "format": "int64", "description": "Enrich top # of rows / table.", "type": "integer", "example": 100, "nullable": false }, "classify_value_number": { "format": "int64", "description": "Classify based on # values / column.", "type": "integer", "example": 10, "nullable": false } } }, "DataDiscoveriesNameEnum1": { "enum": [ "BASIC", "COMPREHENSIVE", "CUSTOM", "MODERATE" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentSettings": { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentSettings" }, "DataDiscoveriesMetadataEnrichmentAreaPatchRequest": { "description": "An object containing fields to patch a metadata enrichment", "type": "object", "properties": { "name": { "description": "name of the metadata enrichment area asset", "type": "string", "example": "Sample enrichment" }, "description": { "description": "description of the metadata enrichment area asset", "type": "string", "example": "This is a description for my sample metadata enrichment." }, "target_catalog_id": { "description": "Id of the catalog to metadata enrichment area assets into", "type": "string", "example": "342b07da-fbe5-4a0a-94ee-ab89696975d5" }, "job": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentJobEdit" }, { "description": "" } ] }, "publish_job": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesPublishJobEdit" }, { "description": "" } ] }, "objective": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentAreaObjective" }, { "description": "" } ] }, "tags": { "description": "list of tags", "type": "array", "items": { "type": "string" } } } }, "DataDiscoveriesEnrichmentDataScopePatchRequestInner": { "required": [ "op", "type", "value" ], "type": "object", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesOpEnum2" }, { "description": "operation to perform", "enum": [ "add, remove" ], "nullable": false } ] }, "type": { "description": "Asset type. e.g. data_asset, metadata_import", "type": "string", "example": "data_asset", "nullable": false }, "value": { "description": "ID of the asset to add to or remove from the metadata enrichment area", "type": "string", "example": "30bc8c7a-ef65-4383-b9c6-d304bc191e26", "nullable": false } } }, "DataDiscoveriesOpEnum2": { "enum": [ "ADD", "REMOVE" ], "type": "string" }, "DataDiscoveriesAsyncExecutionInfo": { "type": "object", "properties": { "execution_id": { "description": "", "type": "string", "example": "be4b1280-a1be-43f2-898b-0f640008ade4" } } }, "DataDiscoveriesDataAssetTermAssignments": { "type": "object", "properties": { "asset_id": { "description": "asset_id", "type": "string", "example": "75985844-aa3f-410f-82be-9788ffd6ec75" }, "terms": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesTermAssignments" }, { "description": "" } ] } } }, "DataDiscoveriesTermAssignmentOptions": { "required": [ "dataassets" ], "type": "object", "properties": { "dataassets": { "description": "IDs of assets to enrich metadata", "type": "array", "items": { "type": "string" }, "nullable": false }, "terms": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesTerm" } } } }, "DataDiscoveriesTermAssignments": { "type": "object", "properties": { "assigned_terms": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesTermAssignment" } }, "suggested_terms": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesTermAssignment" } }, "rejected_terms": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesTermAssignment" } } } }, "DataDiscoveriesTerm": { "required": [ "id", "display_name" ], "type": "object", "properties": { "id": { "description": "Global ID of term", "type": "string", "example": "5f672add-e650-4357-bf5c-15e0a4c97f54_ac4e07e5-5711-46e3-a7f9-8d2d17c8d3fc", "nullable": false }, "display_name": { "description": "term display name", "type": "string", "nullable": false } } }, "DataDiscoveriesTermAssignment": { "type": "object", "properties": { "term_id": { "description": "", "type": "string", "example": "5f672add-e650-4357-bf5c-15e0a4c97f54_ac4e07e5-5711-46e3-a7f9-8d2d17c8d3fc" }, "term_display_name": { "description": "", "type": "string", "example": "my term" }, "confidence": { "format": "double", "description": "", "maximum": 1, "minimum": 0, "type": "number" }, "specification": { "description": "", "type": "string" }, "user": { "description": "", "type": "string", "example": "IBMid-123002ABCD" }, "assignment_date": { "description": "", "type": "string", "example": "2022-01-01T01:30:00.000Z" } } }, "DataDiscoveriesDataAssetColumnTermAssignments": { "type": "object", "properties": { "asset_id": { "description": "asset_id", "type": "string", "example": "75985844-aa3f-410f-82be-9788ffd6ec75" }, "terms_of_columns": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesColumnTermAssignments" } } } }, "DataDiscoveriesColumnTermAssignmentOptions": { "required": [ "dataasset_columns", "terms" ], "type": "object", "properties": { "dataasset_columns": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesMdeAssetColumns" }, "nullable": false }, "terms": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesTerm" }, "nullable": false } } }, "DataDiscoveriesColumnTermAssignments": { "type": "object", "properties": { "column_name": { "description": "", "type": "string", "example": "column1" }, "terms": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesTermAssignments" }, { "description": "" } ] } } }, "DataDiscoveriesMdeAssetColumns": { "required": [ "asset_id", "columns" ], "type": "object", "properties": { "asset_id": { "description": "asset_id", "type": "string", "example": "75985844-aa3f-410f-82be-9788ffd6ec75", "nullable": false }, "columns": { "description": "columns of an asset", "type": "array", "items": { "type": "string" }, "nullable": false } } }, "DataDiscoveriesDataClassAssignmentOptionsInner": { "required": [ "asset_id", "operations" ], "type": "object", "properties": { "asset_id": { "description": "", "type": "string", "example": "b5568a7e-7fca-4824-8466-f18119096e81", "nullable": false }, "operations": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesDataClassColumnOperation" }, "nullable": false } } }, "DataDiscoveriesDataClassColumnOperation": { "required": [ "op", "column" ], "type": "object", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesOpEnum1" }, { "description": "type of operation", "enum": [ "add, remove" ], "example": "add", "nullable": false } ] }, "column": { "description": "specify the column name", "type": "string", "example": "ACCT_NUM", "nullable": false }, "value": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesDataClass" }, { "description": "" } ] } } }, "DataDiscoveriesDataClass": { "required": [ "global_id" ], "type": "object", "properties": { "global_id": { "description": "dataclass id", "type": "string", "example": "c6c1b0e9-6a22-4117-a61c-4b094947822e_4b34779a-720c-4651-90cf-3031604465ec", "nullable": false }, "name": { "description": "", "type": "string", "example": "dataclass name" } } }, "DataDiscoveriesOpEnum1": { "enum": [ "ADD", "REMOVE" ], "type": "string" }, "DataDiscoveriesReviewdateMde": { "type": "object", "properties": { "review_date": { "format": "int64", "description": "", "type": "integer", "example": 1631089384058 } } }, "DataDiscoveriesJobRunInfo": { "type": "object", "properties": { "job_id": { "description": "", "type": "string", "example": "b85c866b-f913-424e-9e2d-a26996ff5969" }, "job_run_id": { "description": "", "type": "string", "example": "6e71ef7d-1d27-4925-9736-fbb10dc9e84d" } } }, "DataDiscoveriesPublishRequest": { "required": [ "catalog" ], "type": "object", "properties": { "catalog": { "description": "catalog Id", "type": "string", "example": "ae568a7e-7fca-4824-8466-f18119096e82", "nullable": false }, "duplicate_action": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesDuplicateActionEnum" }, { "description": "action if asset already exists", "enum": [ "replace, update, ignore" ], "example": "update" } ] }, "asset_ids": { "description": "IDs of assets to enrich metadata", "type": "array", "items": { "type": "string" } }, "filter": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesFilterCatalogSearch" }, { "description": "" } ] } } }, "DataDiscoveriesFilterCatalogSearch": { "required": [ "type", "asset_type", "search_criteria" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesTypeEnum6" }, { "description": "type of search", "enum": [ "catalog_search" ], "nullable": false } ] }, "asset_type": { "description": "Asset type for catalog search.", "type": "string", "example": "metadata_enrichment_area_info", "nullable": false }, "search_criteria": { "description": "JSON object for search payload", "type": "object", "additionalProperties": {}, "example": { "query": "asset.name:Asset* AND metadata_enrichment_area_info.area_id:62df1c42-53cd-4503-a6f5-f020aaabca72" }, "nullable": false } } }, "DataDiscoveriesDuplicateActionEnum": { "enum": [ "IGNORE", "REPLACE", "UPDATE" ], "type": "string" }, "DataDiscoveriesTypeEnum6": { "enum": [ "CATALOG_SEARCH" ], "type": "string" }, "DataDiscoveriesMetadataImport": { "description": "An object containing information about a metadata import asset", "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportMetadata" }, { "description": "" } ] }, "entity": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportEntity" }, { "description": "" } ] } } }, "DataDiscoveriesMetadataImportRequest": { "description": "Properties of the request to create metadata import asset.", "required": [ "name" ], "type": "object", "properties": { "sap_assets_added": { "description": "List of the assets to be update with SAP Business Metdata", "type": "array", "items": { "type": "string" } }, "description": { "description": "description of the metadata import asset", "type": "string", "example": "Import of a db2 table" }, "name": { "description": "name of the metadata import asset", "type": "string", "example": "db2_tables_import", "nullable": false }, "import_type": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesImportTypeEnum" }, { "description": "The type of the import. The possible values are 'metadata' and 'lineage'.", "enum": [ "metadata, lineage" ] } ] }, "connection_id": { "description": "Id of the connection which is being discovered", "type": "string", "example": "96e2149d-6916-427b-bf98-a0cb989306d7" }, "connection_id_list": { "description": "List of connection_id which is being discovered", "type": "array", "items": { "type": "string" }, "example": [ "69196df7-714f-416b-a49b-ea025cd5d5e7", "224a78fe-7946-4e10-b685-af7b5f047d0a" ] }, "file_list": { "description": "List of configuration/datasource files for which metadata/lineage has to be extracted.", "type": "array", "items": {}, "example": [ { "asset_id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "technology": "erwin" } ] }, "workspace_root_paths": { "description": "List of workspace rootPath.", "type": "array", "items": {}, "example": [ { "id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "path": "/Workspace/export_uc", "name": "Databricks_connection", "type": "Connection" } ] }, "asset_ref_map": { "description": "asset ref map when trying to export and import a project .", "type": "object" }, "reimport_options": { "description": "specify if name, description, column descriptions to be udpated during re-import.", "type": "object", "example": [ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ] }, "business_extraction": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesBusinessMetadataExtraction" }, { "description": "" } ] }, "import_options": { "description": "support advanced options of metadata import.", "type": "object", "example": [ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ] }, "target_catalog_id": { "description": "Id of the catalog to import assets into", "type": "string", "example": "342b07da-fbe5-4a0a-94ee-ab89696975d5" }, "target_project_id": { "description": "Id of the project to import assets into", "type": "string", "example": "c5b3daa2-c880-4f83-9bfa-c50ff70d9f42" }, "job_id": { "description": "Id of the metadata import job", "type": "string", "example": "330c6256-3661-11e7-a919-92ebcb67fe33" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportScope" }, { "description": "" } ] }, "tags": { "description": "list of tags", "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2" ] }, "importflow_name": { "description": "Name of the metaBroker importflow", "type": "string", "example": "Run open Export" }, "metadata_enrichment_area_info": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentInfo" }, { "description": "" } ] }, "goal": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesGoalEnum" }, { "description": "The goal the import. The possible values are 'metadata','lineage',`data_model`, `data_integration`, `data_integration_discover`, `business_intelligence`, `business_intelligence_discover` and `open_manta`", "enum": [ "metadata, lineage, data_model, data_integration, data_integration_discover, business_intelligence, business_intelligence_discover, open_manta" ], "example": "metadata" } ] } } }, "DataDiscoveriesMetadataImportEntity": { "description": "Properties of the metadata import asset.", "required": [ "name" ], "type": "object", "properties": { "sap_assets_added": { "description": "List of the assets to be update with SAP Business Metdata", "type": "array", "items": { "type": "string" } }, "description": { "description": "description of the metadata import asset", "type": "string", "example": "Import of a db2 table" }, "name": { "description": "name of the metadata import asset", "type": "string", "example": "db2_tables_import", "nullable": false }, "import_type": { "description": "The type of the import. The possible values are 'metadata' and 'lineage'.", "type": "string", "example": "metadata" }, "connection_id": { "description": "Id of the connection which is being imported", "type": "string", "example": "96e2149d-6916-427b-bf98-a0cb989306d7" }, "connection_id_list": { "description": "List of connection_id which is being discovered", "type": "array", "items": { "type": "string" } }, "file_list": { "description": "List of configuration/datasource files for which metadata/lineage has to be extracted.", "type": "array", "items": {}, "example": [ { "asset_id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "technology": "erwin" } ] }, "workspace_root_paths": { "description": "List of workspace rootPath.", "type": "array", "items": {}, "example": [ { "id": "dde62b91-ae75-4d7d-aa08-e93065520aa4", "path": "/Workspace/export_uc", "name": "Databricks_connection", "type": "Connection" } ] }, "target_catalog_id": { "description": "Id of the catalog to import assets into", "type": "string", "example": "342b07da-fbe5-4a0a-94ee-ab89696975d5" }, "target_project_id": { "description": "Id of the project to import assets into", "type": "string", "example": "c5b3daa2-c880-4f83-9bfa-c50ff70d9f42" }, "job_id": { "description": "Id of the metadata import job", "type": "string", "example": "330c6256-3661-11e7-a919-92ebcb67fe33" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportScope" }, { "description": "" } ] }, "datasource_type": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesDatasourceTypeEnum" }, { "description": "The type of the data source. The possible values are 'database', 'file', and 'generic'.", "enum": [ "database, file, generic" ] } ] }, "last_run_started": { "format": "int64", "description": "Started time of the last run.", "type": "integer", "example": 1547578689512 }, "last_run_completed": { "format": "int64", "description": "Completed time of the last run.", "type": "integer", "example": 1547578689512 }, "number_of_runs": { "format": "int32", "description": "Number of runs.", "type": "integer", "example": 10 }, "version": { "format": "int32", "description": "Version of metadata import.", "type": "integer", "example": 1 }, "importflow_name": { "description": "Name of the metabroker importflow", "type": "string", "example": "Run Open Export" }, "importflow_executionid": { "description": "MetaBroker importflow executionid", "type": "string" }, "number_of_new_assets": { "format": "int64", "description": "The number of assets imported newly since last importing.", "type": "integer", "example": 10 }, "number_of_updated_assets": { "format": "int64", "description": "The number of assets updated since last importing.", "type": "integer", "example": 5 }, "number_of_removed_assets": { "format": "int64", "description": "The number of assets removed since last importing.", "type": "integer", "example": 3 }, "mde_enabled": { "description": "the flag if the metadata enrichment can work or not.", "type": "boolean", "example": true }, "reimport_options": { "description": "options while reimporting metadata.", "type": "object", "example": [ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ] }, "import_options": { "description": "support advanced options of metadata import.", "type": "object", "example": [ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ] }, "business_extraction": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesBusinessMetadataExtraction" }, { "description": "" } ] }, "metadata_enrichment_area_info": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataEnrichmentInfo" }, { "description": "" } ] }, "metabroker_scanner_validation_msg": { "description": "Contains warning message, if validation of metabroker scanner passes partially.", "type": "string", "example": "true" }, "goal": { "description": "The goal the import. The possible values are 'metadata','lineage',`data_model`, `data_integration`, `data_integration_discover`, `business_intelligence`, `business_intelligence_discover` and `open_manta`", "type": "string", "example": "metadata" } } }, "DataDiscoveriesMetadataImportMetadata": { "description": "Metadata about a metadata import asset. Set by system, not changeable by the user.", "type": "object", "properties": { "asset_id": { "description": "The metadata import id assigned by the system. Read-only", "type": "string" }, "asset_type": { "description": "The type of the asset", "type": "string" }, "creator_id": { "description": "The IAM ID of the user that created the asset", "type": "string" }, "created_at": { "description": "Timestamp representing creation datetime of metadata import asset *read-only*", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "project_id": { "description": "The ID of the project which contains the asset.", "type": "string" }, "usage": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportUsage" }, { "description": "" } ] }, "tags": { "description": "list of tags", "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2" ] } } }, "DataDiscoveriesGoalEnum": { "enum": [ "BUSINESS_INTELLIGENCE", "BUSINESS_INTELLIGENCE_DISCOVER", "DATA_INTEGRATION", "DATA_INTEGRATION_DISCOVER", "DATA_MODEL", "LINEAGE", "METADATA", "OPEN_MANTA" ], "type": "string" }, "DataDiscoveriesMetadataEnrichmentInfo": { "type": "object", "properties": { "added_date": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "area_id": { "description": "", "type": "string", "example": "96e2149d-6916-427b-bf98-a0cb989306d7" } } }, "DataDiscoveriesMetadataImportScope": { "description": "Scope of assets to be imported from the connection.", "type": "object", "properties": { "paths": { "description": "list of paths", "type": "array", "items": { "type": "string" }, "example": [ "/schema1/table1" ] } } }, "DataDiscoveriesBusinessMetadataExtraction": { "type": "object", "properties": { "enrichment_area_id": { "description": "", "type": "string" }, "isPublished": { "description": "", "type": "boolean" }, "enrichment_categories": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesEnrichmentCategories" }, { "description": "" } ] }, "primary_category": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesPrimaryCategory" }, { "description": "" } ] }, "dictionary_connection": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesDictionaryConnection" }, { "description": "" } ] }, "sap_assets_ids": { "description": "List of the assets to be updated with SAP Business Metdata", "type": "array", "items": { "type": "string" } } } }, "DataDiscoveriesImportTypeEnum": { "enum": [ "LINEAGE", "METADATA" ], "type": "string" }, "DataDiscoveriesDatasourceTypeEnum": { "enum": [ "DATABASE", "FILE", "GENERIC" ], "type": "string" }, "DataDiscoveriesMetadataImportUsage": { "type": "object", "properties": { "last_updated_at": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_updater_id": { "description": "", "type": "string", "example": "IBMid-550000FRA0" }, "last_update_time": { "format": "int64", "description": "", "type": "integer", "example": 1547578689512 }, "last_accessed_at": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_access_time": { "format": "int64", "description": "", "type": "integer", "example": 1547578689512 }, "last_accessor_id": { "description": "", "type": "string", "example": "IBMid-550000FRA0" }, "access_count": { "format": "int64", "description": "", "type": "integer", "example": 0 } } }, "DataDiscoveriesDictionaryConnection": { "type": "object", "properties": { "connectionName": { "description": "", "type": "string" }, "connectionId": { "description": "", "type": "string" } } }, "DataDiscoveriesPrimaryCategory": { "type": "object", "properties": { "id": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" } } }, "DataDiscoveriesEnrichmentCategories": { "type": "array" }, "DataDiscoveriesMetadataImportDatasourceType": { "required": [ "datasource_id" ], "type": "object", "properties": { "datasource_id": { "description": "datasource id", "type": "string", "example": "96e2149d-6916-427b-bf98-a0cb989306d7", "nullable": false }, "scope_enabled": { "description": "Whether datasource supports scoping.", "type": "boolean", "example": true }, "lineage_enabled": { "description": "Whether datasource supports manta.", "type": "boolean", "example": true }, "is_relational_database": { "description": "Whether datasource is of type relational database.", "type": "boolean", "example": false }, "data_enabled": { "description": "Indicates whether data be can fetched from this connection type, It will be true for SCAPI connections and false for manta only connections.", "type": "boolean", "example": true } } }, "DataDiscoveriesJob": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesAssetMetadata2" }, { "description": "" } ] }, "entity": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesJobEntity1" }, { "description": "" } ] } } }, "DataDiscoveriesJobEntity1": { "description": "The underlying job definition.", "type": "object", "properties": { "job": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesJobEntityJob1" }, { "description": "" } ] } } }, "DataDiscoveriesAssetMetadata2": { "description": "AssetMetadata Model", "required": [ "name", "asset_category", "asset_type", "origin_country" ], "type": "object", "properties": { "name": { "description": "", "type": "string", "example": "Name", "nullable": false }, "description": { "description": "", "type": "string", "example": "Description." }, "asset_id": { "description": "", "type": "string", "example": "d5d898ac-b87a-40a1-9648-2c5f49fd0096" }, "asset_category": { "description": "", "type": "string", "example": "USER", "nullable": false }, "asset_type": { "description": "", "type": "string", "example": "job", "nullable": false }, "origin_country": { "description": "", "type": "string", "example": "us", "nullable": false }, "rov": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesAssetRov2" }, { "description": "" } ] }, "project_id": { "description": "", "type": "string", "example": "727a9f14-e692-4096-84ac-0db57dae0530" }, "sandbox_id": { "description": "", "type": "string", "example": "727a9f14-e692-4096-84ac-0db57dae0530" }, "usage": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesAssetMetadataUsage2" }, { "description": "" } ] }, "rating": { "format": "int64", "description": "", "type": "integer", "example": 0 }, "total_ratings": { "format": "int64", "description": "", "type": "integer", "example": 0 }, "catalog_id": { "description": "", "type": "string", "example": "edc30d9a-1691-4860-b947-4c8514e69f50" }, "created": { "format": "int64", "description": "", "type": "integer", "example": 1547578689512 }, "created_at": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "owner_id": { "description": "", "type": "string", "example": "IBMid-550000FRA0" }, "size": { "format": "int64", "description": "", "type": "integer", "example": 0 }, "version": { "format": "int32", "description": "", "type": "integer", "example": 2 }, "asset_state": { "description": "", "type": "string", "example": "available" }, "asset_attributes": { "description": "", "type": "array", "items": { "type": "string" }, "example": [ "job" ] }, "tags": { "description": "", "type": "array", "items": { "type": "string" }, "example": "['tag1', 'tag2', 'tag3']" } } }, "DataDiscoveriesJobEntityJob1": { "type": "object", "properties": { "asset_ref": { "description": "ID of associated asset to run.", "type": "string", "example": "ff1ab70b-0553-409a-93f9-ccc31471c218" }, "asset_ref_name": { "description": "Name of associated asset to run.", "type": "string", "example": "Data preparation" }, "asset_ref_type": { "description": "Read-only field used to distinguish between different types of jobs based on the associated asset to run.", "type": "string", "example": "notebook" }, "last_run_status": { "description": "Status of the last run. 'None' if there is no run yet.", "type": "string", "example": "Completed" }, "last_run_status_timestamp": { "format": "int64", "description": "Status of the last run. 'None' if there is no run yet.", "type": "integer", "example": 1547578689512 }, "last_run_time": { "description": "Creation time of the last run. 'None' if there is no run yet.", "type": "string", "example": "2019-07-04T21:00:48.000Z" }, "last_run_initiator": { "description": "Initiator of last run. None if there is no run yet, and Scheduler if the job is a scheduled job.", "type": "string", "example": "Scheduler" }, "schedule": { "description": "A cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.", "type": "string", "example": "0 3 21 13 1 ? 2019" }, "schedule_info": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesJobEntityJobScheduleInfo1" }, { "description": "" } ] }, "configuration": { "description": "", "type": "object" } } }, "DataDiscoveriesAssetMetadataUsage2": { "type": "object", "properties": { "last_updated_at": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_updater_id": { "description": "", "type": "string", "example": "IBMid-550000FRA0" }, "last_update_time": { "format": "int64", "description": "", "type": "integer", "example": 1547578689512 }, "last_accessed_at": { "description": "", "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_access_time": { "format": "int64", "description": "", "type": "integer", "example": 1547578689512 }, "last_accessor_id": { "description": "", "type": "string", "example": "IBMid-550000FRA0" }, "access_count": { "format": "int64", "description": "", "type": "integer", "example": 0 } } }, "DataDiscoveriesAssetRov2": { "type": "object", "properties": { "mode": { "format": "int32", "description": "", "type": "integer" } } }, "DataDiscoveriesJobEntityJobScheduleInfo1": { "description": "An object defining defining more detail about job's schedule", "type": "object", "properties": { "repeat": { "description": "Whether the job has a repeating schedule", "type": "boolean", "example": true }, "startOn": { "format": "int64", "description": "Epoch time", "type": "integer", "example": 1564686345309 }, "endOn": { "format": "int64", "description": "Epoch time", "type": "integer", "example": 1564686395309 } } }, "DataDiscoveriesJobRun": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesAssetMetadata2" }, { "description": "" } ] }, "entity": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesJobRunEntity" }, { "description": "" } ] } } }, "DataDiscoveriesJobRunEntity": { "type": "object", "properties": { "job_run": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesJobRunEntityJobRun" }, { "description": "" } ] } } }, "DataDiscoveriesJobRunEntityJobRun": { "type": "object", "properties": { "job_ref": { "description": "The ID of the job used to create this run.", "type": "string", "example": "958b4236-0148-4d5d-a14d-0e51f13e4ef3" }, "state": { "description": "The state that a job can be in. Possible values: 'Completed', 'Failed', 'Canceled', 'Starting', 'Running'.", "type": "string", "example": "Starting" }, "runtime_job_id": { "description": "The runtime job ID returned from the runtime system, used to identify the job run in the runtime system.", "type": "string", "example": "1556290769-999:4cfe93c01afbadd7" }, "duration": { "description": "The duration of the job run in seconds.", "type": "string", "example": "10" }, "data_flow_job_output": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesJobRunEntityJobRunDataFlowJobOutput" }, { "description": "" } ] }, "configuration": { "description": "", "type": "object" } } }, "DataDiscoveriesJobRunEntityJobRunDataFlowJobOutput": { "description": "The output of a Data Flow jobs only.", "type": "object", "properties": { "total_rows_read": { "format": "int64", "description": "The total rows read by the Data Flow job.", "type": "integer", "example": 4000 }, "total_rows_written": { "format": "int64", "description": "The total rows written by the Data Flow job.", "type": "integer", "example": 10 }, "total_bytes_read": { "format": "int64", "description": "The total bytes read by the Data Flow job.", "type": "integer", "example": 232469 }, "total_bytes_written": { "format": "int64", "description": "The total bytes written by the Data Flow job.", "type": "integer", "example": 508 } } }, "DataDiscoveriesJobRunReconcileRequest": { "type": "object", "properties": { "body": { "description": "patch operations", "type": "array", "items": { "$ref": "#/components/schemas/DataDiscoveriesJobRunPatchRequest" } } } }, "DataDiscoveriesJobRunPatchRequest": { "type": "object", "properties": { "op": { "description": "patch operation", "type": "string" }, "path": { "description": "path in the resource", "type": "string" }, "value": { "description": "object json string", "type": "object" }, "logStr": { "description": "job run log string", "type": "string" } } }, "DataDiscoveriesRecoveryResponse": { "description": "status message", "type": "object", "properties": { "status": { "description": "An overall status for recovery routine", "type": "string" } } }, "DataDiscoveriesRecoveryCondition": { "description": "Condition to recovery some pending jobs", "type": "object", "properties": { "recovery_date": { "format": "date", "description": "The timestamp when the data was restored (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339)", "type": "string", "example": "2022-04-13T14:59:04.000Z" }, "pending_type": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesPendingTypeEnum" }, { "description": "The status that will be restarted. The possible values are 'starting' and 'running'. The 'running' includes 'starting' status, too.", "enum": [ "starting, running" ] } ] } } }, "DataDiscoveriesPendingTypeEnum": { "enum": [ "RUNNING", "STARTING" ], "type": "string" }, "DataDiscoveriesMetadataImportPatchRequest": { "description": "An object containing fields to patch a metadata import", "type": "object", "properties": { "name": { "description": "name of the metadata import asset", "type": "string", "example": "db2_tables_import" }, "description": { "description": "description of the metadata import asset", "type": "string", "example": "Import of a db2 table" }, "connection_id": { "description": "Id of the connection which is being discovered", "type": "string", "example": "96e2149d-6916-427b-bf98-a0cb989306d7" }, "target_catalog_id": { "description": "Id of the catalog to import assets into", "type": "string", "example": "342b07da-fbe5-4a0a-94ee-ab89696975d5" }, "target_project_id": { "description": "Id of the project to import assets into", "type": "string", "example": "c5b3daa2-c880-4f83-9bfa-c50ff70d9f42" }, "job_id": { "description": "Id of the metadata import job", "type": "string", "example": "330c6256-3661-11e7-a919-92ebcb67fe33" }, "importflow_name": { "description": "Name of the metabroker importflow", "type": "string", "example": "Run Open Export" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/DataDiscoveriesMetadataImportScope" }, { "description": "" } ] }, "tags": { "description": "list of tags", "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2" ] }, "mde_enabled": { "description": "the flag if the metadata enrichment can work or not.", "type": "boolean", "example": true }, "asset_ref_map": { "description": "asset ref map when trying to export and import a project .", "type": "object" }, "reimport_options": { "description": "specify if name, description, column descriptions to be udpated during re-import.", "type": "object", "example": [ { "update_name": false, "update_description": false, "update_column_descriptions": false, "delete_when_deleted_at_source": false, "delete_when_removed_from_scope": false } ] }, "import_options": { "description": "support advanced options of metadata import.", "type": "object", "example": [ { "exclude_tables": false, "exclude_views": false, "import_incremental_changes_only": false, "include_foreign_key": false, "include_primary_key": false } ] } } }, "DataProfilesErrorContainer1": { "required": [ "errors", "trace" ], "type": "object", "properties": { "trace": { "type": "string", "description": "Trace information" }, "errors": { "type": "array", "description": "Errors occurred", "items": { "$ref": "#/components/schemas/DataProfilesErrorModel1" } } } }, "DataProfilesDataProfile": { "required": [ "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/DataProfilesDataProfileMetadataInfo" }, "metadata_outstanding": { "$ref": "#/components/schemas/DataProfilesDataProfileMetadataInfo" }, "record_info": { "$ref": "#/components/schemas/DataProfilesDataProfileRecordInfo" }, "entity": { "required": [ "data_profile" ], "type": "object", "properties": { "data_profile": { "$ref": "#/components/schemas/DataProfilesDataProfileEntityDataProfile" }, "data_profile_outstanding": { "$ref": "#/components/schemas/DataProfilesDataProfileEntityDataProfile" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesDataProfileEntityColumns" } }, "attachment_id": { "type": "string" } }, "description": "The underlying asset entity." }, "href": { "type": "string", "description": "The location url where the data profile is created." } }, "description": "A data profile holds the data profiling controls, options and results of a data set." }, "DataProfilesDataProfilePagedCollection": { "type": "object", "properties": { "resources": { "type": "array", "description": "Collection of data profiles", "items": { "$ref": "#/components/schemas/DataProfilesDataProfile" } } }, "description": "A page from a collection of data profiles." }, "DataProfilesErrorModel1": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "target": { "$ref": "#/components/schemas/DataProfilesErrorTargetModel1" }, "message": { "type": "string", "description": "Error message" }, "more_info": { "type": "string", "description": "Additional information about the error" } }, "additionalProperties": { "type": "object" } }, "DataProfilesDataProfileEntityColumns": { "properties": { "name": { "type": "string", "description": "The column name." }, "type": { "required": [ "name", "type" ], "type": "object", "properties": { "length": { "type": "integer", "description": "The column length.", "format": "int32", "default": 0 }, "nullable": { "type": "boolean", "description": "Indicates whether the values in the column can be null or not.", "default": false }, "scale": { "type": "integer", "description": "The column scale.", "format": "int32", "default": 0 }, "type": { "$ref": "#/components/schemas/DataProfilesOriginalDataType" } }, "description": "The column type inferred by analysis." } }, "description": "Column metadata inferred by analysis." }, "DataProfilesDataProfileEntityDataProfile": { "type": "object", "properties": { "attachment_id": { "type": "string", "description": "The id of the dataprofile attachment" }, "attachment_url": { "type": "string", "description": "The attachment url to upload the dataprofile summary content." }, "connection_id": { "type": "string", "description": "The id of the connection asset holding the physical data resource for which the data profile is created. It is retrieved from the dataset used to create the data profile.", "readOnly": true }, "connection_path": { "type": "string", "description": "The path in the connection identifying the physical data resource for which the data profile is created. (e.g. schemaName/tableName). It is retrieved from the data set used to create the data profile.", "readOnly": true }, "score": { "type": "integer", "description": "The overall quality score of the profiled rows. It is a number between 0 and 100.", "format": "int32" }, "options": { "$ref": "#/components/schemas/DataProfilesDataProfileOptions" }, "execution": { "$ref": "#/components/schemas/DataProfilesDataProfileExecution" }, "summary": { "$ref": "#/components/schemas/DataProfilesDataProfileSummary" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesDataProfileColumn" } }, "has_overrides": { "type": "boolean", "description": "flag to indicate whether overrides exists for columns or not" }, "failed_assets": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesFailedAsset" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesDataProfileJobLogEntry" } } }, "description": "The data profile definition." }, "DataProfilesDataProfileRecordInfo": { "properties": { "number_of_records": { "type": "integer", "description": "The total number of records in the data asset", "format": "int64" }, "computed": { "type": "boolean", "description": "Is this computed by profiling service" } }, "description": "Information about the number of records" }, "DataProfilesDataProfileMetadataInfo": { "required": [ "catalog_id", "dataset_id" ], "type": "object", "properties": { "guid": { "type": "string", "description": "The ID of the profile." }, "asset_id": { "type": "string", "description": "The ID of the profile asset (response only)" }, "dataset_id": { "type": "string", "description": "The ID of the dataset" }, "dataset_ids": { "type": "array", "description": "The IDs of the datasets to use during bulk processing", "items": { "type": "string" } }, "correlation_id": { "type": "string", "description": "The ID to be used for tracking end to end flow." }, "url": { "type": "string", "description": "The Location URL where DataProfile is created." }, "project_id": { "type": "string", "description": "The ID of the project to use. Either catalog_id or project_id is required." }, "catalog_id": { "type": "string", "description": "The ID of the catalog to use. Either catalog_id or project_id is required." }, "created_at": { "type": "string", "description": "The timestamp when the data profile was created (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339) (response only)", "format": "date-time" }, "accessed_at": { "type": "string", "description": "The timestamp when the data profile was accessed (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339) (response only)", "format": "date-time" }, "owner": { "type": "string", "description": "The user ID that created the data profile." }, "last_updater": { "type": "string", "description": "The user ID that updated the data profile." }, "owner_id": { "type": "string", "description": "The IAM ID of the user that created the data profile." }, "last_updater_id": { "type": "string", "description": "The IAM id of the user that updated the data profile." } }, "description": "Profiling specific metadata" }, "DataProfilesErrorTargetModel1": { "required": [ "name", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the target", "enum": [ "field", "parameter", "header" ] }, "name": { "type": "string", "description": "Name of the target" } } }, "DataProfilesOriginalDataType": { "type": "string", "description": "The original data type of a column as defined in the source.", "enum": [ "bigint", "binary", "bit", "char", "date", "decimal", "double", "float", "guid", "integer", "longvarbinary", "longvarchar", "numeric", "real", "smallint", "time", "timestamp", "tinyint", "unknown", "varbinary", "varchar", "wchar", "wlongvarchar", "wvarchar" ] }, "DataProfilesDataProfileJobLogEntry": { "type": "object", "properties": { "date": { "type": "string", "description": "The timestamp when the asset was last accessed (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339) (Response only)" }, "event_id": { "type": "string", "description": "The event id." }, "message_id": { "type": "string", "description": "The message id." }, "message_text": { "type": "string", "description": "The message text." }, "type": { "type": "string", "description": "The event type.", "enum": [ "fatal", "warning", "info" ] } }, "description": "Contains a single log event for a data profile job run." }, "DataProfilesFailedAsset": { "required": [ "failure_message", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The dataset id." }, "name": { "type": "string", "description": "The dataset name." }, "failure_message": { "type": "string", "description": "The error message" } }, "description": "The dataset that is failed to profile in prerequisite check" }, "DataProfilesDataProfileColumn": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The column name." }, "dq_version": { "type": "string", "description": "Version of DQF used for analysis." }, "transformed": { "type": "boolean", "description": "Indicates whether the column is transformed for the requested user.", "default": false }, "original_type": { "$ref": "#/components/schemas/DataProfilesOriginalColumnType" }, "overwritten_type": { "required": [ "type", "user" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataProfilesInferredColumnType" }, "nullable": { "type": "boolean", "description": "Indicates whether the values in the column can be null or not.", "default": true }, "user": { "type": "string", "description": "The ID of the user who did the manual overwrite." } }, "description": "The manually overwritten column type." }, "overwritten_class": { "required": [ "class", "user" ], "type": "object", "properties": { "class": { "$ref": "#/components/schemas/DataProfilesDataClassifier" }, "user": { "type": "string", "description": "The ID of the user who did the manual overwrite." }, "transient": { "type": "boolean", "description": "If set to true, the overwritten class will be removed during next profile run. Applicable to class code U only." } }, "description": "The manually overwritten column data class." }, "overwritten_format": { "required": [ "format", "user" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/DataProfilesInferredColumnFormat" }, "user": { "type": "string", "description": "The ID of the user who did the manual overwrite." } }, "description": "The manually overwritten format." }, "value_analysis": { "$ref": "#/components/schemas/DataProfilesColumnValuesAnalysisResults" }, "quality_analysis": { "$ref": "#/components/schemas/DataProfilesColumnQualityAnalysisResults" } }, "description": "The definition and profiling results of a given data set column." }, "DataProfilesDataProfileSummary": { "required": [ "row_count", "score" ], "type": "object", "properties": { "version": { "type": "string", "description": "The DQF Version used for generating Summary." }, "row_count": { "type": "integer", "description": "The total number of rows that have been profiled.", "format": "int64" }, "score": { "type": "integer", "description": "The overall quality score of the profiled rows. It is a number between 0 and 100.", "format": "int32" }, "access_denied_by_policy": { "type": "boolean", "description": "Whether access to the asset is denied by policy. Deep enforcement" }, "row_filter_applied_by_policy": { "type": "boolean", "description": "Whether row level filtering is applied by policy. Deep enforcement" }, "score_stats": { "required": [ "mean", "n" ], "type": "object", "properties": { "n": { "type": "integer", "description": "The number of available row quality scores.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the available row quality scores.", "format": "double" }, "variance": { "type": "number", "description": "The variance of the available row quality scores.", "format": "double" }, "stddev": { "type": "number", "description": "The standard deviation of the available row quality scores.", "format": "double" }, "min": { "type": "number", "description": "The minimum of the available row quality scores.", "format": "double" }, "max": { "type": "number", "description": "The maximum of the available row quality scores.", "format": "double" }, "sum": { "type": "number", "description": "The sum of the available row quality scores.", "format": "double" } }, "description": "Univariate statistics about the quality score of each data set row." }, "problem_distribution": { "type": "array", "description": "The quality problem distribution across the different columns.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "The value quality problem of a column." }, "count": { "type": "integer", "description": "The number of columns exhibiting the quality problem.", "format": "int32" } } } }, "type_distribution": { "type": "array", "description": "The inferred data type distribution across the different columns.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesInferredDataType" }, "count": { "type": "integer", "description": "The number of columns with the inferred data type.", "format": "int32" } } } }, "logical_type_distribution": { "type": "array", "description": "The logical data type distribution across the different columns.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesLogicalDataType" }, "count": { "type": "integer", "description": "The number of columns with the logical data type.", "format": "int32" } } } }, "class_distribution": { "type": "array", "description": "The data class distribution across the different columns.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesDataClassifier" }, "count": { "type": "integer", "description": "The number of columns with the data class.", "format": "int32" } } } }, "dataprofile_classification": { "type": "array", "description": "The dataprofile classification inferred for the data set based on the profiling result. They define the data set level classification.", "items": { "$ref": "#/components/schemas/DataProfilesDataProfileClassification" } } }, "description": "Summary of the profiling result for the whole data set." }, "DataProfilesDataProfileExecution": { "type": "object", "properties": { "status": { "type": "string", "description": "The current status of the profiling execution.", "readOnly": false, "enum": [ "none", "initiated", "attachment_creation_failed", "activity_creation_failed", "activity_run_creation_failed", "activity_failed_due_to_gateway", "profile_failed_due_to_gateway", "dataflow_creation_failed", "dataflow_run_creation_failed", "dataflow_failed_due_to_gateway", "submitted", "running", "finished", "finish_pending", "finished_with_errors", "error", "aborted", "cancelled", "activities_capacity_unit_exceeded", "empty_data_asset", "failed_to_submit_job", "failed_to_persist_results" ] }, "migration_status": { "description": "The state of migration from BG 1.0 to 3.0", "enum": [ "initiated", "running", "error", "finished" ] }, "activity_id": { "type": "string", "description": "The ID of the activity used for the profiling execution.", "readOnly": false }, "is_supported": { "type": "boolean", "description": "Whether data source is supported for profiling or not.", "readOnly": false }, "activity_run_id": { "type": "string", "description": "The ID of the activity run of the last or current profiling execution.", "readOnly": false }, "hb_task_id": { "type": "string", "description": "The ID of the job triggered by profiling service of the last or current profiling execution.", "readOnly": false }, "run_by": { "type": "string", "description": "The tenant id of the user that triggered the job. (Note that, this is work in progress, not yet supported.)", "readOnly": false }, "dataflow_id": { "type": "string", "description": "The ID of the dataflow used for the profiling execution.", "readOnly": false }, "dataflow_run_id": { "type": "string", "description": "The ID of the dataflow run of the last or current profiling execution.", "readOnly": false }, "error_message": { "type": "string", "description": "The error message that is identified before profiling is started.", "readOnly": false }, "create_time": { "type": "string", "description": "The timestamp when the profiling is requested (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339) " }, "completed_date": { "type": "string", "description": "The timestamp when the profiling is completed (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339) " } }, "description": "The execution details of a data profile." }, "DataProfilesDataProfileOptions": { "type": "object", "properties": { "profiling_type": { "type": "string", "description": "The type of profiling. The default is \"NORMAL\" profiling. If \"NORMAL\" is specified, the existing profiling analysis works as before. If \"ADVANCED\" is specified, a new profiling analysis works. It may take longer time, but the profiling result might become precise.", "enum": [ "NORMAL", "ADVANCED" ] }, "disable_profiling": { "type": "boolean", "description": "True to disable the profiling." }, "bivariate_statistics": { "type": "boolean", "description": "True to enable bivariate statistics as part of profiling." }, "min_row_count": { "type": "integer", "description": "The minimum number of rows to profile.", "format": "int64" }, "max_row_count": { "type": "integer", "description": "The maximum number of rows to profile. A missing or negative value indicates that the full set of rows must be profiled.", "format": "int64" }, "sample_type": { "type": "string", "description": "The sample type.", "enum": [ "SEQUENTIAL", "RANDOM" ] }, "sample_percent": { "type": "string", "description": "The sample percentage (to be used with Sample type)" }, "collect_data_values": { "type": "boolean", "description": "To manage more value distribution for SAL.", "default": false }, "data_values_size": { "type": "integer", "description": "The maximum size of the data values needed for SAL.", "format": "int32" }, "max_distribution_size": { "type": "integer", "description": "The maximum size of the various distributions produced by the profiling process. Default value is 100.", "format": "int32", "default": 100 }, "max_numeric_stats_bins": { "type": "integer", "description": "The maximum number of bins to use in the numerical statistics. Default value is 200.", "format": "int32" }, "max_columns_per_task": { "type": "integer", "description": "Maximum number of columns to be analyzed in parallel in the same task. If a table has more columns, the columns will be splits in groups of maximum that number of columns to avoid memory issues during the analysis. Default value 250.", "format": "int32" }, "max_rows_per_batch": { "type": "integer", "description": "Maximum number of rows to use in one batch. If the number of records to analyze is larger than this value, then the data will be split in multiple batches and is analyzed independently from each others. Default value 10000.", "format": "int32" }, "enable_fast_classification": { "type": "boolean", "description": "True to enable classification of the most frequent values only. Default value is false." }, "enable_dqa": { "type": "boolean", "description": "True to run data quality analysis. Default value is true." }, "dqa_dimensions": { "type": "string", "description": "comma separated list of the data quality dimensions (problem types) to use during the analysis. The IDs of the out of the box DQ dimensions are: BiasedValue,CaseViolation,DataClassViolation,DataTypeViolation,FormatViolation,MissingValue,NonStandardMissingValue,RuleViolation,SuspectClassifiedValue,SuspectCorrelatedValue,SuspectValues,UniquenessViolation,ValueRangeViolation" }, "nullability_threshold": { "type": "number", "description": "Maximum percentage (expressed as a number between 0.0 and 1.0) of missing values that a column can have before being considered as nullable. Default value is 0.05", "format": "double" }, "uniqueness_threshold": { "type": "number", "description": "Minimum percentage (expressed as a number between 0.0 and 1.0) of unique values that a column must have to be considered as expecting only unique values. Default value is 0.95", "format": "double" }, "data_classification_confidence_threshold": { "type": "number", "description": "Double (between 0.0 and 1.0) indicating the minimum confidence that data classes should have to be automatically inferred/selected. Default value is 0.75", "format": "double" }, "min_data_classification_confidence_threshold": { "type": "number", "description": "Double (between 0.0 and 1.0) indicating the minimum confidence that data classes should have to be suggested as candidates. Default value is 0.25", "format": "double" }, "target_connection_id": { "type": "string", "description": "IKC(IBM Knowledge Catalog) connection ID of the target database to which exception records are pushed" }, "target_catalog": { "type": "string", "description": "The name of catalog to which the schema of data quality exception table is created or availaed" }, "target_schema": { "type": "string", "description": "The name of schema in which data quality exceptions table is created or available" }, "target_table": { "type": "string", "description": "The name of table to which data quality exception are pushed" }, "target_records_table": { "type": "string", "description": "The name of table to which data quality exception records are pushed" }, "exceptions_count": { "type": "integer", "description": "The number of exceptions records to be persisted per issue of a column", "format": "int32" }, "classification_options": { "$ref": "#/components/schemas/DataProfilesClassificationOptions" }, "overriding_options": { "$ref": "#/components/schemas/DataProfilesOverridingOptions" }, "unique_value_table": { "$ref": "#/components/schemas/DataProfilesUniqueValueTable" }, "key_analysis_options": { "$ref": "#/components/schemas/DataProfilesKeyAnalysisOptions" } }, "description": "The options of the profiling execution." }, "DataProfilesColumnQualityAnalysisResults": { "required": [ "score" ], "type": "object", "properties": { "score": { "type": "integer", "description": "The overall quality score of the column. It is a number between 0 and 100.", "format": "int32" }, "score_stats": { "required": [ "mean", "n" ], "type": "object", "properties": { "n": { "type": "integer", "description": "The number of available column value quality scores.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the available column value quality scores.", "format": "double" }, "variance": { "type": "number", "description": "The variance of the available column value quality scores.", "format": "double" }, "stddev": { "type": "number", "description": "The standard deviation of the available column value quality scores.", "format": "double" }, "min": { "type": "number", "description": "The minimum of the available column value quality scores.", "format": "double" }, "max": { "type": "number", "description": "The maximum of the available column value quality scores.", "format": "double" }, "sum": { "type": "number", "description": "The sum of the available column value quality scores.", "format": "double" } }, "description": "Univariate statistics about the quality score of each column value." }, "problem_distribution": { "type": "array", "description": "The quality problem distribution across the different column values.\nDepending if the quality problem is looked for each individual column value or for the column as a whole,\nthe count/distinct_count or the confidence distribution attributes are specified.\n", "items": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "The value quality problem of a column." }, "count": { "type": "integer", "description": "The number of column values exhibiting the quality problem.", "format": "int64" }, "code_description": { "type": "string", "description": "The description of code." }, "prevalence": { "type": "number", "description": "The prevalence factor.", "format": "double" }, "distinct_count": { "type": "integer", "description": "The number of unique column values exhibiting the quality problem.", "format": "int64" }, "confidence": { "type": "number", "description": "The level of confidence (between 0 and 1) of the quality problem for the whole column.", "format": "double" } } } } }, "description": "The quality analyis results of a data set column." }, "DataProfilesColumnValuesAnalysisResults": { "type": "object", "properties": { "distinct_count": { "type": "integer", "description": "The number of non null and non empty distinct values found in the column.", "format": "int64" }, "null_count": { "type": "integer", "description": "The number of null values found in the column.", "format": "int64" }, "empty_count": { "type": "integer", "description": "The number of empty values found in the column. A value is considered as empty if value.toString().trim().length()==0.", "format": "int64" }, "unique_count": { "type": "integer", "description": "The number of non null and non empty unique value. A unique value is a value which only occurs once in the column.", "format": "int64" }, "max_value_frequency": { "type": "integer", "description": "The frequency of the most frequent value in the column.", "format": "int64" }, "min_string": { "type": "string", "description": "The minimum value of this column, using the string comparison order." }, "max_string": { "type": "string", "description": "The maximum value of this column, using the string comparison order." }, "min_number": { "type": "number", "description": "The minimum numeric value or minimum string value that could be parsed as a number, using the numeric comparison order.", "format": "double" }, "max_number": { "type": "number", "description": "The maximum numeric value or maximum string value that could be parsed as a number, using the numeric comparison order.", "format": "double" }, "max_integer_length": { "type": "integer", "description": "The length of the longest integer or 0 if the column did not contain any.", "format": "int32" }, "min_date": { "type": "string", "description": "The minimum date value or minimum string value that could be parsed as a date, using the date comparison order," }, "max_date": { "type": "string", "description": "The maximum date value or maximum string value that could be parsed as a date, using the date comparison order." }, "inferred_type": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataProfilesInferredColumnType" } }, "description": "The column data type inferred by the profiling process." }, "inferred_class": { "required": [ "class" ], "type": "object", "properties": { "class": { "$ref": "#/components/schemas/DataProfilesDataClassifier" }, "confidence": { "type": "number", "description": "The level of confidence (between 0 and 1) that the data class is a match for the column.", "format": "double" }, "priority": { "type": "integer", "description": "The priority of the inferred data class (see the data class definition for more details).", "format": "int32" } }, "description": "The column data class inferred by the profiling process." }, "inferred_format": { "required": [ "format" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/DataProfilesInferredColumnFormat" } }, "description": "The column format inferred by the profiling process." }, "value_distribution": { "type": "array", "description": "The distinct value distribution for the column.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "the distinct column value." }, "count": { "type": "integer", "description": "The number of column values matching the distinct value.", "format": "int64" } } } }, "value_problem_distribution": { "type": "array", "description": "The distinct value problem distribution for the column.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "the distinct column violation value." }, "count": { "type": "integer", "description": "The number of column values violating with the distinct value.", "format": "int64" } } } }, "class_distribution": { "type": "array", "description": "The inferred data class distribution across the various column values.\nDepending if the data class candidate is looked for each individual column value or for the column as a whole,\nthe count or the confidence distribution attributes are specified.\n", "items": { "required": [ "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesDataClassifier" }, "count": { "type": "integer", "description": "The number of column values matching the data class.", "format": "int64" }, "confidence": { "type": "number", "description": "The level of confidence (between 0 and 1) that the data class is a match for the whole column.", "format": "double" }, "priority": { "type": "integer", "description": "The priority of data class (see the data class definition for more details).", "format": "int32" } } } }, "type_distribution": { "type": "array", "description": "The inferred data type distribution across the different column values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesInferredColumnType" }, "count": { "type": "integer", "description": "The number of column values matching the data type.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values matching the data type.", "format": "int64" } } } }, "logical_type_distribution": { "type": "array", "description": "The logical data type distribution across the different column values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesLogicalDataType" }, "count": { "type": "integer", "description": "The number of column values matching the logical data type.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values matching the logical data type.", "format": "int64" } } } }, "format_distribution": { "type": "array", "description": "The format distribution across the different column values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesInferredColumnFormat" }, "count": { "type": "integer", "description": "The number of column values matching the format.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values matching the format.", "format": "int64" } } } }, "bigram_distribution": { "type": "array", "description": "The bigram (sequence of two adjacent letters) distribution across the different column values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "The bigram value." }, "count": { "type": "integer", "description": "The number of column values containing the bigram.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values containing the bigram.", "format": "int64" } } } }, "length_distribution": { "type": "array", "description": "The length distribution across the different column values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "integer", "description": "The length of the column value.", "format": "int32" }, "count": { "type": "integer", "description": "The number of column values with the length.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values with the length.", "format": "int64" } } } }, "precision_distribution": { "type": "array", "description": "The precision distribution across the different column values. Relevant only for numeric values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "integer", "description": "The precision of the column value.", "format": "int32" }, "count": { "type": "integer", "description": "The number of column values with the precision.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values with the precision.", "format": "int64" } } } }, "scale_distribution": { "type": "array", "description": "The scale distribution across the different column values. Relevant only for numeric values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "integer", "description": "The scale of the column value.", "format": "int32" }, "count": { "type": "integer", "description": "The number of column values with the scale.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values with the scale.", "format": "int64" } } } }, "case_distribution": { "type": "array", "description": "The string case distribution across the different column values.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "$ref": "#/components/schemas/DataProfilesStringCase" }, "count": { "type": "integer", "description": "The number of column values matching the string case.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values matching the string case.", "format": "int64" } } } }, "word_distribution": { "type": "array", "description": "The word distribution across the different column values. A word is a part of a value which is only made up of letters and is separated from other characters by either a space, a digit or a special character.", "items": { "required": [ "count", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "The word value." }, "count": { "type": "integer", "description": "The number of column values containing the word.", "format": "int64" }, "distinct_count": { "type": "integer", "description": "The number of unique column values containing the word.", "format": "int64" } } } }, "numeric_stats": { "required": [ "count", "mean" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of column values that could be inferred as a number.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the column values that could be inferred as a number.", "format": "double" }, "variance": { "type": "number", "description": "The variance of the column values that could be inferred as a number.", "format": "double" }, "bins": { "type": "array", "description": "The numeric value distribution grouped by bins.", "items": { "required": [ "count", "max", "mean", "min" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of values in the bin.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the bin values.", "format": "double" }, "min": { "type": "number", "description": "The minimum value in the bin.", "format": "double" }, "max": { "type": "number", "description": "The maximum value in the bin.", "format": "double" } } } } }, "description": "The statistics about the distribution of the column values which could be inferred as a number" }, "word_stats": { "required": [ "mean", "n" ], "type": "object", "properties": { "n": { "type": "integer", "description": "The number of column values that have been examined.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the number of words in each column value.", "format": "double" }, "variance": { "type": "number", "description": "The variance of the number of words in each column value.", "format": "double" }, "stddev": { "type": "number", "description": "The standard deviation of the number of words in each column value.", "format": "double" }, "min": { "type": "number", "description": "The minimum of the number of words in each column value.", "format": "double" }, "max": { "type": "number", "description": "The maximum of the number of words in each column value.", "format": "double" }, "sum": { "type": "number", "description": "The sum of the number of words in each column value.", "format": "double" } }, "description": "Univariate statistics about the number of words in each column value. A word is a part of a value which is only made up of letters and is separated from other characters by either a space, a digit or a special character." }, "alpha_chatacter_stats": { "required": [ "mean", "n" ], "type": "object", "properties": { "n": { "type": "integer", "description": "The number of column values that have been examined.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the percentage of letters in each column value.", "format": "double" }, "variance": { "type": "number", "description": "The variance of the percentage of letters in each column value.", "format": "double" }, "stddev": { "type": "number", "description": "The standard deviation of the percentage of letters in each column value.", "format": "double" }, "min": { "type": "number", "description": "The minimum of the percentage of letters in each column value.", "format": "double" }, "max": { "type": "number", "description": "The maximum of the percentage of letters in each column value.", "format": "double" }, "sum": { "type": "number", "description": "The sum of the percentage of letters in each column value.", "format": "double" } }, "description": "Univariate statistics about the percentage of letters in each column value." }, "digit_chatacter_stats": { "required": [ "mean", "n" ], "type": "object", "properties": { "n": { "type": "integer", "description": "The number of column values that have been examined.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the percentage of digits in each column value.", "format": "double" }, "variance": { "type": "number", "description": "The variance of the percentage of digits in each column value.", "format": "double" }, "stddev": { "type": "number", "description": "The standard deviation of the percentage of digits in each column value.", "format": "double" }, "min": { "type": "number", "description": "The minimum of the percentage of digits in each column value.", "format": "double" }, "max": { "type": "number", "description": "The maximum of the percentage of digits in each column value.", "format": "double" }, "sum": { "type": "number", "description": "The sum of the percentage of digits in each column value.", "format": "double" } }, "description": "Univariate statistics about the percentage of digits in each column value." }, "other_chatacter_stats": { "required": [ "mean", "n" ], "type": "object", "properties": { "n": { "type": "integer", "description": "The number of column values that have been examined.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of the percentage of other characters in each column value.", "format": "double" }, "variance": { "type": "number", "description": "The variance of the percentage of other characters in each column value.", "format": "double" }, "stddev": { "type": "number", "description": "The standard deviation of the percentage of other characters in each column value.", "format": "double" }, "min": { "type": "number", "description": "The minimum of the percentage of other characters in each column value.", "format": "double" }, "max": { "type": "number", "description": "The maximum of the percentage of other characters in each column value.", "format": "double" }, "sum": { "type": "number", "description": "The sum of the percentage of other characters in each column value.", "format": "double" } }, "description": "Univariate statistics about the percentage of other characters (non letter and non digit) in each column value." }, "length_stats": { "required": [ "mean", "n" ], "type": "object", "properties": { "n": { "type": "integer", "description": "The number of column values that have been examined.", "format": "int64" }, "mean": { "type": "number", "description": "The arithmetic mean of each column value length.", "format": "double" }, "variance": { "type": "number", "description": "The variance of each column value length.", "format": "double" }, "stddev": { "type": "number", "description": "The standard deviation of each column value length.", "format": "double" }, "min": { "type": "number", "description": "The minimum of each column value length.", "format": "double" }, "max": { "type": "number", "description": "The maximum of each column value length.", "format": "double" }, "sum": { "type": "number", "description": "The sum of each column value length.", "format": "double" } }, "description": "Univariate statistics about the length of each column value." }, "date_stats": { "required": [ "count", "mean" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of column values that could be inferred as a date.", "format": "int64" }, "mean": { "type": "string", "description": "The arithmetic mean of the column values that could be inferred as a date.", "format": "date" }, "variance": { "type": "number", "description": "The variance of the column values that could be inferred as a date.", "format": "double" }, "bins": { "type": "array", "description": "The date value distribution grouped by bins.", "items": { "required": [ "count", "max", "mean", "min" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of values in the bin.", "format": "int64" }, "mean": { "type": "string", "description": "The arithmetic mean of the bin values.", "format": "date" }, "min": { "type": "string", "description": "The minimum value in the bin.", "format": "date" }, "max": { "type": "string", "description": "The maximum value in the bin.", "format": "date" } } } } }, "description": "The statistics about the distribution of the column values which could be inferred as a date" }, "min_hash_signature": { "required": [ "min_hash_values", "signature_id" ], "type": "object", "properties": { "signature_id": { "type": "integer", "description": "The ID of the signature characterized by the hash functions used to compute it.", "format": "int64" }, "min_hash_values": { "type": "array", "description": "The min hash values building up the signature.", "items": { "type": "integer", "format": "int32" } } }, "description": "The MinHash signature is a signature that can be computed for each column and whose similarity to another signature from another column is an estimation of the Jaccard coefficient between the two tables (nb of values contained in both columns / nb of values contained in any of the both columns) (A intersect B / a union B)" } }, "description": "The values analysis results of a data set column." }, "DataProfilesInferredColumnFormat": { "type": "object", "properties": { "value": { "type": "string", "description": "The column format." } }, "description": "The column format as inferred by the profiling process. A column format is a string matching the column values where all uppercase letters are replaced by A, lowercase by a, ideographic characters by a I, digits by 9 and other chars remain unchanged." }, "DataProfilesDataClassifier": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code (ID) of the data class. For example, “PAN” for passport number or “SSN4” for last 4 digits of US social security number." }, "name": { "type": "string", "description": "The english name of the data class. For example “Passport Number” for PAN or “US Social Security Number Last 4” for SSN4. Localized names must be computed locally by the caller." }, "transient": { "type": "boolean", "description": "If set to true, the overwritten class will be removed during next profile run. Applicable to class code U only." } }, "description": "Reference to an existing data class." }, "DataProfilesInferredColumnType": { "required": [ "type" ], "type": "object", "properties": { "length": { "type": "integer", "description": "The column length.", "format": "int32", "default": 0 }, "precision": { "type": "integer", "description": "The column precision. Relevant for numeric values only.", "format": "int32", "default": 0 }, "scale": { "type": "integer", "description": "The column scale. Relevant for numeric values only.", "format": "int32", "default": 0 }, "type": { "$ref": "#/components/schemas/DataProfilesInferredDataType" }, "display_name": { "type": "string", "description": "Display name of the column type." } }, "description": "A column type definition as inferred by the profiling process." }, "DataProfilesOriginalColumnType": { "required": [ "type" ], "type": "object", "properties": { "length": { "type": "integer", "description": "The column length.", "format": "int32", "default": 0 }, "nullable": { "type": "boolean", "description": "Indicates whether the values in the column can be null or not.", "default": false }, "scale": { "type": "integer", "description": "The column scale.", "format": "int32", "default": 0 }, "type": { "$ref": "#/components/schemas/DataProfilesOriginalDataType" } }, "description": "A column type definition as defined in the source." }, "DataProfilesDataProfileClassification": { "required": [ "global_id", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the business classification." }, "name": { "type": "string", "description": "The business classification name/value." }, "global_id": { "type": "string", "description": "The unique ID of business classification introduced by BG to support IGC Classses." } }, "description": "Reference to an existing business classification." }, "DataProfilesLogicalDataType": { "type": "string", "description": "The logical data type of a column.", "enum": [ "UNKNOWN", "NUMERIC", "STRING", "DATE", "TIME", "TIMESTAMP" ] }, "DataProfilesInferredDataType": { "type": "string", "description": "The inferred data type of a column.", "enum": [ "UNKNOWN", "INT8", "INT16", "INT32", "INT64", "DECIMAL", "DATE", "STRING", "TIME", "TIMESTAMP" ] }, "DataProfilesKeyAnalysisOptions": { "type": "object", "properties": { "analysis_id": { "type": "string", "description": "The ID of the key analysis" }, "min_confidence": { "maximum": 1, "minimum": 0, "type": "number", "description": "Defines the minimum confidence for a column to be suggested as primary key", "format": "double", "example": 0 } }, "description": "options for key analysis configuration" }, "DataProfilesUniqueValueTable": { "type": "object", "properties": { "location": { "$ref": "#/components/schemas/DataProfilesUniqueValueTableLocation" }, "count": { "type": "integer", "description": "It is the maximum number of stored records on the unique database. If it is null, all values are stored.", "format": "int32", "example": 1000 } }, "description": "the information of frequency distribution results table" }, "DataProfilesOverridingOptions": { "type": "object", "properties": { "columns": { "type": "array", "description": "Collection of DataProfileColumns", "items": { "$ref": "#/components/schemas/DataProfilesDataProfileColumn" } } }, "description": "Overriding columns related options of the profiling execution." }, "DataProfilesClassificationOptions": { "type": "object", "properties": { "disabled": { "type": "boolean", "description": "True to disable the classification options and use the defaults." }, "use_all_ibm_classes": { "type": "boolean", "description": "True to use all the IBM classifiers, when false use the ones specified in ibm_class_codes." }, "use_all_custom_classes": { "type": "boolean", "description": "True to use all the custom classifiers, when false use the ones specified in custom_class_codes." }, "ibm_class_codes": { "type": "array", "description": "The IBM specific data class code to consider during profiling. Valid data class code can be obtained through the data class service.", "items": { "type": "string" } }, "custom_class_codes": { "type": "array", "description": "The custom data class code to consider during profiling.", "items": { "type": "string" } }, "class_categories": { "type": "array", "description": "The list of categories from which all data classes should be considred for profiling.", "items": { "type": "string" } }, "data_classes_location": { "type": "string", "description": "The location where data classes XML is saved" } }, "description": "Classification related options of the profiling execution." }, "DataProfilesStringCase": { "type": "string", "description": "The string case of a column.", "enum": [ "AnyCase", "UpperCase", "LowerCase", "NameCase", "SentenceCase" ] }, "DataProfilesUniqueValueTableLocation": { "type": "object", "properties": { "connection_id": { "type": "string", "description": "the connection Id", "example": "4bcbc092-3ec6-4a44-a976-56d4a9171a71" }, "schema_name": { "type": "string", "description": "schema name", "example": "DB2INST1" }, "table_name": { "type": "string", "description": "table name", "example": "SALES" }, "catalog_name": { "type": "string", "description": "catalog name", "example": "DEFAULT" } }, "description": "the path of frequency distribution results table" }, "DataProfilesBulkAssetsUpdateResponse": { "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesBulkAssetsUpdateResponseEntry" } }, "trace": { "type": "string", "description": "Trace key associated with the current request" } }, "description": "Contains updates to more than one asset via a POST request, as specified by the JSON patch format in RFC 6902" }, "DataProfilesBulkAssetsUpdateRequest": { "type": "array", "description": "Contains updates to more than one asset via a POST request, as specified by the JSON patch format in RFC 6902", "items": { "$ref": "#/components/schemas/DataProfilesBulkAssetsUpdateRequestEntry" } }, "DataProfilesBulkAssetsUpdateResponseEntry": { "type": "object", "properties": { "asset_id": { "type": "string", "description": "The ID of the profile asset." }, "data_profile": { "$ref": "#/components/schemas/DataProfilesBulkResponseDataProfile" }, "status": { "type": "integer", "description": "The asset update status.", "format": "int32" }, "errors": { "type": "array", "description": "Errors occurred", "items": { "$ref": "#/components/schemas/DataProfilesErrorModel1" } } }, "description": "Contains respone details for one asset in a bulk assets update response, as specified by the JSON patch format in RFC 6902" }, "DataProfilesBulkAssetsUpdateRequestEntry": { "type": "object", "properties": { "asset_id": { "type": "string", "description": "The ID of the profile asset" }, "operations": { "$ref": "#/components/schemas/JSONResourcePatchRequestModel" } }, "description": "contains the collection of updates for a profiled asset." }, "DataProfilesBulkResponseDataProfile": { "type": "object", "properties": { "attribute_classes": { "type": "array", "description": "The attribute classes found in this data asset.", "items": { "type": "string" } }, "attribute_classification_manual": { "type": "array", "description": "The data profile details for a profile asset.", "items": { "$ref": "#/components/schemas/DataProfilesAttributeClassificationManual" } }, "column_info": { "type": "object", "description": "column info" } }, "description": "Contains respone details for one asset in a bulk assets update response, as specified by the JSON patch format in RFC 6902" }, "DataProfilesAttributeClassificationManual": { "required": [ "name", "overwritten_class" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the column." }, "transformed": { "type": "boolean", "description": "Whether this column is transformed or not by policy enforcement." }, "overwritten_class": { "properties": { "class": { "$ref": "#/components/schemas/DataProfilesDataClassifier" } }, "description": "The manually overwritten column data class." } }, "description": "Attribute classification manual override" }, "DataProfilesDataProfileRunStatusRequest": { "type": "object", "properties": { "action": { "type": "string", "description": "The requested action (Response only).", "enum": [ "stop", "stop_all" ] } }, "description": "The requested action to perform on an profile run." }, "DataProfilesDataProfileJobLogEntryCollection": { "type": "object", "properties": { "logs": { "type": "array", "description": "A collection of data profile job run log entries.", "items": { "$ref": "#/components/schemas/DataProfilesDataProfileJobLogEntry" } } }, "description": "A collection of data profile job run log entries." }, "DataProfilesDataQualityDimensionCollection": { "type": "object", "properties": { "dimensions": { "type": "array", "description": "A collection of data quality dimensions.", "items": { "$ref": "#/components/schemas/DataProfilesDataQualityDimension" } } }, "description": "A collection of data quality dimensions." }, "DataProfilesDataQualityDimension": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The dimension id." }, "name": { "type": "string", "description": "The display name of data quality check." }, "description": { "type": "string", "description": "The description of the data quality check." }, "asset_id": { "type": "string", "description": "The uuid of the data quality check asset." }, "dimension": { "type": "string", "description": "The name of the dimension this check contributes." } }, "description": "Data quality dimension for quality analysis." }, "DataProfilesCommonCustomObject": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Custom data to be associated with a given object" }, "DataProfilesDataProfileOptionsObject": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/DataProfilesDataProfileOptionsMetadata" }, "entity": { "required": [ "data_profile_options" ], "type": "object", "properties": { "data_profile_options": { "$ref": "#/components/schemas/DataProfilesDataProfileOptions" } }, "description": "The underlying asset entity." } }, "description": "Definition of a data profile options." }, "DataProfilesDataProfileOptionsMetadata": { "required": [ "account_id" ], "type": "object", "properties": { "asset_id": { "type": "string", "description": "The ID of the data profile options (Response only)" }, "account_id": { "type": "string", "description": "The ID of the account which contains the data profile options." }, "project_id": { "type": "string", "description": "The ID of the project to use." }, "catalog_id": { "type": "string", "description": "The ID of the catalog to use." }, "created_at": { "type": "string", "description": "The timestamp when the asset was created (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339) (Response only)", "format": "date-time" }, "creator": { "type": "string", "description": "The user ID that created the asset (Response only)" }, "accessed_at": { "type": "string", "description": "The timestamp when the asset was last accessed (in format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ, matching the date-time format as specified by RFC 3339) (Response only)", "format": "date-time" }, "last_updater": { "type": "string", "description": "The user ID that last updated the class (Response only)" } }, "description": "Metadata about data profile options" }, "DataProfilesProfilingResults": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Custom data to be associated with a given object" }, "DataProfilesDataProfileResultStatus": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "The data profile status." } }, "description": "The data profile result status to update." }, "DataProfilesBivariateResults": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Bivariate results to be associated with given asset." }, "DataProfilesDataProfileExport": { "required": [ "file_paths" ], "properties": { "file_paths": { "type": "array", "description": "List of file paths that hold the profiling results. These files should be added to the project export archive.", "items": { "type": "string" } } } }, "DataProfilesDataProfileImport": { "properties": { "source_path": { "type": "string", "description": "Source path where the import archive is deflated. If this value is provided, the profiling results are read from source_path/assets/profiling directory by setting the root=true. If this value is not provided, results files are read from profiling directory by setting the root=false." }, "asset_ref_map": { "$ref": "#/components/schemas/DataProfilesDataProfileImportAssetRefMap" }, "owner_id": { "maxLength": 100, "minLength": 1, "type": "string", "description": "IBM cloud IAM user id of the creator of the asset.", "example": "IBMid-270002ABCD" } } }, "DataProfilesDataProfileImportAssetRefMap": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Map of the old asset ids to new asset ids" }, "DataProfilesFrequencyDistributionResults": { "type": "object", "properties": { "total_count": { "type": "integer", "format": "int32", "example": 120 }, "unique_values": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesFrequencyDistributionResult" } } }, "description": "list of frequency distribution result of the column" }, "DataProfilesFrequencyDistributionRequestBody": { "required": [ "column_name", "dataset_id" ], "type": "object", "properties": { "project_id": { "type": "string", "example": "project_id" }, "catalog_id": { "type": "string", "example": "catalog_id" }, "dataset_id": { "type": "string", "example": "dataset_id" }, "column_name": { "type": "string", "example": "col1" }, "get_total_count": { "type": "boolean", "default": false }, "value_after": { "type": "string", "example": "some_value" }, "count_after": { "type": "integer", "format": "int32", "example": 10 }, "format_after": { "type": "string", "example": "AAA" }, "offset": { "type": "integer", "format": "int32", "example": 100 }, "limit": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32", "example": 100 }, "type": { "type": "string", "example": "INT8" }, "length": { "type": "integer", "format": "int32", "example": 10 }, "scale": { "type": "integer", "format": "int32", "example": 5 }, "precision": { "type": "integer", "format": "int32", "example": 2 }, "format": { "type": "string", "example": "AAA" }, "data_class": { "type": "string", "example": "U" }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesFrequencyDistributionRequestBodySort" } }, "search": { "type": "array", "items": { "$ref": "#/components/schemas/DataProfilesFrequencyDistributionRequestBodySearch" } } }, "description": "filters to get frequency distribution" }, "DataProfilesFrequencyDistributionResult": { "type": "object", "properties": { "invalid_reason_code": { "type": "string" }, "value": { "type": "string", "example": "sample" }, "format": { "type": "string", "example": "AAAAA" }, "percent": { "type": "number", "example": 0 }, "count": { "type": "integer", "format": "int32", "example": 3 }, "data_classes": { "type": "array", "example": "[\"U\",\"data class name\",\"3361256e-510a-48bc-a271-4c0065585796_d985497f-752b-4156-b068-0b8045d1a3c7\"]", "items": { "type": "string" } }, "type": { "$ref": "#/components/schemas/DataProfilesFrequencyDistributionResultType" }, "validity": { "type": "string", "example": "v" } }, "description": "frequency distribution result" }, "DataProfilesFrequencyDistributionRequestBodySearch": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "value" ] }, "value": { "type": "string", "example": "some_value" } } }, "DataProfilesFrequencyDistributionRequestBodySort": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "value", "count", "format" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] } } }, "DataProfilesFrequencyDistributionResultType": { "type": "object", "properties": { "length": { "type": "integer", "format": "int32", "example": 3 }, "scale": { "type": "integer", "format": "int32", "example": 5 }, "precision": { "type": "integer", "format": "int32", "example": 2 }, "type": { "type": "string", "example": "DECIMAL" }, "display_name": { "type": "string", "example": "decimal(5,3)" } }, "description": "frequency distribution type result" }, "DataProfilesMigrationResponseLogs": { "properties": { "logs": { "type": "array", "items": { "type": "string" } } }, "description": "Migration status logging to track progress." }, "DataProfilesHbTaskResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the task" }, "account_id": { "type": "string", "description": "The ID of the account" }, "free_account_plan": { "type": "boolean", "description": "Indicates if account plan is free plan" }, "job_type": { "type": "string", "description": "Type of the job" }, "job_payload": { "type": "string", "description": "The job payload" }, "correlation_id": { "type": "string", "description": "The id to track complete flow" }, "priority": { "type": "integer", "description": "Priority of the HB job", "format": "int32", "default": 1 }, "job_id": { "type": "string", "description": "The ID of the HB job" }, "create_time": { "type": "string", "description": "Timestamp of task creation", "format": "date-time" }, "job_submission_time": { "type": "string", "description": "Timestamp of job submission", "format": "date-time" }, "job_end_time": { "type": "string", "description": "Timestamp of job completion", "format": "date-time" }, "job_execution_time": { "type": "integer", "description": "The duration for which job was run", "format": "int64" }, "retry_count": { "type": "integer", "description": "The number of times the job was retried", "format": "int32" }, "status": { "type": "string", "description": "Status of the HB job", "enum": [ "REQUESTED", "SUBMITTED", "RUNNING", "COMPLETED", "ERROR", "STOPPED", "STOPPED_CAPACITY_UNIT_EXCEEDED", "QUEUED" ] }, "project_id_for_logs": { "type": "string", "description": "The ID of the project where the spark job logs need to be saved. If this value is not provided or is invalid then the spark job logs will be stored in default COS bucket." }, "runtime_registration_parameters": { "$ref": "#/components/schemas/DataProfilesRuntimeRegistrationParameters" }, "compute_units": { "$ref": "#/components/schemas/DataProfilesComputeUnits" } }, "description": "An HbTaskResponse holds details about Hummingbird job and the status of task in queue." }, "DataProfilesHbTaskRequest": { "required": [ "account_id", "free_account_plan", "job_payload", "job_type" ], "type": "object", "properties": { "account_id": { "type": "string", "description": "The ID of the account" }, "free_account_plan": { "type": "boolean", "description": "Indicates if account plan is free plan" }, "job_type": { "type": "string", "description": "Type of the job" }, "job_payload": { "type": "string", "description": "The job payload" }, "correlation_id": { "type": "string", "description": "The id to track complete flow" }, "status": { "type": "string", "description": "Status of the HB job", "default": "REQUESTED", "enum": [ "REQUESTED", "QUEUED" ] }, "priority": { "type": "integer", "description": "Priority of the HB job", "format": "int32", "default": 1 }, "project_id_for_logs": { "type": "string", "description": "The ID of the project where the spark job logs need to be saved. If this value is not provided or is invalid then the spark job logs will be stored in default COS bucket." }, "runtime_registration_parameters": { "$ref": "#/components/schemas/DataProfilesRuntimeRegistrationParameters" }, "compute_units": { "$ref": "#/components/schemas/DataProfilesComputeUnits" } }, "description": "An HbTaskRequest holds details about Hummingbird job." }, "DataProfilesHbTaskResponseCollection": { "type": "array", "description": "Collection of HB tasks.", "items": { "$ref": "#/components/schemas/DataProfilesHbTaskResponse" } }, "DataProfilesComputeUnits": { "required": [ "max_compute_units_per_month", "notify_on_max_compute_units", "stop_on_max_compute_units" ], "type": "object", "properties": { "stop_on_max_compute_units": { "type": "boolean", "description": "Stop job submission if an account has surpassed its allocated CUH" }, "notify_on_max_compute_units": { "type": "boolean", "description": "Send a notification if an account has surpassed its allocated CUH" }, "max_compute_units_per_month": { "type": "number", "description": "Maximum allocated CUH per month for current account plan", "format": "double" } }, "description": "A ComputeUnits holds details to determine if a particular account has surpassed its CUH." }, "DataProfilesRuntimeRegistrationParameters": { "required": [ "environment_type", "instance", "service_offering", "tool_name" ], "type": "object", "properties": { "environment_type": { "type": "string", "description": "Type of of the component" }, "tool_name": { "type": "string", "description": "Tool name of the component" }, "service_offering": { "type": "string", "description": "Service offering name e.g. watson_knowledge_catalog" }, "instance": { "type": "string", "description": "The id of the instance the CUH needs to be charged to. e.g. an id of the wkc instance" }, "capacity_units": { "type": "integer", "description": "Capacity units multiplication factor", "format": "int32" }, "minimum_usage": { "type": "integer", "description": "Minimum usage in milliseconds to be charged for this job", "format": "int64" }, "hardware_specification": { "$ref": "#/components/schemas/DataProfilesHardwareSpecification" } }, "description": "A RuntimeRegistrationParameters holds details to be sent to runtimes api to report CUH for HB job." }, "DataProfilesHardwareSpecification": { "required": [ "free", "mem", "num_cpu" ], "type": "object", "properties": { "free": { "type": "boolean", "description": "If set to true, no usage will be reported for this job" }, "num_cpu": { "type": "string", "description": "Number of CPUs used for this job" }, "mem": { "type": "string", "description": "Memory being used by this job" } }, "description": "If capacity_units is not provided then this can be used to alter the multiplication factor by the runtimes api." }, "DataProfilesStopHbTasksResponse": { "type": "object", "properties": { "already_completed_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that were already completed. These Hummingbird tasks will be ignored.", "items": { "type": "string" } }, "missing_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that were not found. These Hummingbird tasks will be ignored.", "items": { "type": "string" } }, "stopped_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that were actually stopped", "items": { "type": "string" } }, "locked_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that were locked by other process.", "items": { "type": "string" } } }, "description": "A StopHbTasksResponse holds details about stop Hummingbird tasks response." }, "DataProfilesHbTaskIds": { "required": [ "hb_task_ids" ], "type": "object", "properties": { "hb_task_ids": { "type": "array", "description": "The array of hb_task_id to use during bulk processing", "items": { "type": "string" } } }, "description": "A HbTaskIds holds an array of hb_task_id." }, "DataProfilesDeleteHbTasksResponse": { "type": "object", "properties": { "deleted_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that were deleted.", "items": { "type": "string" } }, "missing_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that were not found. These Hummingbird tasks will be ignored.", "items": { "type": "string" } }, "running_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that are running", "items": { "type": "string" } }, "locked_hb_task_ids": { "type": "array", "description": "The array of hb_task_id that were locked by other process.", "items": { "type": "string" } } }, "description": "A StopHbTasksResponse holds details about stop Hummingbird tasks response." }, "DataQualityWWWAuthenticate": { "type": "string", "description": "The authentication scheme.", "example": "bearer", "default": "bearer", "enum": [ "bearer" ] }, "DataQualityAsset": { "required": [ "children", "created_at", "creator_id", "id", "name", "native_id", "type", "weight" ], "allOf": [ { "type": "object", "properties": { "parent": { "description": "The Id of an eventual parent, or null if this asset has no parent", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetIdentityById" } ] }, "name": { "example": "CUSTOMERS", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "native_id": { "example": "4cdcd382-4e3a-4537-b7ae-09993acee4cf/6835c729-8d79-4b12-b02d-c82a20ac00a6", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] }, "wkc_asset_type": { "$ref": "#/components/schemas/DataQualityWkcAssetType" }, "wkc_asset_id": { "description": "The identity of the IBM Knowledge Catalog asset this Asset is referring", "allOf": [ { "$ref": "#/components/schemas/DataQualityIdentity" } ] }, "wkc_container_id": { "description": "The identity of the IBM Knowledge Catalog container (either project/catalog/space) this asset belongs to.", "allOf": [ { "$ref": "#/components/schemas/DataQualityIdentity" } ] }, "virtualized_asset": { "description": "If specified, indicates that this asset is the virtualization of another asset whose id is specified in this field", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetIdentityById" } ] }, "type": { "example": "data_asset", "allOf": [ { "$ref": "#/components/schemas/DataQualityTypeIdentity" } ] }, "link": { "$ref": "#/components/schemas/DataQualityLink" }, "weight": { "maximum": 1, "minimum": 0, "type": "number", "description": "The weight of this asset in the computation of the data quality scores", "format": "double" }, "children": { "maxItems": 100000, "minItems": 0, "type": "array", "description": "Eventual children of this asset. If omitted, no children for this asset.", "items": { "$ref": "#/components/schemas/DataQualityAsset" } } }, "description": "A data asset on which data quality is measured." } ] }, "DataQualityContentLocation": { "maxLength": 512, "minLength": 1, "type": "string", "description": "The URL of a resource", "format": "url", "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" }, "DataQualityAssetPrototype": { "required": [ "name", "native_id", "type", "weight" ], "type": "object", "properties": { "name": { "example": "CUSTOMERS", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "parent": { "description": "The Id of an eventual parent, or null if this asset has no parent", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetIdentity" } ] }, "native_id": { "example": "4cdcd382-4e3a-4537-b7ae-09993acee4cf/6835c729-8d79-4b12-b02d-c82a20ac00a6", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] }, "wkc_asset_type": { "$ref": "#/components/schemas/DataQualityWkcAssetType" }, "wkc_asset_id": { "description": "The identity of the IBM Knowledge Catalog asset this Asset is referring", "allOf": [ { "$ref": "#/components/schemas/DataQualityIdentity" } ] }, "wkc_container_id": { "description": "The identity of the IBM Knowledge Catalog container (either project/catalog/space) this asset belongs to.", "allOf": [ { "$ref": "#/components/schemas/DataQualityIdentity" } ] }, "virtualized_asset": { "description": "If specified, indicates that this asset is the virtualization of another asset whose id is specified in this field", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetIdentity" } ] }, "type": { "example": "data_asset", "allOf": [ { "$ref": "#/components/schemas/DataQualityTypeIdentity" } ] }, "link": { "$ref": "#/components/schemas/DataQualityLink" }, "weight": { "type": "number", "description": "The weight of this asset in the computation of the data quality scores", "format": "double", "example": 0 } }, "description": "A data asset on which data quality is measured." }, "DataQualityAssetCollection": { "required": [ "assets", "first", "limit", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "assets": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality assets.", "items": { "$ref": "#/components/schemas/DataQualityAsset" } } }, "description": "A collection of data quality assets." }, "DataQualityLink": { "maxLength": 500, "minLength": 1, "type": "string", "description": "Link to corresponding data quality component. No default link is available, it is empty if not provided.", "example": "/v2/assets/f0d42bb9-55b5-4ec8-aca5-f77e42978a86?project_id=08716e38-1a1b-4e0e-9533-c2b419063223" }, "DataQualityTypeIdentity": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The type of the data quality resource" }, "DataQualityAssetIdentityById": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a data quality asset." }, "DataQualityIdentity": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Resource identifier.", "format": "identifier", "example": "b1ba1d22-71a7-4adf-99b2-3c8ba19497f5" }, "DataQualityWkcAssetType": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The type of the IBM Knowledge Catalog asset", "example": "DataSet" }, "DataQualityNativeIdentity": { "maxLength": 500, "minLength": 1, "type": "string", "description": "Unique identifier set by the creator of the resource", "format": "identifier" }, "DataQualityDQResourceName": { "maxLength": 200, "minLength": 1, "type": "string", "description": "Name of a data quality resource.(Name need not be unique)" }, "DataQualityAssetIdentity": { "oneOf": [ { "$ref": "#/components/schemas/DataQualityAssetIdentityByNativeId" } ] }, "DataQualityPageLinkToken": { "required": [ "href", "start" ], "type": "object", "properties": { "href": { "maxLength": 512, "minLength": 1, "type": "string", "description": "The location URL to retrieve the collection page.", "format": "url", "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules?limit=200&start=g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWhoaGIGkOWDSyBJZAO9qD40" }, "start": { "$ref": "#/components/schemas/DataQualityStart" } }, "description": "The link to a page in paginated collection." }, "DataQualityPageLink": { "required": [ "href" ], "type": "object", "properties": { "href": { "maxLength": 512, "minLength": 1, "type": "string", "description": "The location URL to retrieve the collection page.", "format": "url", "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules?limit=200" } }, "description": "The link to a page in paginated collection." }, "DataQualityLimit": { "maximum": 200, "minimum": 1, "type": "integer", "description": "The maximum number of resources to return.", "format": "int32", "example": 20, "default": 200 }, "DataQualityStart": { "maxLength": 512, "minLength": 1, "type": "string", "description": "The start token of the resource from where the page should begin.", "example": "g1AAAAA-eJzLYWBgYMpgSmHgKy5JLCrJTq2MT8lPzkzJBYqzmxiYWJiZGYGkOWDSyBJZAPCBD58" }, "DataQualityErrorTargetModel1": { "required": [ "name", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the problematic field.", "example": "field", "enum": [ "field", "parameter", "header" ] }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the problematic field.", "example": "output" } }, "description": "The target model of the error." }, "DataQualityAssetIdentityByNativeId": { "required": [ "native_id", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataQualityTypeIdentity" }, "native_id": { "$ref": "#/components/schemas/DataQualityNativeIdentity" } }, "description": "Native identity of a data quality asset." }, "DataQualityJSONResourcePatchModel1": { "required": [ "op", "path" ], "type": "object", "properties": { "op": { "type": "string", "description": "The operation to be performed.", "example": "add", "enum": [ "add", "remove", "replace", "move", "copy", "test" ] }, "path": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "A pointer to the field to update.", "example": "/bindings" }, "from": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "A string containing a pointer value.", "example": "/bindings/variable" }, "value": { "properties": {}, "description": "Value to be updated.", "oneOf": [ { "maxLength": 5000, "minLength": 1, "type": "string" } ] } } }, "DataQualityCheck": { "required": [ "children", "created_at", "creator_id", "id", "issues", "name", "native_id", "type" ], "allOf": [ { "type": "object", "properties": { "dimension": { "description": "the dimension this check belongs to", "allOf": [ { "$ref": "#/components/schemas/DataQualityDimension" } ] }, "name": { "example": "check_uniqueness_of_id", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "native_id": { "example": "4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] }, "wkc_container_id": { "description": "The identity of the IBM Knowledge Catalog container (either project/catalog/space) this check belongs to.", "allOf": [ { "$ref": "#/components/schemas/DataQualityIdentity" } ] }, "parent": { "description": "The Id of an eventual parent, or null if this check has no parent", "allOf": [ { "$ref": "#/components/schemas/DataQualityCheckIdentityById" } ] }, "type": { "example": "data_rule", "allOf": [ { "$ref": "#/components/schemas/DataQualityTypeIdentity" } ] }, "link": { "$ref": "#/components/schemas/DataQualityLink" }, "children": { "maxItems": 100000, "minItems": 0, "type": "array", "description": "The optional eventual children of this data quality check.", "items": { "$ref": "#/components/schemas/DataQualityCheck" } }, "issues": { "maxItems": 100000, "minItems": 0, "type": "array", "description": "An optional list of issues reported by this data quality check.", "items": { "$ref": "#/components/schemas/DataQualityIssueReference" } } }, "description": "A data quality check, i.e. an action to measure data quality." } ] }, "DataQualityCheckPrototype": { "required": [ "dimension", "name", "native_id", "type" ], "type": "object", "properties": { "dimension": { "description": "the dimension this check belongs to", "allOf": [ { "$ref": "#/components/schemas/DataQualityDimensionReference" } ] }, "name": { "example": "check_uniqueness_of_id", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "native_id": { "example": "4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] }, "parent": { "description": "The Id of an eventual parent, or null if this check has no parent", "allOf": [ { "$ref": "#/components/schemas/DataQualityCheckIdentity" } ] }, "type": { "example": "data_rule", "allOf": [ { "$ref": "#/components/schemas/DataQualityTypeIdentity" } ] }, "link": { "$ref": "#/components/schemas/DataQualityLink" } }, "description": "A data quality check, i.e. an action to measure data quality." }, "DataQualityCheckCollection": { "required": [ "checks", "first", "limit", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "checks": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality checks.", "items": { "$ref": "#/components/schemas/DataQualityCheck" } } }, "description": "A collection of data quality checks." }, "DataQualityIssueReference": { "oneOf": [ { "$ref": "#/components/schemas/DataQualityIssueNativeIdReference" } ] }, "DataQualityCheckIdentityById": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a data quality check." }, "DataQualityDimension": { "required": [ "created_at", "creator_id", "id", "is_default", "name" ], "allOf": [ { "type": "object", "properties": { "is_default": { "type": "boolean", "description": "Flag indicating whether the dimension is a built-in dimension or not.", "default": false } } } ] }, "DataQualityCheckIdentity": { "oneOf": [ { "$ref": "#/components/schemas/DataQualityCheckIdentityByNativeId" } ] }, "DataQualityDimensionReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a data quality dimension." }, "DataQualityIssueNativeIdReference": { "required": [ "native_id", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataQualityTypeIdentity" }, "native_id": { "$ref": "#/components/schemas/DataQualityNativeIdentity" } }, "description": "Native identity of a data quality issue." }, "DataQualityCheckIdentityByNativeId": { "required": [ "native_id", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataQualityTypeIdentity" }, "native_id": { "$ref": "#/components/schemas/DataQualityNativeIdentity" } }, "description": "Native identity of a data quality check." }, "DataQualityDimensionPrototype": { "required": [ "name" ], "type": "object", "properties": { "name": { "example": "Completeness", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The optional description of the dimension. Provide a description to understand the reason for its existence.", "example": "The proportion of data stored against the potential for 100 percent. If this property is omitted, no description is set." } }, "description": "A data quality dimension." }, "DataQualityDimensionCollection": { "required": [ "dimensions", "first", "limit", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "dimensions": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality dimensions.", "items": { "$ref": "#/components/schemas/DataQualityDimension1" } } }, "description": "A collection of data quality dimensions." }, "DataQualityDimension1": { "required": [ "created_at", "creator_id", "id", "name" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the dimension.", "example": "Completeness" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The description of the dimension.", "example": "The proportion of data stored against the potential for 100%. If this property is omitted, no description is set." }, "creator_id": { "maxLength": 100, "minLength": 1, "type": "string", "description": "The creator of the dimension. If the quality dimension is system generated, then this value will be 'SYSTEM'. For user created dimensions, it will be the IBM cloud IAM user id.", "example": "IBMid-270002ABCD" }, "created_at": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The creation time of the dimension.", "format": "date-time" } }, "description": "A data quality dimension." }, "DataQualityIssue": { "required": [ "check", "created_at", "creator_id", "id", "ignored", "reported_for" ], "allOf": [ { "type": "object", "properties": { "check": { "description": "the check that produces this issue", "allOf": [ { "$ref": "#/components/schemas/DataQualityCheck" } ] }, "reported_for": { "description": "The Id of the asset on which this issue was found", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetIdentityById" } ] }, "link": { "$ref": "#/components/schemas/DataQualityLink" }, "number_of_occurrences": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "The absolute number of occurrences of the issues which have been identified on the asset. If this is missing, percent_occurrences must be provided.", "format": "int64", "example": 123 }, "number_of_tested_records": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "The total number of records which have been tested by the Data Quality Check. If this is missing, percent_occurrences must be provided.", "format": "int64", "example": 456789 }, "percent_occurrences": { "maximum": 1, "minimum": 0, "type": "number", "description": "The relative frequency of the issue (percentage of tested records having the issue), as a number between 0.0 and 1.0. If omitted, it is calculated using number_of_occurrences and number_of_tested_records.", "format": "double", "example": 0 }, "status": { "type": "string", "description": "The status of the issue.", "example": "actual", "enum": [ "actual", "aggregation", "archive" ] }, "ignored": { "type": "boolean", "description": "Flag indicating whether the issue is ignored or not." } }, "description": "A data quality issue, i.e. a data quality problem detected during a check." } ] }, "DataQualityIssuePrototype": { "required": [ "check", "ignored", "reported_for" ], "type": "object", "properties": { "check": { "description": "the check that produces this issue", "allOf": [ { "$ref": "#/components/schemas/DataQualityCheckIdentity" } ] }, "reported_for": { "description": "The Id of the asset on which this issue was found", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetIdentity" } ] }, "link": { "$ref": "#/components/schemas/DataQualityLink" }, "number_of_occurrences": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "The absolute number of occurrences of the issues which have been identified on the asset. If this is missing, percent_occurrences must be provided.", "format": "int64", "example": 123 }, "number_of_tested_records": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "The total number of records which have been tested by the Data Quality Check. If this is missing, percent_occurrences must be provided.", "format": "int64", "example": 456789 }, "percent_occurrences": { "maximum": 1, "minimum": 0, "type": "number", "description": "The relative frequency of the issue (percentage of tested records having the issue), as a number between 0.0 and 1.0. If omitted, it is calculated using number_of_occurrences and number_of_tested_records.", "format": "double", "example": 0 }, "status": { "type": "string", "description": "The status of the issue.", "example": "actual", "default": "actual", "enum": [ "actual", "aggregation" ] }, "ignored": { "type": "boolean", "description": "Flag indicating whether the issue is ignored or not." } }, "description": "A data quality issue, i.e. a data quality problem detected during a check." }, "DataQualityIssueCollection": { "required": [ "first", "issues", "limit", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "issues": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality issues.", "items": { "$ref": "#/components/schemas/DataQualityIssueCollectionItem" } } }, "description": "A collection of data quality issues." }, "DataQualityIssueCollectionItem": { "allOf": [ { "required": [ "archived_issues", "children" ], "type": "object", "properties": { "archived_issues": { "maxItems": 100, "minItems": 0, "type": "array", "description": "An array of previous data quality issues detected during the same check on the given asset.", "items": { "$ref": "#/components/schemas/DataQualityIssue" } }, "children": { "maxItems": 10000, "minItems": 0, "type": "array", "description": "An array of data quality issues detected during the same check on children of the given asset.", "items": { "$ref": "#/components/schemas/DataQualityIssueCollectionItem" } } }, "description": "A data quality issue, i.e. a data quality problem detected during a check on a given asset." } ] }, "DataQualityIdentities": { "maxLength": 10000, "minLength": 1, "type": "string", "description": "Comma-separated list of resource identifiers.", "example": "b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710" }, "DataQualityIssuesBatchPrototype": { "required": [ "issues" ], "type": "object", "properties": { "issues": { "maxItems": 100000, "minItems": 0, "type": "array", "description": "list of issues to create.", "items": { "$ref": "#/components/schemas/DataQualityIssuePrototype" } }, "assets": { "maxItems": 100000, "minItems": 0, "type": "array", "description": "Optional list of assets to create. For each of these assets the system will check if an asset with the same native_id exists. If yes, it will ignore it, if not it will create it", "items": { "$ref": "#/components/schemas/DataQualityAssetPrototype" } }, "existing_checks": { "maxItems": 100000, "minItems": 0, "type": "array", "description": "Optional list of existing checks. For each pair of (asset, check) given, system will create, update or remove an issue depending on the current issue stored for this pair and the new issue given in the payload (or not for deletion).", "items": { "$ref": "#/components/schemas/DataQualityCheckIdentity" } } }, "description": "A payload to report one or multiple DQ issues together with their assets" }, "DataQualityScoreCollection": { "required": [ "asset", "children", "scores", "total_count" ], "type": "object", "properties": { "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of scores available.", "format": "int64", "example": 100 }, "asset": { "$ref": "#/components/schemas/DataQualityAssetInfo" }, "scores": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality scores.", "items": { "$ref": "#/components/schemas/DataQualityScore" } }, "children": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality scores.", "items": { "$ref": "#/components/schemas/DataQualityScoreOfAsset" } } }, "description": "A collection of data quality scores." }, "DataQualityScoreOfAsset": { "required": [ "asset", "scores" ], "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/DataQualityAssetInfo" }, "scores": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality scores.", "items": { "$ref": "#/components/schemas/DataQualityScore" } } }, "description": "Data quality scores of asset." }, "DataQualityScore": { "required": [ "dimension_scores", "number_of_checks", "score", "status", "timestamp" ], "type": "object", "properties": { "status": { "type": "string", "description": "The status of the score.", "example": "actual", "enum": [ "actual", "archive" ] }, "score": { "maximum": 1, "minimum": 0, "type": "number", "description": "The overall Data Quality Score (cross dimension) of the whole asset, as a number between 0.0 and 1.0", "format": "double" }, "number_of_checks": { "type": "integer", "description": "Number of checks on the asset", "format": "int64" }, "timestamp": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The creation time.", "format": "date-time" }, "dimension_scores": { "maxItems": 100000, "minItems": 0, "type": "array", "description": "The different scores by dimensions", "items": { "$ref": "#/components/schemas/DataQualityScoreOfDimension" } } }, "description": "Data Quality Score reported for an asset on different dimensions" }, "DataQualityAssetInfo": { "required": [ "id", "name" ], "type": "object", "properties": { "name": { "example": "CUSTOMERS", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Information of asset." }, "DataQualityScoreOfDimension": { "required": [ "dimension", "score", "timestamp" ], "type": "object", "properties": { "dimension": { "$ref": "#/components/schemas/DataQualityDimension" }, "score": { "maximum": 1, "minimum": 0, "type": "number", "description": "The Data Quality Score for the given dimension as a number between 0.0 and 1.0", "format": "double" }, "timestamp": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The creation time.", "format": "date-time" } }, "description": "A single Data Quality Score for one dimension and one asset" }, "DataQualityScoreCollectionItems": { "type": "array", "description": "An array of ScoreCollection objects.", "items": { "$ref": "#/components/schemas/DataQualityScoreCollection" } }, "DataQualitySLA": { "allOf": [ { "required": [ "actions", "children", "conditions", "filters", "name" ], "type": "object", "properties": { "name": { "description": "The name of the SLA", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The description of the SLA" }, "filters": { "maxItems": 100, "minItems": 0, "type": "array", "description": "The filter conditions determining which assets are governed by this SLA", "items": { "$ref": "#/components/schemas/DataQualityAssetFilter" } }, "conditions": { "maxItems": 100, "minItems": 0, "type": "array", "description": "The conditions that have to be met to fulfill this SLA", "items": { "$ref": "#/components/schemas/DataQualitySLACondition" } }, "children": { "maxItems": 100, "minItems": 0, "type": "array", "description": "The child SLAs applying to the children of assets governed directly by this SLA", "items": { "$ref": "#/components/schemas/DataQualitySubSLA" } }, "actions": { "maxItems": 100, "minItems": 0, "type": "array", "description": "The actions to be performed when the SLA conditions are not met", "items": { "$ref": "#/components/schemas/DataQualityActionDefinition" } } }, "description": "A Data Quality Service Level Agreement specifying data quality thresholds for specific assets as well as the remediation actions to be triggered when violations are found." } ] }, "DataQualitySLAPrototype": { "required": [ "name" ], "type": "object", "properties": { "name": { "description": "The name of the SLA. Must be unique.", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The description of the SLA" }, "filters": { "maxItems": 200, "minItems": 0, "type": "array", "description": "The filter conditions determining which assets are governed by this SLA", "items": { "$ref": "#/components/schemas/DataQualityAssetFilter" } }, "conditions": { "maxItems": 200, "minItems": 0, "type": "array", "description": "The conditions that have to be met to fulfill this SLA", "items": { "$ref": "#/components/schemas/DataQualitySLACondition" } }, "children": { "maxItems": 200, "minItems": 0, "type": "array", "description": "The sub-SLAs applying to the children of assets governed directly by this SLA", "items": { "$ref": "#/components/schemas/DataQualitySubSLA" } }, "actions": { "maxItems": 200, "minItems": 0, "type": "array", "description": "The actions to be performed when the SLA conditions are not met", "items": { "$ref": "#/components/schemas/DataQualityActionDefinition" } } }, "description": "A Data Quality Service Level Agreement specifying data quality thresholds for specific assets as well as the remediation actions to be triggered when violations are found" }, "DataQualitySLACollection": { "required": [ "first", "limit", "slas", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "slas": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality SLAs", "items": { "$ref": "#/components/schemas/DataQualitySLA" } } }, "description": "A collection of data quality Service Level Agreements" }, "DataQualityActionDefinition": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of action, e.g. a workflow.", "enum": [ "workflow", "none" ] }, "native_id": { "description": "The ID of the attached object used in the action definition, e.g. the workflow configuration ID", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] } }, "description": "The definition of an action triggered when an SLA's conditions are not met" }, "DataQualitySubSLA": { "required": [ "conditions", "filters" ], "type": "object", "properties": { "filters": { "maxItems": 200, "minItems": 0, "type": "array", "description": "The filter conditions determining which ones of the parent asset's children\nhave additional conditions applying to them\n", "items": { "$ref": "#/components/schemas/DataQualityAssetFilter" } }, "conditions": { "maxItems": 200, "minItems": 0, "type": "array", "description": "The conditions to be applied to the child assets", "items": { "$ref": "#/components/schemas/DataQualitySLACondition" } } }, "description": "A set of filters and conditions applying to the children of an asset governed by the parent SLA." }, "DataQualitySLACondition": { "required": [ "threshold" ], "type": "object", "properties": { "dimension": { "description": "The quality dimension this condition uses. If empty, the overall score is considered.", "allOf": [ { "$ref": "#/components/schemas/DataQualityDimensionInfo" } ] }, "threshold": { "maximum": 1, "minimum": 0, "type": "number", "description": "The threshold for the data quality score, as a number between 0.0 and 1.0", "format": "double" } }, "description": "A condition defining a data quality score threshold that assets need to satisfy" }, "DataQualityAssetFilter": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of asset filter, i.e. whether assets are filtered by name or by attached business term", "enum": [ "name", "term" ] }, "value": { "description": "The value to use when filtering by asset name", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetNamePattern" } ] }, "native_id": { "description": "The ID of the attached object used for filtering assets, such as a business term", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] }, "name": { "description": "The name of the attached object", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] } }, "description": "A filter definition used to specify what assets are covered by an SLA" }, "DataQualityDimensionInfo": { "required": [ "id", "name" ], "type": "object", "properties": { "name": { "$ref": "#/components/schemas/DataQualityDQResourceName" }, "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identifying information on a dimension" }, "DataQualityAssetNamePattern": { "maxLength": 500, "minLength": 1, "type": "string", "description": "A search string used to define which assets should be governed by an SLA. The search only looks for exact matches." }, "DataQualitySLAAssessmentCollection": { "required": [ "first", "limit", "sla_assessments", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "The total number of resources available", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "sla_assessments": { "maxItems": 200, "minItems": 0, "type": "array", "description": "An array of data quality SLA assessments", "items": { "$ref": "#/components/schemas/DataQualitySLAAssessment" } } }, "description": "A collection of data quality SLA assessments" }, "DataQualitySLAAssessment": { "required": [ "actions", "asset", "created_at", "is_latest", "num_violations", "sla", "violations_on_asset", "violations_on_children" ], "allOf": [ { "type": "object", "properties": { "asset": { "description": "The main asset that was evaluated for SLA violations (potentially including child assets)", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetInfoWithType" } ] }, "sla": { "description": "The evaluated SLA", "allOf": [ { "$ref": "#/components/schemas/DataQualitySLAReference" } ] }, "num_violations": { "type": "integer", "description": "The total number of found violations", "format": "int32" }, "violations_on_asset": { "type": "integer", "description": "The number of found violations on the asset itself", "format": "int32" }, "violations_on_children": { "type": "integer", "description": "The number of found violations on the asset's children", "format": "int32" }, "dimensions_with_violations": { "type": "array", "description": "A list of all data quality dimensions with violations in this assessment. The 'overall' dimension is represented by an empty object.", "items": { "$ref": "#/components/schemas/DataQualityDimensionInfo" } }, "violations": { "description": "The violations found in this assessment (optional, limited to the first page of the full list)", "allOf": [ { "$ref": "#/components/schemas/DataQualitySLAViolationCollection" } ] }, "is_latest": { "type": "boolean", "description": "Flag indicating whether this is the latest assessment for the referenced SLA on the referenced asset" }, "actions": { "maxItems": 200, "minItems": 0, "type": "array", "description": "The actions triggered by this assessment", "items": { "$ref": "#/components/schemas/DataQualityAction" } }, "created_at": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The assessment time.", "format": "date-time" } }, "description": "An instance of an SLA assessment for a specific asset and its sub-assets" } ] }, "DataQualityAction": { "required": [ "completed", "name", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of action, e.g. a workflow.", "enum": [ "workflow" ] }, "native_id": { "description": "The native ID of the action object, e.g. the workflow ID", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] }, "native_definition_id": { "description": "The native ID of the action definition object, e.g. the workflow configuration ID", "allOf": [ { "$ref": "#/components/schemas/DataQualityNativeIdentity" } ] }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "The name of the action" }, "completed": { "type": "boolean", "description": "Whether the action has been completed" } }, "description": "An action triggered by an SLA assessment that found violations" }, "DataQualitySLAViolationCollection": { "required": [ "first", "limit", "total_count", "violations" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "The total number of resources available", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "violations": { "maxItems": 200, "minItems": 1, "type": "array", "description": "An array of data quality SLA violations", "items": { "$ref": "#/components/schemas/DataQualitySLAViolation" } } }, "description": "A collection of data quality SLA violations" }, "DataQualitySLAReference": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "name": { "description": "The name of the SLA", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] } }, "description": "A reference to a data quality SLA" }, "DataQualityAssetInfoWithType": { "required": [ "name", "wkc_asset_id", "wkc_asset_type" ], "type": "object", "properties": { "name": { "example": "CUSTOMERS", "allOf": [ { "$ref": "#/components/schemas/DataQualityDQResourceName" } ] }, "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "wkc_asset_id": { "description": "The identity of the IBM Knowledge Catalog asset this Asset is referring", "allOf": [ { "$ref": "#/components/schemas/DataQualityIdentity" } ] }, "wkc_asset_type": { "$ref": "#/components/schemas/DataQualityWkcAssetType" } }, "description": "Basic identifying information on an asset" }, "DataQualitySLAViolation": { "required": [ "asset", "missed_threshold", "score" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "asset": { "description": "The asset that violated the condition", "allOf": [ { "$ref": "#/components/schemas/DataQualityAssetInfoWithType" } ] }, "dimension": { "description": "The data quality dimension in which the condition violation occurred. For the overall quality score, the dimension is omitted.", "allOf": [ { "$ref": "#/components/schemas/DataQualityDimensionInfo" } ] }, "missed_threshold": { "maximum": 1, "minimum": 0, "type": "number", "description": "The Data Quality score threshold that was not reached, leading to this violation", "format": "double" }, "score": { "type": "number", "description": "The measured Data Quality Score violating the SLA condition", "format": "double" } }, "description": "An SLA condition violation identified in an SLA assessment" }, "DataQualityBooleanStatus": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "boolean", "description": "The status value" } }, "description": "A status object with a boolean value" }, "DataQualityContentLocation1": { "maxLength": 512, "minLength": 1, "type": "string", "description": "The location URL of a resource.", "format": "url", "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf" }, "DataQualityRule": { "required": [ "href", "id", "input", "is_valid", "name" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the data quality rule. The name of the quality rule will be unique in a given project.", "example": "address_exists_rule" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The description of the data quality rule. If this property is omitted, no description is set.", "example": "Rule to check address exists." }, "dimension": { "$ref": "#/components/schemas/DataQualityDimensionReference1" }, "apply_all_present_dimensions": { "type": "boolean", "description": "Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then `dimension` will be ignored." }, "input": { "$ref": "#/components/schemas/DataQualityRuleInput" }, "output": { "$ref": "#/components/schemas/DataQualityRuleOutput" }, "joins": { "maxItems": 50, "minItems": 1, "type": "array", "description": "The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a `data_stage` element is provided.", "items": { "$ref": "#/components/schemas/DataQualityRuleJoin" } }, "sampling": { "$ref": "#/components/schemas/DataQualityRuleSampling" }, "data_stage": { "$ref": "#/components/schemas/DataQualityRuleDataStage" }, "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "is_valid": { "type": "boolean", "description": "Flag indicating whether the rule is valid or not." }, "href": { "$ref": "#/components/schemas/DataQualityHREF" } }, "description": "A data quality rule defines an executable applying a boolean expression on bound columns." }, "DataQualityRulePrototype": { "required": [ "input", "name" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the data quality rule. The rule name must be unique in the given project. If no unique name is provided, the quality rule will not be created.", "example": "address_exists_rule" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The description of the data quality rule. If this property is omitted, no description is set.", "example": "Rule to check address exists." }, "dimension": { "$ref": "#/components/schemas/DataQualityDimensionIdentity" }, "apply_all_present_dimensions": { "type": "boolean", "description": "Flag indicating whether the rule contributes to all dimensions that are defined in the data quality definitions used in this rule. If the value of this field is set to true, then `dimension` will be ignored." }, "input": { "$ref": "#/components/schemas/DataQualityRuleInputPrototype" }, "output": { "$ref": "#/components/schemas/DataQualityRuleOutputPrototype" }, "joins": { "maxItems": 50, "minItems": 1, "type": "array", "description": "The joins between data assets referenced in bindings and output. This property is not required if the rule is to be run on a single data asset. This property is also not required if a value for `data_stage` is provided.", "items": { "$ref": "#/components/schemas/DataQualityRuleJoinPrototype" } }, "sampling": { "$ref": "#/components/schemas/DataQualityRuleSamplingPrototype" }, "data_stage": { "$ref": "#/components/schemas/DataQualityRuleDataStagePrototype" } }, "description": "A data quality rule to be created." }, "DataQualityRuleCollection": { "required": [ "first", "limit", "rules", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "rules": { "maxItems": 200, "minItems": 1, "type": "array", "description": "A collection of data quality rules.", "items": { "$ref": "#/components/schemas/DataQualityRule" } } }, "description": "A collection of data quality rules to be returned." }, "DataQualityIds": { "maxLength": 10000, "minLength": 1, "type": "string", "description": "Comma-separated list of resource identifiers.", "example": "b1ba1d22-71a7-4adf-99b2-3c8ba19497f5,b1ba1d22-71a7-4adf-99b2-3c8ba1949710" }, "DataQualityHREF": { "maxLength": 512, "minLength": 1, "type": "string", "description": "The location URL of a resource.", "format": "url", "example": "https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf" }, "DataQualityRuleDataStage": { "required": [ "flow", "propagate_all_incoming_columns" ], "type": "object", "properties": { "flow": { "$ref": "#/components/schemas/DataQualityFlowReference" }, "propagate_all_incoming_columns": { "type": "boolean", "description": "If selected, columns from the incoming link are propagated to the output in addition to the selected output." }, "read_only": { "type": "boolean", "description": "If true, the referenced DataStage flow already exists and should not be created, updated or deleted.", "default": false } }, "description": "Data stage flow details." }, "DataQualityRuleSampling": { "required": [ "sampling_type", "size" ], "type": "object", "properties": { "sampling_type": { "type": "string", "description": "The sampling method to use.", "example": "random", "enum": [ "none", "sequential", "every_nth", "random" ] }, "size": { "maximum": 9007199254740991, "minimum": 1, "type": "integer", "description": "The maximum size of the sample. This is the maximum number of source records that are tested against the rule logic.", "format": "int64", "example": 500 }, "interval": { "maximum": 9007199254740991, "minimum": 1, "type": "integer", "description": "The sampling interval for the sampling type `sequential`. This property is not set for other values of `sampling_type`.", "format": "int64", "example": 100 }, "seed": { "maximum": 9007199254740991, "minimum": 1, "type": "integer", "description": "The sampling seed for the sampling type `random`. If no value for this property is provided, a value is generated from the current timestamp. This property is not set for other values of `sampling_type`.", "format": "int64", "example": 2354 }, "fraction": { "maximum": 1, "minimum": 0, "exclusiveMinimum": true, "type": "number", "description": "The sampling percentage for the sampling type `random`. This property is not set for other values of `sampling_type`.", "format": "float", "example": 0 } }, "description": "The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source." }, "DataQualityRuleJoin": { "required": [ "left_column_name", "left_data_asset", "right_column_name", "right_data_asset", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the join.", "example": "inner_join", "enum": [ "inner_join", "left_outer_join", "right_outer_join", "full_outer_join" ] }, "left_data_asset": { "$ref": "#/components/schemas/DataQualityDataAssetReference" }, "right_data_asset": { "$ref": "#/components/schemas/DataQualityDataAssetReference" }, "left_column_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Name of the column on the left side of the join.", "example": "column2" }, "right_column_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Name of the column on the right side of the join.", "example": "column1" } }, "description": "A join between two data sets referenced in the data quality rule bindings or output. This element is required if the rule is supposed to be run on multiple data assets." }, "DataQualityRuleOutput": { "required": [ "columns", "maximum_record_count" ], "type": "object", "properties": { "database": { "$ref": "#/components/schemas/DataQualityRuleOutputDatabase" }, "maximum_record_count": { "maximum": 100000000, "minimum": -1, "type": "integer", "description": "Maximum number of records to be written to the output. The value `-1` indicates that all records should be written to the output.", "format": "int64", "example": 1000 }, "columns": { "maxItems": 200, "minItems": 1, "type": "array", "description": "A list of columns in the rule output." }, "links": { "maxItems": 4, "minItems": 1, "type": "array", "description": "The output links to be generated when the output needs to be further processed in the data stage flow. This field should be used when value of `data_stage` is provided and the output needs to be further passed to the next data stage operators. This field can be omitted if value for `database` field is provided.", "items": { "$ref": "#/components/schemas/DataQualityRuleOutputLink" } } }, "description": "The output details of a data quality rule." }, "DataQualityRuleInput": { "type": "object", "properties": { "sql": { "$ref": "#/components/schemas/DataQualityRuleInputSql" }, "definitions": { "maxItems": 100, "minItems": 1, "type": "array", "description": "Provides data quality rule input definition details. This property can be omitted if `sql` value is provided.", "items": { "$ref": "#/components/schemas/DataQualityRuleInputDefinition" } } }, "description": "Data quality rule input details." }, "DataQualityDimensionReference1": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of data quality dimension. This property would be used during the import/export of the data quality asset." }, "description": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The description of the data quality dimension. This property would be used during the import/export of the data quality asset." } }, "description": "Identity of a data quality dimension resource." }, "DataQualityRuleDataStagePrototype": { "required": [ "flow" ], "type": "object", "properties": { "flow": { "$ref": "#/components/schemas/DataQualityFlowPrototype" }, "propagate_all_incoming_columns": { "type": "boolean", "description": "If selected, columns from the incoming link are propagated to the output in addition to the selected output.", "default": false }, "read_only": { "type": "boolean", "description": "If true, the referenced DataStage flow already exists and should not be created, updated or deleted.", "default": false } }, "description": "Representation of the data stage flow resource to create. If this property is omitted, no subflow is created for the data quality rule." }, "DataQualityRuleSamplingPrototype": { "type": "object", "properties": { "sampling_type": { "type": "string", "description": "The sampling method to use.", "example": "random", "default": "sequential", "enum": [ "none", "sequential", "every_nth", "random" ] }, "size": { "maximum": 9007199254740991, "minimum": 1, "type": "integer", "description": "The maximum size of the sample. This is the maximum number of source records that are tested against the rule logic.", "format": "int64", "example": 500, "default": 2000 }, "interval": { "maximum": 9007199254740991, "minimum": 1, "type": "integer", "description": "The sampling interval for the sampling type `sequential`.", "format": "int64", "example": 100, "default": 1 }, "seed": { "maximum": 9007199254740991, "minimum": 1, "type": "integer", "description": "The sampling seed for the sampling type `random`. If no value for this property is provided, a value is generated from the current timestamp.", "format": "int64", "example": 2354 }, "fraction": { "maximum": 1, "minimum": 0, "exclusiveMinimum": true, "type": "number", "description": "The sampling fraction for the sampling type `random`.", "format": "float", "example": 0, "default": 1 } }, "description": "The sampling options to be used during data quality rule run. If no sampling options are set, the rule is run against all the rows of the source." }, "DataQualityRuleJoinPrototype": { "required": [ "left_column_name", "left_data_asset", "right_column_name", "right_data_asset", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the join.", "example": "inner_join", "default": "inner_join", "enum": [ "inner_join", "left_outer_join", "right_outer_join", "full_outer_join" ] }, "left_data_asset": { "$ref": "#/components/schemas/DataQualityDataAssetIdentity" }, "right_data_asset": { "$ref": "#/components/schemas/DataQualityDataAssetIdentity" }, "left_column_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Name of the column on the left side of the join.", "example": "column2" }, "right_column_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Name of the column on the right side of the join.", "example": "column1" } }, "description": "A join between two data sets referenced in the data quality rule bindings or output. This element is required if the rule is supposed to be run on multiple data assets." }, "DataQualityRuleOutputPrototype": { "required": [ "columns" ], "type": "object", "properties": { "database": { "$ref": "#/components/schemas/DataQualityRuleOutputDatabasePrototype" }, "maximum_record_count": { "maximum": 100000000, "minimum": -1, "type": "integer", "description": "Maximum number of records to be written to the output. The value `-1` indicates that all records should be written to the output.", "format": "int64", "example": 1000, "default": -1 }, "columns": { "maxItems": 200, "minItems": 1, "type": "array", "description": "A list of columns in the rule output." }, "links": { "maxItems": 4, "minItems": 1, "type": "array", "description": "The output links to be generated when the output needs to be further processed in the data stage flow. This field should be used when value of `data_stage` is provided and the output needs to be further passed to the next data stage operators. This field can be omitted if value for `database` field is provided.", "items": { "$ref": "#/components/schemas/DataQualityRuleOutputLinkPrototype" } } }, "description": "The output details of a data quality rule. If this property is omitted, no output records are saved." }, "DataQualityRuleInputPrototype": { "type": "object", "properties": { "sql": { "$ref": "#/components/schemas/DataQualityRuleInputSqlPrototype" }, "definitions": { "maxItems": 100, "minItems": 1, "type": "array", "description": "Provides data quality rule input definition details. This property can be omitted if `sql` value is provided.", "items": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionPrototype" } } }, "description": "Data quality rule input details." }, "DataQualityDimensionIdentity": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a data quality dimension resource. If this property is omitted, no data quality dimension is associated with the resource." }, "DataQualityFlowReference": { "required": [ "name" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of data stage flow to create for the data quality rule. Data stage flow names are unique in the given project. If a data stage flow with this name exists already in the project, the rule is not created.", "example": "flow1" } }, "description": "Identity of a data stage flow resource." }, "DataQualityDataAssetReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a data asset resource." }, "DataQualityRuleOutputLink": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the output link.", "example": "all_records", "enum": [ "all_records", "passing_records", "failing_records", "violated_definitions" ] } }, "description": "The output link to be generated when the output needs to be further processed in the data stage flow." }, "DataQualityRuleOutputDatabase": { "required": [ "location", "records_type", "update_type" ], "type": "object", "properties": { "location": { "$ref": "#/components/schemas/DataQualityRuleOutputDatabaseLocation" }, "records_type": { "type": "string", "description": "This property defines what type of content the output table contains.", "example": "failing_records", "enum": [ "all_records", "passing_records", "failing_records" ] }, "update_type": { "type": "string", "description": "This property defines whether output records in the output table are to be appended or overwritten.", "example": "overwrite", "enum": [ "append", "overwrite" ] } }, "description": "The output database details when the output needs to be saved in a database table. This field can be omitted if value for `links` is provided." }, "DataQualityRuleInputDefinition": { "required": [ "definition" ], "type": "object", "properties": { "definition": { "$ref": "#/components/schemas/DataQualityDefinitionReference" }, "disambiguator": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The number used to disambiguate the multiple definitions in the input. This property is not required if data quality rule uses only one definition.", "format": "int32", "example": 1 }, "bindings": { "maxItems": 100, "minItems": 1, "type": "array", "description": "Binds columns or constants to variable names of the data quality rule expression.", "items": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBinding" } }, "bound_expression": { "$ref": "#/components/schemas/DataQualityRuleBoundExpression" } }, "description": "Data quality rule input definition details." }, "DataQualityRuleInputSql": { "required": [ "connection", "select_statement" ], "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/DataQualityConnectionReference" }, "select_statement": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The sql statement to execute with select clause. If needed, the value of this field should be base64 encoded for CPDaaS.", "example": "select * from bank1.bank_clients" }, "status_column": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The column name of the select statement containing 0 (failed) or 1 (passed).", "example": "col1" } }, "description": "Data quality rule input sql details. This property can be omitted if `definitions` values is provided." }, "DataQualityFlowPrototype": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of data stage flow to create for the data quality rule. Data stage flow names are unique in the given project. If a data stage flow with this name exists already in the project, the rule is not created.", "example": "flow1" } }, "description": "Data stage flow to create." }, "DataQualityDataAssetIdentity": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a data asset resource." }, "DataQualityRuleOutputLinkPrototype": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The type of the output link.", "example": "all_records", "enum": [ "all_records", "passing_records", "failing_records", "violated_definitions" ] } }, "description": "The output link to be generated when the output needs to be further processed in the data stage flow." }, "DataQualityRuleOutputDatabasePrototype": { "required": [ "location" ], "type": "object", "properties": { "records_type": { "type": "string", "description": "This property defines what type of content the output table contains.", "example": "failing_records", "default": "failing_records", "enum": [ "all_records", "passing_records", "failing_records" ] }, "update_type": { "type": "string", "description": "This property defines whether output records in the output table are to be appended or overwritten.", "example": "overwrite", "default": "append", "enum": [ "append", "overwrite" ] }, "location": { "$ref": "#/components/schemas/DataQualityRuleOutputDatabaseLocationPrototype" } }, "description": "The output database details when the output needs to be saved in a database table. This field can be omitted if value for `links` is provided." }, "DataQualityRuleInputDefinitionPrototype": { "required": [ "definition" ], "type": "object", "properties": { "definition": { "$ref": "#/components/schemas/DataQualityDefinitionIdentity" }, "disambiguator": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The number used to disambiguate the multiple definitions in the input. This property is not required if data quality rule uses only one definition.", "format": "int32", "example": 1 }, "bindings": { "maxItems": 100, "minItems": 1, "type": "array", "description": "Binds columns or constants to variable names of the data quality rule expression.", "items": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingPrototype" } } }, "description": "Data quality rule input definition details." }, "DataQualityRuleInputSqlPrototype": { "required": [ "connection", "select_statement" ], "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/DataQualityConnectionIdentity" }, "select_statement": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The sql statement to execute with select clause. If needed, the value of this field should be base64 encoded for CPDaaS.", "example": "select * from bank1.bank_clients" }, "status_column": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The column name of the select statement containing 0 (failed) or 1 (passed).", "example": "col1" } }, "description": "Data quality rule input sql details. This property can be omitted if `definitions` values is provided." }, "DataQualityRuleOutputDatabaseLocation": { "required": [ "connection", "schema_name", "table_name" ], "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/DataQualityConnectionReference" }, "catalog_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The name of the output table catalog." }, "schema_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The name of the output table schema." }, "table_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The name of the output table." } }, "description": "The output table location of the data quality rule." }, "DataQualityRuleBoundExpression": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The rule expression where variables have been replaced by the bindings defined in the rule. This property is set only if the rule is valid (`is_valid=true`).", "example": "field0 EXISTS" }, "DataQualityRuleInputDefinitionBinding": { "type": "object", "properties": { "variable_name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the data quality rule expression variable. This property is not required if `data_stage` property is provided but `column_type` is not provided.", "example": "var1" }, "column_type": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingColumnType" }, "target": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingTarget" } }, "description": "Binds columns or constants to variable names of the data quality rule expression.. Property `target` is not required if a `data_stage` element is provided." }, "DataQualityDefinitionReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a definition resource." }, "DataQualityConnectionReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a connection resource." }, "DataQualityRuleOutputDatabaseLocationPrototype": { "required": [ "connection", "schema_name", "table_name" ], "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/DataQualityConnectionIdentity" }, "catalog_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The name of the output table catalog." }, "schema_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The name of the output table schema." }, "table_name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The name of the output table." } }, "description": "The output table location of the data quality rule." }, "DataQualityRuleInputDefinitionBindingPrototype": { "type": "object", "properties": { "variable_name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the data quality rule expression variable. This property is not required if `data_stage` property is provided but `column_type` is not provided.", "example": "var1" }, "column_type": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingColumnTypePrototype" }, "target": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingTargetPrototype" } }, "description": "Binds columns or constants to variable names of the data quality rule expression. Property `target` is not required if a `data_stage` element is provided." }, "DataQualityDefinitionIdentity": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a definition resource." }, "DataQualityConnectionIdentity": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a connection resource." }, "DataQualityRuleInputDefinitionBindingTarget": { "oneOf": [ { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingTargetLiteral" } ] }, "DataQualityRuleInputDefinitionBindingColumnType": { "required": [ "is_nullable", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "ODBC type name of the column.", "enum": [ "char", "varchar", "smallint", "integer", "bigint", "decimal", "float", "double", "date", "time", "timestamp" ] }, "max_length": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "The maximum length of a `char` or `varchar` data type.", "format": "int32", "example": 10 }, "precision": { "maximum": 38, "minimum": 1, "type": "integer", "description": "The precision of a `decimal` data type.", "format": "int32", "example": 10 }, "scale": { "maximum": 38, "minimum": 1, "type": "integer", "description": "The scale of a `decimal` data type.", "format": "int32", "example": 10 }, "is_unicode_string": { "type": "boolean", "description": "The flag for a nullable data type." }, "is_signed": { "type": "boolean", "description": "The flag for a signed numeric data type." }, "is_nullable": { "type": "boolean", "description": "The flag to indicate nullability of column." } }, "description": "The column type details to be provided when the `data_stage` property is provided. This object is optional. If no value for this object is provided, then inferred column type is used." }, "DataQualityRuleInputDefinitionBindingTargetPrototype": { "oneOf": [ { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingTargetLiteralPrototype" } ] }, "DataQualityRuleInputDefinitionBindingColumnTypePrototype": { "required": [ "is_nullable", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "ODBC type name of the column.", "enum": [ "char", "varchar", "smallint", "integer", "bigint", "decimal", "float", "double", "date", "time", "timestamp" ] }, "max_length": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "The maximum length of a `char` or `varchar` data type.", "format": "int32", "example": 10 }, "precision": { "maximum": 38, "minimum": 1, "type": "integer", "description": "The precision of a `decimal` data type.", "format": "int32", "example": 10 }, "scale": { "maximum": 38, "minimum": 1, "type": "integer", "description": "The scale of a `decimal` data type.", "format": "int32", "example": 10 }, "is_unicode_string": { "type": "boolean", "description": "The flag for a nullable data type." }, "is_signed": { "type": "boolean", "description": "The flag for a signed numeric data type." }, "is_nullable": { "type": "boolean", "description": "The flag to indicate nullability of column." } }, "description": "The column type details to be provided when the `data_stage` property is provided. This object is optional. If no value is provided, then inferred column type is used." }, "DataQualityRuleInputDefinitionBindingTargetLiteral": { "allOf": [ { "required": [ "constant" ], "type": "object", "properties": { "constant": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingTargetLiteralConstant" } }, "description": "The bound literal." } ] }, "DataQualityRuleInputDefinitionBindingTargetLiteralPrototype": { "allOf": [ { "required": [ "constant" ], "type": "object", "properties": { "constant": { "$ref": "#/components/schemas/DataQualityRuleInputDefinitionBindingTargetLiteralConstantPrototype" } }, "description": "The bound literal." } ] }, "DataQualityRuleInputDefinitionBindingTargetLiteralConstant": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the literal.", "example": "numeric", "enum": [ "numeric", "date", "time", "datetime", "string" ] }, "string_value": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The value of a string literal. This property is used when the type of literal is `any` or `string`.", "example": "value1" }, "date_value": { "maxLength": 10, "minLength": 10, "type": "string", "description": "The value of a date literal. This property is used when the type of literal is `date`.", "format": "date" }, "time_value": { "maxLength": 18, "minLength": 9, "type": "string", "description": "The value of a date/time literal. This property is used when the type of literal is `time`.", "example": "22:20:22.202Z" }, "date_time_value": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The value of a date-time literal. This property is used when the type of literal is `date-time`.", "format": "date-time" }, "numeric_value": { "type": "number", "description": "The value of numeric literal. This property is used when the type of literal is `numeric`.", "format": "double", "example": 100 } }, "description": "The bound constant literal if if the type of the binding target is `literal`." }, "DataQualityRuleInputDefinitionBindingTargetLiteralConstantPrototype": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of the literal.", "example": "numeric", "enum": [ "numeric", "date", "time", "datetime", "string" ] }, "string_value": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The value of a string literal. This property is used when the type of literal is `any` or `string`.", "example": "value1" }, "date_value": { "maxLength": 10, "minLength": 10, "type": "string", "description": "The value of a date literal. This property is used when the type of literal is `date`.", "format": "date" }, "time_value": { "maxLength": 18, "minLength": 9, "type": "string", "description": "The value of a date/time literal. This property is used when the type of literal is `time`.", "example": "22:20:22.202Z" }, "date_time_value": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The value of a date-time literal. This property is used when the type of literal is `date-time`.", "format": "date-time" }, "numeric_value": { "type": "number", "description": "The value of numeric literal. This property is used when the type of literal is `numeric`.", "format": "double", "example": 100 } }, "description": "The bound constant literal if the type of the binding target is `literal`." }, "DataQualityRuleExecution": { "required": [ "href", "id", "job", "job_run", "run_by", "status" ], "type": "object", "properties": { "passing_record_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Number of passing records.", "format": "int64", "example": 900 }, "failing_record_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Number of failing records.", "format": "int64", "example": 100 }, "input": { "$ref": "#/components/schemas/DataQualityRuleInput" }, "output": { "$ref": "#/components/schemas/DataQualityRuleOutput" }, "sampling": { "$ref": "#/components/schemas/DataQualityRuleSampling" }, "tested_record_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Number of records tested.", "format": "int64", "example": 1000 }, "job": { "$ref": "#/components/schemas/DataQualityJobReference" }, "job_run": { "$ref": "#/components/schemas/DataQualityJobRunReference" }, "status": { "$ref": "#/components/schemas/DataQualityRuleExecutionStatus" }, "started_at": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The start time of the rule run.", "format": "date-time" }, "ended_at": { "maxLength": 24, "minLength": 20, "type": "string", "description": "The end time of the rule run.", "format": "date-time" }, "run_by": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The name of the user that ran the rule.", "example": "IBMid-270002ABCD" }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "Name of the result.", "example": "execution1" }, "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "href": { "$ref": "#/components/schemas/DataQualityHREF" }, "definition_counts": { "maxItems": 100, "minItems": 1, "type": "array", "description": "A list of execution results per definition.", "items": { "$ref": "#/components/schemas/DataQualityRuleExecutionDefinitionCounts" } } }, "description": "The representation of a data quality rule execution." }, "DataQualityRuleExecutionDefinitionCounts": { "required": [ "definition" ], "type": "object", "properties": { "definition": { "$ref": "#/components/schemas/DataQualityDefinitionReference" }, "disambiguator": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The number used to disambiguate the multiple definitions in the input. This property is not required if data quality rule uses only one definition.", "format": "int32", "example": 1 }, "passing_record_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Number of passing records.", "format": "int64", "example": 900 }, "failing_record_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Number of failing records.", "format": "int64", "example": 100 }, "tested_record_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Number of records tested.", "format": "int64", "example": 1000 } }, "description": "The representation of a data quality rule execution for one definition only." }, "DataQualityRuleExecutionStatus": { "required": [ "state" ], "type": "object", "properties": { "state": { "type": "string", "description": "The status of the rule run.", "example": "running", "enum": [ "not_analyzed", "scheduled", "running", "partially_analyzed", "analyzed", "outdated", "error", "not_anlyzable" ] }, "error_message": { "maxLength": 128, "minLength": 1, "type": "string", "description": "The error message of a failed analysis.", "example": "Cannot connect to the data source." } }, "description": "The status of the rule run." }, "DataQualityJobRunReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a run associated with a job, which in turn is associated with a a rule." }, "DataQualityJobReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/DataQualityIdentity" } }, "description": "Identity of a job associated with a rule." }, "DataQualityRuleExecutionCollection": { "required": [ "executions", "first", "limit", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "executions": { "maxItems": 50, "minItems": 1, "type": "array", "description": "A list of rule run results, sorted based on the value of the `sort` query parameter.", "items": { "$ref": "#/components/schemas/DataQualityRuleExecution" } } }, "description": "Data quality rule run history" }, "DataQualityOffset": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The first index in the output.", "format": "int32", "example": 20, "default": 0 }, "DataQualityDefinition": { "required": [ "expression", "href", "id", "name" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the data quality definition. The name of the quality definition is unique in a given project.", "example": "Address exists definition" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The description of the data quality definition. If this property is omitted, no description is set.", "example": "Definition to check if address exists" }, "expression": { "maxLength": 10000, "minLength": 1, "type": "string", "description": "The expression of the data quality definition.", "example": "field0 exists" }, "dimension": { "$ref": "#/components/schemas/DataQualityDimensionReference1" }, "id": { "$ref": "#/components/schemas/DataQualityIdentity" }, "href": { "$ref": "#/components/schemas/DataQualityHREF" } }, "description": "A data quality definition defines a boolean rule along with the variables." }, "DataQualityDefinitionPrototype": { "required": [ "expression", "name" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The name of the data quality definition. The name of the definition must be unique in the given project. If no unique name is provided, the REST call fails.", "example": "Address exists definition" }, "description": { "maxLength": 5000, "minLength": 1, "type": "string", "description": "The description of the data quality definition. If this property is omitted, no description is set.", "example": "Definition to check if address exists" }, "expression": { "maxLength": 10000, "minLength": 1, "type": "string", "description": "The expression of the data quality definition.", "example": "field0 exists" }, "dimension": { "$ref": "#/components/schemas/DataQualityDimensionIdentity" } }, "description": "A data quality definition to be created." }, "DataQualityDefinitionCollection": { "required": [ "definitions", "first", "limit", "total_count" ], "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/DataQualityLimit" }, "total_count": { "maximum": 9007199254740991, "minimum": 0, "type": "integer", "description": "Total number of resources available.", "format": "int64", "example": 100 }, "first": { "$ref": "#/components/schemas/DataQualityPageLink" }, "next": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "previous": { "$ref": "#/components/schemas/DataQualityPageLinkToken" }, "definitions": { "maxItems": 200, "minItems": 1, "type": "array", "description": "A collection of existing definitions.", "items": { "$ref": "#/components/schemas/DataQualityDefinition" } } }, "description": "An array of data quality definitions." }, "DataQualityDefinitionValidation": { "required": [ "variables" ], "type": "object", "properties": { "variables": { "maxItems": 100, "minItems": 1, "type": "array", "description": "The list of variables in this expression. This field is set if the rule is valid (`is_valid=true`).", "items": { "$ref": "#/components/schemas/DataQualityDefinitionValidationVariable" } } }, "description": "This response contains the rule expression variables and their types." }, "DataQualityDefinitionValidationVariable": { "required": [ "name", "type", "usage" ], "type": "object", "properties": { "usage": { "type": "string", "description": "Type of use of the rule expression variable.", "example": "input_data", "enum": [ "input_data", "reference_data" ] }, "name": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Name of the rule expression variable.", "example": "field0" }, "type": { "type": "string", "description": "The type of the rule expression variable.", "example": "numeric", "enum": [ "numeric", "double", "int", "float", "string", "date", "time", "timestamp", "list", "any", "unknown" ] } }, "description": "A rule expression variable in a data quality definition." }, "DataQualitySettings": { "required": [ "allow_partial_evaluation", "allow_quoted_variables", "case_sensitive_group_key", "heap_size", "ignore_trailing_spaces", "implicit_casting", "max_string_length" ], "type": "object", "properties": { "default_else_value": { "type": "boolean", "description": "In rules of the form \"IF condition THEN test\", this property indicates how data records that do not fulfil the condition have to be evaluated. If the property is not set, the data records are not counted. Otherwise, the records are counted as failing (false) or as passing (true) as defined." }, "ignore_trailing_spaces": { "type": "boolean", "description": "In rules containing equality tests between strings, this property indicates whether the values to be tested should consider trailing spaces." }, "implicit_casting": { "type": "boolean", "description": "This property indicates whether values of data quality rule variables have to be casted automatically to the type expected in the data quality rule expression." }, "max_string_length": { "maximum": 1024, "minimum": 1, "type": "integer", "description": "The maximum length of String values when executing data quality rules.", "format": "int32", "example": 512 }, "allow_partial_evaluation": { "type": "boolean", "description": "In rules with multiple definitions, indicates if definitions evaluating as null (undefined) have to be considered failing (false) or passing (true)." }, "case_sensitive_group_key": { "type": "boolean", "description": "This property indicates whether group keys for aggregations in the data quality rule are case sensitive or not." }, "allow_quoted_variables": { "type": "boolean", "description": "If set to true, a string surrounded by double quotes in an expression will be treated as a variable instead of string literal value." }, "heap_size": { "maximum": 2048, "minimum": 1, "type": "integer", "description": "The heap size in MB of the Java stages needed to implement data rules.", "format": "int32", "example": 512, "default": 256 } }, "description": "Project settings." }, "DataQualitySettingsPrototype": { "type": "object", "properties": { "default_else_value": { "type": "boolean", "description": "In rules of the form \"IF condition THEN test\", this property indicates how data records that do not fulfil the condition have to be evaluated. If the property is not set, the data records are not counted. Otherwise, the records are counted as failing (false) or as passing (true) as defined." }, "ignore_trailing_spaces": { "type": "boolean", "description": "In rules containing equality tests between strings, this property indicates whether the values to be tested should consider trailing spaces.", "default": false }, "implicit_casting": { "type": "boolean", "description": "This property indicates whether values of data quality rule variables have to be casted automatically to the type expected in the data quality rule expression.", "default": true }, "max_string_length": { "maximum": 1024, "minimum": 1, "type": "integer", "description": "The maximum length of String values when executing data quality rules.", "format": "int32", "example": 512, "default": 1024 }, "allow_partial_evaluation": { "type": "boolean", "description": "In rules with multiple definitions, indicates if definitions evaluating as null (undefined) have to be considered failing (false) or passing (true).", "default": true }, "case_sensitive_group_key": { "type": "boolean", "description": "This property indicates whether group keys for aggregations in the data quality rule are case sensitive or not.", "default": true }, "allow_quoted_variables": { "type": "boolean", "description": "If set to true, a string surrounded by double quotes in an expression will be treated as a variable instead of string literal value.", "default": false }, "heap_size": { "maximum": 2048, "minimum": 1, "type": "integer", "description": "The heap size in MB of the Java stages needed to implement data rules.", "format": "int32", "example": 512, "default": 256 } }, "description": "Project settings." }, "EnvironmentsErrorDefinition": { "description": "An error response.", "required": [ "trace", "errors" ], "properties": { "trace": { "description": "The trace ID used in logs.", "type": "string" }, "errors": { "description": "The error objects.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsError" } } } }, "EnvironmentsEnvironment": { "description": "Environment with references to external hardware and software specifications.", "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/EnvironmentsEnvironmentMetadata" }, "entity": { "$ref": "#/components/schemas/EnvironmentsEnvironmentEntity" } } }, "EnvironmentsEnvironmentCreateBody": { "description": "Body to send with a POST request to create an environment.", "required": [ "type", "name", "display_name", "software_specification", "hardware_specification" ], "properties": { "type": { "description": "Type of the environment.", "type": "string", "enum": [ "notebook", "wml_flow", "rstudio", "default_spark", "remote_spark", "jupyterlab", "remote_yarn", "datastage", "profiling", "modeler", "data_privacy", "pipelines" ], "example": "notebook" }, "name": { "description": "Name of the environment.", "type": "string", "example": "my notebook environment" }, "description": { "description": "Description of the environment.", "type": "string", "example": "this is my notebook environment" }, "display_name": { "description": "Display name of the environment.", "type": "string", "example": "My Notebook Environment" }, "environment_variables": { "x-out-of-example": true, "description": "Environment variables for the environment.", "type": "object", "example": { "key1": "value1", "key2": "value2" } }, "config_variables": { "x-out-of-example": true, "description": "Configuration variables for the environment.", "type": "object", "example": { "key1": "value1", "key2": "value2" } }, "runtime_idle_time": { "x-internal": "cpd", "x-out-of-example": true, "description": "Runtime idle timeout.", "type": "integer", "example": 1800000 }, "runtime_definition": { "x-internal": "cpd", "description": "Runtime definition for the environment.", "type": "string", "example": "204dac19-7d94-4692-a4c8-2acd77e28792" }, "hardware_specification": { "$ref": "#/components/schemas/EnvironmentsReferencedHardwareSpecification" }, "software_specification": { "$ref": "#/components/schemas/EnvironmentsReferencedSoftwareSpecification" }, "compute_specification": { "$ref": "#/components/schemas/EnvironmentsComputeSpecification" }, "tools_specification": { "$ref": "#/components/schemas/EnvironmentsToolsSpecification" } } }, "EnvironmentsEnvironmentsList": { "description": "A list of environments.", "required": [ "total_results", "resources" ], "properties": { "total_results": { "description": "Size of the list.", "type": "integer", "example": 1 }, "resources": { "description": "An array of environments.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsEnvironment" } } } }, "EnvironmentsError": { "description": "An error object.", "required": [ "code", "message" ], "properties": { "code": { "description": "The code describing the error.", "type": "string" }, "message": { "description": "The detailed information about the error.", "type": "string" }, "target": { "$ref": "#/components/schemas/EnvironmentsErrorTarget" } } }, "EnvironmentsEnvironmentEntity": { "description": "Environment entity.", "type": "object", "properties": { "environment": { "$ref": "#/components/schemas/EnvironmentsEnvironmentEntityDefinition" } } }, "EnvironmentsEnvironmentMetadata": { "description": "Environment metadata.", "properties": { "name": { "description": "Environment names are not unique globally or even per project.", "type": "string", "example": "my notebook environment" }, "description": { "description": "Description of the environment.", "type": "string", "example": "this is my notebook environment" }, "asset_type": { "description": "Type of the asset.", "type": "string", "enum": [ "environment" ], "example": "environment" }, "asset_id": { "description": "The unique ID of this environment. Use this to run operations on this environment.", "type": "string", "example": "656ca7c3-d971-42c3-918b-a15023cd6b8e" }, "project_id": { "description": "The project the environment belongs to.", "type": "string", "example": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf" }, "space_id": { "description": "The space the environment belongs to.", "type": "string", "example": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0" }, "owner_id": { "description": "IAM ID of the asset's owner.", "type": "string", "example": "IBMid-310000SG2Y" }, "created_at": { "description": "Creation date, ISO format.", "type": "string", "example": "2021-10-12T09:18:34.000Z" }, "href": { "description": "Full URI of the environment.", "type": "string", "example": "/v2/environments/656ca7c3-d971-42c3-918b-a15023cd6b8e" } } }, "EnvironmentsToolsSpecification": { "description": "Tools specification of the environment.", "properties": { "supported_kernels": { "description": "An array of supported kernels.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsKernelSpecification" } } } }, "EnvironmentsComputeSpecification": { "x-internal": "cpd", "x-out-of-example": true, "description": "Compute specification of the environment.", "type": "object", "properties": { "type": { "description": "Compute Type.", "type": "string", "example": "hadoop" } } }, "EnvironmentsReferencedSoftwareSpecification": { "description": "A pointer to a software specification that was defined elsewhere.", "type": "object", "required": [ "guid" ], "properties": { "guid": { "description": "A UUID of an existing specification.", "type": "string", "example": "555bd074-cc5b-4396-a7f8-5f03d336a8e5" } } }, "EnvironmentsReferencedHardwareSpecification": { "description": "A pointer to a hardware specification that was defined elsewhere.", "type": "object", "required": [ "guid" ], "properties": { "guid": { "description": "A UUID of an existing specification.", "type": "string", "example": "2d5191ba-ff9b-4b48-a852-948d49dd9210" } } }, "EnvironmentsErrorTarget": { "description": "The target of the error.", "required": [ "type", "name" ], "properties": { "type": { "description": "The type of the problematic field.", "type": "string", "enum": [ "field", "query", "header" ] }, "name": { "description": "The name of the problematic field.", "type": "string" } } }, "EnvironmentsEnvironmentEntityDefinition": { "description": "Entity of an environment with references to external hardware and software specifications.", "properties": { "sub_type": { "description": "Environment subtype.", "type": "string", "enum": [ "notebook", "wml_flow", "rstudio", "default_spark", "remote_spark", "jupyterlab", "remote_yarn", "datastage", "profiling", "modeler", "data_privacy", "pipelines" ], "example": "notebook" }, "display_name": { "description": "Environment display name.", "type": "string", "example": "My Notebook Environment" }, "environment_variables": { "x-out-of-example": true, "description": "Environment variables for the environment.", "type": "object", "example": { "key1": "value1", "key2": "value2" } }, "config_variables": { "x-out-of-example": true, "description": "Configuration variables for the environment.", "type": "object", "example": { "key1": "value1", "key2": "value2" } }, "runtime_idle_time": { "x-internal": "cpd", "x-out-of-example": true, "description": "Runtime idle timeout.", "type": "integer", "example": 1800000 }, "hardware_specification": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecification" }, "software_specification": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecification" }, "tools_specification": { "$ref": "#/components/schemas/EnvironmentsToolsSpecification" }, "compute_specification": { "$ref": "#/components/schemas/EnvironmentsComputeSpecification" }, "runtime_definition": { "x-internal": "cpd", "description": "Runtime definition for the environment.", "type": "string", "example": "204dac19-7d94-4692-a4c8-2acd77e28792" }, "spec_type": { "description": "Always \"referenced\".", "type": "string", "enum": [ "referenced" ], "example": "referenced" } } }, "EnvironmentsKernelSpecification": { "description": "Specification of a compute kernel.", "properties": { "name": { "description": "Name of the kernel.", "type": "string", "example": "python3" }, "language": { "description": "Language of the kernel.", "type": "string", "example": "python" }, "version": { "description": "Version of the kernel.", "type": "string", "example": 3.9 }, "display_name": { "description": "Display name of the kernel.", "type": "string", "example": "Python 3.9" } } }, "EnvironmentsSoftwareSpecification": { "description": "A software specification.", "properties": { "metadata": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationMetadata" }, "entity": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationEntity" } } }, "EnvironmentsHardwareSpecification": { "description": "A hardware specification.", "properties": { "metadata": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMetadata" }, "entity": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationEntity" } } }, "EnvironmentsSoftwareSpecificationEntity": { "description": "Software specification entity.", "properties": { "software_specification": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationEntityDefinition" } } }, "EnvironmentsSoftwareSpecificationMetadata": { "description": "The software specification metadata.", "properties": { "name": { "description": "Name of the software specification.", "type": "string", "example": "my software specification" }, "description": { "description": "Description of the software specification.", "type": "string", "example": "this is my software specification" }, "asset_type": { "description": "Type of the asset.", "type": "string", "enum": [ "software_specification" ], "example": "software_specification" }, "asset_id": { "description": "The unique ID of the software specification.", "type": "string", "example": "555bd074-cc5b-4396-a7f8-5f03d336a8e5" }, "project_id": { "description": "The project ID.", "type": "string", "example": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf" }, "space_id": { "description": "The space ID.", "type": "string", "example": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0" }, "owner_id": { "description": "IAM ID of the asset's owner.", "type": "string", "example": "IBMid-310000SG2Y" }, "created_at": { "description": "Date the asset was created.", "type": "string", "example": "2021-08-02T12:00:24.269Z" }, "updated_at": { "description": "Date the asset was last updated.", "type": "string", "example": "2021-08-02T12:00:24.269Z" }, "purpose": { "description": "The purposes of the software specification.", "x-internal": "cpd", "$ref": "#/components/schemas/EnvironmentsPurpose" }, "life_cycle": { "x-internal": "cpd", "$ref": "#/components/schemas/EnvironmentsLifeCycle" }, "href": { "description": "The route to the software specification.", "type": "string", "example": "/v2/software_specifications/555bd074-cc5b-4396-a7f8-5f03d336a8e5" } } }, "EnvironmentsHardwareSpecificationEntity": { "description": "Hardware specification main entity.", "properties": { "hardware_specification": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationEntityDefinition" } } }, "EnvironmentsHardwareSpecificationMetadata": { "description": "Hardware specification metadata.", "properties": { "name": { "description": "Name of the hardware specification.", "type": "string", "example": "my hardware specification" }, "description": { "description": "Description of the hardware specification.", "type": "string", "example": "this is my hardware specification" }, "asset_type": { "description": "Type of the asset.", "type": "string", "enum": [ "hardware_specification" ], "example": "hardware_specification" }, "asset_id": { "description": "The unique ID of the hardware specification.", "type": "string", "example": "2d5191ba-ff9b-4b48-a852-948d49dd9210" }, "project_id": { "description": "The project ID.", "type": "string", "example": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf" }, "space_id": { "description": "The space ID.", "type": "string", "example": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0" }, "owner_id": { "description": "IAM ID of the asset's owner.", "type": "string", "example": "IBMid-310000SG2Y" }, "created_at": { "description": "Date the asset was created.", "type": "string", "example": "2021-08-02T12:00:24.269Z" }, "updated_at": { "description": "Date the asset was last updated.", "type": "string", "example": "2021-08-02T12:00:24.269Z" }, "purpose": { "description": "The purposes of the hardware specification.", "x-internal": "cpd", "$ref": "#/components/schemas/EnvironmentsPurpose" }, "href": { "description": "The route to the hardware specification.", "type": "string", "example": "/v2/hardware_specifications/2d5191ba-ff9b-4b48-a852-948d49dd9210" } } }, "EnvironmentsSoftwareSpecificationEntityDefinition": { "description": "Software specification entity definition.", "properties": { "type": { "description": "The type (base or derived).", "type": "string", "enum": [ "derived", "base" ], "example": "derived" }, "display_name": { "description": "Software specification display name.", "type": "string", "example": "My Software Specification" }, "base_software_specification": { "$ref": "#/components/schemas/EnvironmentsBaseSoftwareSpecificationReference" }, "package_extensions": { "description": "The package extensions.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsPackageExtension" } }, "software_configuration": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationEntitySoftwareConfigurationDefinition" } } }, "EnvironmentsLifeCycle": { "x-internal": "cpd", "description": "The life cycle of the software specification.", "properties": { "deprecated": { "description": "Whether a software specification is deprecated or not.", "type": "boolean", "example": true }, "constricted": { "description": "Whether a software specification is constricted or not.", "type": "boolean" }, "retired": { "description": "Whether a software specification is retired or not.", "type": "boolean" }, "wml": { "$ref": "#/components/schemas/EnvironmentsWmlLifeCycle" }, "since_version": { "description": "CPD version since when the software specification is deployed.", "type": "string" }, "deprecated_since_version": { "description": "CPD version since when the software specification is deprecated.", "type": "string" }, "retired_since_version": { "description": "CPD version since when the software specification is retired.", "type": "string" }, "replacement_name": { "description": "Name of the successive software specification.", "type": "string" } } }, "EnvironmentsPurpose": { "description": "Purpose of a specification.", "type": "array", "items": { "x-internal": "cpd", "type": "string", "enum": [ "autoai", "do", "jupyterlab", "masking_flows", "notebook", "rstudio", "wml", "wmla", "wml-a" ] }, "example": [ "notebook", "wml" ] }, "EnvironmentsHardwareSpecificationEntityDefinition": { "description": "Hardware specification entity definition.", "oneOf": [ { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNodes" }, { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSpark" }, { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStage" } ] }, "EnvironmentsSoftwareSpecificationEntitySoftwareConfigurationDefinition": { "description": "Software configuration.", "properties": { "included_packages": { "description": "An array of included packages.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsIncludedPackagesDefinition" } }, "platform": { "$ref": "#/components/schemas/EnvironmentsPlatformDefinition" }, "language": { "$ref": "#/components/schemas/EnvironmentsLanguageDefinition" } } }, "EnvironmentsPackageExtension": { "description": "A package extension.", "properties": { "metadata": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionMetadata" }, "entity": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntity" } } }, "EnvironmentsBaseSoftwareSpecificationReference": { "description": "A reference to a base software specification.", "properties": { "guid": { "description": "The UUID of software specification.", "type": "string", "example": "ab9e1b80-f2ce-592c-a7d2-4f2344f77194" }, "href": { "x-out-of-example": true, "description": "The href of the software specification.", "type": "string", "example": "/v2/software_specifications/ab9e1b80-f2ce-592c-a7d2-4f2344f77194" } } }, "EnvironmentsWmlLifeCycle": { "x-internal": "cpd", "description": "The life cycle of the software specification for WML usage.", "properties": { "deprecated": { "description": "Whether a software specification is deprecated or not.", "type": "boolean", "example": false }, "constricted": { "description": "Whether a software specification is constricted or not.", "type": "boolean" }, "retired": { "description": "Whether a software specification is retired or not.", "type": "boolean" } } }, "EnvironmentsHardwareSpecificationDataStage": { "description": "Hardware specification DataStage main entity.", "properties": { "datastage": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStageDefinition" } } }, "EnvironmentsHardwareSpecificationSpark": { "description": "Hardware specification Spark main entity.", "properties": { "spark": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkDefinition" } } }, "EnvironmentsHardwareSpecificationNodes": { "description": "Hardware specification nodes main entity.", "properties": { "nodes": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNodesDefinition" } } }, "EnvironmentsLanguageDefinition": { "description": "A language definition.", "properties": { "name": { "description": "The name of the platform definition.", "type": "string", "example": "python" }, "version": { "description": "The version of the platform definition.", "type": "string", "example": 3.9 } } }, "EnvironmentsPlatformDefinition": { "description": "A platform definition.", "properties": { "name": { "description": "The name of the platform definition.", "type": "string", "example": "spark" }, "version": { "description": "The version of the platform definition.", "type": "string", "example": 3.2 } } }, "EnvironmentsIncludedPackagesDefinition": { "description": "The shape of included packages.", "properties": { "name": { "description": "The type of the package.", "type": "string", "example": "ipython" }, "version": { "description": "The version of the package.", "type": "string", "example": "7.22.0" } } }, "EnvironmentsPackageExtensionEntity": { "description": "Package extension entity.", "properties": { "package_extension": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityDefinitionWithObjectKey" } } }, "EnvironmentsPackageExtensionMetadata": { "description": "The package extension metadata.", "properties": { "name": { "description": "The name of the package extension.", "type": "string", "example": "my package extension" }, "description": { "description": "A description of the package extension.", "type": "string", "example": "this is my package extension" }, "asset_type": { "description": "Asset type.", "type": "string", "enum": [ "package_extension" ], "example": "package_extension" }, "asset_id": { "description": "The unique ID of the package extension.", "type": "string", "example": "461db2c9-effb-4bfb-8319-f4acf8ba06a3" }, "project_id": { "description": "The project ID.", "type": "string", "example": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf" }, "space_id": { "description": "The space ID.", "type": "string", "example": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0" }, "owner_id": { "description": "IAM ID of the asset's owner.", "type": "string", "example": "IBMid-310000SG2Y" }, "created_at": { "description": "Date when the asset was created.", "type": "string", "example": "2021-08-02T12:00:24.269Z" }, "updated_at": { "description": "Date when the asset was last updated.", "type": "string", "example": "2021-08-02T12:00:24.269Z" } } }, "EnvironmentsHardwareSpecificationDataStageDefinition": { "description": "DataStage definition of hardware specification.", "properties": { "num_conductors": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfConductors" }, "num_computes": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfComputes" }, "conductor": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStageConductorDefinition" }, "compute": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStageComputeDefinition" }, "instance": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStageInstance" } } }, "EnvironmentsHardwareSpecificationSparkDefinition": { "description": "Spark definition of hardware specification.", "properties": { "num_drivers": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkNumOfDrivers" }, "num_executors": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkNumOfExecutors" }, "driver": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkDriverDefinition" }, "executor": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkExecutorDefinition" } } }, "EnvironmentsHardwareSpecificationNodesDefinition": { "description": "Compute node definition of hardware specification.", "properties": { "cpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationCpuDefinition" }, "mem": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemoryDefinition" }, "gpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationGpuDefinition" }, "num_nodes": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfNodes" }, "num_drivers": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfDrivers" }, "drivers": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDriversDefinition" } } }, "EnvironmentsPackageExtensionEntityDefinitionWithObjectKey": { "description": "Package extension entity definition with object key.", "allOf": [ { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityDefinition" }, { "type": "object", "properties": { "object_key": { "type": "string", "description": "The file path of the package extension.", "example": "package_extension/Package_Extension_9GShiX8H0.yml" } } } ] }, "EnvironmentsHardwareSpecificationDataStageInstance": { "description": "Instance of DataStage.", "type": "string", "example": "instance-1" }, "EnvironmentsHardwareSpecificationDataStageComputeDefinition": { "description": "DataStage compute definition of hardware specification.", "properties": { "cpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationCpuDefinition" }, "mem": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemoryDefinition" } } }, "EnvironmentsHardwareSpecificationDataStageConductorDefinition": { "description": "DataStage conductor definition of hardware specification.", "properties": { "cpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationCpuDefinition" }, "mem": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemoryDefinition" } } }, "EnvironmentsHardwareSpecificationNumOfComputes": { "description": "Number of computes.", "type": "integer", "example": 2 }, "EnvironmentsHardwareSpecificationNumOfConductors": { "description": "Number of conductors.", "type": "integer", "example": 1 }, "EnvironmentsHardwareSpecificationSparkExecutorDefinition": { "description": "Spark executor definition of hardware specification.", "properties": { "cpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationCpuDefinition" }, "mem": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemoryDefinition" } } }, "EnvironmentsHardwareSpecificationSparkDriverDefinition": { "description": "Spark driver definition of hardware specification.", "properties": { "cpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationCpuDefinition" }, "mem": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemoryDefinition" } } }, "EnvironmentsHardwareSpecificationSparkNumOfExecutors": { "description": "Number of executors.", "type": "integer", "example": 2 }, "EnvironmentsHardwareSpecificationSparkNumOfDrivers": { "description": "Number of drivers.", "type": "integer", "example": 1 }, "EnvironmentsHardwareSpecificationDriversDefinition": { "description": "Drivers definition of hardware specification. Only support for Watson Machine Learning Accelerator.", "properties": { "cpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationCpuDefinition" }, "mem": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemoryDefinition" } } }, "EnvironmentsHardwareSpecificationNumOfDrivers": { "description": "Number of drivers. Only support for Watson Machine Learning Accelerator.", "type": "integer", "example": 1 }, "EnvironmentsHardwareSpecificationNumOfNodes": { "description": "Number of compute nodes.", "type": "integer", "example": 1 }, "EnvironmentsHardwareSpecificationGpuDefinition": { "description": "GPU definition of hardware specification.", "properties": { "num_gpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfGpu" }, "name": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationGpuName" }, "gpu_profile": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationGpuProfile" }, "mig_profile": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMigProfile" } } }, "EnvironmentsHardwareSpecificationMemoryDefinition": { "description": "Memory size of hardware specification.", "properties": { "size": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemorySize" } } }, "EnvironmentsHardwareSpecificationCpuDefinition": { "description": "(Fraction of) number of CPUs of hardware specification.", "properties": { "units": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationUnits" }, "model": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationModel" } } }, "EnvironmentsPackageExtensionEntityDefinition": { "description": "Package extension entity definition.", "properties": { "type": { "type": "string", "description": "The type of the package extension.", "enum": [ "conda_yml", "pip_zip" ], "example": "conda_yml" }, "interpreter": { "type": "string", "description": "The interpreter of the package extension.", "example": "mamba" } } }, "EnvironmentsHardwareSpecificationMigProfile": { "description": "MIG profile.", "type": "string", "example": "N/A" }, "EnvironmentsHardwareSpecificationGpuProfile": { "description": "GPU profile.", "type": "string", "example": "generic" }, "EnvironmentsHardwareSpecificationGpuName": { "description": "GPU model name.", "type": "string", "example": "v100" }, "EnvironmentsHardwareSpecificationNumOfGpu": { "description": "Number of GPUs.", "type": "integer", "example": 2 }, "EnvironmentsHardwareSpecificationMemorySize": { "type": "string", "example": "8Gi", "description": "Size of memory in Kubernetes." }, "EnvironmentsHardwareSpecificationModel": { "description": "Model of CPU.", "type": "string", "example": "string" }, "EnvironmentsHardwareSpecificationUnits": { "description": "Kubernetes units allowed.", "type": "string", "example": "100m" }, "EnvironmentsEnvironmentUpdateBody": { "description": "Body to send with a PATCH request to update an environment.", "properties": { "/metadata/name": { "description": "Name of the environment.", "type": "string", "example": "my updated notebook environment" }, "/metadata/description": { "description": "Description of the environment.", "type": "string", "example": "this is my updated notebook environment" }, "/entity/environment/display_name": { "description": "Display name of the environment.", "type": "string", "example": "My Updated Notebook Environment" }, "/entity/environment/hardware_specification": { "$ref": "#/components/schemas/EnvironmentsReferencedHardwareSpecification" }, "/entity/environment/software_specification": { "$ref": "#/components/schemas/EnvironmentsReferencedSoftwareSpecification" }, "/entity/environment/compute_specification": { "$ref": "#/components/schemas/EnvironmentsComputeSpecification" }, "/entity/environment/runtime_idle_time": { "x-internal": "cpd", "description": "Runtime idle timeout.", "type": "integer", "example": 3600000 }, "/entity/environment/environment_variables": { "$ref": "#/components/schemas/EnvironmentsEnvironmentVariables" }, "/entity/environment/config_variables": { "$ref": "#/components/schemas/EnvironmentsConfigVariables" }, "/entity/environment/tools_specification": { "$ref": "#/components/schemas/EnvironmentsToolsSpecification" } } }, "EnvironmentsConfigVariables": { "description": "Config variables for the environment.", "type": "object", "example": { "key3": "value3", "key4": "value4" } }, "EnvironmentsEnvironmentVariables": { "description": "Environment variables for the environment.", "type": "object", "example": { "key1": "value1", "key2": "value2" } }, "EnvironmentsHardwareSpecificationCreateBody": { "description": "Body to send with POST request to create hardware specification.", "required": [ "name" ], "allOf": [ { "type": "object", "properties": { "name": { "description": "Name of hardware specification.", "type": "string", "example": "my hardware specification" }, "description": { "description": "Description of hardware specification.", "type": "string", "example": "this is my hardware specification" } } }, { "oneOf": [ { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNodes" }, { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSpark" }, { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStage" } ] } ] }, "EnvironmentsHardwareSpecificationsList": { "description": "A list of hardware specifications.", "required": [ "total_results", "resources" ], "properties": { "total_results": { "description": "Number of items in the list.", "type": "integer", "example": 1 }, "resources": { "description": "An array of hardware specifications.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecification" } } } }, "EnvironmentsHardwareSpecificationUpdateBody": { "description": "Body of a PATCH call to update a hardware specification.", "allOf": [ { "type": "object", "properties": { "/metadata/name": { "description": "Name of the hardware specification.", "type": "string", "example": "my hardware specification" }, "/metadata/description": { "description": "Description of the hardware specification.", "type": "string", "example": "this is my hardware specification" } } }, { "oneOf": [ { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNodesUpdate" }, { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkUpdate" }, { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStageUpdate" } ] } ] }, "EnvironmentsHardwareSpecificationDataStageUpdate": { "description": "Body parameters to update a DataStage hardware specification.", "properties": { "/entity/hardware_specification/datastage/num_conductors": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfConductors" }, "/entity/hardware_specification/datastage/num_computes": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfComputes" }, "/entity/hardware_specification/datastage/conductor/cpu/units": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationUnits" }, "/entity/hardware_specification/datastage/conductor/cpu/model": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationModel" }, "/entity/hardware_specification/datastage/conductor/mem/size": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemorySize" }, "/entity/hardware_specification/datastage/compute/cpu/units": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationUnits" }, "/entity/hardware_specification/datastage/compute/cpu/model": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationModel" }, "/entity/hardware_specification/datastage/compute/mem/size": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemorySize" }, "/entity/hardware_specification/datastage/instance": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationDataStageInstance" } } }, "EnvironmentsHardwareSpecificationSparkUpdate": { "description": "Body parameters to update a Spark hardware specification.", "properties": { "/entity/hardware_specification/spark/num_drivers": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkNumOfDrivers" }, "/entity/hardware_specification/spark/num_executors": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationSparkNumOfExecutors" }, "/entity/hardware_specification/spark/driver/cpu/units": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationUnits" }, "/entity/hardware_specification/spark/driver/cpu/model": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationModel" }, "/entity/hardware_specification/spark/driver/mem/size": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemorySize" }, "/entity/hardware_specification/spark/executor/cpu/units": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationUnits" }, "/entity/hardware_specification/spark/executor/cpu/model": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationModel" }, "/entity/hardware_specification/spark/executor/mem/size": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemorySize" } } }, "EnvironmentsHardwareSpecificationNodesUpdate": { "description": "Body parameters to update a nodes hardware specification.", "properties": { "/entity/hardware_specification/nodes/cpu/units": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationUnits" }, "/entity/hardware_specification/nodes/cpu/model": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationModel" }, "/entity/hardware_specification/nodes/mem/size": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationMemorySize" }, "/entity/hardware_specification/nodes/gpu/num_gpu": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfGpu" }, "/entity/hardware_specification/nodes/gpu/name": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationGpuName" }, "/entity/hardware_specification/nodes/num_nodes": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationNumOfNodes" } } }, "EnvironmentsSoftwareSpecificationCreateBody": { "description": "The shape of the POST request body when creating a new software specification.", "required": [ "name" ], "allOf": [ { "type": "object", "properties": { "name": { "description": "Name of the software specification.", "type": "string", "example": "my software specification" }, "description": { "description": "Description of the software specification.", "type": "string", "example": "this is my software specification" }, "package_extensions": { "description": "Package extensions of the software specification.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionReference" } } } }, { "oneOf": [ { "$ref": "#/components/schemas/EnvironmentsDerivedSoftwareSpecificationCreateBody" }, { "$ref": "#/components/schemas/EnvironmentsBaseSoftwareSpecificationCreateBody" } ] } ] }, "EnvironmentsSoftwareSpecificationsList": { "description": "A list of software specifications.", "required": [ "total_results", "resources" ], "properties": { "total_results": { "description": "Number of results.", "type": "integer", "example": 1 }, "resources": { "description": "An array of software specifications.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecification" } } } }, "EnvironmentsBaseSoftwareSpecificationCreateBody": { "x-internal": "cpd", "description": "Payload for creating a new base software specification.", "required": [ "software_configuration" ], "properties": { "software_configuration": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationEntitySoftwareConfigurationDefinition" }, "purpose": { "$ref": "#/components/schemas/EnvironmentsPurpose" }, "life_cycle": { "$ref": "#/components/schemas/EnvironmentsLifeCycle" } } }, "EnvironmentsDerivedSoftwareSpecificationCreateBody": { "description": "Payload for creating a new derived software specification.", "required": [ "base_software_specification" ], "properties": { "base_software_specification": { "$ref": "#/components/schemas/EnvironmentsBaseSoftwareSpecificationReference" } } }, "EnvironmentsPackageExtensionReference": { "description": "A reference to a package extension.", "properties": { "guid": { "description": "The UUID of the package extension.", "type": "string", "example": "b82b95df-fc3e-4273-98f7-473d62a03c2b" }, "href": { "x-out-of-example": true, "description": "The href of the package extension.", "type": "string", "example": "/v2/package_extensions/b82b95df-fc3e-4273-98f7-473d62a03c2b" } } }, "EnvironmentsSoftwareSpecificationUpdateBody": { "description": "The shape of the PATCH request body when updating a software specification.", "properties": { "/metadata/name": { "description": "Name of the software specification.", "type": "string", "example": "my updated software specification" }, "/metadata/description": { "description": "Description of the software specification.", "type": "string", "example": "this is my updated software specification." }, "/entity/software_specification/display_name": { "description": "Display name of the software specification.", "type": "string", "example": "My Updated Software Specification." }, "/entity/software_specification/package_extensions": { "description": "Package extension of the software specification.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionReference" } } } }, "EnvironmentsPackageExtensionWithSignedURL": { "description": "A package extension with signed URL.", "properties": { "metadata": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionMetadata" }, "entity": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityWithSignedURL" } } }, "EnvironmentsPackageExtensionCreateBody": { "description": "The body to send with a package extension POST call.", "required": [ "name", "type" ], "properties": { "name": { "description": "The name of the package extension. Should be unique.", "type": "string", "example": "my package extension" }, "description": { "description": "The description of the package extension. Can be any string.", "type": "string", "example": "this is my package extension" }, "type": { "description": "The type of the package extension.", "type": "string", "enum": [ "pip_zip", "conda_yml" ], "example": "conda_yml" }, "interpreter": { "description": "The interpreter of the package extension.", "type": "string", "enum": [ "conda", "mamba" ], "example": "mamba" } } }, "EnvironmentsPackageExtensionsList": { "description": "A list of package extensions.", "required": [ "total_results", "resources" ], "properties": { "total_results": { "description": "The number of results.", "type": "integer", "example": 1 }, "resources": { "description": "An array of package extensions.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsPackageExtension" } } } }, "EnvironmentsPackageExtensionEntityWithSignedURL": { "description": "Package extension entity with signed URL.", "properties": { "package_extension": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityDefinitionWithSignedURL" } } }, "EnvironmentsPackageExtensionEntityDefinitionWithSignedURL": { "description": "Package extension entity definition with signed URL.", "allOf": [ { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityDefinition" }, { "type": "object", "properties": { "href": { "type": "string", "description": "A pre-signed URL for uploading (after POST) or downloading (after GET) the library contents.", "example": "/package_extension/Package_Extension_9GShiX8H0.yml" } } } ] }, "EnvironmentsPackageExtensionFull": { "description": "A package extension with object key and signed URL.", "properties": { "metadata": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionMetadata" }, "entity": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityFull" } } }, "EnvironmentsPackageExtensionUpdateBody": { "description": "The attributes that can be changed on a PATCH call.", "properties": { "/metadata/name": { "description": "The name of the package extension.", "type": "string", "example": "my updated package extension" }, "/metadata/description": { "description": "A description of the package extension.", "type": "string", "example": "this is my updated package extension" }, "/entity/package_extension/type": { "description": "The type of the package extension. One would not normally want to change it.", "type": "string", "enum": [ "conda_yml", "pip_zip" ], "example": "pip_zip" } } }, "EnvironmentsPackageExtensionEntityFull": { "description": "Package extension entity with object key and signed URL.", "properties": { "package_extension": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityDefinitionFull" } } }, "EnvironmentsPackageExtensionEntityDefinitionFull": { "description": "Package extension entity definition with object key and signed URL.", "allOf": [ { "$ref": "#/components/schemas/EnvironmentsPackageExtensionEntityDefinitionWithObjectKey" }, { "type": "object", "properties": { "href": { "type": "string", "description": "A pre-signed URL for uploading (after POST) or downloading (after GET) the library contents.", "example": "/package_extension/Package_Extension_9GShiX8H0.yml" } } } ] }, "EnvironmentsRuntimeDefinition": { "description": "Runtime definition.", "properties": { "metadata": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinitionMetadata" }, "entity": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinitionEntity" } } }, "EnvironmentsRuntimeDefinitionCreateBody": { "description": "Body to send with a POST request to create a runtime definition.", "required": [ "name", "display_name", "launch_configuration", "software_configuration" ], "properties": { "name": { "description": "Name of the runtime definition.", "type": "string", "example": "jupyter-py39" }, "display_name": { "description": "Display name of the runtime definition.", "type": "string", "example": "Runtime 22.1 on Python 3.9" }, "description": { "description": "Description of the runtime definition.", "type": "string", "example": "Runtime 22.1 on Python 3.9" }, "author": { "description": "Author of the runtime definition.", "type": "string", "example": "IBM" }, "tested": { "description": "Tested?", "type": "boolean", "example": true }, "is_service": { "description": "Service?", "type": "boolean", "example": true }, "features": { "description": "An array of features.", "type": "array", "items": { "type": "string", "example": "environment" } }, "runtime_type": { "description": "The type of the runtime.", "type": "string", "example": "jupyter-py39" }, "launch_configuration": { "description": "Custom launch configuration.", "type": "object", "additionalProperties": true }, "software_configuration": { "description": "Custom software configuration.", "type": "object", "additionalProperties": true } } }, "EnvironmentsRuntimeDefinitionsList": { "description": "List of runtime definitions.", "required": [ "total_results", "resources" ], "properties": { "total_results": { "description": "Size of list.", "type": "integer", "example": 1 }, "resources": { "description": "An array of runtime definitions.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinition" } } } }, "EnvironmentsRuntimeDefinitionEntity": { "description": "Main entity of runtime definition.", "properties": { "name": { "description": "Name of runtime definition.", "type": "string", "example": "jupyter-py39" }, "display_name": { "description": "Display name of runtime definition.", "type": "string", "example": "Runtime 22.1 on Python 3.9" }, "description": { "description": "Description of runtime definition.", "type": "string", "example": "Runtime 22.1 on Python 3.9" }, "project": { "description": "Project of the runtime definition.", "type": "string", "example": "103d3fc4-2e46-4581-a23a-b4484e13519e" }, "author": { "description": "Author of the runtime definition.", "type": "string", "example": "IBM" }, "tested": { "description": "Tested?", "type": "boolean", "example": true }, "is_service": { "description": "Service?", "type": "boolean", "example": true }, "features": { "description": "An array of features.", "type": "array", "items": { "type": "string", "example": "environment" } }, "runtime_type": { "description": "Type of runtime.", "type": "string", "example": "jupyter-py39" }, "launch_configuration": { "description": "Custom launch configuration.", "type": "object", "additionalProperties": true }, "software_configuration": { "description": "Custom software configuration.", "type": "object", "additionalProperties": true } } }, "EnvironmentsRuntimeDefinitionMetadata": { "description": "Runtime definition metadata.", "properties": { "guid": { "description": "Unique ID of the runtime definition.", "type": "string", "example": "c82b95df-fc3e-4273-98f7-473d62a03c2b" }, "created_at": { "description": "Date when the asset was created.", "type": "string", "example": "2021-07-01T00:00:00.000Z" }, "updated_at": { "description": "Date when the asset was last updated.", "type": "string", "example": "2021-07-01T00:00:00.000Z" } } }, "EnvironmentsRuntimeDefinitionUpdateBody": { "description": "Body to send with a PUT request to update a runtime definition.", "properties": { "name": { "description": "Name of the runtime definition.", "type": "string", "example": "jupyter-py39" }, "display_name": { "description": "Display name of the runtime definition.", "type": "string", "example": "Runtime 22.1 on Python 3.9" }, "description": { "description": "Description of the runtime definition.", "type": "string", "example": "Runtime 22.1 on Python 3.9" }, "author": { "description": "Author of the runtime definition.", "type": "string", "example": "IBM" }, "tested": { "description": "Tested?", "type": "boolean", "example": true }, "is_service": { "description": "Service?", "type": "boolean", "example": true }, "features": { "description": "An array of features.", "type": "array", "items": { "type": "string", "example": "environment" } }, "runtime_type": { "description": "The type of the runtime.", "type": "string", "example": "jupyter-py39" }, "launch_configuration": { "description": "Custom launch configuration.", "type": "object", "additionalProperties": true }, "software_configuration": { "description": "Custom software configuration.", "type": "object", "additionalProperties": true } } }, "GlobalSearchBulkUpdateResponseContent": { "type": "object", "properties": { "failures": { "type": "array", "items": { "type": "string" } }, "numUpdates": { "type": "number" }, "timeTook": { "type": "number" }, "versionConflicts": { "type": "number" } } }, "GlobalSearchRelationshipUpdateBody": { "type": "object", "properties": { "last_updated_at": { "type": "integer", "format": "int64" }, "query": { "type": "string" }, "script": { "type": "string" }, "provider_type_id_list": { "type": "array", "example": "[\"cams\"]", "items": { "type": "string" } } } }, "GlobalSearchSampleSearchResponse": { "type": "object", "properties": { "size": { "type": "integer", "format": "int32" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalSearchRow" } } } }, "GlobalSearchRow": { "type": "object", "properties": { "_score": { "type": "integer", "format": "int64" }, "provider_type_id": { "type": "string" }, "tenant_id": { "type": "string" }, "artifact_id": { "type": "string" }, "last_updated_at": { "type": "integer", "format": "int64" }, "metadata": { "$ref": "#/components/schemas/GlobalSearchMetadata" }, "entity": { "$ref": "#/components/schemas/GlobalSearchEntity" }, "custom_attributes": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalSearchCustomAttribute" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalSearchCategory" } } } }, "GlobalSearchCategory": { "type": "object", "properties": { "last_updated_at": { "type": "integer", "format": "int64" }, "primary_category_id": { "type": "string" }, "primary_category_global_id": { "type": "string" }, "primary_category_name": { "type": "string" }, "secondary_category_ids": { "type": "array", "items": { "type": "string" } }, "secondary_category_global_ids": { "type": "array", "items": { "type": "string" } }, "secondary_category_names": { "type": "array", "items": { "type": "string" } } } }, "GlobalSearchCustomAttribute": { "type": "object", "properties": { "last_updated_at": { "type": "integer", "format": "int64" }, "attribute_name": { "type": "string" }, "attribute_value": { "type": "string" } } }, "GlobalSearchEntity": { "type": "object", "properties": { "artifacts": { "$ref": "#/components/schemas/GlobalSearchArtifact" }, "assets": { "$ref": "#/components/schemas/GlobalSearchAsset" } } }, "GlobalSearchMetadata": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "artifact_type": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "modified_on": { "type": "string", "format": "date-time" }, "modified_by": { "type": "string" }, "terms": { "type": "array", "items": { "type": "string" } }, "term_global_ids": { "type": "array", "items": { "type": "string" } }, "steward_ids": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "classifications": { "type": "array", "items": { "type": "string" } }, "classification_global_ids": { "type": "array", "items": { "type": "string" } } } }, "GlobalSearchAsset": { "type": "object", "properties": { "catalog_id": { "type": "string" }, "project_id": { "type": "string" }, "space_id": { "type": "string" }, "column_names": { "type": "array", "items": { "type": "string" } }, "column_terms": { "type": "array", "items": { "type": "string" } }, "column_term_global_ids": { "type": "array", "items": { "type": "string" } }, "column_descriptions": { "type": "array", "items": { "type": "string" } }, "connection_paths": { "type": "array", "items": { "type": "string" } }, "column_tags": { "type": "array", "items": { "type": "string" } }, "connection_ids": { "type": "array", "items": { "type": "string" } }, "column_data_class_names": { "type": "array", "items": { "type": "string" } }, "resource_key": { "type": "string" } } }, "GlobalSearchArtifact": { "type": "object", "properties": { "global_id": { "type": "string" }, "version_id": { "type": "string" }, "artifact_id": { "type": "string" }, "rule_type": { "type": "string" }, "effective_start_date": { "type": "string", "format": "date-time" }, "effective_end_date": { "type": "string", "format": "date-time" }, "abbreviation": { "type": "array", "items": { "type": "string" } }, "synonyms": { "type": "array", "items": { "type": "string" } }, "synonym_global_ids": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" } } }, "GlossaryV3ErrorContainerV3": { "type": "object", "description": "Error Container", "properties": { "errors": { "type": "array", "description": "List of errors.", "items": { "$ref": "#/components/schemas/GlossaryV3ErrorModelV3" } }, "trace": { "type": "string", "description": "The trace id.", "example": "f31b503c-784a-496b-99ce-68f090415054", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, "required": [ "errors", "trace" ] }, "GlossaryV3CategoryResponse": { "type": "object", "description": " * Response returned on creating a category.
It differs from its base class ({@link CreateResponse}) because it does not include {@code /version/{version_id}} in paths of returned URLs (the categories API does not have such endpoints, only {@code GET /categories/{category_id}}).", "properties": { "resources": { "type": "array", "description": "IDs of the created items.", "items": { "$ref": "#/components/schemas/GlossaryV3GlossaryResource" } } } }, "GlossaryV3NewCategoryEntity": { "type": "object", "description": "Represents a category to be created.", "properties": { "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category_id": { "type": "string", "description": "Artifact ID of a parent category", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reporting_authorized": { "type": "boolean", "description": "Used by reporting service for authorization. Can be set only for root level categories." }, "response_custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "name" ] }, "GlossaryV3ErrorModelV3": { "type": "object", "description": "List of errors.", "properties": { "code": { "type": "string", "description": "The error code.", "example": "not_found", "pattern": "^(success|info|redirect|unknown|client_error|not_found|conflict|server_error|service_unavailable|invalid_json_provided|insufficient_privileges|plan_limit_reached|database_deadlock|missing_required_property|unchangeable_property)$" }, "message": { "type": "string", "description": "The error message.", "maxLength": 4000, "minLength": 1, "pattern": ".*" }, "more_info": { "type": "string", "description": "The additional information of the error.", "maxLength": 4000, "minLength": 1, "pattern": ".*" }, "target": { "$ref": "#/components/schemas/GlossaryV3ErrorTargetModelV3" } }, "required": [ "code", "message" ] }, "GlossaryV3GlossaryResource": { "type": "object", "description": "Glossary artifact data", "properties": { "artifact_id": { "type": "string", "description": "The ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "entity_type": { "type": "string", "description": "The type of the artifact", "enum": [ "category", "glossary_term", "classification", "data_class", "reference_data", "policy", "rule" ], "example": "data_class", "readOnly": true }, "global_id": { "type": "string", "description": "The global ID of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})", "readOnly": true }, "href": { "type": "string", "description": "Resource url", "example": "/v3/glossary_terms/990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent_category_global_id": { "type": "string", "description": "The global ID of the parent category of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})" }, "parent_category_id": { "type": "string", "description": "The artifact ID of the parent category", "example": "990e33f5-3108-4d45-a667-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "version_id": { "type": "string", "description": "The version ID of the artifact", "example": "4fb86a70-7035-4b3e-8825-137c7b9b1687_1", "maxLength": 40, "minLength": 36, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?" }, "workflow_id": { "type": "string", "description": "The workflow ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true } }, "required": [ "artifact_id" ] }, "GlossaryV3ResponseCustomRelationship": { "type": "object", "description": "Custom relationship", "properties": { "artifact_id": { "type": "string", "description": "Custom attribute artifact ID", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "definition_id": { "type": "string", "description": "Custom attribute definition ID", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "description": { "type": "string", "description": "Custom attribute description", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "name": { "type": "string", "description": "Custom attribute name. The parameter is_reversed is taken into account", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "read_only": { "type": "boolean", "description": "true or false", "readOnly": true }, "related_artifact_types": { "type": "array", "description": "Related artifact types supported by this custom relationship definition. The parameter is_reversed is taken into account", "items": { "type": "string", "description": "Related artifact types supported by this custom relationship definition. The parameter is_reversed is taken into account", "maxLength": 32, "minLength": 1, "pattern": ".*", "readOnly": true }, "maxLength": 32, "minLength": 1, "pattern": ".*", "readOnly": true, "uniqueItems": true }, "relationships": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "reversed": { "type": "boolean", "description": "true or false" }, "total_count": { "type": "integer", "format": "int64", "description": "Total number of custom relationships fo given type.", "example": 30 } }, "readOnly": true }, "GlossaryV3NewCustomRelationship": { "type": "object", "description": "Custom relationship", "properties": { "definition_id": { "type": "string", "description": "Custom attribute definition ID", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "relationships": { "type": "array", "description": "List of custom relationships values", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "reversed": { "type": "boolean", "description": "true or false" }, "target_type": { "type": "string", "description": "Asset type", "example": "data_class", "maxLength": 32, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3CustomAttributeV3": { "type": "object", "description": "Custom attribute with its values", "properties": { "custom_attribute_definition_id": { "type": "string", "description": "Custom attribute definition ID", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "description": { "type": "string", "description": "Custom Attribute description", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "name": { "type": "string", "description": "Custom Attribute name", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "read_only": { "type": "boolean", "description": "True if custom attribute is read only, otherwise false", "readOnly": true }, "searchable": { "type": "boolean", "description": "True if custom attribute is searchable in global search, otherwise false", "readOnly": true }, "type": { "type": "string", "description": "Type of Custom Attribute", "maxLength": 32, "minLength": 1, "pattern": ".*", "readOnly": true }, "values": { "type": "array", "description": "List of values", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeValueObject" } } } }, "GlossaryV3NewRelationship": { "type": "object", "description": "The parent category of the artifact.", "properties": { "id": { "type": "string", "description": "Artifact id of the related artifact.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } }, "GlossaryV3ErrorTargetModelV3": { "type": "object", "description": "Error Target", "properties": { "name": { "type": "string", "description": "The name of error target.", "example": "Source type" }, "type": { "type": "string", "description": "The type of the error target, like field, parameter, header.", "enum": [ "field", "parameter", "header" ] } }, "required": [ "name", "type" ] }, "GlossaryV3PaginatedRelationshipsList": { "type": "object", "description": "Paginated relationships", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipRelationshipEntityV3" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3CustomAttributeValueObject": { "type": "object", "description": "Custom Attribute Value", "properties": { "value": { "type": "object", "description": "Value" } } }, "GlossaryV3RelationshipRelationshipEntityV3": { "type": "object", "description": "Relationship object", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3RelationshipEntityV3" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3GlossaryResourceLinkV3": { "type": "object", "description": "Represents an html link.", "properties": { "href": { "type": "string", "description": "URL to access the given Glossary resource", "maxLength": 2048, "minLength": 1, "pattern": ".*" }, "offset": { "type": "integer", "format": "int32", "description": "The offset of given Glossary resource" } } }, "GlossaryV3GlossaryObjectMetadataV3": { "type": "object", "description": "Metadata of the entity.", "properties": { "artifact_id": { "type": "string", "description": "Artifact ID", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "artifact_type": { "type": "string", "description": "Artifact type", "enum": [ "category", "glossary_term", "classification", "data_class", "reference_data", "policy", "rule" ], "maxLength": 32, "minLength": 1 }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 timestamp on when the artifact was created (system managed)", "example": "2017-02-15T02:30:32.000Z", "maxLength": 32, "minLength": 10, "readOnly": true }, "created_by": { "type": "string", "description": "User ID of the user who created the artifact (system managed)", "example": "IBMid-1234567ABC", "maxLength": 64, "minLength": 1, "pattern": ".*", "readOnly": true }, "draft_ancestor_id": { "type": "string", "description": "Draft Ancestor ID", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "draft_mode": { "type": "string", "description": "Draft mode", "enum": [ "created", "modified", "marked_for_deletion", "import_create", "import_modified", "MOVE" ] }, "effective_end_date": { "type": "string", "format": "date-time", "description": "Effective End Date", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "Effective Start Date", "maxLength": 32, "minLength": 10 }, "external_id": { "type": "string", "description": "External ID that is applicable to artifacts shared through OMRS. ID of the artifact in the external metadata source.", "maxLength": 64, "minLength": 64, "pattern": ".*", "readOnly": true }, "global_id": { "type": "string", "description": "Global ID that uniquely identifies a specific artifact in any repository in the OMRS cohort. Formatted as '_'.", "maxLength": 73, "minLength": 1, "pattern": ".*" }, "modified_at": { "type": "string", "format": "date-time", "description": "RFC 3339 timestamp on when the artifact was last modified (system managed)", "example": "2017-02-15T02:30:32.000Z", "maxLength": 32, "minLength": 10, "readOnly": true }, "modified_by": { "type": "string", "description": "User ID of the user who last modified the artifact (system managed)", "example": "IBMid-1234567ABC", "maxLength": 64, "minLength": 1, "pattern": ".*", "readOnly": true }, "name": { "type": "string", "description": "Name of the artifact", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "published_ancestor_id": { "type": "string", "description": "Published Ancestor ID", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "read_only": { "type": "boolean", "description": "Read only" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "short_description": { "type": "string", "description": "Short description of the artifact", "example": "short description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "source_repository_id": { "type": "string", "description": "ID of the source repository where the artifact / category is managed. If the artifact / category is created in local repository, then it is the ID of the local repository. If the artifact / category is synced from an external repository through OMRS, it is the ID of the external metadata repository.", "maxLength": 64, "minLength": 36, "pattern": ".*", "readOnly": true }, "source_repository_name": { "type": "string", "description": "Name of the source repository where the artifact / category is managed. If the artifact / category is created in local repository, then it is the name of the local repository. If the artifact / category is synced from an external repository through OMRS, it is the name of the external metadata repository.", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "state": { "type": "string", "description": "State of the artifact", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ] }, "steward_ids": { "type": "array", "description": "Steward IDs", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "Steward IDs", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "Tags", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "Tags", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "user_access": { "type": "boolean", "description": "User access" }, "version_id": { "type": "string", "description": "Version ID", "maxLength": 40, "minLength": 1, "pattern": ".*" }, "workflow_id": { "type": "string", "description": "Workflow ID", "maxLength": 73, "minLength": 1, "pattern": ".*" }, "workflow_state": { "type": "string", "description": "State of the workflow", "example": "PUBLISHED", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "readOnly": true }, "GlossaryV3RelationshipEntityV3": { "type": "object", "description": "Entity object for relationship", "properties": { "additional_info": { "$ref": "#/components/schemas/GlossaryV3AdditionalInfo" }, "definition_id": { "type": "string", "description": "Custom Relationship definition ID.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "description": { "type": "string", "description": "Description of the relationship.", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of a relationship managed in an external metadata server." }, "target_description": { "type": "string", "description": "Description of the referenced entity.", "maxLength": 15000, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_effective_end_date": { "type": "string", "format": "date-time", "description": "Effective End Date of the referenced entity.", "readOnly": true }, "target_effective_start_date": { "type": "string", "format": "date-time", "description": "Effective Start Date of the referenced entity.", "readOnly": true }, "target_global_id": { "type": "string", "description": "Global ID of the referenced entity.", "maxLength": 73, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_href": { "type": "string", "description": "The URI to access the referenced entity.", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_id": { "type": "string", "description": "ID of the referenced entity.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "target_name": { "type": "string", "description": "Name of the referenced entity.", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_parent_category_id": { "type": "string", "description": "Artifact ID of the parent category of the referenced entity.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "target_parent_category_name": { "type": "string", "description": "Name of the parent category of the referenced entity.", "maxLength": 255, "pattern": ".*", "readOnly": true }, "target_version_id": { "type": "string", "description": "The version ID of the artifact.", "maxLength": 40, "minLength": 1, "pattern": ".*", "readOnly": true }, "type": { "type": "string", "description": "Relationship Type", "enum": [ "parent_category", "categories", "terms", "classifications", "data_classes", "reference_data", "policies", "rules", "custom", "all", "is_a_type_of_category", "has_types_category", "is_a_parent_category_for", "grouped_assets", "owned_by", "is_a_type_of_classification", "has_types_classifications", "has_types_classifications_hierarchy", "related_categories", "is_a_type_of_data_class", "has_types_data_classes", "has_types_data_class_hierarchy", "parent_policy", "sub_policies", "data_location_rules", "data_protection_rules", "child", "parent", "child_value", "parent_value", "parent_value_hierarchy", "single_value_mappings", "multi_value_mappings", "value_mappings", "is_a_type_of_terms", "has_type_terms", "has_types_term_hierarchy", "is_of_terms", "has_terms", "synonym_terms", "related_terms", "replaces_terms", "replaced_by_terms", "reference_data_values" ] } } }, "GlossaryV3AdditionalInfo": { "type": "object", "description": "Additional info for relationship", "properties": { "rds_code": { "type": "string", "description": "Rds Code", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "rds_id": { "type": "string", "description": "Rds id", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "rds_value": { "type": "string", "description": "Rds value", "maxLength": 4000, "minLength": 1, "pattern": ".*" }, "rds_value_description": { "type": "string", "description": "Rds value description", "maxLength": 8000, "minLength": 1, "pattern": ".*" }, "rds_version_id": { "type": "string", "description": "Rds version id", "maxLength": 40, "minLength": 1, "pattern": ".*" }, "rdv_composite_key_values": { "type": "array", "description": "Values of custom columns being part of composite key for target RDV", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntity" } }, "source_rds_id": { "type": "string", "description": "Source rds id", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "target_rds_id": { "type": "string", "description": "Target rds id", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "target_rds_name": { "type": "string", "description": "Target rds name", "maxLength": 4000, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3RDVCustomColumnEntity": { "type": "object", "description": "Values of custom columns being part of composite key", "properties": { "id": { "type": "string", "description": "Custom column ID", "example": "b4610037-3a7c-4e4e-9e7e-4d2c03f4f75b", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "name": { "type": "string", "description": "Custom column name", "example": "CC1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "type": { "type": "string", "description": "Custom column type", "enum": [ "TEXT", "DATE", "NUMBER" ] }, "value": { "type": "string", "description": "Custom column value", "example": "Custom Column Value", "maxLength": 4000, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3BootstrapStatus": { "type": "object", "description": "Bootstrap Status", "properties": { "completed_records": { "type": "integer", "format": "int32", "description": "Number of records already bootstrapped successfully" }, "completion_message": { "type": "string", "description": "Overall outcome of the bootstrap process. Set once bootstrapping is finished." }, "current_step": { "type": "string", "description": "Current bootstrap activity" }, "errors": { "type": "array", "description": "Bootstrap process errors", "items": { "type": "string", "description": "Bootstrap process errors" } }, "status": { "type": "string", "description": "Current bootstrap status", "enum": [ "NOT_STARTED", "NEW", "IN_PROGRESS", "SUCCEEDED", "FAILED", "STALLED" ] }, "total_records": { "type": "integer", "format": "int32", "description": "Total number of records to be processed by the bootstrap process" } }, "required": [ "status" ] }, "GlossaryV3BootstrapStatusHistoryResponse": { "type": "object", "description": "Response returned on retrieving bootstrap status history.", "properties": { "bootstrap_status_history": { "type": "array", "description": "Bootstrap status history list", "items": { "$ref": "#/components/schemas/GlossaryV3BootstrapStatus" } } } }, "GlossaryV3CategoryHierarchyResponse": { "type": "object", "description": "Response returned on retrieving hierarchy path for category.", "properties": { "category_hierarchy_paths": { "type": "array", "description": "IDs and names of categories in category hierarchy path for each category id", "items": { "$ref": "#/components/schemas/GlossaryV3CategoryHierarchyPath" } } } }, "GlossaryV3GlossaryResourceList": { "type": "object", "description": "List of glossary resources", "properties": { "resources": { "type": "array", "description": "List of resources.", "items": { "$ref": "#/components/schemas/GlossaryV3GlossaryResource" } } } }, "GlossaryV3CategoryHierarchyPath": { "type": "object", "description": "Object to contain the information about hierarchy path of category.", "properties": { "category_hierarchy_path": { "type": "array", "description": "Category Hierarchy Records", "items": { "$ref": "#/components/schemas/GlossaryV3CategoryHierarchyRecord" } }, "category_id": { "type": "string", "description": "The artifact ID of the category.", "example": "990e33f5-3108-4d45-a530-0307458362d4" } } }, "GlossaryV3CategoryHierarchyRecord": { "type": "object", "description": "Object to contain the information about id and name of category hierarchy record.", "properties": { "artifact_id": { "type": "string", "description": "The artifact ID of the category.", "example": "990e33f5-3108-4d45-a530-0307458362d4" }, "name": { "type": "string", "description": "The category name.", "example": "category name" }, "user_access": { "type": "boolean", "description": "True when user has has access to the category, false otherwise", "example": true } } }, "GlossaryV3CategoryV3": { "type": "object", "description": "Represents a category object - which contains metadata and category entity.", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3CategoryEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3CategoryEntity": { "type": "object", "description": "Represents a category.", "properties": { "classification_relationships": { "type": "array", "description": "The relationships to the classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "grouped_assets_rels": { "type": "array", "description": "Assets grouped by category. If a certain asset type requires a workflow process, only published assets of this type can belong to this list.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" }, "readOnly": true }, "has_types_category_rels": { "type": "array", "description": "The list of child categories in the category type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" }, "readOnly": true }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "parent_category_for": { "type": "array", "description": "List of artifacts for which this category is a parent category. If a certain asset type requires a workflow process, only published assets of this type can belong to this list.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" }, "readOnly": true }, "parent_category_id": { "type": "string", "description": "Artifact ID of a parent category" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reporting_authorized": { "type": "boolean", "description": "Used by reporting service for authorization. Can be set only for root level categories." }, "response_custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3RelationshipObject": { "type": "object", "description": "Relationship object", "properties": { "entity": { "type": "object", "description": "Entity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } }, "readOnly": true }, "GlossaryV3UpdatableCategoryEntity": { "type": "object", "description": "Represents a data class to be updated.", "properties": { "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category_id": { "type": "string", "description": "Artifact ID of a parent category. This is read only property and should not be changed.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reporting_authorized": { "type": "boolean", "description": "Used by reporting service for authorization. Can be set only for root level categories." }, "response_custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3GlossaryArchiveResponse": { "type": "object", "description": "Glossary archive response object", "properties": { "archived_guids": { "type": "array", "description": "Guids of the archived objects.", "items": { "type": "string", "description": "Guids of the archived objects." } }, "delete_guids": { "type": "array", "description": "Guids of the deleted objects.", "items": { "type": "string", "description": "Guids of the deleted objects." } }, "updated_guids": { "type": "array", "description": "Guids of the updated objects.", "items": { "type": "string", "description": "Guids of the updated objects." } } } }, "GlossaryV3NewCategoryAssignment": { "type": "object", "description": "Assignment of an artifact to a category", "properties": { "artifact_type": { "type": "string", "description": "Type of the artifact to be added to a category", "example": "data_class", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "is_primary_category": { "type": "boolean", "description": "true when a primary category should be set for an artifact, false when the artifact should be added to a secondary category", "example": true } }, "required": [ "artifact_type", "is_primary_category" ] }, "GlossaryV3Collaborator": { "type": "object", "description": "Category permission list for given category id", "properties": { "category_artifact_id": { "type": "string", "description": "Category Artifact Id" }, "category_name": { "type": "string", "description": "Category Name" }, "create_time": { "type": "string", "format": "date-time", "description": "Create Time" }, "dps_rule_id": { "type": "string", "description": "DPS Rule Id" }, "id": { "type": "string", "description": "Id" }, "principal_id": { "type": "string", "description": "Principal Id" }, "role": { "type": "string", "description": "Role" }, "user_type": { "type": "string", "description": "User type" } } }, "GlossaryV3NewRoleAssignment": { "type": "object", "description": "New collaborator data representing user with assigned role. It will be created in the context of specific category.", "properties": { "principal_id": { "type": "string", "description": "Id of the user to be assigned to given role", "maxLength": 73, "minLength": 1, "pattern": ".*" }, "role": { "type": "string", "description": "Role to be assigned", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "user_type": { "type": "string", "description": "Type of the user. When not provided defaults to USER", "enum": [ "USER", "GROUP" ] } }, "required": [ "principal_id", "role" ] }, "GlossaryV3RoleAssignmentResponse": { "type": "object", "description": "Response returned on retrieving category permissions.", "properties": { "collaborators": { "type": "array", "description": "Category permission list for given category id", "items": { "$ref": "#/components/schemas/GlossaryV3Collaborator" } }, "total_results": { "type": "integer", "format": "int32", "description": "Number of category permissions" } } }, "GlossaryV3RelationshipsResponse": { "type": "object", "description": "Response that includes relationships to a managed object, like business term, data class, classification", "properties": { "custom_relationships": { "type": "array", "description": "List of custom relationships", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "empty": { "type": "boolean" }, "relationships": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GlossaryV3OffsetPaginatedListRelationshipObject" }, "description": "Mapping of the relationship type to the paginated list of relationships" } } }, "GlossaryV3OffsetPaginatedListRelationshipObject": { "type": "object", "description": "Base V3 class for paginated results", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3CategoryRoleStatisticsList": { "type": "object", "description": "List of role usage summary", "properties": { "role_assignment_statistics": { "type": "array", "description": "List of roles assigned in glossary, along with number of categories which have role assigned", "items": { "$ref": "#/components/schemas/GlossaryV3CategoryRoleStatisticsItem" } } } }, "GlossaryV3CategoryRoleStatisticsItem": { "type": "object", "description": "List of roles assigned in glossary, along with number of categories which have role assigned", "properties": { "numer_of_categories": { "type": "integer", "format": "int64", "description": "Numer of categories which has this role assigned" }, "role": { "type": "string", "description": "Role" } } }, "GlossaryV3PaginatedCategoryStatisticItemList": { "type": "object", "description": "List of category statistic items", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3CategoryStatisticItem" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3CategoryStatisticItem": { "type": "object", "description": "Represents a category statistics item.", "properties": { "category_artifact_id": { "type": "string", "description": "Category Artifact Id" }, "category_hierarchy_path": { "type": "array", "description": "Category Hierarchy Records", "items": { "$ref": "#/components/schemas/GlossaryV3CategoryHierarchyRecord" } }, "category_name": { "type": "string", "description": "Category Name" }, "groups_assignments_count": { "type": "integer", "format": "int64", "description": "Number of group-type collaborators assigned to this category" }, "users_assignments_count": { "type": "integer", "format": "int64", "description": "Number of user-type collaborators assigned to this category" } } }, "GlossaryV3Resource": { "type": "object", "description": "Create response object returned on creating a resource such as a Term, Category, Classification, DataClass, Policy.", "properties": { "resources": { "type": "array", "description": "IDs of the created items.", "items": { "$ref": "#/components/schemas/GlossaryV3GlossaryResource" } } } }, "GlossaryV3NewClassificationEntity": { "type": "object", "description": "New classification entity", "properties": { "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "has_types_classifications": { "type": "array", "description": "The child classification relationships in the classification type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_a_type_of_classification": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "related_categories": { "type": "array", "description": "Relationships to categories.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "short_description": { "type": "string", "description": "The short description of an artifact.", "example": "short description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "workflow_state": { "type": "string", "description": "The workflow state of an artifact", "example": "PUBLISHED", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "name" ] }, "GlossaryV3PaginatedArtifactList": { "type": "object", "description": "List of paginated artifacts", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3WdpApiModeledObjectEntityV3" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3WdpApiModeledObjectEntityV3": { "type": "object", "description": "Represents an object that we send back to the end user. It has two parts: entity and metadata.", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3EntityV3" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3EntityV3": { "type": "object", "description": "Base object for entity" }, "GlossaryV3ResponseClassification": { "type": "object", "description": "Response classification object", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3ResponseClassificationEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3UpdatableClassificationEntity": { "type": "object", "description": "Update classification entity object", "properties": { "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "has_types_classifications": { "type": "array", "description": "The child classification relationships in the classification type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_a_type_of_classification": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "related_categories": { "type": "array", "description": "Relationships to categories.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "short_description": { "type": "string", "description": "The short description of an artifact.", "example": "short description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } }, "required": [ "revision" ] }, "GlossaryV3ResponseClassificationEntity": { "type": "object", "description": "Response classification entity object", "properties": { "categories": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "data_classes": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "has_types_classifications": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "has_types_classifications_hierarchy": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "is_a_type_of_classification": { "$ref": "#/components/schemas/GlossaryV3PaginatedParentRelationshipsList" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "policies": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reference_data": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "related_categories": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "rules": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "items": { "type": "string", "description": "The tags assigned to an artifact." } }, "terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" } } }, "GlossaryV3PaginatedParentRelationshipsList": { "type": "object", "description": "The list of parent business terms in the business term containment hierarchy.", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3ParentRelationship" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3ParentRelationship": { "type": "object", "description": "Parent Relationship object", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3ParentRelationshipEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3ParentRelationshipEntity": { "type": "object", "description": "Entity", "properties": { "child_category_id": { "type": "string", "description": "Artifact ID of the parent category of the child artifact.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "child_description": { "type": "string", "description": "Description of the child artifact.", "readOnly": true }, "child_global_id": { "type": "string", "description": "Child Global ID.", "maxLength": 73, "minLength": 1, "pattern": ".*", "readOnly": true }, "child_href": { "type": "string", "description": "The URI to access the child artifact.", "readOnly": true }, "child_id": { "type": "string", "description": "Child ID.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "child_name": { "type": "string", "description": "Child name.", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "description": { "type": "string", "description": "Description of the relationship.", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent_category_id": { "type": "string", "description": "Artifact ID of the parent category of the parent.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "parent_description": { "type": "string", "description": "Description of the parent.", "maxLength": 15000, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent_effective_end_date": { "type": "string", "format": "date-time", "description": "Effective end date of the parent.", "readOnly": true }, "parent_effective_start_date": { "type": "string", "format": "date-time", "description": "Effective start date of the parent.", "readOnly": true }, "parent_global_id": { "type": "string", "description": "Global ID of the parent.", "maxLength": 73, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent_href": { "type": "string", "description": "The URI to access the parent.", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent_id": { "type": "string", "description": "ID of the parent.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "parent_name": { "type": "string", "description": "Name of the parent.", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent_parent_category_name": { "type": "string", "description": "Name of the parent category of the parent.", "maxLength": 255, "pattern": ".*", "readOnly": true }, "parent_version_id": { "type": "string", "description": "Version ID of the parent.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of a relationship managed in an external metadata server." }, "target_description": { "type": "string", "description": "Description of the referenced entity.", "maxLength": 15000, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_effective_end_date": { "type": "string", "format": "date-time", "description": "Effective End Date of the referenced entity.", "readOnly": true }, "target_effective_start_date": { "type": "string", "format": "date-time", "description": "Effective Start Date of the referenced entity.", "readOnly": true }, "target_global_id": { "type": "string", "description": "Global ID of the referenced entity.", "maxLength": 73, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_href": { "type": "string", "description": "The URI to access the referenced entity.", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_id": { "type": "string", "description": "ID of the referenced entity.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "target_name": { "type": "string", "description": "Name of the referenced entity.", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "target_parent_category_id": { "type": "string", "description": "Artifact ID of the parent category of the referenced entity.", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true }, "target_parent_category_name": { "type": "string", "description": "Name of the parent category of the referenced entity.", "maxLength": 255, "pattern": ".*", "readOnly": true }, "target_version_id": { "type": "string", "description": "The version ID of the artifact.", "maxLength": 40, "minLength": 1, "pattern": ".*", "readOnly": true }, "type": { "type": "string", "description": "Relationship Type", "enum": [ "parent_category", "categories", "terms", "classifications", "data_classes", "reference_data", "policies", "rules", "custom", "all", "is_a_type_of_category", "has_types_category", "is_a_parent_category_for", "grouped_assets", "owned_by", "is_a_type_of_classification", "has_types_classifications", "has_types_classifications_hierarchy", "related_categories", "is_a_type_of_data_class", "has_types_data_classes", "has_types_data_class_hierarchy", "parent_policy", "sub_policies", "data_location_rules", "data_protection_rules", "child", "parent", "child_value", "parent_value", "parent_value_hierarchy", "single_value_mappings", "multi_value_mappings", "value_mappings", "is_a_type_of_terms", "has_type_terms", "has_types_term_hierarchy", "is_of_terms", "has_terms", "synonym_terms", "related_terms", "replaces_terms", "replaced_by_terms", "reference_data_values" ] } } }, "GlossaryV3ClassificationRelationshipsRequest": { "type": "object", "description": "Classification relationships request", "properties": { "categories": { "type": "array", "description": "Category relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_classes": { "type": "array", "description": "The relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "has_types_classifications": { "type": "array", "description": "The child classification relationships in the classification type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_a_type_of_classification": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "related_categories": { "type": "array", "description": "The relationships to categories.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "terms": { "type": "array", "description": "The relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } }, "GlossaryV3NewDataClassEntity": { "type": "object", "description": "Entity class of new dataclass", "properties": { "additional_applicable_for": { "type": "string", "description": "To specify additional applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )", "example": "all_data", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "additional_regular_expression": { "type": "string", "description": "To specify additional regular expression; ( This property is applicable for data class type: Regex )", "example": ".*", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "allow_substring_match": { "type": "boolean", "description": "To specify allow substring match boolean flag; ( This property is applicable for data class type: ValidValues )" }, "applicable_for": { "type": "string", "description": "To specify applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )", "example": "all_data", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "case_sensitive": { "type": "boolean", "description": "To specify case sensitive boolean flag; ( This property is applicable for data class type: ValidValues )" }, "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "class_code": { "type": "string", "description": "Unique class code given to the data class.", "example": "class code1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "column_name_match": { "type": "string", "description": "To specify column name match", "example": "^[a-zA-Z]*$", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_class_type": { "type": "string", "description": "To specify the type of data class: ColumnSimilarity, Java, ReferenceDataSet, Regex, Script, Undefined, UnstructuredFilter, ValidValues", "maxLength": 32, "minLength": 1, "pattern": "^(ColumnSimilarity|Java|Regex|Script|Undefined|UnstructuredFilter|ValidValues|ReferenceDataSet|Fingerprint|OtherMatchingCriteria)$" }, "data_type": { "type": "array", "description": "DataType: numeric, string, date, time, timestamp", "example": [ "numeric", "string", "date", "time", "timestamp" ], "items": { "type": "string", "description": "DataType: numeric, string, date, time, timestamp", "example": "[\"numeric\",\"string\",\"date\",\"time\",\"timestamp\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "enabled": { "type": "boolean", "description": "This flag indicates whether the data class can be used for data profiling or not." }, "example": { "type": "string", "description": "Data class example", "example": "example1", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "expression": { "type": "string", "description": "To specify expression; ( This property is applicable for data class type: UnstructuredFilter )", "example": "expression", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "has_types_data_classes": { "type": "array", "description": "List of immediate child data classes in the data class type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_a_type_of_data_class": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "java_class_name": { "type": "string", "description": "To specify Java class name; ( This property is applicable for data class type: Java )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "language": { "type": "string", "description": "To specify language: JavaScript, DataRule; ( This property is applicable for data class type: Script )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maximum_data_length": { "type": "integer", "format": "int32", "description": "To specify maximum data length" }, "minimum_data_length": { "type": "integer", "format": "int32", "description": "To specify minimum data length" }, "name": { "type": "string", "description": "The name of the artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "priority": { "type": "number", "format": "double", "description": "Data class priority used while profiling." }, "properties": { "type": "string", "description": "To specify properties; ( This property is applicable for data class type: Java )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "provider": { "type": "string", "description": "The provider of data class", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "reference_columns_metadata": { "type": "string", "description": "To specify reference columns metadata; ( This property is applicable for data class type: ColumnSimilarity )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "regular_expression": { "type": "string", "description": "To specify regular expression; ( This property is applicable for data class type: Regex )", "example": "^[a-zA-Z]*$", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "scope": { "type": "string", "description": "To specify scope: value, column, dataset_columns, dataset; ( This property is applicable for data class types: Script & Java )", "maxLength": 255, "minLength": 1, "pattern": "^(value|column|dataset_columns|dataset)$" }, "script": { "type": "string", "description": "To specify script name; ( This property is applicable for data class type: Script )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "squeeze_consecutive_white_spaces": { "type": "boolean", "description": "To specify squeeze consecutive white spaces boolean flag; ( This property is applicable for data class type: ValidValues )" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "threshold": { "type": "integer", "format": "int32", "description": "The percentage of threshold." }, "valid_value_reference_file": { "type": "string", "description": "To specify valid value reference file path; ( This property is applicable for data class type: ValidValues )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "valid_values": { "type": "array", "description": "To specify valid values; ( This property is applicable for data class type: ValidValues )", "items": { "type": "string", "description": "To specify valid values; ( This property is applicable for data class type: ValidValues )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "workflow_state": { "type": "string", "description": "The workflow state of an artifact", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "name" ] }, "GlossaryV3PaginatedDataClassList": { "type": "object", "description": "Presents a paginated list of DataClasses", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3DataClass" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3DataClass": { "type": "object", "description": "Dataclass object", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3DataClassEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3DataClassEntity": { "type": "object", "description": "Entity object for dataclass", "properties": { "additional_applicable_for": { "type": "string", "description": "To specify additional applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )", "example": "all_data", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "additional_regular_expression": { "type": "string", "description": "To specify additional regular expression; ( This property is applicable for data class type: Regex )", "example": ".*", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "allow_substring_match": { "type": "boolean", "description": "To specify allow substring match boolean flag; ( This property is applicable for data class type: ValidValues )" }, "applicable_for": { "type": "string", "description": "To specify applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )", "example": "all_data", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "case_sensitive": { "type": "boolean", "description": "To specify case sensitive boolean flag; ( This property is applicable for data class type: ValidValues )" }, "class_code": { "type": "string", "description": "Unique class code given to the data class.", "example": "class code1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "classification_relationships": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" } }, "column_name_match": { "type": "string", "description": "To specify column name match", "example": "^[a-zA-Z]*$", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "data_class_type": { "type": "string", "description": "To specify the type of data class: ColumnSimilarity, Java, ReferenceDataSet, Regex, Script, Undefined, UnstructuredFilter, ValidValues", "maxLength": 32, "minLength": 1, "pattern": "^(ColumnSimilarity|Java|Regex|Script|Undefined|UnstructuredFilter|ValidValues|ReferenceDataSet|Fingerprint|OtherMatchingCriteria)$" }, "data_type": { "type": "array", "description": "DataType: numeric, string, date, time, timestamp", "example": [ "numeric", "string", "date", "time", "timestamp" ], "items": { "type": "string", "description": "DataType: numeric, string, date, time, timestamp", "example": "[\"numeric\",\"string\",\"date\",\"time\",\"timestamp\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "definition": { "type": "string", "description": "Definition of dataclass" }, "enabled": { "type": "boolean", "description": "This flag indicates whether the data class can be used for data profiling or not." }, "example": { "type": "string", "description": "Data class example", "example": "example1", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "expression": { "type": "string", "description": "To specify expression; ( This property is applicable for data class type: UnstructuredFilter )", "example": "expression", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "has_types_data_class_relationships": { "type": "array", "description": "The list of child data classes in the data class type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" } }, "is_a_type_of_data_class_relationship": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" }, "java_class_name": { "type": "string", "description": "To specify Java class name; ( This property is applicable for data class type: Java )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "language": { "type": "string", "description": "To specify language: JavaScript, DataRule; ( This property is applicable for data class type: Script )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maximum_data_length": { "type": "integer", "format": "int32", "description": "To specify maximum data length" }, "minimum_data_length": { "type": "integer", "format": "int32", "description": "To specify minimum data length" }, "priority": { "type": "number", "format": "double", "description": "Data class priority used while profiling." }, "properties": { "type": "string", "description": "To specify properties; ( This property is applicable for data class type: Java )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "provider": { "type": "string", "description": "The provider of data class", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "reference_columns_metadata": { "type": "string", "description": "To specify reference columns metadata; ( This property is applicable for data class type: ColumnSimilarity )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "regular_expression": { "type": "string", "description": "To specify regular expression; ( This property is applicable for data class type: Regex )", "example": "^[a-zA-Z]*$", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "scope": { "type": "string", "description": "To specify scope: value, column, dataset_columns, dataset; ( This property is applicable for data class types: Script & Java )", "maxLength": 255, "minLength": 1, "pattern": "^(value|column|dataset_columns|dataset)$" }, "script": { "type": "string", "description": "To specify script name; ( This property is applicable for data class type: Script )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "squeeze_consecutive_white_spaces": { "type": "boolean", "description": "To specify squeeze consecutive white spaces boolean flag; ( This property is applicable for data class type: ValidValues )" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "threshold": { "type": "integer", "format": "int32", "description": "The percentage of threshold." }, "valid_value_reference_file": { "type": "string", "description": "To specify valid value reference file path; ( This property is applicable for data class type: ValidValues )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "valid_values": { "type": "array", "description": "To specify valid values; ( This property is applicable for data class type: ValidValues )", "items": { "type": "string", "description": "To specify valid values; ( This property is applicable for data class type: ValidValues )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3UpdatableDataClassEntity": { "type": "object", "description": "Update dataclass entity object", "properties": { "additional_applicable_for": { "type": "string", "description": "To specify additional applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )", "example": "all_data", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "additional_regular_expression": { "type": "string", "description": "To specify additional regular expression; ( This property is applicable for data class type: Regex )", "example": ".*", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "allow_substring_match": { "type": "boolean", "description": "To specify allow substring match boolean flag; ( This property is applicable for data class type: ValidValues )" }, "applicable_for": { "type": "string", "description": "To specify applicable for: structured_data_only, unstructured_data_only, all_data; ( This property is applicable for data class type: Regex )", "example": "all_data", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "case_sensitive": { "type": "boolean", "description": "To specify case sensitive boolean flag; ( This property is applicable for data class type: ValidValues )" }, "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "class_code": { "type": "string", "description": "Unique class code given to the data class.", "example": "class code1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "column_name_match": { "type": "string", "description": "To specify column name match", "example": "^[a-zA-Z]*$", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_class_type": { "type": "string", "description": "To specify the type of data class: ColumnSimilarity, Java, ReferenceDataSet, Regex, Script, Undefined, UnstructuredFilter, ValidValues", "maxLength": 32, "minLength": 1, "pattern": "^(ColumnSimilarity|Java|Regex|Script|Undefined|UnstructuredFilter|ValidValues|ReferenceDataSet|Fingerprint|OtherMatchingCriteria)$" }, "data_type": { "type": "array", "description": "DataType: numeric, string, date, time, timestamp", "example": [ "numeric", "string", "date", "time", "timestamp" ], "items": { "type": "string", "description": "DataType: numeric, string, date, time, timestamp", "example": "[\"numeric\",\"string\",\"date\",\"time\",\"timestamp\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "enabled": { "type": "boolean", "description": "This flag indicates whether the data class can be used for data profiling or not." }, "example": { "type": "string", "description": "Data class example", "example": "example1", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "expression": { "type": "string", "description": "To specify expression; ( This property is applicable for data class type: UnstructuredFilter )", "example": "expression", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "has_types_data_classes": { "type": "array", "description": "List of immediate child data classes in the data class type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_a_type_of_data_class": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "java_class_name": { "type": "string", "description": "To specify Java class name; ( This property is applicable for data class type: Java )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "language": { "type": "string", "description": "To specify language: JavaScript, DataRule; ( This property is applicable for data class type: Script )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maximum_data_length": { "type": "integer", "format": "int32", "description": "To specify maximum data length" }, "minimum_data_length": { "type": "integer", "format": "int32", "description": "To specify minimum data length" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "priority": { "type": "number", "format": "double", "description": "Data class priority used while profiling." }, "properties": { "type": "string", "description": "To specify properties; ( This property is applicable for data class type: Java )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "provider": { "type": "string", "description": "The provider of data class", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "reference_columns_metadata": { "type": "string", "description": "To specify reference columns metadata; ( This property is applicable for data class type: ColumnSimilarity )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "regular_expression": { "type": "string", "description": "To specify regular expression; ( This property is applicable for data class type: Regex )", "example": "^[a-zA-Z]*$", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "scope": { "type": "string", "description": "To specify scope: value, column, dataset_columns, dataset; ( This property is applicable for data class types: Script & Java )", "maxLength": 255, "minLength": 1, "pattern": "^(value|column|dataset_columns|dataset)$" }, "script": { "type": "string", "description": "To specify script name; ( This property is applicable for data class type: Script )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "squeeze_consecutive_white_spaces": { "type": "boolean", "description": "To specify squeeze consecutive white spaces boolean flag; ( This property is applicable for data class type: ValidValues )" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "threshold": { "type": "integer", "format": "int32", "description": "The percentage of threshold." }, "valid_value_reference_file": { "type": "string", "description": "To specify valid value reference file path; ( This property is applicable for data class type: ValidValues )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "valid_values": { "type": "array", "description": "To specify valid values; ( This property is applicable for data class type: ValidValues )", "items": { "type": "string", "description": "To specify valid values; ( This property is applicable for data class type: ValidValues )", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "revision" ] }, "GlossaryV3DataClassRelationshipsRequest": { "type": "object", "description": "Request object of dataclass relationships", "properties": { "categories": { "type": "array", "description": "Category relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "The relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "has_types_data_classes": { "type": "array", "description": "New list of child data classes in the data class type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_a_type_of_data_class": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "terms": { "type": "array", "description": "The relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } }, "GlossaryV3ServerInfoV3": { "type": "object", "description": "Holds business glossary build information and DB2 connection status information", "properties": { "build_info": { "$ref": "#/components/schemas/GlossaryV3BuildInfoV3" }, "db2_status": { "type": "string", "description": "Status of DB2.", "example": "UP" }, "external_rabbit_mq_listener_status": { "type": "string", "description": "The status of the external Rabbit MQ listener.", "example": "CONNECTED" }, "internal_rabbit_mq_listener_status": { "type": "string", "description": "The status of the internal Rabbit MQ listener.", "example": "CONNECTED" }, "status": { "type": "string", "description": "OK indicates that the service is up and running.", "example": "OK" }, "version": { "type": "string", "description": "The version of the build.", "example": "2.0.0.1000" } } }, "GlossaryV3BuildInfoV3": { "type": "object", "description": "Build information.", "properties": { "build_tag": { "type": "string", "description": "The build tag that identifies the the build in Jenkins dashboard.", "example": "jenkins-BG-Development-Pipeline-200" }, "build_time": { "type": "string", "format": "date-time", "description": "The timestamp when the Business Glossary service was built." }, "build_version": { "type": "string", "description": "Deprecated." }, "semantic_version": { "type": "string", "description": "The semantic version of the codebase.", "example": "2.1.0" } } }, "GlossaryV3TenantInitStatus": { "type": "object", "description": "Tenant init status", "properties": { "status": { "type": "string", "description": "tenant status, one of READY, NOT READY", "example": "READY" } } }, "GlossaryV3NewTermEntityV3": { "type": "object", "description": "New glossary term entity object", "properties": { "abbreviations": { "type": "array", "description": "The list of abbreviations of a business term.", "items": { "type": "string", "description": "The list of abbreviations of a business term.", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "example": { "type": "string", "description": "Example", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "has_terms": { "type": "array", "description": "The list of child business terms in the business term containment hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "has_type_terms": { "type": "array", "description": "The list of child business terms in the business term type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "import_source_created_by": { "type": "string", "description": "Name of the user who has created the term in the original source for imported term.", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "import_source_created_on": { "type": "string", "format": "date-time", "description": "The timestamp when the term was created in the original source for imported term.", "maxLength": 32, "minLength": 10 }, "import_source_usage": { "type": "string", "description": "The usage of the term in the original source for imported term.", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "is_a_type_of_terms": { "type": "array", "description": "The list of parent business terms in the business term type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_of_terms": { "type": "array", "description": "The list of parent business terms in the business term containment hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "related_term_relationships": { "type": "array", "description": "The list of related business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" }, "readOnly": true }, "related_terms": { "type": "array", "description": "The list of related business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "replaced_by_terms": { "type": "array", "description": "The list of business terms that are replaced by this business term.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "replaces_terms": { "type": "array", "description": "The list of business terms that replace this business term.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "synonym_terms": { "type": "array", "description": "The list of synonym business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "system_business_reference": { "type": "string", "description": "System business reference of a business term.", "example": "SAP:MANDANT,AWS:XYZ123", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "items": { "type": "string", "description": "The tags assigned to an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "workflow_state": { "type": "string", "description": "The workflow state of an artifact", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "name" ] }, "GlossaryV3ResponseGlossaryTerm": { "type": "object", "description": "Response glossary term object", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3ResponseTermEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3UpdatableTermEntity": { "type": "object", "description": "Update glossary term entity object", "properties": { "abbreviations": { "type": "array", "description": "The list of abbreviations of a business term.", "items": { "type": "string", "description": "The list of abbreviations of a business term.", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "example": { "type": "string", "description": "Example", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "has_terms": { "type": "array", "description": "The list of child business terms in the business term containment hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "has_type_terms": { "type": "array", "description": "The list of child business terms in the business term type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "import_source_created_by": { "type": "string", "description": "Name of the user who has created the term in the original source for imported term.", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "import_source_created_on": { "type": "string", "format": "date-time", "description": "The timestamp when the term was created in the original source for imported term.", "maxLength": 32, "minLength": 10 }, "import_source_usage": { "type": "string", "description": "The usage of the term in the original source for imported term.", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "is_a_type_of_terms": { "type": "array", "description": "The list of parent business terms in the business term type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_of_terms": { "type": "array", "description": "The list of parent business terms in the business term containment hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "related_term_relationships": { "type": "array", "description": "The list of related business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipObject" }, "readOnly": true }, "related_terms": { "type": "array", "description": "The list of related business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "replaced_by_terms": { "type": "array", "description": "The list of business terms that are replaced by this business term.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "replaces_terms": { "type": "array", "description": "The list of business terms that replace this business term.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "synonym_terms": { "type": "array", "description": "The list of synonym business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "system_business_reference": { "type": "string", "description": "System business reference of a business term.", "example": "SAP:MANDANT,AWS:XYZ123", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "items": { "type": "string", "description": "The tags assigned to an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" } }, "required": [ "revision" ] }, "GlossaryV3ResponseTermEntity": { "type": "object", "description": "Response glossary term entity object", "properties": { "abbreviations": { "type": "array", "description": "The list of abbreviations of a business term.", "items": { "type": "string", "description": "The list of abbreviations of a business term.", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "categories": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "classifications": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "data_classes": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "example": { "type": "string", "description": "Example", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "has_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "has_type_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "has_types_term_hierarchy": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "import_source_created_by": { "type": "string", "description": "Name of the user who has created the term in the original source for imported term.", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "import_source_created_on": { "type": "string", "format": "date-time", "description": "The timestamp when the term was created in the original source for imported term.", "maxLength": 32, "minLength": 10 }, "import_source_usage": { "type": "string", "description": "The usage of the term in the original source for imported term.", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "is_a_type_of_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedParentRelationshipsList" }, "is_of_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedParentRelationshipsList" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "policies": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reference_data": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "reference_data_values": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "related_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "replaced_by_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "replaces_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "rules": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "synonym_terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "system_business_reference": { "type": "string", "description": "System business reference of a business term.", "example": "SAP:MANDANT,AWS:XYZ123", "maxLength": 32672, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3TermRelationshipsRequest": { "type": "object", "description": "Term relationships request", "properties": { "categories": { "type": "array", "description": "Category relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "The relationships to the classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_classes": { "type": "array", "description": "The relationships to the data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "has_terms": { "type": "array", "description": "The list of child business terms in the business term containment hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "has_type_terms": { "type": "array", "description": "The list of child business terms in the business term type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_a_type_of_terms": { "type": "array", "description": "The list of parent business terms in the business term type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "is_of_terms": { "type": "array", "description": "The list of parent business terms in the business term containment hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "related_terms": { "type": "array", "description": "The list of related business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "replaced_by_terms": { "type": "array", "description": "The list of business terms that are replaced by this business term.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "replaces_terms": { "type": "array", "description": "The list of business terms that replace this business term.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "synonym_terms": { "type": "array", "description": "The list of synonym business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } }, "GlossaryV3GlossaryImportStatus": { "type": "object", "description": "Glossary Import Status", "properties": { "children_statuses": { "type": "array", "description": "Children statuses", "items": { "$ref": "#/components/schemas/GlossaryV3ProcessBasicStatus" } }, "completion_time": { "type": "string", "format": "date-time", "description": "Completion time" }, "creation_time": { "type": "string", "format": "date-time", "description": "Creation time" }, "error_message": { "type": "string", "description": "Error message" }, "heartbeat_time": { "type": "string", "format": "date-time", "description": "Heartbeat time" }, "heartbeater_id": { "type": "string", "description": "Heartbeater id" }, "messages": { "$ref": "#/components/schemas/GlossaryV3PaginatedImportMessagesList" }, "operations_count": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "description": "Operations count" }, "description": "Operations count" }, "description": "Operations count" }, "process_id": { "type": "string", "description": "Process Id" }, "status": { "type": "string", "description": "Status" }, "step_message": { "type": "string", "description": "Step message" }, "step_number": { "type": "integer", "format": "int32", "description": "Step number" }, "tenant_id": { "type": "string", "description": "Tenant Id" }, "total_steps": { "type": "integer", "format": "int32", "description": "Total steps" }, "workflow_id": { "type": "string", "description": "Workflow Id" } } }, "GlossaryV3PaginatedImportMessagesList": { "type": "object", "description": "List of import messages", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3ImportMessage" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3ProcessBasicStatus": { "type": "object", "description": "Process Basic Status", "properties": { "completion_time": { "type": "string", "format": "date-time", "description": "Completion time" }, "creation_time": { "type": "string", "format": "date-time", "description": "Creation time" }, "error_message": { "type": "string", "description": "Error message" }, "heartbeat_time": { "type": "string", "format": "date-time", "description": "Heartbeat time" }, "heartbeater_id": { "type": "string", "description": "Heartbeater id" }, "name": { "type": "string", "description": "Name" }, "percentage": { "type": "integer", "format": "int32", "description": "Completed percentage" }, "process_id": { "type": "string", "description": "Process Id" }, "status": { "type": "string", "description": "Status" }, "type": { "type": "string", "description": "Type" } } }, "GlossaryV3ImportMessage": { "type": "object", "description": "Results of the list / search.", "properties": { "code": { "type": "string", "description": "Code" }, "first_line_number": { "type": "integer", "format": "int64", "description": "First Line Number" }, "first_line_ref_number": { "type": "integer", "format": "int64", "description": "Line Reference Number" }, "first_record_number": { "type": "integer", "format": "int64", "description": "First Record Number" }, "locations": { "type": "array", "description": "Locations", "items": { "$ref": "#/components/schemas/GlossaryV3ImportMessageLocation" } }, "message": { "type": "string" }, "message_template": { "type": "string", "description": "Message Template" }, "parameters": { "type": "array", "description": "Parameters", "items": { "type": "string", "description": "Parameters" } } } }, "GlossaryV3ImportMessageLocation": { "type": "object", "description": "Locations", "properties": { "artifact_name": { "type": "string", "description": "Artifact Name" }, "file_name": { "type": "string", "description": "File Name" }, "line_number": { "type": "integer", "format": "int64", "description": "Line Number" }, "line_ref_number": { "type": "integer", "format": "int64", "description": "Line Reference Number" }, "record_number": { "type": "integer", "format": "int64", "description": "Record Number" } } }, "GlossaryV3PaginatedSearchArtifactsList": { "type": "object", "description": "List of paginated workflow artifacts", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3SearchArtifact" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3SearchArtifact": { "type": "object", "description": "Workflow Artifact model", "properties": { "abbreviations": { "type": "array", "description": "List of abbreviations, applicable only for draft terms.", "items": { "type": "string", "description": "List of abbreviations, applicable only for draft terms." } }, "artifact_id": { "type": "string", "description": "Artifact ID" }, "created_at": { "type": "string", "format": "date-time", "description": "Created time, applicable only for draft artifacts." }, "created_by": { "type": "string", "description": "Created by, applicable only for draft artifacts." }, "draft_mode": { "type": "string", "description": "Draft mode, applicable only for draft artifacts." }, "is_enabled": { "type": "boolean", "description": "Is enabled, applicable only for draft artifacts." }, "long_description": { "type": "string", "description": "Long description, applicable only for draft artifacts." }, "modified_at": { "type": "string", "format": "date-time", "description": "Modified time" }, "modified_by": { "type": "string", "description": "Modified by, applicable only for draft artifacts." }, "name": { "type": "string", "description": "Name of the artifact" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3SearchRelatedAsset" }, "tags": { "type": "array", "description": "Artifact tags, applicable only for draft artifacts.", "items": { "type": "string", "description": "Artifact tags, applicable only for draft artifacts." } }, "type": { "type": "string", "description": "Artifact type" }, "version_id": { "type": "string", "description": "Version ID" }, "workflow_id": { "type": "string", "description": "Workflow ID, applicable only for draft artifacts." }, "workflow_status": { "type": "string", "description": "Workflow status of artifact, applicable only for draft artifacts." } } }, "GlossaryV3SearchRelatedAsset": { "type": "object", "description": "Search related asset object", "properties": { "artifact_id": { "type": "string", "description": "Artifact ID of an asset" }, "name": { "type": "string", "description": "Name of an asset" } } }, "GlossaryV3NewCustomAttributeDefinitionEntity": { "type": "object", "description": "Custom Attribute Definition", "properties": { "artifact_types": { "type": "array", "description": "Set of artifact types", "example": [ "glossary_term" ], "items": { "type": "string", "description": "Set of artifact types", "example": "[\"glossary_term\"]", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "maxLength": 32, "minLength": 1, "pattern": ".*", "uniqueItems": true }, "category_artifact_ids": { "type": "array", "description": "Set of restricted category artifact ids", "items": { "type": "string", "description": "Set of restricted category artifact ids", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*", "uniqueItems": true }, "default_value": { "type": "string", "description": "The default value of the custom attribute", "example": "xyz", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "description": { "type": "string", "description": "Description", "example": "description of custom attribute definition", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "display_in_child_assets": { "type": "boolean", "description": "Specifies whether custom attribute values should be displayed in child assets", "example": true }, "elements": { "type": "array", "description": "List of predefined values. Supported only for the type ENUM.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefElementEntity" } }, "max_length": { "type": "integer", "format": "int32", "description": "Maximum length of custom attribute values of the type string", "example": 500 }, "maximum": { "type": "number", "format": "double", "description": "Maximum" }, "min_length": { "type": "integer", "format": "int32", "description": "Minimum length of custom attribute values of the type string", "example": 5 }, "minimum": { "type": "number", "format": "double", "description": "Minimum" }, "multiple_values": { "type": "boolean", "description": "Specifies whether the custom attribute can have more than one value", "example": true }, "name": { "type": "string", "description": "Name of custom attribute", "example": "ca def 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "read_only": { "type": "boolean", "description": "Specifies whether custom attribute values should be read only", "example": true }, "related_artifact_types": { "type": "array", "description": "Set of related artifact types", "items": { "type": "string", "description": "Set of related artifact types", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "maxLength": 32, "minLength": 1, "pattern": ".*", "uniqueItems": true }, "related_category_artifact_ids": { "type": "array", "description": "Set of restricted related category artifact ids", "items": { "type": "string", "description": "Set of restricted related category artifact ids", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*", "uniqueItems": true }, "reverse_name": { "type": "string", "description": "Reversed Custom Attribute relationship name which may be display on the related artifact", "example": "Term related to category", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "searchable": { "type": "boolean", "description": "Specifies whether custom attribute definition should be global search", "example": true }, "type": { "type": "string", "description": "Type of custom attribute values", "example": "TEXT", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "name", "type" ] }, "GlossaryV3CustomAttributeDefinition": { "type": "object", "description": "Used to facilitate serialization and correct swagger documentation.", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefinitionEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3CustomAttributeDefElementEntity": { "type": "object", "description": "Custom Attribute Def Element Entity", "properties": { "description": { "type": "string", "description": "Description", "example": "description of custom attribute definition value", "maxLength": 255, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3CustomAttributeDefinitionEntity": { "type": "object", "description": "Custom Attribute Definition Entity", "properties": { "artifact_types": { "type": "array", "description": "Set of artifact types", "example": [ "glossary_term" ], "items": { "type": "string", "description": "Set of artifact types", "example": "[\"glossary_term\"]", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "maxLength": 32, "minLength": 1, "pattern": ".*", "uniqueItems": true }, "category_artifact_ids": { "type": "array", "description": "Set of restricted category artifact ids", "items": { "type": "string", "description": "Set of restricted category artifact ids", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*", "uniqueItems": true }, "default_value": { "type": "string", "description": "The default value of the custom attribute", "example": "xyz", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "description": { "type": "string", "description": "Description", "example": "description of custom attribute definition", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "display_in_child_assets": { "type": "boolean", "description": "Specifies whether custom attribute values should be displayed in child assets", "example": true }, "elements_list": { "type": "array", "description": "List of predefined values", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefElement" } }, "max_length": { "type": "integer", "format": "int32", "description": "Maximum length of custom attribute values of the type string", "example": 500 }, "maximum": { "type": "number", "format": "double", "description": "Maximum" }, "min_length": { "type": "integer", "format": "int32", "description": "Minimum length of custom attribute values of the type string", "example": 5 }, "minimum": { "type": "number", "format": "double", "description": "Minimum" }, "multiple_values": { "type": "boolean", "description": "Specifies whether the custom attribute can have more than one value", "example": true, "readOnly": true }, "read_only": { "type": "boolean", "description": "Specifies whether custom attribute values should be read only", "example": true }, "related_artifact_types": { "type": "array", "description": "Set of related artifact types", "items": { "type": "string", "description": "Set of related artifact types", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "maxLength": 32, "minLength": 1, "pattern": ".*", "uniqueItems": true }, "related_category_artifact_ids": { "type": "array", "description": "Set of restricted related category artifact ids", "items": { "type": "string", "description": "Set of restricted related category artifact ids", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*", "uniqueItems": true }, "reverse_name": { "type": "string", "description": "Reversed Custom Attribute relationship name which may be display on the related artifact", "example": "Term related to category", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "searchable": { "type": "boolean", "description": "Specifies whether custom attribute definition should be global search", "example": true }, "type": { "type": "string", "description": "Type of custom attribute values", "example": "TEXT" } } }, "GlossaryV3CustomAttributeDefElement": { "type": "object", "description": "List of predefined values", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefElementEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3UpdatableCustomAttributeDefinitionEntity": { "type": "object", "description": "Updatable custom attribute definition entity", "properties": { "artifact_types": { "type": "array", "description": "Set of artifact types", "example": [ "glossary_term" ], "items": { "type": "string", "description": "Set of artifact types", "example": "[\"glossary_term\"]", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "maxLength": 32, "minLength": 1, "pattern": ".*", "uniqueItems": true }, "category_artifact_ids": { "type": "array", "description": "Set of restricted category artifact ids", "items": { "type": "string", "description": "Set of restricted category artifact ids", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*", "uniqueItems": true }, "default_value": { "type": "string", "description": "The default value of the custom attribute", "example": "xyz", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "description": { "type": "string", "description": "Description", "example": "description of custom attribute definition", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "display_in_child_assets": { "type": "boolean", "description": "Specifies whether custom attribute values should be displayed in child assets", "example": true }, "elements": { "type": "array", "description": "List of predefined values. Supported only for the type ENUM.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeDefElementEntity" } }, "max_length": { "type": "integer", "format": "int32", "description": "Maximum length of custom attribute values of the type string", "example": 500 }, "maximum": { "type": "number", "format": "double", "description": "Maximum" }, "min_length": { "type": "integer", "format": "int32", "description": "Minimum length of custom attribute values of the type string", "example": 5 }, "minimum": { "type": "number", "format": "double", "description": "Minimum" }, "multiple_values": { "type": "boolean", "description": "Specifies whether the custom attribute can have more than one value", "example": true, "readOnly": true }, "name": { "type": "string", "description": "Name of custom attribute", "example": "ca def 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "read_only": { "type": "boolean", "description": "Specifies whether custom attribute values should be read only", "example": true }, "related_artifact_types": { "type": "array", "description": "Set of related artifact types", "items": { "type": "string", "description": "Set of related artifact types", "maxLength": 32, "minLength": 1, "pattern": ".*" }, "maxLength": 32, "minLength": 1, "pattern": ".*", "uniqueItems": true }, "related_category_artifact_ids": { "type": "array", "description": "Set of restricted related category artifact ids", "items": { "type": "string", "description": "Set of restricted related category artifact ids", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*", "uniqueItems": true }, "reverse_name": { "type": "string", "description": "Reversed Custom Attribute relationship name which may be display on the related artifact", "example": "Term related to category", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "searchable": { "type": "boolean", "description": "Specifies whether custom attribute definition should be global search", "example": true } } }, "GlossaryV3Task": { "type": "object", "description": "Task", "properties": { "task_id": { "type": "string", "description": "Task id" } } }, "GlossaryV3GlossaryResourceIdentifierList": { "type": "object", "description": "List of glossary resource identifiers", "properties": { "resources": { "type": "array", "description": "List of resource identifiers.", "items": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceIdentifier" } } } }, "GlossaryV3GlossaryResourceIdentifier": { "type": "object", "description": "Glossary resource id object", "properties": { "artifact_id": { "type": "string", "description": "The ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "version_id": { "type": "string", "description": "The version ID of the artifact", "example": "4fb86a70-7035-4b3e-8825-137c7b9b1687_1", "maxLength": 40, "minLength": 36, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?" } }, "required": [ "artifact_id" ] }, "GlossaryV3WdpApiModeledObject": { "type": "object", "description": "Represents an object that we send back to the end user. It has two parts: entity and metadata.", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3EntityV3" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3MoveTargetCategory": { "type": "object", "description": "Specifies target category for move operations", "properties": { "target_category_id": { "type": "string", "description": "specifies id of category to become parent after move. One can specify either artifact ID or global ID. In case of category, one can specify string `ROOT` to move it to the top level", "example": "e39ada11-8338-3704-90e3-681a71e7c839", "maxLength": 73, "minLength": 1, "pattern": ".*" } }, "required": [ "target_category_id" ] }, "GlossaryV3PaginatedAssetAggregatedCommentsList": { "type": "object", "description": "List of paginated asset aggregated comments", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3AssetAggregatedCommentsList" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3AssetAggregatedCommentsList": { "type": "object", "description": "List of asset aggregated comments", "properties": { "entities": { "type": "array", "description": "Entity values", "items": { "$ref": "#/components/schemas/GlossaryV3AssetAggregatedComment" } }, "imported": { "type": "boolean", "description": "Indicates whether the development log entry originates from import" }, "log_status": { "type": "string", "description": "Status of log" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3AssetAggregatedCommentsMetadata" } } }, "GlossaryV3AssetAggregatedCommentsMetadata": { "type": "object", "description": "Metadata of asset aggregated comments", "properties": { "day_of_event": { "type": "string", "description": "Day of event" }, "time_zone_offset": { "type": "string", "description": "Timezone offset" } } }, "GlossaryV3AssetAggregatedComment": { "type": "object", "description": "Asset aggregated comment object", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3AssetAggregatedCommentEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3AssetCommentMetadata" } } }, "GlossaryV3AssetCommentMetadata": { "type": "object", "description": "Comment Metadata", "properties": { "asset_ancestor_id": { "type": "string", "description": "Asset ancestor ID" }, "asset_name": { "type": "string", "description": "Asset name" }, "asset_version_id": { "type": "string", "description": "Asset version ID" }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 timestamp on when the comment was created (system managed)", "example": "2017-02-15T02:30:32.000Z", "readOnly": true }, "id": { "type": "string", "description": "Comment ID" }, "modified_at": { "type": "string", "format": "date-time", "description": "RFC 3339 timestamp on when the comment was last modified (system managed)", "example": "2017-02-15T02:30:32.000Z", "readOnly": true }, "modified_by": { "type": "string", "description": "User ID of the user who last modified the comment (system managed)", "example": "IBMid-1234567ABC", "readOnly": true } } }, "GlossaryV3AssetAggregatedCommentEntity": { "type": "object", "description": "Entity object of asset aggregated comment", "properties": { "action": { "type": "string", "description": "The action" }, "comment": { "type": "string", "description": "Comment by WorkFlow Service" }, "imported": { "type": "boolean", "description": "Indicates whether the development log entry originates from import" }, "log_status": { "type": "string", "description": "The log status" }, "modification_details": { "type": "array", "description": "The Modifications", "items": { "$ref": "#/components/schemas/GlossaryV3AssetAggregatedCommentPropertyModification" } }, "new_wf_status": { "type": "string", "description": "The new WorkFlow status" }, "old_wf_status": { "type": "string", "description": "The old WorkFlow status" } } }, "GlossaryV3AssetAggregatedCommentPropertyModification": { "type": "object", "description": "Asset aggregated comment property modification", "properties": { "action": { "type": "string", "description": "A type of an performed action" }, "additional_info": { "type": "string", "description": "Additional info for the property, eg. for relationship it's a type of second end of the relationship" }, "initial_values": { "type": "array", "description": "Initial Values", "items": { "$ref": "#/components/schemas/GlossaryV3AssetCommentsModificationDetails" } }, "mod_id": { "type": "string", "description": "Modification Id" }, "new_value": { "type": "string", "description": "The new value of the property" }, "number_of_elements": { "type": "integer", "format": "int64", "description": "Indicates number of elements in this collection" }, "old_value": { "type": "string", "description": "The old value of the property" }, "property_name": { "type": "string", "description": "Modified Property Name" }, "property_type": { "type": "string", "description": "A type of the property" } } }, "GlossaryV3AssetCommentsModificationDetails": { "type": "object", "description": "Object of Asset comment modification details", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3AssetCommentModificationEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3AssetCommentMetadata" } } }, "GlossaryV3AssetCommentModificationEntity": { "type": "object", "description": "Entity object of asset comment modification", "properties": { "modification_details": { "$ref": "#/components/schemas/GlossaryV3AssetAggregatedCommentPropertyModification" } } }, "GlossaryV3PaginatedAssetCommentsModificationDetails": { "type": "object", "description": "Paginated asset comment modification details", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3AssetCommentsModificationDetails" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3AssetCommentUserEntity": { "type": "object", "description": "Comment By User", "properties": { "comment": { "type": "string", "description": "User comment", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "imported": { "type": "boolean", "description": "Indicates whether the development log entry originates from import" } }, "required": [ "comment" ] }, "GlossaryV3PaginatedAssetCommentList": { "type": "object", "description": "Paginated Asset Comment List", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3AssetComment" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3AssetComment": { "type": "object", "description": "Results of the list / search.", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3AssetCommentEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3AssetCommentMetadata" } } }, "GlossaryV3AssetCommentEntity": { "type": "object", "description": "Asset comment entity", "properties": { "action": { "type": "string", "description": "The action" }, "comment": { "type": "string", "description": "Comment by WorkFlow Service" }, "imported": { "type": "boolean", "description": "Indicates whether the development log entry originates from import" }, "log_status": { "type": "string", "description": "The log status" }, "modification_details": { "type": "array", "description": "The Modifications", "items": { "$ref": "#/components/schemas/GlossaryV3AssetCommentPropertyModification" } }, "new_wf_status": { "type": "string", "description": "The new WorkFlow status" }, "old_wf_status": { "type": "string", "description": "The old WorkFlow status" } } }, "GlossaryV3AssetCommentPropertyModification": { "type": "object", "description": "The Modifications", "properties": { "action": { "type": "string", "description": "A type of an performed action" }, "additional_info": { "type": "string", "description": "Additional info for the property, eg. for relationship it's a type of second end of the relationship" }, "new_value": { "type": "string", "description": "The new value of the property" }, "old_value": { "type": "string", "description": "The old value of the property" }, "property_name": { "type": "string", "description": "Modified Property Name" }, "property_type": { "type": "string", "description": "A type of the property" } } }, "GlossaryV3NewPolicyEntity": { "type": "object", "description": "Represents a policy to be created, used for policy POST request.", "properties": { "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_location_rules": { "type": "array", "description": "Relationships to data location rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_protection_rules": { "type": "array", "description": "Relationships to data protection rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "parent_policy": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "rules": { "type": "array", "description": "Relationships to governance rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "sub_policies": { "type": "array", "description": "The list of sub-policies in the policy type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "items": { "type": "string", "description": "The tags assigned to an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "workflow_state": { "type": "string", "description": "The workflow state of an artifact", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "name" ] }, "GlossaryV3ResponsePolicy": { "type": "object", "description": "Policy returned by REST GET method that includes the relationships as paginated list.", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3ResponsePolicyEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3UpdatablePolicyEntity": { "type": "object", "description": "Represents a policy to be updated used for policy PATCH request.", "properties": { "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_location_rules": { "type": "array", "description": "Relationships to data location rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_protection_rules": { "type": "array", "description": "Relationships to data protection rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "long_description": { "type": "string", "description": "The long description of an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "parent_policy": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "rules": { "type": "array", "description": "Relationships to governance rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "short_description": { "type": "string", "description": "The short description of an artifact.", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "sub_policies": { "type": "array", "description": "The list of sub-policies in the policy type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "items": { "type": "string", "description": "The tags assigned to an artifact.", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } }, "required": [ "revision" ] }, "GlossaryV3ResponsePolicyEntity": { "type": "object", "description": "Policy entity for GET response.", "properties": { "categories": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "classifications": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "data_classes": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "data_location_rules": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "data_protection_rules": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "parent_policy": { "$ref": "#/components/schemas/GlossaryV3PaginatedParentRelationshipsList" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "rules": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "sub_policies": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" } } }, "GlossaryV3PolicyRelationshipsRequest": { "type": "object", "description": "Policy relationships request", "properties": { "categories": { "type": "array", "description": "Category relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_location_rules": { "type": "array", "description": "Relationships to data location rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_protection_rules": { "type": "array", "description": "Relationships to data protection rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "parent_policy": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "rules": { "type": "array", "description": "Relationships to governance rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "sub_policies": { "type": "array", "description": "The list of sub-policies in the policy type hierarchy.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } }, "GlossaryV3PaginatedLightweightSearchRelationshipWithArtifactsList": { "type": "object", "description": "Paginated lightweight search artifact list", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "resources": { "type": "array", "description": "Results of the list / search.", "items": { "$ref": "#/components/schemas/GlossaryV3LightweightRelationshipWithArtifacts" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3LightweightRelationshipWithArtifacts": { "type": "object", "description": "Lightweight artifact relationship with basic information about related artifacts", "properties": { "name": { "type": "string", "description": "Custom relationship name" }, "reverse": { "type": "string", "description": "Custom relationship reverse name" }, "source": { "$ref": "#/components/schemas/GlossaryV3BasicLightweightTypeArtifact" }, "target": { "$ref": "#/components/schemas/GlossaryV3BasicLightweightTypeArtifact" }, "type": { "type": "string", "description": "Relationship type", "example": "has_types_data_class_hierarchy" } } }, "GlossaryV3BasicLightweightTypeArtifact": { "type": "object", "description": "Basic lightweight artifact", "properties": { "artifact_id": { "type": "string", "description": "Artifact ID" }, "artifact_type": { "type": "string", "description": "Artifact type" }, "global_id": { "type": "string", "description": "Global ID" }, "modified_at": { "type": "string", "format": "date-time", "description": "Modified time" }, "name": { "type": "string", "description": "Asset name" }, "parent_category_artifact_id": { "type": "string", "description": "Parent category artifact ID" }, "state": { "type": "string", "description": "Artifact workflow state", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ] }, "version_id": { "type": "string", "description": "Version ID" } } }, "GlossaryV3NewRuleEntity": { "type": "object", "description": "Represents a data class to be created.", "properties": { "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Rule 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "policies": { "type": "array", "description": "The relationships to governance policies.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reference_data": { "type": "array", "description": "The relationships to reference data sets.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "rule_type": { "type": "string", "description": "Currently supported: Governance.", "enum": [ "Quality", "Automation", "DataProtection", "Governance", "Data" ], "example": "Governance" }, "rules": { "type": "array", "description": "Relationships to governance rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "short_description": { "type": "string", "description": "The short description of an artifact.", "example": "short description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } }, "required": [ "name", "rule_type" ] }, "GlossaryV3ResponseRule": { "type": "object", "description": "Rule returned by REST GET method that includes the relationships as paginated list.", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3ResponseRuleEntity" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3UpdatableRuleEntity": { "type": "object", "description": "Represents a rule to be updated.", "properties": { "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "data_classes": { "type": "array", "description": "Relationships to data classes.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "Name 1", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "policies": { "type": "array", "description": "The relationships to governance policies.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reference_data": { "type": "array", "description": "The relationships to reference data sets.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "rules": { "type": "array", "description": "Relationships to governance rules only. Does not include other rule relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "short_description": { "type": "string", "description": "The short description of an artifact.", "example": "short description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "The stewards assigned to an artifact.", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "The stewards assigned to an artifact.", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } }, "required": [ "revision" ] }, "GlossaryV3ResponseRuleEntity": { "type": "object", "description": "Represents a rule entity returned by REST GET methods that include the relationships as paginated lists", "properties": { "categories": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "classifications": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "custom_attributes": { "type": "array", "description": "List of custom attributes with their values.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomAttributeV3" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "data_classes": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "policies": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "reference_data": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "rule_type": { "type": "string", "description": "Currently supported: Governance.", "enum": [ "Quality", "Automation", "DataProtection", "Governance", "Data" ], "example": "Governance" }, "rules": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "terms": { "$ref": "#/components/schemas/GlossaryV3PaginatedRelationshipsList" } } }, "GlossaryV3RuleRelationshipsRequest": { "type": "object", "description": "Relationship request class used for creating and updating Rules relationships", "properties": { "categories": { "type": "array", "description": "Category relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "The list of related classifications", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "data_classes": { "type": "array", "description": "The list of related data classes", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "policies": { "type": "array", "description": "The list of parent policies", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "reference_data": { "type": "array", "description": "The list of related reference data sets", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "rules": { "type": "array", "description": "The list of related rules", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "terms": { "type": "array", "description": "The list of related business terms", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } }, "GlossaryV3NewReferenceDataSetEntityV4": { "type": "object", "description": "Represents a Reference Data Set to be created for RDS V4 API version.", "properties": { "categories": { "type": "array", "description": "Secondary categories the artifact belongs to.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "child": { "type": "array", "description": "The relationships to reference data sets.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "Relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "description of reference data set", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "reference data set name", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent": { "type": "array", "description": "The relationships to reference data sets.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "Stewards Ids", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "Stewards Ids", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "type": "array", "description": "Relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "type": { "type": "string", "description": "Type", "enum": [ "TEXT", "NUMBER", "DATE" ], "example": "TEXT", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "name" ] }, "GlossaryV3ReferenceDataSetResponseListV4": { "type": "object", "description": "Paginated list of V4 Reference Data Sets", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "versions": { "type": "array", "description": "List of reference data set versions", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseReferenceDataSetV4" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3ResponseReferenceDataSetV4": { "type": "object", "description": "API V4 Response Reference Data Set", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3ResponseReferenceDataSetEntityV4" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3GlossaryObjectMetadataV3" } } }, "GlossaryV3ResponseReferenceDataSetEntityV4": { "type": "object", "description": "Reference Data Set entity returned by V4 REST GET method that includes the relationships as paginated list.", "properties": { "case_sensitive": { "type": "boolean", "description": "Indicates if reference data set uses case sensitive codes for its reference data values" }, "categories": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" }, "child": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" }, "classifications": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" }, "composite_key": { "type": "array", "description": "List of composite key members", "items": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnResponse" } }, "custom_columns": { "type": "array", "description": "List of sections and custom columns", "items": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnResponse" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseCustomRelationship" }, "readOnly": true }, "data_classes": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" }, "import_info": { "$ref": "#/components/schemas/GlossaryV3RDVImportInfo" }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "long description", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "parent": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" }, "rds_values_total_count": { "type": "integer", "format": "int64", "description": "Reference data values total count" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "rules": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "Stewards Ids", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "Stewards Ids", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "terms": { "$ref": "#/components/schemas/GlossaryV3RelationshipResponseListV4" }, "type": { "type": "string", "description": "Type", "enum": [ "TEXT", "NUMBER", "DATE" ], "example": "TEXT", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true } } }, "GlossaryV3RelationshipResponseListV4": { "type": "object", "description": "Paginated list of relationships", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "relationships": { "type": "array", "description": "List of relationships", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipRelationshipEntityV3" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3RDVImportInfo": { "type": "object", "description": "RDV import info", "properties": { "href": { "type": "string", "description": "Url value", "example": "/v3/reference_data/da6f6dc1-a0ac-4733-8697-6299de0531e5/versions/7015d2af-0651-4a68-ade1-10aa0eb644a4/values/import/83a7a25a-4a51-4053-a6e7-4e374d26fe1a" }, "import_id": { "type": "string", "description": "Import id for the reference data values import process.", "example": "d3516e0e-3775-498c-ba32-ce8fb0863376", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "import_message": { "type": "string", "description": "Additional message about the current State of the Import.", "example": "Import Completed", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "import_state": { "type": "string", "description": "Current State of the Import.", "example": "SUCCEEDED", "pattern": "^(NEW|QUEUED|IN_PROGRESS|SUCCEEDED|FAILED|CANCELLED|CANCEL_REQUESTED|CANCELLING|STALLED|PAUSE_REQUESTED|PAUSED|RESUME_REQUESTED)$" }, "rels_deleted": { "type": "integer", "format": "int64", "description": "Total count of relationships deleted.", "maximum": 10000000, "minimum": 0 }, "rels_inserted": { "type": "integer", "format": "int64", "description": "Total count of relationships inserted.", "maximum": 10000000, "minimum": 0 }, "rels_processed": { "type": "integer", "format": "int64", "description": "Total count of relationships processed.", "maximum": 10000000, "minimum": 0 }, "rels_skipped": { "type": "integer", "format": "int64", "description": "Total count of relationships skipped.", "maximum": 10000000, "minimum": 0 }, "rels_values_processed": { "type": "integer", "format": "int64", "description": "Total count of values which relationships were processed for.", "maximum": 1000000, "minimum": 0 }, "start_time": { "type": "string", "format": "date-time", "description": "Import start time.", "example": "2017-02-15T02:30:32.000Z", "maxLength": 32, "minLength": 10, "pattern": "^\\d{4}(-\\d\\d(-\\d\\d(T\\d\\d:\\d\\d(:\\d\\d)?(\\.\\d+)?(([+-]\\d\\d:\\d\\d)|Z)?)?)?)?$" }, "started_by": { "type": "string", "description": "User that started import.", "example": "IBMid-1234567ABC", "pattern": ".*" }, "values_count": { "type": "integer", "format": "int64", "description": "Total count of values.", "maximum": 1000000, "minimum": 0 }, "values_inserted": { "type": "integer", "format": "int64", "description": "Total count of values inserted or modified.", "maximum": 1000000, "minimum": 0 }, "values_processed": { "type": "integer", "format": "int64", "description": "Total count of values processed.", "maximum": 1000000, "minimum": 0 }, "values_skipped": { "type": "integer", "format": "int64", "description": "Total count of values skipped.", "maximum": 1000000, "minimum": 0 }, "warnings": { "type": "array", "description": "Warnings, by default only first 100 warnings are reported.", "items": { "$ref": "#/components/schemas/GlossaryV3Warning" }, "properties": { "empty": { "type": "boolean" }, "file_name": { "type": "string" } } }, "warnings_count": { "type": "integer", "format": "int64", "description": "Total count of warnings.", "maximum": 1000000, "minimum": 0 } } }, "GlossaryV3RDSCustomColumnResponse": { "type": "object", "description": "List of composite key members", "properties": { "composite_key": { "type": "boolean", "default": false, "description": "Determinate if it is a part of composite key. If a column is a composite key, it must be mandatory.", "example": false }, "description": { "type": "string", "description": "description", "example": "Custom Column Description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "hidden": { "type": "boolean", "description": "Determines if column is hidden", "example": false }, "id": { "type": "string", "description": "Custom Column Definition Id", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "mandatory": { "type": "boolean", "description": "Determinate if it is mandatory", "example": false }, "max_character_count": { "type": "integer", "format": "int32", "description": "Allowed maximum character count", "example": 2000, "maximum": 2000, "minimum": 1, "pattern": "\\d*" }, "name": { "type": "string", "description": "name", "example": "Custom Column Name", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "owner_rds_id": { "type": "string", "description": "Artifact id of reference data set owning this custom column", "example": "9ec35f22-db7f-56c9-8a05-25983e485adc", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "example": "0", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "type": { "type": "string", "description": "Custom Column definitions type.", "enum": [ "NUMBER", "TEXT", "DATE" ], "example": "TEXT" }, "validator_rds_id": { "type": "string", "description": "Artifact id of reference data set validating this custom column", "example": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, "required": [ "name" ] }, "GlossaryV3Warning": { "type": "object", "description": "Warning details containing line number and a message", "properties": { "filename": { "type": "string", "description": "Filename.", "example": "reference_data_value_1.csv", "maximum": 1000000, "minimum": 1 }, "info": { "type": "array", "description": "Warning details.", "example": "Import Completed", "items": { "type": "string", "description": "Warning details.", "example": "Import Completed", "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "maxLength": 32672, "minLength": 1, "pattern": ".*" }, "row": { "type": "integer", "format": "int64", "description": "Row number.", "example": 100, "maximum": 1000000, "minimum": 1 } } }, "GlossaryV3UpdatableReferenceDataSetEntityV4": { "type": "object", "description": "Represents a V4 reference data set to be updated.", "properties": { "composite_key_order": { "type": "array", "description": "New composite key order", "items": { "$ref": "#/components/schemas/GlossaryV3RDSColumnOrderEntity" } }, "effective_end_date": { "type": "string", "format": "date-time", "description": "The effective end date at which the artifact ends and no longer effective. If the effective end date is not specified, then the artifact remains effect forever.", "maxLength": 32, "minLength": 10 }, "effective_start_date": { "type": "string", "format": "date-time", "description": "The effective start date at which the artifact goes into effect. If the effective start date is not specified, then the artifact goes into effect immediately.", "maxLength": 32, "minLength": 10 }, "long_description": { "type": "string", "description": "The long description of an artifact.", "example": "description of reference data set", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "name": { "type": "string", "description": "The name of the artifact.", "example": "ISO Country Codes", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "reference_copy": { "type": "boolean", "description": "Indicates that it is a reference copy of an artifact managed in an external metadata server." }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "example": "0", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "state": { "type": "string", "description": "The state of an artifact, such as DRAFT, ACTIVE or ARCHIVED.", "enum": [ "DRAFT", "PUBLISHED", "DRAFT_HISTORY", "PUBLISHED_HISTORY", "DELETED", "ARCHIVED", "PENDING_DELETE" ], "readOnly": true }, "steward_group_ids": { "type": "array", "description": "The steward groups assigned to an artifact.", "example": [ "steward_group1", "steward_group2" ], "items": { "type": "string", "description": "The steward groups assigned to an artifact.", "example": "[\"steward_group1\",\"steward_group2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "steward_ids": { "type": "array", "description": "Stewards Ids", "example": [ "steward1", "steward2" ], "items": { "type": "string", "description": "Stewards Ids", "example": "[\"steward1\",\"steward2\"]", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "maxLength": 255, "minLength": 1, "pattern": ".*" }, "tags": { "type": "array", "description": "The tags assigned to an artifact.", "example": [ "tag1", "tag2" ], "items": { "type": "string", "description": "The tags assigned to an artifact.", "example": "[\"tag1\",\"tag2\"]", "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "maxLength": 15000, "minLength": 1, "pattern": ".*" }, "type": { "type": "string", "description": "Type", "enum": [ "TEXT", "NUMBER", "DATE" ], "example": "TEXT", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true } }, "required": [ "revision" ] }, "GlossaryV3RDSColumnOrderEntity": { "type": "object", "description": "New composite key order", "properties": { "hidden": { "type": "boolean", "description": "Determines if column is hidden", "example": false }, "id": { "type": "string", "description": "Custom Column Definition Id", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } }, "GlossaryV3CustomColumnCreateResponse": { "type": "object", "description": "Custom column create response", "properties": { "resources": { "type": "array", "description": "resources of custom columns.", "items": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnResponse" } } } }, "GlossaryV3RDSCustomColumnsCreateRequest": { "type": "object", "description": "RDS custom columns create request", "properties": { "columns": { "type": "array", "description": "List of custom column Definitions.", "items": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnEntity" } } } }, "GlossaryV3RDSCustomColumnEntity": { "type": "object", "description": "List of custom column Definitions.", "properties": { "composite_key": { "type": "boolean", "default": false, "description": "Determinate if it is a part of composite key. If a column is a composite key, it must be mandatory.", "example": false }, "description": { "type": "string", "description": "description", "example": "Custom Column Description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "mandatory": { "type": "boolean", "description": "Determinate if it is mandatory", "example": false }, "max_character_count": { "type": "integer", "format": "int32", "description": "Allowed maximum character count", "example": 2000, "maximum": 2000, "minimum": 1, "pattern": "\\d*" }, "name": { "type": "string", "description": "name", "example": "Custom Column Name", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "type": { "type": "string", "description": "Custom Column definitions type.", "enum": [ "NUMBER", "TEXT", "DATE" ], "example": "TEXT" }, "validator_rds_id": { "type": "string", "description": "Artifact id of reference data set validating this custom column", "example": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, "required": [ "name" ] }, "GlossaryV3RDSCustomColumnUpdatableEntity": { "type": "object", "description": "RDS custom column updatable entity", "properties": { "description": { "type": "string", "description": "description", "example": "Custom Column Description", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "mandatory": { "type": "boolean", "description": "Determinate if it is mandatory", "example": false }, "max_character_count": { "type": "integer", "format": "int32", "description": "Allowed maximum character count", "example": 2000, "maximum": 2000, "minimum": 1, "pattern": "\\d*" }, "name": { "type": "string", "description": "name", "example": "Custom Column Name", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "example": "0", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "type": { "type": "string", "description": "Type", "example": "TEXT", "maxLength": 255, "minLength": 1, "pattern": ".*", "readOnly": true }, "validator_rds_id": { "type": "string", "description": "Artifact id of reference data set validating this custom column", "example": "d58b8247-8f94-4c1f-8ea1-48f1cb55122a", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } }, "required": [ "name", "revision" ] }, "GlossaryV3RDSCustomColumnsGetResponse": { "type": "object", "description": "RDS Custom Columns Get Response", "properties": { "entity": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnResponse" }, "metadata": { "$ref": "#/components/schemas/GlossaryV3RDSCustomColumnsGetMetaData" } } }, "GlossaryV3RDSCustomColumnsGetMetaData": { "type": "object", "description": "metadata of cust columns.", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "created_at", "example": "2017-02-15T02:30:32.000Z" }, "created_by": { "type": "string", "description": "created_by", "example": "IBMid-1234567ABC" }, "id": { "type": "string", "description": "Custom Column Definition Id", "example": "990e33f5-3108-4d45-a530-0307458362d4" }, "modified_at": { "type": "string", "format": "date-time", "description": "modified_at", "example": "2017-02-15T02:30:32.000Z" }, "modified_by": { "type": "string", "description": "modified_by", "example": "IBMid-1234567ABC" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "example": "0", "maxLength": 20, "minLength": 1, "pattern": "\\d*" } }, "required": [ "created_at", "created_by", "modified_at", "modified_by" ] }, "GlossaryV3CreateRelationshipResponseV4": { "type": "object", "description": "Create relationship response for Reference Data Set V4", "properties": { "artifact_id": { "type": "string", "description": "The ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "categories": { "type": "array", "description": "secondary category relationships added", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } }, "child": { "type": "array", "description": "child reference data set relationships added", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } }, "classifications": { "type": "array", "description": "classification relationships added", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } }, "custom_relationships": { "type": "object", "additionalProperties": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" }, "readOnly": true }, "description": "Custom relationships to asset", "readOnly": true }, "entity_type": { "type": "string", "description": "The type of the artifact", "enum": [ "category", "glossary_term", "classification", "data_class", "reference_data", "policy", "rule" ], "example": "data_class", "readOnly": true }, "global_id": { "type": "string", "description": "The global ID of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})", "readOnly": true }, "href": { "type": "string", "description": "Resource url", "example": "/v3/glossary_terms/990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent": { "type": "array", "description": "parent reference data set relationships added", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" }, "parent_category_global_id": { "type": "string", "description": "The global ID of the parent category of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})" }, "parent_category_id": { "type": "string", "description": "The artifact ID of the parent category", "example": "990e33f5-3108-4d45-a667-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "terms": { "type": "array", "description": "term relationships added", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } }, "version_id": { "type": "string", "description": "The version ID of the artifact", "example": "4fb86a70-7035-4b3e-8825-137c7b9b1687_1", "maxLength": 40, "minLength": 36, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?" }, "workflow_id": { "type": "string", "description": "The workflow ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true } }, "required": [ "artifact_id" ] }, "GlossaryV3ReferenceDataSetRelationshipsV4": { "type": "object", "description": "Reference Data Set Relationships V4", "properties": { "categories": { "type": "array", "description": "Category relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "child": { "type": "array", "description": "New relationship with reference data set.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "classifications": { "type": "array", "description": "The relationships to classifications.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "custom_relationships": { "type": "array", "description": "Custom relationships to asset", "items": { "$ref": "#/components/schemas/GlossaryV3NewCustomRelationship" } }, "parent": { "type": "array", "description": "New relationship with reference data set.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } }, "parent_category": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" }, "terms": { "type": "array", "description": "The relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } }, "GlossaryV3RelationshipCreateResponseIds": { "type": "object", "description": "Response ID's of create relationships", "properties": { "relationship_id": { "type": "string", "description": "relationship id" }, "target_id": { "type": "string", "description": "target id" } } }, "GlossaryV3RDVImportInfoResponseV4": { "type": "object", "description": "RDV Import Info Response V4", "properties": { "artifact_id": { "type": "string", "description": "The ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "entity_type": { "type": "string", "description": "The type of the artifact", "enum": [ "category", "glossary_term", "classification", "data_class", "reference_data", "policy", "rule" ], "example": "data_class", "readOnly": true }, "global_id": { "type": "string", "description": "The global ID of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})", "readOnly": true }, "href": { "type": "string", "description": "Resource url", "example": "/v3/glossary_terms/990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "import_info": { "$ref": "#/components/schemas/GlossaryV3RDVImportInfo" }, "version_id": { "type": "string", "description": "The version ID of the artifact", "example": "4fb86a70-7035-4b3e-8825-137c7b9b1687_1", "maxLength": 40, "minLength": 36, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?" }, "workflow_id": { "type": "string", "description": "The workflow ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true } }, "required": [ "artifact_id" ] }, "GlossaryV3RDVImportRequest": { "type": "object", "description": "Request for reference data values import.", "properties": { "import_csv_file": { "type": "string", "format": "binary", "description": "Input stream for a import file with reference data values.", "minLength": 1 }, "import_parameters": { "$ref": "#/components/schemas/GlossaryV3RDVImportRequestParameters" } }, "required": [ "import_csv_file", "import_parameters" ] }, "GlossaryV3RDVImportRequestParameters": { "type": "object", "description": "RDV Import Request Parameters:\n

    \n
  • code - name of column or column number with codes,
    • \n
  • value - name of column or column number with values,
    • \n
  • description - name of column or column number with descriptions,
    • \n
  • parent - name of column or column number with parent RDVs,
    • \n
  • related_terms - name of column or column number with related terms,
    • \n
  • value_conflicts - conflict resolution strategy, allowable values are:
    • \n
      \n
    • OVERWRITE - in case of duplicates, overwrite existing data,
      • \n
    • IGNORE - in case of duplicates, the existing data remains,
      • \n
    • REJECT - in case of duplicates, import fails
      • \n
    \n
  • is_first_row_header - indicates if the first row in a file is a header, by default true,
    • \n
  • trim_white_spaces - indicates if the values should be trimmed, by default false,
    • \n
  • import_relationships_only - indicates if only relationships should be imported, by default false,
    • \n
  • skip_workflow_if_possible - indicates if workflow should be skipped, by default false,
    • \n
  • custom_columns_mappings - mappings for names of custom columns,
    • \n
  • value_mappings - mappings for relationships for values from other reference data sets,\n mapping_types: single_value_mappings or multi_value_mappings,
    • \n
\n", "properties": { "code": { "type": "string", "description": "Column name (number if first_row_header is false) of the code field in CSV file.", "example": "my_code", "minLength": 1, "pattern": ".*" }, "custom_columns_mappings": { "type": "array", "description": "Mapping for custom column names.", "items": { "$ref": "#/components/schemas/GlossaryV3CustomColumnEntity" } }, "description": { "type": "string", "description": "Column name (number if first_row_header is false) of the description field in CSV file.", "example": "my_description", "minLength": 1, "pattern": ".*" }, "first_row_header": { "type": "boolean" }, "import_relationships_only": { "type": "boolean", "description": "If set to true only relationships (related terms, parent relationships and value mappings) will be imported." }, "parent": { "type": "string", "description": "Column name (number if first_row_header is false) of the parent field in CSV file.", "example": "my_parent", "minLength": 1, "pattern": ".*" }, "related_terms": { "type": "string", "description": "Column name (number if first_row_header is false) of the related_terms field in CSV file.
If column name not provided, the default column name related terms or related_terms will be used. ", "example": "my_related_terms", "minLength": 1, "pattern": ".*" }, "skip_workflow_if_possible": { "type": "boolean", "default": false, "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation." }, "standard_column_mappings": { "type": "object", "additionalProperties": { "type": "string" } }, "trim_white_spaces": { "type": "boolean", "default": false, "description": "Specify if to trim leading and trailing spaces for code, value & description." }, "value": { "type": "string", "description": "Column name (number if first_row_header is false) of the value field in CSV file.", "example": "my_value", "minLength": 1, "pattern": ".*" }, "value_conflicts": { "type": "string", "default": "OVERWRITE", "description": "ignore/overwrite/reject if a value already exists. Default is overwrite", "enum": [ "OVERWRITE", "IGNORE", "REJECT" ] }, "value_mappings": { "type": "array", "description": "Description of single or multi mapping to value from another reference data set.", "items": { "$ref": "#/components/schemas/GlossaryV3ValueMappingEntity" } } }, "required": [ "code" ] }, "GlossaryV3ValueMappingEntity": { "type": "object", "description": "Reference data value mappings", "properties": { "csv_column_name": { "type": "string", "description": "Name of mapping column in csv file.", "example": "Column1", "minLength": 1, "pattern": ".*" }, "map_to_rds_id": { "type": "string", "description": "Artifact id of mapping reference data set.", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "mapping_type": { "type": "string", "description": "Type of values mapping. Allowed values: one_to_one/many_to_many.", "enum": [ "single_value_mappings", "multi_value_mappings" ] } }, "required": [ "csv_column_name", "map_to_rds_id", "mapping_type" ] }, "GlossaryV3CustomColumnEntity": { "type": "object", "description": "Mapping between custom column name and name in csv file", "properties": { "csv_column_name": { "type": "string", "description": "Name of mapping column in csv file.", "example": "Column1", "minLength": 1, "pattern": ".*" }, "custom_column_name": { "type": "string", "description": "Name of custom column.", "example": "CustomColumn", "minLength": 1, "pattern": ".*" } }, "required": [ "csv_column_name", "custom_column_name" ] }, "GlossaryV3CreateRdvRelationshipsResponseV4": { "type": "object", "description": "V4 response for Create Value Relationships request", "properties": { "artifact_id": { "type": "string", "description": "The ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "entity_type": { "type": "string", "description": "The type of the artifact", "enum": [ "category", "glossary_term", "classification", "data_class", "reference_data", "policy", "rule" ], "example": "data_class", "readOnly": true }, "global_id": { "type": "string", "description": "The global ID of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})", "readOnly": true }, "href": { "type": "string", "description": "Resource url", "example": "/v3/glossary_terms/990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "parent_category_global_id": { "type": "string", "description": "The global ID of the parent category of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})" }, "parent_category_id": { "type": "string", "description": "The artifact ID of the parent category", "example": "990e33f5-3108-4d45-a667-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "value_relationships": { "type": "array", "description": "List of Reference Data Values with relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3CreateRdvRelationshipResponseV4" } }, "version_id": { "type": "string", "description": "The version ID of the artifact", "example": "4fb86a70-7035-4b3e-8825-137c7b9b1687_1", "maxLength": 40, "minLength": 36, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?" }, "workflow_id": { "type": "string", "description": "The workflow ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true } }, "required": [ "artifact_id" ] }, "GlossaryV3ReferenceDataValuesRelationshipsRequestV4": { "type": "object", "description": "Reference Data Values Relationships", "properties": { "value_relationships": { "type": "array", "description": "Reference Data Values Relationships", "items": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueRelationshipsRequestV4" } } } }, "GlossaryV3CreateRdvRelationshipResponseV4": { "type": "object", "description": "V4 response for Create Value Relationship request", "properties": { "artifact_id": { "type": "string", "description": "Artifact Id", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "child": { "type": "array", "description": "Artifact ids of children reference data values", "items": { "type": "string", "description": "Artifact ids of children reference data values" } }, "multi_value_mappings": { "type": "array", "description": "Multi mapping relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } }, "single_value_mappings": { "type": "array", "description": "Single mapping relationships.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } }, "terms": { "type": "array", "description": "The relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipCreateResponseIds" } } } }, "GlossaryV3ReferenceDataValueRelationshipsRequestV4": { "type": "object", "description": "Reference Data Value relationships request object used in request payload to create RDV relationships", "properties": { "child": { "type": "array", "description": "The artifact id to other reference data values as child.", "example": [ "1fea0a80-98ec-4c13-968b-cebd0ba94726", "5aa0508c-6301-4cd2-8570-78d584fc275e" ], "items": { "type": "string", "description": "The artifact id to other reference data values as child.", "example": "[\"1fea0a80-98ec-4c13-968b-cebd0ba94726\",\"5aa0508c-6301-4cd2-8570-78d584fc275e\"]", "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "multi_value_mappings": { "type": "array", "description": "The relationships to other reference data values as multi value mapping.", "items": { "$ref": "#/components/schemas/GlossaryV3NewMultiValueMappingV4" } }, "rdv_artifact_id": { "type": "string", "description": "Artifact id of target reference data value", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "single_value_mappings": { "type": "array", "description": "The relationship to other reference data value as single value mapping.", "items": { "$ref": "#/components/schemas/GlossaryV3NewSingleValueMappingV4" } }, "terms": { "type": "array", "description": "The relationships to business terms.", "items": { "$ref": "#/components/schemas/GlossaryV3NewRelationship" } } } }, "GlossaryV3NewSingleValueMappingV4": { "type": "object", "description": "Stores the attributes required for creating a single mapping relationship.", "properties": { "rds_artifact_id": { "type": "string", "description": "Artifact id of target reference data set", "example": "572a3691-c7aa-4cce-a782-f2c38c6f35c8", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "rdv_artifact_id": { "type": "string", "description": "Artifact id of target reference data value", "example": "74d6b4f6-7147-4569-955a-d45f1244524b", "maxLength": 36, "minLength": 36 } }, "required": [ "rds_artifact_id", "rdv_artifact_id" ] }, "GlossaryV3NewMultiValueMappingV4": { "type": "object", "description": "Stores the attributes required for creating a multi mapping relationship.", "properties": { "rds_artifact_id": { "type": "string", "description": "Artifact id of target reference data set", "example": "572a3691-c7aa-4cce-a782-f2c38c6f35c8", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "rdv_artifact_ids": { "type": "array", "description": "Artifact ids of target reference data values", "example": [ "7102b4fe-3047-49f2-baf7-71b11116ff5e", "5f54f255-8026-4b13-9284-518c299ea069" ], "items": { "type": "string", "description": "Artifact ids of target reference data values", "example": "[\"7102b4fe-3047-49f2-baf7-71b11116ff5e\",\"5f54f255-8026-4b13-9284-518c299ea069\"]", "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" }, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})(,([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12}))*" } }, "required": [ "rds_artifact_id" ] }, "GlossaryV3ReferenceDataValueDetailsV4": { "type": "object", "description": "V4 API Reference data value details", "properties": { "artifact_id": { "type": "string", "description": "Artifact ID", "example": "498ce3d1-4321-44eb-a381-d74c7c34c95b", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "child": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueChildrenResponseListV4" }, "code": { "type": "string", "description": "Code", "example": "GER", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "composite_key_values": { "type": "array", "description": "Values of custom columns being part of composite key", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntity" } }, "custom_column_values": { "type": "array", "description": "Values of custom columns not being part of composite key", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntity" } }, "description": { "type": "string", "description": "Description", "example": "European Country", "maxLength": 8000, "minLength": 1, "pattern": ".*" }, "has_children": { "type": "boolean", "description": "Indicates if reference data value has at least one child" }, "multi_value_mappings": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueRelationshipResponseListV4" }, "parent": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueDetailsV4" }, "parent_hierarchy": { "type": "array", "description": "List of parent reference data values in hierarchical order", "items": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueDetailsV4" } }, "parent_value_artifact_id": { "type": "string", "description": "Parent Artifact ID", "example": "e28f5002-b16e-4f82-b434-e070636c9aee", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "revision": { "type": "string", "description": "Revision, must be provided for reference data value modification", "example": "0", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "single_value_mappings": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueRelationshipResponseListV4" }, "terms": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueRelationshipResponseListV4" }, "value": { "type": "string", "description": "Value", "example": "Germany", "maxLength": 4000, "minLength": 1, "pattern": ".*" }, "value_mappings": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueRelationshipResponseListV4" } } }, "GlossaryV3ReferenceDataValueRelationshipResponseListV4": { "type": "object", "description": "Presents a paginated list of Reference Data Value relationships", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "relationships": { "type": "array", "description": "List of relationships", "items": { "$ref": "#/components/schemas/GlossaryV3RelationshipRelationshipEntityV3" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3ReferenceDataValueChildrenResponseListV4": { "type": "object", "description": "Presents a paginated list of Reference Data Value children", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "relationships": { "type": "array", "description": "List of relationships", "items": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueDetailsV4" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3ReferenceDataValuesSearchResponseListV4": { "type": "object", "description": "Presents a paginated list of V4 Reference Data Value search results", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "value_search": { "type": "array", "description": "List of reference data values", "items": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueDetailsV4" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3RDVSearchParameters": { "type": "object", "description": "Search Filter object", "properties": { "filter_type": { "type": "string", "enum": [ "CODE_EQUALS", "CODE_OR_VALUE_CONTAINS", "CODE_STARTS_WITH" ] }, "filter_value": { "type": "string", "description": "Reference data value search filter value", "example": "filter text", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "include_custom_column_values": { "type": "boolean", "default": false, "description": "Fetch custom column values for reference data set values." }, "include_parent_value_details": { "type": "boolean", "default": false, "description": "Fetch parent reference data details for reference data set values." }, "include_relationship": { "type": "string", "description": "Comma-separated list of relationship types for reference data value.
", "enum": [ "parent_value", "parent_value_hierarchy", "child_value", "multi_value_mappings", "single_value_mappings", "terms", "value_mappings" ], "example": "value_mappings" }, "limit": { "type": "integer", "format": "int32", "description": "The maximum number of values to return - must be at least 1 and cannot exceed 200. The default value is 10.", "maximum": 200, "minimum": 1 }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "The index of the first matching value to include in the result.", "maximum": 2147483647, "minimum": 1, "pattern": "\\d*" }, "relationship_limit": { "type": "integer", "format": "int32", "description": "The maximum number of relationships to return - must be at least 1 and cannot exceed 200. The default value is 10.", "maximum": 200, "minimum": 1 }, "sort": { "type": "string", "description": "Value on which results need to be sorted, currently only CODE is supported.Prefix hyphen (-) for descending order, applicable only for reference data values search.", "example": "-CODE", "pattern": "^(\\+|-){0,1}CODE$" } }, "required": [ "filter_type", "filter_value" ] }, "GlossaryV3CreateUpdateMultipleRDVsResponseV4": { "type": "object", "description": "Create, update or delete multiple RDVs response for Reference Data Set Api V4", "properties": { "artifact_id": { "type": "string", "description": "The ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "entity_type": { "type": "string", "description": "The type of the artifact", "enum": [ "category", "glossary_term", "classification", "data_class", "reference_data", "policy", "rule" ], "example": "data_class", "readOnly": true }, "global_id": { "type": "string", "description": "The global ID of the artifact", "example": "867907bd-4c80-458d-9e75-c5683e013533_0da59a9d-3a5a-4e1d-aa0c-e67ac8bfbbb6", "maxLength": 73, "minLength": 73, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})_([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})", "readOnly": true }, "href": { "type": "string", "description": "Resource url", "example": "/v3/glossary_terms/990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 2048, "minLength": 1, "pattern": ".*", "readOnly": true }, "values": { "type": "array", "description": "Reference data values", "items": { "$ref": "#/components/schemas/GlossaryV3ResponseReferenceDataValueEntityV4" } }, "version_id": { "type": "string", "description": "The version ID of the artifact", "example": "4fb86a70-7035-4b3e-8825-137c7b9b1687_1", "maxLength": 40, "minLength": 36, "pattern": "([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})(_[0-9]{1,4})?" }, "workflow_id": { "type": "string", "description": "The workflow ID of the artifact", "example": "990e33f5-3108-4d45-a530-0307458362d4", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})", "readOnly": true } }, "required": [ "artifact_id" ] }, "GlossaryV3CreateUpdateReferenceDataValuesListV4": { "type": "object", "description": "Schema for list with new Reference Data Value Entities for Reference Data Set Api V4", "properties": { "values": { "type": "array", "description": "Reference data values", "items": { "$ref": "#/components/schemas/GlossaryV3CreateUpdateReferenceDataValueEntityV4" } } } }, "GlossaryV3NewReferenceDataValueEntityV4": { "type": "object", "description": "Schema for creating single Reference Data Value in Reference Data Set - API V4", "properties": { "code": { "type": "string", "description": "Code of reference data value.", "example": "IND", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "custom_column_values": { "type": "array", "description": "List of custom column values", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntityV4" } }, "description": { "type": "string", "description": "Description", "example": "Country code for India", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_value_artifact_id": { "type": "string", "description": "Artifact id of parent reference data value", "example": "e599caea-afea-424b-9cbf-00a72864a557", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "value": { "type": "string", "description": "Value of reference data value", "example": "India", "maxLength": 255, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3RdvJsonPatch": { "type": "object", "description": "Reference data set values patch model", "properties": { "move_child_to": { "type": "string", "description": "Specifies behavior when deleted reference data value has children. Options are:
  • root - make them root values
  • immediate_parent - move them to the parent of deleted value
  • other_value - move them to specified value
", "enum": [ "root", "immediate_parent", "other_value" ] }, "operations": { "type": "array", "description": "Operation to be performed", "items": { "$ref": "#/components/schemas/GlossaryV3RdvJsonPatchOperation" } }, "skip_workflow_if_possible": { "type": "boolean", "description": "If configuration permits, the published artifact will be updated by skipping the workflow. For details refer to documentation." }, "target_value_artifact_id": { "type": "string", "format": "uuid", "description": "Target reference data value (to become parent for children of deleted one) artifact id (note: it has to \"belong\" to same reference data set as deleted value", "example": "b4610037-3a7c-4e4e-9e7e-4d2c03f4f75b", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" } } }, "GlossaryV3ReferenceDataValuesGetResponseListV4": { "type": "object", "description": "Presents a paginated list of V4 Reference Data Values", "properties": { "count": { "type": "integer", "format": "int64", "description": "The total number of items that matches the given criteria.", "example": 300 }, "first": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "last": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "limit": { "type": "integer", "format": "int32", "default": 10, "description": "The limit parameter passed to the list / search method.", "example": 30, "maximum": 1000, "minimum": 1 }, "missing_rdv_artifact_ids": { "type": "array", "description": "Reports requested rdv_artifact_ids that do not exist under given version of reference data set", "items": { "type": "string", "description": "Reports requested rdv_artifact_ids that do not exist under given version of reference data set" }, "uniqueItems": true }, "next": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "offset": { "type": "integer", "format": "int32", "description": "Offset used in the list / search method.", "example": 80 }, "prev": { "$ref": "#/components/schemas/GlossaryV3GlossaryResourceLinkV3" }, "values": { "type": "array", "description": "List of reference data values", "items": { "$ref": "#/components/schemas/GlossaryV3ReferenceDataValueDetailsV4" } } }, "required": [ "limit", "offset" ] }, "GlossaryV3ResponseReferenceDataValueEntityV4": { "type": "object", "description": "Reference data values", "properties": { "artifact_id": { "type": "string", "description": "Artifact id of reference data value", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "code": { "type": "string", "description": "Code", "example": "IND", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "composite_key_values": { "type": "array", "description": "List of composite key members", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntityV4" } }, "custom_column_values": { "type": "array", "description": "List of custom column values", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntityV4" } }, "description": { "type": "string", "description": "Description", "example": "Country code for India", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_value_artifact_id": { "type": "string", "description": "Artifact id of parent reference data value", "example": "e599caea-afea-424b-9cbf-00a72864a557", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "value": { "type": "string", "description": "Value of reference data value", "example": "India", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "revision" ] }, "GlossaryV3CreateUpdateReferenceDataValueEntityV4": { "type": "object", "description": "Schema for creating and updating single Reference Data Value in Reference Data Set - API V4", "properties": { "artifact_id": { "type": "string", "description": "Artifact id of reference data value. Required only for Reference Data Values which should be updated. If not provided, Reference Data Value is treated as new one.", "example": "b4610037-3a7c-4e4e-9e7e-4d2c03f4f75b", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "code": { "type": "string", "description": "Code of reference data value. Required only for new Reference Data Values. Cannot be updated.", "example": "IND", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "custom_column_values": { "type": "array", "description": "List of custom column values", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntityV4" } }, "description": { "type": "string", "description": "Description", "example": "Country code for India", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_value_artifact_id": { "type": "string", "description": "Artifact id of parent reference data value", "example": "e599caea-afea-424b-9cbf-00a72864a557", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking. Required only for Reference Data Values which should be updated.", "example": "1", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "value": { "type": "string", "description": "Value of reference data value", "example": "India", "maxLength": 255, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3RDVCustomColumnEntityV4": { "type": "object", "description": "List of custom column values", "properties": { "id": { "type": "string", "description": "Custom column ID", "example": "b4610037-3a7c-4e4e-9e7e-4d2c03f4f75b", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "value": { "type": "string", "description": "Custom column value", "example": "custom column value", "maxLength": 2000, "minLength": 1, "pattern": ".*" } } }, "GlossaryV3RdvJsonPatchOperation": { "type": "object", "description": "Specifies single operation to be applied to reference data value.

Note: only replace and remove operations are supported", "properties": { "op": { "type": "string", "description": "Operation to be performed", "enum": [ "add", "replace", "remove" ], "example": "replace" }, "path": { "type": "string", "description": "Path to value to be removed/replaced in following format: /{value_artifact_id}", "example": "/3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "/([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "value": { "$ref": "#/components/schemas/GlossaryV3RdvJsonPatchValue" } } }, "GlossaryV3RdvJsonPatchValue": { "type": "object", "description": "Reference Data Set Value to replace selected one", "properties": { "description": { "type": "string", "description": "Description", "example": "Country code for India", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_value_artifact_id": { "type": "string", "description": "Artifact id of parent reference data value", "example": "e599caea-afea-424b-9cbf-00a72864a557", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "example": "0", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "value": { "type": "string", "description": "Value of reference data value", "example": "India", "maxLength": 255, "minLength": 1, "pattern": ".*" } }, "required": [ "revision" ] }, "GlossaryV3UpdateReferenceDataValueEntityV4": { "type": "object", "description": "Schema for updating single Reference Data Value in Reference Data Set - API V4", "properties": { "custom_column_values": { "type": "array", "description": "List of custom column values", "items": { "$ref": "#/components/schemas/GlossaryV3RDVCustomColumnEntityV4" } }, "description": { "type": "string", "description": "Description", "example": "Country code for India", "maxLength": 255, "minLength": 1, "pattern": ".*" }, "parent_value_artifact_id": { "type": "string", "description": "Artifact id of parent reference data value", "example": "e599caea-afea-424b-9cbf-00a72864a557", "maxLength": 36, "minLength": 36, "pattern": "([A-Za-z0-9]{8}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{12})" }, "revision": { "type": "string", "description": "The revision of the artifact. It is used for optimistic locking.", "example": "1", "maxLength": 20, "minLength": 1, "pattern": "\\d*" }, "value": { "type": "string", "description": "Value of reference data value", "example": "India", "maxLength": 255, "minLength": 1, "pattern": ".*" } } }, "JobsJob": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/JobsAssetMetadata" }, "entity": { "$ref": "#/components/schemas/JobsJobEntity" } } }, "JobsJobPostBody": { "type": "object", "properties": { "job": { "required": [ "configuration", "name" ], "type": "object", "properties": { "asset_ref": { "type": "string", "description": "ID of associated asset to run (provide either asset_ref or asset_ref_type).", "example": "ff1ab70b-0553-409a-93f9-ccc31471c218" }, "asset_ref_type": { "type": "string", "description": "The type of asset to run (provide either asset_ref or asset_ref_type).", "example": "notebook" }, "name": { "type": "string", "description": "The name of the job", "example": "Name" }, "description": { "type": "string", "description": "The description of the job.", "example": "Description." }, "schedule": { "type": "string", "description": "A cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.", "example": "0 0 1 * *" }, "schedule_info": { "type": "object", "properties": { "repeat": { "type": "boolean", "description": "Indicate a repeated job", "example": true }, "startOn": { "type": "integer", "description": "A timestamp in epoch time, the scheduled job will be triggered after this timestamp.", "example": 1547578689512, "format": "int64" }, "endOn": { "type": "integer", "description": "A timestamp in epoch time, the scheduled job will be triggered before this timestamp.", "example": 1547578689512, "format": "int64" } } }, "serving_name": { "type": "string", "description": "A globally unique attribute to be used in place of the job id when sending calls. Must be a combination of lowercase alphanumeric and underscore characters, and must be between 1 and 36 characters.", "example": "my_job_1_2_3" }, "retention_policy": { "type": "object", "properties": { "days": { "type": "integer" }, "amount": { "type": "integer" } } }, "configuration": { "$ref": "#/components/schemas/JobsJobPostBodyConfiguration" }, "job_parameters": { "$ref": "#/components/schemas/JobsJobParametersArray" }, "parameter_sets": { "$ref": "#/components/schemas/JobsParameterSetsArray" } } } } }, "JobsListJobResponse": { "type": "object", "properties": { "next": { "$ref": "#/components/schemas/JobsAssetSearchNext" }, "total_rows": { "type": "integer", "example": 204 }, "results": { "type": "array", "description": "Array of all jobs.", "items": { "$ref": "#/components/schemas/JobsJob" } } } }, "JobsJobEntity": { "type": "object", "properties": { "job": { "type": "object", "properties": { "asset_ref": { "type": "string", "description": "ID of associated asset to run.", "example": "ff1ab70b-0553-409a-93f9-ccc31471c218" }, "asset_ref_name": { "type": "string", "description": "Name of associated asset to run.", "example": "Data preparation" }, "asset_ref_type": { "type": "string", "description": "Read-only field used to distinguish between different types of jobs based on the associated asset to run.", "example": "notebook" }, "hide_run_ui_display": { "type": "boolean", "description": "An attribute to hide the run button in the details page." }, "schedule": { "type": "string", "description": "A cron string defining when the job should be run. If an empty string is provided it means the job is not scheduled to run.", "example": "0 0 1 * *" }, "schedule_info": { "type": "object", "properties": { "repeat": { "type": "boolean", "description": "Whether the job has a repeating schedule", "example": true }, "startOn": { "type": "integer", "description": "Epoch time", "example": 1564686345309, "format": "int64" }, "endOn": { "type": "integer", "description": "Epoch time", "example": 1564686395309, "format": "int64" } }, "description": "An object defining defining more detail about job's schedule" }, "serving_name": { "type": "string", "description": "A globally unique attribute to be used in place of the job id when sending calls. Must be a combination of lowercase alphanumeric and underscore characters, and must be between 1 and 36 characters.", "example": "my_job_1_2_3" }, "notification_types": { "type": "object", "description": "An object defining the notification configuration for the job entity.", "required": [ "success", "warning", "failure" ], "properties": { "success": { "type": "boolean", "description": "Determine if notifications should be created if job runs associated with the job have successfully completed, completed with warnings, or completed with errors", "example": true }, "warning": { "type": "boolean", "description": "Determine if notifications should be created if job runs associated with the job were canceled or have finished with some issues", "example": false }, "failure": { "type": "boolean", "description": "Determine if notifications should be created if job runs associated with the job have failed", "example": true } } }, "configuration": { "$ref": "#/components/schemas/JobsJobRuntimeConfiguration" }, "job_parameters": { "$ref": "#/components/schemas/JobsJobParametersArray" }, "parameter_sets": { "$ref": "#/components/schemas/JobsParameterSetsArray" } } } }, "description": "The underlying job definition." }, "JobsAssetMetadata": { "required": [ "asset_category", "asset_type", "name", "origin_country" ], "type": "object", "properties": { "name": { "type": "string", "example": "Name" }, "description": { "type": "string", "example": "Description." }, "asset_id": { "type": "string", "example": "d5d898ac-b87a-40a1-9648-2c5f49fd0096" }, "asset_category": { "type": "string", "example": "USER" }, "asset_type": { "type": "string", "example": "job" }, "origin_country": { "type": "string", "example": "us" }, "rov": { "$ref": "#/components/schemas/JobsAssetRov" }, "project_id": { "type": "string", "example": "727a9f14-e692-4096-84ac-0db57dae0530" }, "sandbox_id": { "type": "string", "example": "727a9f14-e692-4096-84ac-0db57dae0530" }, "usage": { "type": "object", "properties": { "last_updated_at": { "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_updater_id": { "type": "string", "example": "IBMid-550000FRA0" }, "last_update_time": { "type": "integer", "format": "int64" }, "last_accessed_at": { "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_access_time": { "type": "integer", "example": 1547578689512, "format": "int64" }, "last_accessor_id": { "type": "string", "example": "IBMid-550000FRA0" }, "access_count": { "type": "integer", "example": 0 } } }, "rating": { "type": "integer", "example": 0 }, "total_ratings": { "type": "integer", "example": 0 }, "catalog_id": { "type": "string", "example": "edc30d9a-1691-4860-b947-4c8514e69f50" }, "created": { "type": "integer", "format": "int64", "example": 1547578689512 }, "created_at": { "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "owner_id": { "type": "string", "example": "IBMid-550000FRA0" }, "size": { "type": "integer", "example": 0 }, "version": { "type": "integer", "example": 2 }, "asset_state": { "type": "string", "example": "available" }, "asset_attributes": { "type": "array", "example": [ "job" ], "items": { "type": "string" } }, "tags": { "type": "array", "example": "['tag1', 'tag2', 'tag3']", "items": { "type": "string" } } }, "description": "AssetMetadata Model" }, "JobsParameterSetsArray": { "type": "array", "description": "Array of parameter sets.", "items": { "$ref": "#/components/schemas/JobsParameterSets" } }, "JobsJobParametersArray": { "type": "array", "description": "Array of job parameters.", "items": { "$ref": "#/components/schemas/JobsJobParameter" } }, "JobsJobPostBodyConfiguration": { "type": "object", "properties": { "env_id": { "$ref": "#/components/schemas/Jobsenv_id" }, "env_variables": { "$ref": "#/components/schemas/Jobsenv_variables" }, "version": { "$ref": "#/components/schemas/Jobsversion" }, "deployment_job_definition_id": { "$ref": "#/components/schemas/Jobsdeployment_job_definition_id" } } }, "JobsAssetSearchNext": { "type": "object", "properties": { "query": { "type": "string", "example": "*:*" }, "limit": { "type": "integer", "example": -1 }, "bookmark": { "type": "string", "example": "g1AAAACdeJzLYWBgYMpgTmHQTElKzi9KdUhJMtJLytVNTtYtLdYtzi8tydA1stBLzskvTUnMK9HLSy3JAWlJZEji____f1YGk5v9NzOZA0CxRGZUc4yJMSePBUgyXABSQNPug437_kAGJJbImgUAEAAxvA" }, "sort": { "type": "string", "example": "-asset.created_at" }, "include": { "type": "string", "example": "entity" } } }, "JobsJobRuntimeConfiguration": { "type": "object", "additionalProperties": true, "properties": { "env_id": { "$ref": "#/components/schemas/Jobsenv_id" }, "env_type": { "type": "string", "description": "Type of associated runtime for the job.", "example": "default_spark" }, "env_variables": { "$ref": "#/components/schemas/Jobsenv_variables" }, "version": { "$ref": "#/components/schemas/Jobsversion" }, "deployment_job_definition_id": { "$ref": "#/components/schemas/Jobsdeployment_job_definition_id" }, "outputs": { "type": "object", "properties": { "total_rows_read": { "type": "integer", "description": "Total number of rows read.", "format": "int64", "example": 1000 }, "total_bytes_read": { "type": "integer", "description": "Total number of bytes read.", "format": "int64", "example": 64582 }, "total_bytes_written": { "type": "integer", "description": "Total number of bytes written.", "format": "int64", "example": 594346 }, "total_rows_written": { "type": "integer", "description": "Total number of rows written.", "format": "int64", "example": 1846 } }, "description": "The output of job run." } } }, "JobsAssetRov": { "type": "object", "properties": { "mode": { "type": "integer", "format": "int32" }, "collaborator_ids": { "type": "object", "properties": {}, "example": "{}" } } }, "JobsParameterSets": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "paramset_1" }, "value_set": { "type": "string", "description": "(Optional) the name of a value set; if not provided default parameter set values are used", "example": "red" }, "ref": { "type": "string", "description": "(Optional) ID of a parameter set; if not provided ID is resolved in runtime (by execution service)", "example": "31abfd90-5497-4605-8ac1-d85896fe6c6f" }, "values_from": { "type": "object", "required": [ "parameter_set" ], "properties": { "parameter_set": { "$ref": "#/components/schemas/JobsParameterSet" } } }, "values": { "type": "array", "description": "A list of parameter overwrites.", "items": { "$ref": "#/components/schemas/JobsJobParameter" } } }, "additionalProperties": false }, "JobsJobParameter": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "example": "job_param_1" }, "value": { "example": "The value could be of any type", "description": "The value could be of any type" } }, "additionalProperties": false }, "Jobsdeployment_job_definition_id": { "type": "string", "description": "For WML batch deployment jobs only, the asset ID of a deployment job definition.", "example": "ff1ab70b-0553-409a-93f9-ccc31471c218" }, "Jobsversion": { "type": "string", "description": "For Notebook jobs only, selected version of associated Notebook asset. Empty if using latest version.", "example": "d00a9d88-4394-48f8-86db-d9b8360f8a72" }, "Jobsenv_variables": { "type": "array", "description": "The environment variables, only for Notebook and Script jobs.", "example": [ "key1=value1", "key2=value2" ], "items": { "type": "string" } }, "Jobsenv_id": { "type": "string", "description": "ID of associated runtime for the job.", "example": "defaultsparkr1x4-18ce241b-c9e8-43ed-94a1-9f5585764924" }, "JobsParameterSet": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "paramset_1" }, "value_set": { "type": "string", "description": "(Optional) the name of a value set; if not provided default parameter set values are used", "example": "red" }, "ref": { "type": "string", "description": "(Optional) ID of a parameter set; if not provided ID is resolved in runtime (by execution service)", "example": "31abfd90-5497-4605-8ac1-d85896fe6c6f" } }, "additionalProperties": false }, "JobsJSONJobPatchModel": { "type": "array", "description": "Updates to make in the job run.", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "The operation to be performed. Allowable values: [add, replace].", "example": "replace" }, "path": { "type": "string", "description": "A JSON pointer to the field to update. Allowable field paths to be updated. Ex /metadata/name or /entity/job/configuration", "example": "/metadata/name (or /entity/job/configuration)" }, "value": { "type": "object", "example": "" } } } }, "JobsServingName": { "type": "object", "properties": { "results": { "type": "array", "example": [ "serving_name does not exist in DB" ], "items": { "type": "string" } } } }, "JobsJobRun": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/JobsAssetJobRunMetadata" }, "entity": { "$ref": "#/components/schemas/JobsJobRunEntity" } } }, "JobsJobRunPostBody": { "required": [ "job_run" ], "type": "object", "properties": { "job_run": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the job run", "example": "Name" }, "description": { "type": "string", "description": "The description of the job run", "example": "Description" }, "configuration": { "type": "object", "properties": { "env_variables": { "$ref": "#/components/schemas/Jobsenv_variables" } } }, "job_parameters": { "$ref": "#/components/schemas/JobsJobParametersArray" }, "parameter_sets": { "$ref": "#/components/schemas/JobsParameterSetsArray" } } } } }, "JobsListJobRunResponse": { "type": "object", "properties": { "next": { "$ref": "#/components/schemas/JobsAssetSearchNext" }, "total_rows": { "type": "integer", "example": 204 }, "results": { "type": "array", "description": "Array of all jobs.", "items": { "$ref": "#/components/schemas/JobsJobRun" } } } }, "JobsJobRunState": { "type": "string", "description": "The state of the job run", "enum": [ "Queued", "Starting", "Running", "Paused", "Resuming", "Canceling", "Canceled", "Failed", "Completed", "CompletedWithErrors", "CompletedWithWarnings" ], "example": "Starting" }, "JobsJobRunEntity": { "type": "object", "properties": { "job_run": { "type": "object", "properties": { "job_ref": { "type": "string", "description": "The ID of the job used to create this run.", "example": "958b4236-0148-4d5d-a14d-0e51f13e4ef3" }, "state": { "type": "string", "description": "The state that a job can be in.\n Possible values: 'Completed', 'Failed', 'Canceled', 'Starting', 'Running', 'Queued', 'Canceling', 'Paused', 'Resuming' 'CompletedWithErrors', 'CompletedWithWarnings'.", "example": "Starting" }, "runtime_job_id": { "type": "string", "description": "The runtime job ID returned from the runtime system, used to identify the job run in the runtime system.", "example": "1556290769-999:4cfe93c01afbadd7" }, "duration": { "type": "integer", "description": "The duration of the job run in seconds.", "format": "int64", "example": 10 }, "resource_usage": { "type": "number", "description": "The current or total amount of capacity unit hours (CUH) consumed by the job run", "format": "float" }, "isScheduledRun": { "type": "boolean", "description": "Indicate a scheduled job", "example": false }, "status_reason": { "$ref": "#/components/schemas/Jobsstatus_reason" }, "configuration": { "$ref": "#/components/schemas/JobsJobRuntimeConfiguration" }, "job_parameters": { "$ref": "#/components/schemas/JobsJobParametersArray" }, "job_output_parameters": { "$ref": "#/components/schemas/JobsJobParametersArray" }, "parameter_sets": { "$ref": "#/components/schemas/JobsParameterSetsArray" }, "output_parameter_sets": { "$ref": "#/components/schemas/JobsParameterSetsArray" } } } } }, "JobsAssetJobRunMetadata": { "required": [ "asset_category", "asset_type", "name", "origin_country" ], "type": "object", "properties": { "name": { "type": "string", "example": "Name" }, "description": { "type": "string", "example": "Description." }, "asset_id": { "type": "string", "example": "d5d898ac-b87a-40a1-9648-2c5f49fd0096" }, "asset_category": { "type": "string", "example": "USER" }, "asset_type": { "type": "string", "example": "job_run" }, "origin_country": { "type": "string", "example": "us" }, "rov": { "$ref": "#/components/schemas/JobsAssetRov" }, "project_id": { "type": "string", "example": "727a9f14-e692-4096-84ac-0db57dae0530" }, "sandbox_id": { "type": "string", "example": "727a9f14-e692-4096-84ac-0db57dae0530" }, "usage": { "type": "object", "properties": { "last_updated_at": { "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_updater_id": { "type": "string", "example": "IBMid-550000FRA0" }, "last_update_time": { "type": "integer", "format": "int64" }, "last_accessed_at": { "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "last_access_time": { "type": "integer", "example": 1547578689512, "format": "int64" }, "last_accessor_id": { "type": "string", "example": "IBMid-550000FRA0" }, "access_count": { "type": "integer", "example": 0 } } }, "rating": { "type": "integer", "example": 0 }, "total_ratings": { "type": "integer", "example": 0 }, "catalog_id": { "type": "string", "example": "edc30d9a-1691-4860-b947-4c8514e69f50" }, "created": { "type": "integer", "example": 1547578689512, "format": "int64" }, "created_at": { "type": "string", "example": "2019-01-15T18:58:09.000Z" }, "owner_id": { "type": "string", "example": "IBMid-550000FRA0" }, "size": { "type": "integer", "example": 0 }, "version": { "type": "integer", "example": 2 }, "asset_state": { "type": "string", "example": "available" }, "asset_attributes": { "type": "array", "example": [ "job_run" ], "items": { "type": "string" } }, "tags": { "type": "array", "example": "['tag1', 'tag2', 'tag3']", "items": { "type": "string" } } }, "description": "AssetJobRunMetadata Model" }, "Jobsstatus_reason": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" }, "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" } } } }, "warnings": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "description": { "type": "string" } } } } }, "description": "The status reason for the job run such as warnings or errors.\n Status Reason requires 'code' and 'message' fields in '/entity/job_run/status_reason', as well as in the optional '/entity/job_run/status_reason/errors' and '/entity/job_run/status_reason/warnings'." }, "JobsLogsResponse": { "type": "object", "properties": { "results": { "type": "array", "description": "Array of log string split by line", "example": [ "Size: 28 Blocks: 0 IO Block: 4096 directory", "Device: 3000eeh/3145966d Inode: 453833649 Links: 3", "Access: (0755/drwxr-xr-x) Uid: ( 0/ root) Gid: ( 0/ root)", "Access: 2019-04-08 19:12:21.930122905 +0000", "Modify: 2019-04-08 19:12:21.932122894 +0000", "Change: 2019-04-08 19:12:21.932122894 +0000", "DONE" ], "items": { "type": "string" } }, "total_count": { "type": "integer", "description": "Total number of lines available", "example": 100 } }, "description": "Response of get job run log" }, "Knowledge-AcceleratorsProcessInfo": { "type": "object", "properties": { "process_id": { "type": "string", "description": "A unique process id for an Asynchronous endpoint" }, "process_type": { "type": "string", "description": "The type of process (or action) performed by the endpoint", "enum": [ "asset_assign_terms" ] }, "status": { "type": "string", "description": "The current status of progress of the action being performed by the endpoint" }, "tenant_id": { "type": "string", "description": "The id of the tenant" }, "user_name": { "type": "string", "description": "The user name" }, "start_time": { "type": "string", "description": "Start time" }, "end_time": { "type": "string", "description": "End time" }, "input_params": { "$ref": "#/components/schemas/Knowledge-AcceleratorsIndustryModelsLdmStrategy" }, "log_messages": { "maxItems": 50, "minItems": 0, "type": "array", "description": "Log messages", "items": { "$ref": "#/components/schemas/Knowledge-AcceleratorsLogMessage" } } }, "description": "Information related to an Asynchronous endpoint" }, "Knowledge-AcceleratorsLogMessage": { "type": "object", "properties": { "level": { "type": "string", "description": "The type of message e.g. INFO, STAT" }, "message": { "type": "string", "description": "A log message" } } }, "Knowledge-AcceleratorsIndustryModelsLdmStrategy": { "required": [ "catalog_id" ], "type": "object", "properties": { "strategy": { "type": "string", "description": "The term assignment strategy to apply on the asset", "default": "industrymodel_ldm", "enum": [ "industrymodel_ldm" ] }, "asset_id": { "maxLength": 40, "minLength": 10, "type": "string", "description": "The id of the asset in the catalog, for which to assign Business Terms", "default": "LDM-in-Catalog-if-only-one-in-Catalog" }, "category_ids": { "maxItems": 30, "minItems": 0, "type": "array", "description": "An Array containing a comma separated list of the ids of the categories from which to source the Business Terms to map the asset to. This will automatically include the sub-categories of the category supplied and by extension their terms", "items": { "maxLength": 40, "minLength": 30, "type": "string" } }, "ldm_type": { "type": "string", "description": "The type of Industry Model Logical Model stored assignments to utilise for doing entity/column name to term assignments", "default": "bfmdw_awm", "enum": [ "bfmdw_awm", "bfmdw_dwm", "iiw_bdm", "iiw_awm", "iiw_dwm", "udmh_bdm", "udmh_awm", "udmh_dwm", "dmeu_bdm", "dmeu_awm", "dmeu_dwm" ] }, "term_matching_method": { "type": "string", "description": "The term matching method, artifact_id (id) is only supported", "default": "id", "enum": [ "name", "id" ] }, "catalog_id": { "maxLength": 40, "minLength": 30, "type": "string", "description": "The id of the catalog that contains the asset that we want to assign business terms to. You must provide either a Catalog Id or Project Id but not more than one" } }, "description": "The parameters supplied by the user" }, "Knowledge-AcceleratorsNewProcessResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "A summary message of the assignment status" }, "process_href": { "type": "string", "description": "A URI for checking the status of the process process" }, "process_id": { "type": "string", "description": "A process id for checking the assignment status" } }, "description": "Response information related adding assignment between LDM entities and attributes and Knowledge Accelerator business terms." }, "Knowledge-AcceleratorsKACopyResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "A summary message of the copy status" }, "knowledge_accelerator": { "type": "string", "description": "The Knowledge Accelerator URI of the items to be copied" }, "items": { "maxItems": 20, "minItems": 0, "type": "array", "description": "A copy status for a specific Knowledge Accelerator.", "items": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAItemCopyStatus" } } }, "description": "Response information related to copying Knowledge Accelerator items into a project." }, "Knowledge-AcceleratorsKAItemCopyStatus": { "type": "object", "properties": { "item_id": { "type": "string", "description": "The name of the Knowledge Accelerator item, for example \"core-bpi\"" }, "data_assets": { "maxItems": 20, "minItems": 0, "uniqueItems": true, "type": "array", "description": "Holds data asset status information, corresponding to a Knowledge Accelerator item that was copied or existed in the project.", "items": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKADataAssetStatus" } } }, "description": "A copy status for a specific Knowledge Accelerator item." }, "Knowledge-AcceleratorsKADataAssetStatus": { "type": "object", "properties": { "name": { "type": "string", "description": "Data Asset name" }, "url": { "type": "string", "description": "The URL to the Data Asset " }, "status": { "type": "string", "description": "The copy status of the data asset corresponding to the Knowledge Accelerator item, for example \"copied\"", "enum": [ "copied", "already_exists" ] }, "message": { "type": "string", "description": "Message field for when Data Asset for item already exists in IKC project." } }, "description": "Holds data asset status information, corresponding to what Knowledge Accelerator items were copied or existed in the project." }, "Knowledge-AcceleratorsKAArtifact": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the knowledge accelerator, or the knowledge accelerator item" }, "name": { "type": "string", "description": "The name of this knowledge accelerator item" }, "definition": { "type": "string", "description": "The definition that helps describe the content within the knowledge accelerator item" }, "type": { "type": "string", "description": "The type of the knowledge accelerator item. If the item is of type glossary, then the type of the glossary will further be indicated, for example \"glossary_iav\" (Glossary that is of type, Industry Alignment Vocabulary)" }, "format": { "type": "string", "description": "The format of the content that is stored in this knowledge accelerator item" }, "format_version": { "type": "string", "description": "The version of the tool or service that the format is compatible with" }, "version": { "type": "string", "description": "The version of this knowledge accelerator item. Typically this will only change if the underlying content has changed. If the knowledge accelerator is at a certain version, it would be expected that there would be at least one knowledge accelerator item at that same version" }, "version_definition": { "type": "string", "description": "The definition that might optionally accompany this new version of the content, which would summarise the main changes from prior version." }, "stats": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAStats" }, "mandatory": { "type": "boolean", "description": "If a knowledge accelerator item is depended on by another item, then this property indicates if it should be considered mandatory. Default value is false.", "default": false }, "contains": { "maxItems": 30, "minItems": 0, "type": "array", "description": "A knowledge accelerator can contain 1 or more items. Also in theory a knowledge accelerator item itself, can contain other items and so on", "items": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAArtifact" } }, "depends_on": { "maxItems": 10, "minItems": 0, "type": "array", "description": "If an item depends on one or more items within the same knowledge accelerator, this holds those item ids", "items": { "type": "string" } }, "derived_from": { "maxItems": 10, "minItems": 0, "type": "array", "description": "If an item is derived from one or more items within the same knowledge accelerator, this holds those item ids", "items": { "type": "string" } } }, "description": "A KAArtifact can represent a Knowledge Accelerator or a Knowledge Accelerator item. A knowledge accelerator can contain many knowledge accelerator items, which can be for example, many sub parts of a large IKC glossary. A knowledge accelerator item can depend on other items." }, "Knowledge-AcceleratorsKAStats": { "type": "object", "properties": { "terms": { "type": "integer", "description": "Count of terms in the glossary", "format": "int32" }, "entities": { "type": "integer", "description": "Count of entities", "format": "int32" }, "attributes": { "type": "integer", "description": "Count of attributes", "format": "int32" }, "relationships": { "type": "integer", "description": "Count of relationships in the glossary", "format": "int32" }, "subtype_symbols": { "type": "integer", "description": "Count of subtype symbols in the glossary", "format": "int32" }, "subject_areas": { "type": "integer", "description": "Count of subject areas in the glossary", "format": "int32" }, "domains": { "type": "integer", "description": "Count of domains in the glossary", "format": "int32" }, "diagrams": { "type": "integer", "description": "Count of diagrams in the glossary", "format": "int32" }, "categories": { "type": "integer", "description": "Count of categories in the glossary", "format": "int32" }, "classifications": { "type": "integer", "description": "Count of classifications in the glossary", "format": "int32" }, "reference_data": { "type": "integer", "description": "Count of reference data sets in the glossary", "format": "int32" }, "reference_data_value": { "type": "integer", "description": "The total count of the values within all the reference data sets in the glossary", "format": "int32" }, "data_class": { "type": "integer", "description": "Count of data classes in the glossary", "format": "int32" }, "policy": { "type": "integer", "description": "Count of policies in the glossary", "format": "int32" }, "rule": { "type": "integer", "description": "Count of rules in the glossary", "format": "int32" } }, "description": "Holds statistics for the knowledge accelerator or item. If in existence for an item, then it will contain at least 1 statistic, for example count of categories." }, "Knowledge-AcceleratorsKAImportResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "A summary message of the import status" }, "process_id": { "type": "string", "description": "A URI for checking the status of the import process" }, "import_evaluation": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAImportEvaluation" } }, "description": "An import response holds information related to an attempted or dry run of import of Knowledge Accelerator content. In a dry run scenario there will be no process id, as the import was not actually triggered." }, "Knowledge-AcceleratorsKAImportEvaluation": { "type": "object", "properties": { "knowledge_accelerator": { "type": "string", "description": "The Knowledge Accelerator URI of the import being evaluated" }, "items": { "maxItems": 20, "minItems": 0, "uniqueItems": true, "type": "array", "description": "In the context of a specific Knowledge Accelerator, used to hold information as to what items were imported into the glossary, or what items are going to be attempted to be imported and why.", "items": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAItemImportEvaluation" } } }, "description": "An import evaluation for a specific Knowledge Accelerator." }, "Knowledge-AcceleratorsKAItemImportEvaluation": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of Knowledge Accelerator item import that is being evaluated" }, "evaluation": { "type": "string", "description": "The evaluation status of the Knowledge Accelerator item, for example \"imported\"", "enum": [ "import", "do_not_import", "imported", "imported_at_prior_version", "imported_at_undeterminable_version" ] }, "import_version": { "type": "string", "description": "The version of the Knowledge Accelerator item that is imported into the IKC glossary" }, "latest_version": { "type": "string", "description": "The latest version of the Knowledge Accelerator item that is available in the service" }, "reason": { "type": "string", "description": "The reason for this item being selected for import, for example being a \"mandatory_dependency\" of a user specified item", "enum": [ "user_selected", "dependency", "mandatory_dependency", "exists_at_prior_version", "already_exists", "imported_at_undeterminable_version" ] } }, "description": "In the context of a specific Knowledge Accelerator, used to hold information as to what items were imported into the glossary, or what items are going to be attempted to be imported and why." }, "Knowledge-AcceleratorsKAGetImportResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "A summary message of the import status" }, "import_evaluation": { "maxItems": 20, "minItems": 0, "type": "array", "description": "An import evaluation for a specific Knowledge Accelerator.", "items": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAImportEvaluation" } } }, "description": "Represents information as to what Knowledge Accelerators and associated items are installed in the IKC glossary." }, "Knowledge-AcceleratorsKAArtifactListing": { "type": "object", "properties": { "count": { "type": "integer", "description": "A count of the Knowledge Accelerators that are available", "format": "int32" }, "knowledge_accelerators": { "maxItems": 40, "minItems": 0, "type": "array", "description": "A listing of the Knowledge Accelerators and their contained items that are available for importing into the IKC glossary", "items": { "$ref": "#/components/schemas/Knowledge-AcceleratorsKAArtifact" } } }, "description": "A listing of the Knowledge Accelerators" }, "PoliciesV3PolicyGovernanceTypeListResponse": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "description": "list of governance types", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeListResponseResource" } } }, "description": "Response for the /v3/enforcement/governance_types API" }, "PoliciesV3PolicyGovernanceTypeListResponseResource": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceNonpersistentMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeListResponseEntity" } }, "description": "resource objet within the response for the /v3/enforcement/governance_types API" }, "PoliciesV3PolicyGovernanceTypeListResponseEntity": { "required": [ "actions", "description", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "the displayed name of the governance type" }, "description": { "type": "string", "description": "a more detailed description of the governance type" }, "actions": { "type": "array", "description": "the possible actions defined for the governance type", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeActionDef" } }, "default_action": { "$ref": "#/components/schemas/PoliciesV3Action" } }, "description": "entity object within the resource objet within the response for the /v3/enforcement/governance_types API" }, "PoliciesV3PolicyResourceNonpersistentMetadata": { "type": "object", "description": "metadata object for policy API responses that have no metadata" }, "PoliciesV3Action": { "title": "PolicyRuleAction", "type": "object", "properties": { "name": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/PoliciesV3Parameter" } }, "subaction": { "$ref": "#/components/schemas/PoliciesV3Action" }, "roLTransform": { "type": "boolean" } }, "description": "the action to perform or enforce when the rule triggers" }, "PoliciesV3PolicyGovernanceTypeActionDef": { "required": [ "description", "display_name", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "the name of the allowed action, as specified in rule actions" }, "display_name": { "type": "string", "description": "a displayable name for the action." }, "description": { "type": "string", "description": "a description of the action" }, "parameters": { "type": "array", "description": "an array of parameter definitions for the action if the action has parameters", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeActionParameterDef" } }, "subactions": { "type": "array", "description": "an array of subactions for the action if the action has subactions. (When an action has subactions the action will not have parameters.)", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeActionDef" } } }, "description": "action definition within the /v3/enforcement/governance_types API" }, "PoliciesV3Parameter": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "object" } } }, "PoliciesV3PolicyGovernanceTypeActionParameterDef": { "required": [ "description", "display_name", "multi_value", "name", "required", "type", "type_qualifier" ], "type": "object", "properties": { "name": { "type": "string", "description": "the name of the parameter, as specified in rule actions" }, "display_name": { "type": "string", "description": "a displayable name for the parameter." }, "description": { "type": "string", "description": "a description of the parameter" }, "type": { "type": "string", "description": "the type of the parameter. Three types are current supported: STRING for a string value, ENUM for a value that must come from an enumeration, TERM for a value that must be the name of a term.", "enum": [ "STRING", "ENUM", "TERM" ] }, "type_qualifier": { "type": "string", "description": "a qualifier for the type of the parameter. This is used for ENUM and TERM parameters." }, "multi_value": { "type": "boolean", "description": "if true then this parameter can have multiple values, which are represented on rule actions using a list (array)" }, "required": { "type": "boolean", "description": "if true then this parameter must be specified on rule actions" } }, "description": "parameter definition within action definition within the /v3/enforcement/governance_types API" }, "PoliciesV3PolicyGovernanceTypeResponse": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceNonpersistentMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeResponseEntity" } }, "description": "Response for the /v3/enforcement/governance_types/{governanceTypeId} API" }, "PoliciesV3PolicyGovernanceTypeResponseEntity": { "required": [ "actions", "description", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "the displayed name of the governance type" }, "description": { "type": "string", "description": "a more detailed description of the governance type" }, "actions": { "type": "array", "description": "the possible actions defined for the governance type", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyGovernanceTypeActionDef" } }, "default_action": { "$ref": "#/components/schemas/PoliciesV3Action" } }, "description": "entity object within the response for the /v3/enforcement/governance_types/{governanceTypeId} API" }, "PoliciesV3UDPTermResponse": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3UDPTermResponseEntity" } }, "description": "Response for the /v3/enforcement/udp/{termName} API" }, "PoliciesV3LHSTermRequest": { "required": [ "display_name", "name", "property_name", "source" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the custom LHS." }, "display_name": { "type": "string", "description": "Display name of the custom LHS." }, "description": { "type": "string", "description": "Description of the custom LHS." }, "property_name": { "type": "string", "description": "Property name of the LHS references. For Asset properties, use the path of the property in asset json. For user property, use the name of the mapped User SCIM attribute. (Custom user predicates are not supported in CPDaaS)." }, "source": { "type": "string", "description": "Source for the LHS reference. For custom asset predicate, use 'ASSET'. For custom user predicate use 'CONTEXTUAL' (Custom user predicates are not supported in CPDaaS).", "enum": [ "ASSET, CONTEXTUAL" ] } }, "description": "Request object for the POST /v3/enforcement/lhs/udp API" }, "PoliciesV3UDPTermListResponse": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "description": "list of terms", "items": { "$ref": "#/components/schemas/PoliciesV3UDPTermListResponseResource" } } }, "description": "Response for the /v3/enforcement/udp API" }, "PoliciesV3UDPTermResponseEntity": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the custom LHS which can be used in data protection rules." }, "name": { "type": "string", "description": "Name of the custom LHS." }, "display_name": { "type": "string", "description": "Display name of the custom LHS." }, "description": { "type": "string", "description": "Description of the custom LHS." }, "source": { "type": "string", "description": "Source of the custom LHS." }, "property_name": { "type": "string", "description": "Property name of the custom LHS asset or user reference." }, "permitted_operators": { "type": "array", "description": "Permitted operators for the custom LHS.", "items": { "type": "string", "description": "Permitted operators for the custom LHS." } } }, "description": "entity object within the response for the /v3/enforcement/udp/{termName} API" }, "PoliciesV3PolicyResourceMetadata": { "required": [ "created_at", "creator", "guid", "modifier", "updated_at" ], "type": "object", "properties": { "guid": { "type": "string", "description": "an unique identifier for the resource" }, "created_at": { "type": "string", "description": "time when the resource was first created", "format": "date-time" }, "creator": { "type": "string", "description": "an identifier for the creator of the resource" }, "updated_at": { "type": "string", "description": "time when the resource was last updated", "format": "date-time" }, "modifier": { "type": "string", "description": "an identifier for the last modifier of the resource" } }, "description": "metadata object used in responses returned from policy management related APIs" }, "PoliciesV3UDPTermListResponseResource": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3UDPTermListResponseEntity" } }, "description": "list of terms" }, "PoliciesV3UDPTermListResponseEntity": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the custom LHS." }, "display_name": { "type": "string", "description": "Display name of the custom LHS." }, "description": { "type": "string", "description": "Description of the custom LHS." }, "source": { "type": "string", "description": "Source of the custom LHS." }, "property_name": { "type": "string", "description": "Property name of the custom LHS asset or user reference." }, "permitted_operators": { "type": "array", "description": "Permitted operators for the custom LHS.", "items": { "type": "string", "description": "Permitted operators for the custom LHS." } } } }, "PoliciesV3PolicyMetricsResponse": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceNonpersistentMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyMetricsResponseEntity" } }, "description": "Response for the /v3/enforcement/policy_metrics API" }, "PoliciesV3PolicyMetricsResponseEntity": { "required": [ "metrics" ], "type": "object", "properties": { "metrics": { "type": "array", "description": "a list of metrics. The number of metrics returned depends on the granularity and date range parameters", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyMetric" } } }, "description": "entity objet within the response for the /v3/enforcement/policy_metrics API" }, "PoliciesV3PolicyMetric": { "required": [ "aggregate", "count" ], "type": "object", "properties": { "aggregate": { "type": "string", "description": "The particular aggregate value. The type of the value depends on the aggregate_type query parameter" }, "count": { "type": "integer", "description": "The metric count at the aggregate value", "format": "int64" } }, "description": "A single metric value returned within the /v3/enforcement/policy_metrics response" }, "PoliciesV3PolicyRoleResponse": { "required": [ "entity" ], "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyRoleResponseEntity" } }, "description": "Response for the POST and PUT /v3/enforcement/roles APIs and GET /enforcement/roles/role_id API" }, "PoliciesV3PolicyRolePermissionRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "the displayed name for the role" }, "description": { "type": "string", "description": "a more detailed description of the role" }, "permissions": { "type": "array", "description": "An array of permissions that this role includes", "items": { "type": "string", "description": "An array of permissions that this role includes" } } }, "description": "Request for the POST and PUT /v3/enforcement/roles APIs" }, "PoliciesV3PolicyRoleListResponse": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "description": "list of roles", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyRoleResponse" } } }, "description": "Response for the /v3/enforcement/roles API" }, "PoliciesV3PolicyRoleResponseEntity": { "required": [ "created_at", "creator", "id", "modifier", "name", "permissions", "seq_num", "updated_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID for the role" }, "seq_num": { "type": "string" }, "name": { "type": "string", "description": "the displayed name for the role" }, "description": { "type": "string", "description": "a more detailed description of the role" }, "permissions": { "type": "array", "description": "An array of permissions that this role includes", "items": { "type": "string", "description": "An array of permissions that this role includes" } }, "created_at": { "type": "string", "description": "time when the resource was first created", "format": "date-time" }, "creator": { "type": "string", "description": "an identifier for the creator of the resource" }, "updated_at": { "type": "string", "description": "time when the resource was last updated", "format": "date-time" }, "modifier": { "type": "string", "description": "an identifier for the last modifier of the resource" } }, "description": "entity within the response for the POST and PUT /v3/enforcement/roles APIs" }, "PoliciesV3PolicyPermissionListResponse": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "type": "array", "description": "list of permissions", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyPermissionListResponseResource" } } }, "description": "Response for the /v3/enforcement/roles/permissions API" }, "PoliciesV3PolicyPermissionListResponseResource": { "required": [ "entity" ], "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyPermissionListResponseEntity" } }, "description": "list of permissions" }, "PoliciesV3PolicyPermissionListResponseEntity": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true } } }, "PoliciesV3PolicyRuleResponse": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleResponseEntity" } }, "description": "Response for the /v3/enforcement/rules/{ruleId} API" }, "PoliciesV3PolicyRuleResponseEntity": { "required": [ "action", "governance_type_id", "name", "state", "trigger" ], "type": "object", "properties": { "name": { "type": "string", "description": "the displayed name for the rule" }, "description": { "type": "string", "description": "a more detailed description of the rule" }, "governance_type_id": { "type": "string", "description": "the name of a governance type of this rule" }, "trigger": { "$ref": "#/components/schemas/PoliciesV3Expression" }, "action": { "$ref": "#/components/schemas/PoliciesV3Action" }, "state": { "type": "string", "description": "the state of the rule. Only the rules of policies in active are enforced.", "enum": [ "draft", "active", "archived" ] }, "cat_id": { "type": "string", "description": "category id for RCR rules" }, "user_id": { "type": "string", "description": "user id for RCR rules" }, "user_group_id": { "type": "string", "description": "user group id for RCR rules" } }, "description": "entity within the response for the /v3/enforcement/rules/{ruleId} API" }, "PoliciesV3Expression": { "title": "PolicyRuleTriggerExpression", "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/PoliciesV3Condition" } } }, "description": "nested arrays representing an expression that is evaluated to determine if the action on the rule should be performed or enforced. See the description on the POST /v3/enforcement/rules for more details." }, "PoliciesV3Condition": { "type": "object", "properties": { "not": { "type": "string", "enum": [ "NOT" ] }, "conjunction": { "type": "string", "enum": [ "AND", "OR" ] }, "predicate": { "$ref": "#/components/schemas/PoliciesV3Predicate" } } }, "PoliciesV3Predicate": { "type": "object", "properties": { "lhs": { "type": "object" }, "operator": { "type": "string", "enum": [ "EQUALS", "GREATER_THAN", "LESS_THAN", "EXISTS", "CONTAINS", "GREATER_THAN_EQUALS", "LESS_THAN_EQUALS", "LIKE" ] }, "rhs": { "type": "object" }, "expression": { "$ref": "#/components/schemas/PoliciesV3Expression" } } }, "PoliciesV3PolicyRuleRequest": { "required": [ "action", "governance_type_id", "name", "trigger" ], "type": "object", "properties": { "name": { "type": "string", "description": "the displayed name for the rule" }, "description": { "type": "string", "description": "a more detailed description of the rule" }, "governance_type_id": { "type": "string", "description": "the name of a governance type of this rule" }, "trigger": { "$ref": "#/components/schemas/PoliciesV3Expression" }, "action": { "$ref": "#/components/schemas/PoliciesV3Action" }, "state": { "type": "string", "description": "the state of the rule. Only the rules of policies in active are enforced.", "enum": [ "draft", "active", "archived" ] } }, "description": "Request for the POST and PUT /v3/enforcement/rules APIs" }, "PoliciesV3PolicyRuleListResponse": { "required": [ "count", "first", "last", "limit", "next", "offset", "previous", "resources" ], "type": "object", "properties": { "limit": { "type": "integer", "description": "the limit as specified on the query or defaulted", "format": "int32" }, "offset": { "type": "integer", "description": "the offset as specified on the query or the default value 0", "format": "int32" }, "count": { "type": "integer", "description": "total number of resources in the collection", "format": "int64" }, "first": { "$ref": "#/components/schemas/PoliciesV3Link" }, "last": { "$ref": "#/components/schemas/PoliciesV3Link" }, "next": { "$ref": "#/components/schemas/PoliciesV3Link" }, "previous": { "$ref": "#/components/schemas/PoliciesV3Link" }, "resources": { "type": "array", "description": "list of rules", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleListResponseResource" } }, "paginationValues": { "type": "object", "properties": { "path": { "type": "string" }, "pathSegments": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "matrixParameters": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "requestUri": { "type": "string", "format": "uri" }, "requestUriBuilder": { "type": "object" }, "absolutePath": { "type": "string", "format": "uri" }, "absolutePathBuilder": { "type": "object" }, "baseUri": { "type": "string", "format": "uri" }, "baseUriBuilder": { "type": "object" }, "pathParameters": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "queryParameters": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "matchedURIs": { "type": "array", "items": { "type": "string" } }, "matchedResources": { "type": "array", "items": { "type": "object" } } }, "writeOnly": true } }, "description": "Response for the /v3/enforcement/rules API" }, "PoliciesV3PolicyRuleListResponseResource": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleListResponseEntity" } }, "description": "resource object within the response for the /v3/enforcement/rules API" }, "PoliciesV3Link": { "title": "HrefModel", "type": "object", "properties": { "href": { "type": "string" } }, "description": "link to the previous page of resources, if available" }, "PoliciesV3PolicyRuleListResponseEntity": { "required": [ "action", "governance_type_id", "name", "state", "trigger" ], "type": "object", "properties": { "name": { "type": "string", "description": "the displayed name for the rule" }, "description": { "type": "string", "description": "a more detailed description of the rule" }, "governance_type_id": { "type": "string", "description": "the name of a governance type of this rule" }, "trigger": { "$ref": "#/components/schemas/PoliciesV3Expression" }, "action": { "$ref": "#/components/schemas/PoliciesV3Action" }, "state": { "type": "string", "description": "the state of the rule. Only the rules of policies in active are enforced.", "enum": [ "draft", "active", "archived" ] } }, "description": "entity object within the resource object within the response for the /v3/enforcement/rules API" }, "PoliciesV3PolicyRuleTermListResponse": { "required": [ "resources" ], "type": "object", "properties": { "resources": { "$ref": "#/components/schemas/PoliciesV3RuleTermCompleteListEntity" } }, "description": "Response for the /v3/policy_rules/{ruleId}/terms API" }, "PoliciesV3RuleTermCompleteListEntity": { "required": [ "trigger_terms" ], "type": "object", "properties": { "trigger_terms": { "type": "array", "description": "the name of a term specified in the rule", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleTermListResponseResource" } }, "action_terms": { "type": "array", "description": "terms used in rule action.", "items": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleTermListResponseResource" } } }, "description": "list of terms used in the rule" }, "PoliciesV3PolicyRuleTermListResponseResource": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceForeignEntityMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3PolicyRuleTermListResponseEntity" } }, "description": "resource object within the response for the /v3/policy_rules/{ruleId}/terms API" }, "PoliciesV3PolicyRuleTermListResponseEntity": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "the name of a term specified in the rule" }, "display_name": { "type": "string", "description": "Display name of a term specified in the rule" } }, "description": "entity object within the resource object within the response for the /v3/policy_rules/{ruleId}/terms API" }, "PoliciesV3PolicyResourceForeignEntityMetadata": { "required": [ "artifact_id", "global_id" ], "type": "object", "properties": { "artifact_id": { "type": "string", "description": "an identifier for the resource" }, "global_id": { "type": "string", "description": "a global identifier for the resource" }, "artifact_type": { "type": "string", "description": "artifact type of the resource" } }, "description": "metadata object for responses from policy management related APIs for objects that are not contained within policy management storage" }, "PoliciesV3ImportRuleResponse": { "required": [ "failed", "imported", "matched" ], "type": "object", "properties": { "imported": { "type": "array", "description": "List containing details of rules that are successfully imported.", "items": { "$ref": "#/components/schemas/PoliciesV3Imported" } }, "failed": { "type": "array", "description": "List containing details of rules that are failed to import.", "items": { "$ref": "#/components/schemas/PoliciesV3Failed" } }, "matched": { "type": "array", "description": "List containing details of rules that are successfully matched.", "items": { "$ref": "#/components/schemas/PoliciesV3Matched" } } }, "description": "Response for the /v3/enforcement/rules/export API and /v3/enforcement/rules/import" }, "PoliciesV3Matched": { "required": [ "index" ], "type": "object", "properties": { "name": { "type": "string", "description": "Rule name, matches with a corresponding one request data" }, "index": { "type": "integer", "description": "Index to the rule specified in request data; 1-based.", "format": "int32" }, "rule_guid_in_request": { "type": "string", "description": "Corresponding rule GUID in request data" } }, "description": "Details of rule with artifacts matched successfully" }, "PoliciesV3Failed": { "required": [ "index", "reason" ], "type": "object", "properties": { "name": { "type": "string", "description": "Rule name, matches with a corresponding one request data" }, "index": { "type": "integer", "description": "Index to the rule specified in request data; 1-based.", "format": "int32" }, "rule_guid_in_request": { "type": "string", "description": "Corresponding rule GUID in request data" }, "reason": { "type": "string", "description": "Reason for failure" } }, "description": "Details of rule failed to rule with reason." }, "PoliciesV3Imported": { "required": [ "guid", "index", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Rule name, matches with a corresponding one request data" }, "index": { "type": "integer", "description": "Index to the rule specified in request data; 1-based.", "format": "int32" }, "guid": { "type": "string", "description": "Rule GUID" }, "rule_guid_in_request": { "type": "string", "description": "Corresponding rule GUID in request data" } }, "description": "Details of successfully imported rule." }, "PoliciesV3TenantSettingsResponse": { "required": [ "entity", "metadata" ], "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/PoliciesV3PolicyResourceMetadata" }, "entity": { "$ref": "#/components/schemas/PoliciesV3SettingsResponseEntity" } }, "description": "Response for the /v3/enforcement/settings/{tenantId} API" }, "PoliciesV3PolicySettingsRequest": { "type": "object", "properties": { "governance_access_type": { "type": "string", "description": "Data protection rules convention. Choose DEAA for 'Locked' convention and AEAD for 'Unlocked' convention.", "enum": [ "DEAA, AEAD" ] }, "governance_dlr_type": { "type": "string", "description": "Data location rules convention. Choose DEAA for 'Locked' convention and AEAD for 'Unlocked' convention.", "enum": [ "DEAA, AEAD" ] }, "default_sovereignty": { "type": "string", "description": "Default sovereignty to assign to assets if sovereignty is missing in data assets." }, "enable_data_location_rules": { "type": "boolean", "description": "Enable data location rules enforcement." }, "asset_dealiasing_item_selection": { "type": "string", "description": "Oldest - by creation date, Latest - by modified date, columns, Merge - merge annotations (terms and tags) of all aliases", "enum": [ "Oldest, Latest, Merge" ] }, "access_decision_precedence": { "type": "string", "description": "The rule action precedence for data protection rules. The actions, in order of leniency, are: Allow access, Mask and Filter, Deny access.", "enum": [ "RESTRICTIVE, PERMISSIVE, HIERARCHICAL" ] }, "dlr_decision_precedence": { "type": "string", "description": "The rule action precedence for data location rules. The actions, in order of leniency, are: Allow access, Mask and Filter, Deny access.", "enum": [ "RESTRICTIVE, PERMISSIVE" ] }, "access_transform_precedence": { "type": "string", "description": "The masking method precedence for data protection rules. The masking methods, in privacy order, are: Redact, Substitute, Obfuscate. The masking methods, in utility order, are: Obfuscate, Substitute, Redact.", "enum": [ "RESTRICTIVE, PERMISSIVE" ] }, "dlr_transform_precedence": { "type": "string", "description": "The masking method precedence for data location rules. The masking methods, in privacy order, are: Redact, Substitute, Obfuscate. The masking methods, in utility order, are: Obfuscate, Substitute, Redact.", "enum": [ "RESTRICTIVE, PERMISSIVE" ] }, "enable_has_type_terms": { "type": "boolean", "description": "enable/disable business glossary terms inheritance for DPR/DLR enforcement" }, "enable_has_type_dataclasses": { "type": "boolean", "description": "enable/disable dataclass terms inheritance for DPR/DLR enforcement" }, "enable_has_type_classifications": { "type": "boolean", "description": "enable/disable classification terms inheritance for DPR/DLR enforcement" }, "enable_synonym_terms": { "type": "boolean", "description": "enable/disable business glossary term 1 level synonym relationship for DPR/DLR enforcement" }, "enable_lineage_evaluation": { "type": "boolean", "description": "Enable evaluation based on asset's lineage" }, "transform_option": { "type": "string", "description": "This flag indicates if transform deep enforcement process using 'advanced' or 'classic'. The default value is advanced.", "enum": [ "advanced, classic" ] }, "max_number_of_rules": { "type": "integer", "description": "Maximum combined number of DPR and DLR rules supported.", "format": "int64" }, "enable_evaluation_audit": { "type": "boolean", "description": "Enable/disable audit log for evaluation", "enum": [ false ] } }, "description": "Request for the POST and PUT /v3/enforcement/settings APIs" }, "PoliciesV3SettingsResponseEntity": { "type": "object", "properties": { "governance_access_type": { "type": "string", "description": "Default action for access governance type if no rules apply. DEAA or AEAD", "enum": [ "AEAD", "DEAA" ] }, "governance_dlr_type": { "type": "string", "description": "Default action for DLR governance type if no rules apply. DEAA or AEAD", "enum": [ "AEAD", "DEAA" ] }, "default_sovereignty": { "type": "string", "description": "Default sovereing location. If it is not set there is no default location" }, "enable_data_location_rules": { "type": "boolean", "description": "Enable data location rules" }, "asset_dealiasing_item_selection": { "type": "string", "description": "This is the modality used to choose an asset between aliases to evaluate during evaluate resource. Default value is Oldest.", "enum": [ "Oldest", "Latest", "MostAnnotated", "MostRecentlyEnforced", "Merge" ] }, "access_decision_precedence": { "type": "string", "description": "Decision precedence for access governance type. Restrictive or permissive", "enum": [ "RESTRICTIVE", "PERMISSIVE", "HIERARCHICAL" ] }, "dlr_decision_precedence": { "type": "string", "description": "Decision precedence for DLR governance type. Restrictive or permissive", "enum": [ "RESTRICTIVE", "PERMISSIVE", "HIERARCHICAL" ] }, "access_transform_precedence": { "type": "string", "description": "Transformation precedence for access governance type. Restrictive or permissive", "enum": [ "RESTRICTIVE", "PERMISSIVE", "HIERARCHICAL" ] }, "dlr_transform_precedence": { "type": "string", "description": "Transformation precedence for DLR governance type. Restrictive or permissive", "enum": [ "RESTRICTIVE", "PERMISSIVE", "HIERARCHICAL" ] }, "enable_has_type_terms": { "type": "boolean", "description": "enable/disable business glossary terms inheritance for DPR/DLR enforcement" }, "enable_has_type_dataclasses": { "type": "boolean", "description": "enable/disable dataclass terms inheritance for DPR/DLR enforcement" }, "enable_has_type_classifications": { "type": "boolean", "description": "enable/disable classification terms inheritance for DPR/DLR enforcement" }, "enable_synonym_terms": { "type": "boolean", "description": "enable/disable business glossary term 1 level synonym relationship for DPR/DLR enforcement" }, "is_access_convention_changeable": { "type": "boolean", "description": "This flag indicates if Data protection rules convention (AEAD/DEAA) can be changed. If there are existing DPR rules it cannot be changed." }, "is_dlr_convention_changeable": { "type": "boolean", "description": "This flag indicates if Data location rules convention (AEAD/DEAA) can be changed. If there are existing DLR rules it cannot be changed." }, "max_number_of_rules": { "type": "integer", "description": "Maximum number of DPR and DLR rules. The default value is 1000. This limitation only applies for public cloud version of tbe product", "format": "int64" }, "enable_lineage_evaluation": { "type": "boolean", "description": "Enable lineage evaluation, merges annotations for all assets in lineage during evaluation, default is false" }, "transform_option": { "type": "string", "description": "This flag indicates if transform deep enforcement process using 'advanced' or 'classic'. The default value is advanced.", "enum": [ "advanced", "classic" ] }, "enable_evaluation_audit": { "type": "boolean", "description": "Enable audit log for evaluation" } }, "description": "entity object within the response for the /v3/enforcement/settings/{tenantId} API" }, "ProjectsHTTPErrorResponse": { "type": "object", "description": "A standardized HTTP error response in JSON.", "required": [ "code", "error", "reason", "message" ], "properties": { "code": { "type": "integer", "format": "int32", "description": "The HTTP status code." }, "error": { "type": "string", "description": "The HTTP status code name." }, "reason": { "type": "string", "description": "A detailed error message." }, "message": { "type": "string", "description": "The HTTP status description." }, "id": { "type": "string", "description": "The message ID." } } }, "ProjectsProjects": { "type": "object", "description": "A list of projects.", "properties": { "total_results": { "type": "integer", "description": "The total number of project returned in the query results.", "format": "int32", "minimum": 0, "example": 1 }, "bookmark": { "$ref": "#/components/schemas/ProjectsBookmark" }, "resources": { "type": "array", "description": "A list of projects returned in the query results.", "items": { "$ref": "#/components/schemas/ProjectsProject" } } } }, "ProjectsBookmark": { "type": "string", "pattern": "^[0-9A-Za-z_-]{1,1000}$", "description": "The bookmark is an opaque key returned in the query results set that serves as a reference to the next page of query results.", "example": "g1AAAAE6eJzLYWBgYMlgTmHQTElKzi9KdUhJMtdLytVNTtYtLdYtzi8tydA1MNVLzskvTUnMK9HLSy3JAWphSnIAkkn-____z8pgcrP_afo-ASiQyIhqlAlRRoF0JuXDjPrBf0cBZBQzGa7KYwGSDAeAFNC082DjvnclHgAZx4RqnAXxxl2AGHcfxaNMWQBvIGVg" }, "ProjectsProjectNameParameter": { "type": "string", "description": "A full or partial project name.", "minLength": 1, "maxLength": 100, "example": "Sentiment Analysis" }, "ProjectsMemberRole": { "type": "string", "description": "The role of the project member.", "enum": [ "admin", "editor", "viewer" ], "example": "admin" }, "ProjectsMemberUserName": { "type": "string", "description": "The username of the project member. If the member type is \"service\" or \"group\", then the \"user_name\" and \"id\" fields must match.", "minLength": 1, "maxLength": 100, "example": "zapp.brannigan@ibm.com" }, "ProjectsProjectType": { "type": "string", "description": "The project type. The \"cpd\" project type is used to classify IBM Cloud Pak for Data (CPD) projects. The \"wx\" project type is used to classify IBM watsonx projects. The \"wca\" project type is used to classify IBM watsonx Code Assistant projects. The \"dpx\" project type is used to classify IBM Data Product Exchange projects. The \"wxbi\" project type is used to classify IBM watsonx BI Assistant projects.", "enum": [ "cpd", "wx", "wca", "dpx", "wxbi" ] }, "ProjectsBSSAccountID": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The BSS Account ID represented as a version 1 UUID (RFC 4122). In Private Cloud, the BSS Account ID must be 999.", "example": "0821fa9f9ebcc7b7c9a0d6e9bfa72aa4" }, "ProjectsProject": { "type": "object", "description": "A project object.", "properties": { "metadata": { "type": "object", "description": "The metadata containing information about the project.", "properties": { "guid": { "$ref": "#/components/schemas/ProjectsProjectID" }, "url": { "$ref": "#/components/schemas/ProjectsProjectURL" }, "created_at": { "$ref": "#/components/schemas/ProjectsProjectCreatedAt" }, "updated_at": { "$ref": "#/components/schemas/ProjectsProjectUpdatedAt" } } }, "entity": { "type": "object", "description": "The entity payload representing the core project attributes.", "properties": { "name": { "$ref": "#/components/schemas/ProjectsProjectName" }, "description": { "$ref": "#/components/schemas/ProjectsProjectDescription" }, "type": { "$ref": "#/components/schemas/ProjectsProjectType" }, "public": { "$ref": "#/components/schemas/ProjectsProjectPublic" }, "creator": { "$ref": "#/components/schemas/ProjectsProjectCreator" }, "creator_iam_id": { "$ref": "#/components/schemas/ProjectsProjectCreatorIAMID" }, "scope": { "$ref": "#/components/schemas/ProjectsProjectScope" }, "tags": { "$ref": "#/components/schemas/ProjectsProjectTags" }, "storage": { "$ref": "#/components/schemas/ProjectsProjectStorage" }, "catalog": { "$ref": "#/components/schemas/ProjectsProjectCatalog" }, "compute": { "$ref": "#/components/schemas/ProjectsProjectComputes" }, "github": { "$ref": "#/components/schemas/ProjectsProjectGithub" }, "settings": { "$ref": "#/components/schemas/ProjectsProjectSettings" }, "members": { "type": "array", "description": "The members associated with the project.", "items": { "$ref": "#/components/schemas/ProjectsProjectMember" } }, "tools": { "type": "array", "description": "The tools associated with the project.", "items": { "type": "string", "description": "Names of tools configured for this project", "enum": [ "jupyter_notebooks", "watson_visual_recognition", "dashboards", "streams_designer", "spss_modeler", "experiments", "data_refinery" ] } } } } } }, "ProjectsProjectMember": { "type": "object", "description": "A project member.", "required": [ "user_name", "id", "role" ], "properties": { "user_name": { "$ref": "#/components/schemas/ProjectsMemberUserName" }, "id": { "$ref": "#/components/schemas/ProjectsMemberID" }, "role": { "$ref": "#/components/schemas/ProjectsMemberRole" }, "state": { "$ref": "#/components/schemas/ProjectsMemberState" }, "type": { "$ref": "#/components/schemas/ProjectsMemberType" } } }, "ProjectsProjectSettings": { "type": "object", "description": "The project settings.", "properties": { "audit_events": { "$ref": "#/components/schemas/ProjectsSettingsGroupAuditEvents" }, "access_restrictions": { "$ref": "#/components/schemas/ProjectsSettingsGroupAccessRestrictions" }, "folders": { "$ref": "#/components/schemas/ProjectsSettingsGroupFolders" } } }, "ProjectsProjectGithub": { "type": "object", "description": "The GitHub repository associated with the project.", "required": [ "repository" ], "properties": { "repository": { "type": "string", "description": "Allows for project integration with GitHub. Must be a valid URL to a Github repository.", "example": "git@github.ibm.com:dap/ngp-projects-api.git" } }, "x-sdk-exclude": true }, "ProjectsProjectComputes": { "type": "array", "description": "A list of computes associated with the project.", "items": { "$ref": "#/components/schemas/ProjectsProjectCompute" }, "x-cli-flag-shorthand": "c" }, "ProjectsProjectCatalog": { "type": "object", "description": "A catalog associated with the project.", "required": [ "guid", "public" ], "properties": { "guid": { "$ref": "#/components/schemas/ProjectsCatalogID" }, "public": { "$ref": "#/components/schemas/ProjectsCatalogPublic" } }, "x-cli-flag-shorthand": "C" }, "ProjectsProjectStorage": { "type": "object", "description": "The storage associated with the project.", "required": [ "type" ], "properties": { "type": { "$ref": "#/components/schemas/ProjectsStorageType" }, "guid": { "$ref": "#/components/schemas/ProjectsStorageGUID" }, "properties": { "oneOf": [ { "$ref": "#/components/schemas/ProjectsCloudObjectStorageProperties" }, { "$ref": "#/components/schemas/ProjectsLocalGitStorageProperties" }, { "$ref": "#/components/schemas/ProjectsAmazonS3Properties" } ] } } }, "ProjectsProjectTags": { "type": "array", "description": "A list of tags associated with the project.", "items": { "$ref": "#/components/schemas/ProjectsProjectTag" } }, "ProjectsProjectScope": { "type": "object", "description": "The project scope definition.", "required": [ "bss_account_id" ], "properties": { "bss_account_id": { "$ref": "#/components/schemas/ProjectsBSSAccountID" }, "saml_instance_name": { "type": "string", "description": "Name for a SAML 2.0 instance. Can be optionally provided during POST if the project creator is federated. Can only be set when project is created and cannot be updated.", "example": "my-instance-name" }, "enforce_members": { "type": "boolean", "description": "Setting to true indicates that members added to the project must also be federated and belong to the matching SAML instance. Can only be set when project is created and cannot be updated.", "default": true } } }, "ProjectsProjectCreatorIAMID": { "type": "string", "description": "The IAM ID of the user that created the project.", "example": "IBMid-55000353XF" }, "ProjectsProjectCreator": { "type": "string", "description": "The username of the user that created the project.", "example": "zapp.brannigan@ibm.com" }, "ProjectsProjectPublic": { "type": "boolean", "description": "A value of \"true\" makes the project public.", "default": false, "x-cli-flag-shorthand": "p" }, "ProjectsProjectDescription": { "type": "string", "description": "A description for the new project. The name cannot contain any of the following characters - left angle bracket (<), right angle bracket (>), backslash (\\\\), double quote (\")", "minLength": 0, "maxLength": 1000, "example": "A project description.", "x-cli-flag-shorthand": "d" }, "ProjectsProjectName": { "type": "string", "description": "The name of the project. The name cannot contain any of the following characters - left angle bracket (<), right angle bracket (>), backslash (\\\\), double quote (\"), percentage sign (%)", "minLength": 1, "maxLength": 100, "example": "Project Name", "x-cli-flag-shorthand": "n" }, "ProjectsProjectUpdatedAt": { "type": "string", "description": "The date and time the project was last updated in UTC (ISO 8601)", "example": "2019-10-02T19:26:49.684Z" }, "ProjectsProjectCreatedAt": { "type": "string", "description": "The date and time the project was created in UTC (ISO 8601)", "example": "2019-03-05T23:15:36.175Z" }, "ProjectsProjectURL": { "type": "string", "description": "The project URL.", "example": "/v2/projects/46a19524-bfbf-4810-a1f0-b131f12bc773" }, "ProjectsProjectID": { "type": "string", "pattern": "^[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "The project ID represented as a version 4 UUID.", "example": "46a19524-bfbf-4810-a1f0-b131f12bc773" }, "ProjectsMemberType": { "type": "string", "description": "The project member type.", "enum": [ "user", "group", "service" ], "default": "user" }, "ProjectsMemberState": { "type": "string", "description": "The state of the project member. This field is only supported for members of type \"user\".", "enum": [ "ACTIVE", "PENDING" ], "default": "ACTIVE" }, "ProjectsMemberID": { "type": "string", "pattern": "^[0-9a-zA-Z-]$", "description": "The IAM ID of the project member. This field is required for project members with the \"ACTIVE\" state.", "minLength": 1, "maxLength": 100, "example": "IBMid-55000353XF" }, "ProjectsSettingsGroupFolders": { "type": "object", "description": "The folders settings group.", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "The enablement flag for the folders feature.", "default": false } } }, "ProjectsSettingsGroupAccessRestrictions": { "type": "object", "description": "The access restrictions settings group.", "properties": { "data": { "type": "boolean", "description": "Restrict access to project data. Setting used to manage the \"Mark as sensitive\" control state.", "default": false }, "reporting": { "$ref": "#/components/schemas/ProjectsAccessRestrictionsReporting" } } }, "ProjectsSettingsGroupAuditEvents": { "type": "object", "description": "The audit events settings group.", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "The enablement flag for the audit events feature.", "default": false } } }, "ProjectsProjectCompute": { "type": "object", "description": "A compute associated with the project.", "required": [ "type", "guid", "name", "credentials" ], "properties": { "type": { "type": "string", "description": "The type of compute associated with the project.", "enum": [ "analytics_engine", "machine_learning", "watson", "data_replication", "code-assistant" ], "example": "code-assistant" }, "guid": { "type": "string", "description": "Unique instance ID of the associated project compute.", "example": "630ced06-9675-4e35-a44f-d88197cc10c3" }, "crn": { "type": "string", "description": "The Cloud Resource Name (CRN) for the compute service associated with the project.", "example": "crn:v1:staging:public:code-assistant:us-south:a/0e79133675a31dbfd10504847a9e174f:630ced06-9675-4e35-a44f-d88197cc10c3::" }, "name": { "type": "string", "description": "The display name of the compute instance associated with the project.", "example": "IBM watsonx Code Assistant" }, "label": { "type": "string", "description": "The programmatic service name (label).", "example": "code-assistant" }, "credentials": { "type": "object", "description": "The credentials used to access the compute. Specify an empty Object to indicate that credentials are not applicable for the compute type.", "example": {} } } }, "ProjectsCatalogPublic": { "type": "boolean", "description": "A boolean value indicating whether the catalog is public (true) or private (false).", "default": false }, "ProjectsCatalogID": { "type": "string", "pattern": "^[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "The catalog ID represented as a version 4 UUID.", "example": "fcce617b-1fc9-4965-8820-272864f58399" }, "ProjectsAmazonS3Properties": { "type": "object", "description": "The storage properties for the Amazon S3 (Simple Storage Service) type.", "required": [ "bucket_name", "bucket_region", "role_arn" ], "properties": { "bucket_name": { "type": "string", "pattern": "^[a-z0-9-.]+$", "description": "The Amazon S3 bucket name.", "minLength": 3, "maxLength": 63, "example": "ibm-cpdaas-projects-shared" }, "bucket_region": { "type": "string", "pattern": "^[a-z0-9-]+$", "description": "The Amazon S3 bucket name.", "minLength": 9, "maxLength": 16, "example": "us-east-1" }, "role_arn": { "type": "string", "pattern": "^arn:aws(-cn|-us-gov)?:iam:[a-z0-9-]*:[0-9]{12}:role\\/[a-zA-Z0-9+=,.@_-]{2,64}$", "description": "The Amazon Resource Name (ARN) role used to create temporary credentials.", "minLength": 20, "maxLength": 2048, "example": "arn:aws:iam::675068700468:role/cpdaas_integration" }, "shared": { "type": "boolean", "description": "A flag used to indicate whether the Amazon S3 bucket is shared between projects.", "default": true }, "credentials": { "$ref": "#/components/schemas/ProjectsAmazonS3Credentials" } } }, "ProjectsLocalGitStorageProperties": { "type": "object", "description": "The storage properties for the Local Git Storage type.", "required": [ "repository" ], "properties": { "repository": { "$ref": "#/components/schemas/ProjectsLocalGitStorageRepository" } } }, "ProjectsCloudObjectStorageProperties": { "type": "object", "description": "The storage properties for the Bluemix Cloud Object Storage (BMCOS) type.", "required": [ "bucket_name", "bucket_region", "credentials" ], "properties": { "bucket_name": { "type": "string", "description": "The bucket name to connect to. The value should be between 3-64 characters and should only contain letters, numbers and dashes.", "example": "wdp-default" }, "bucket_region": { "type": "string", "description": "The Cloud Object Storage region ID that represents the bucket region and directly corresponds to a Cloud Object Storage endpoint URL. Cross regions - us-geo, eu-geo, ap-geo. Single regions - us-south, eu-gb, eu-de, jp-tok.", "enum": [ "us-geo", "eu-geo", "ap-geo", "us-south", "eu-gb", "eu-de", "jp-tok" ], "example": "us-geo" }, "endpoint_url": { "type": "string", "description": "The auto-generated Cloud Object Storage API endpoint URL based on the specified bucket region. This field is provided only for convenience and backwards compatibility. Clients should override this value and use the (single region or cross region) Cloud Object Storage API endpoint best suited for their purposes.", "example": "https://s3.us.cloud-object-storage.appdomain.cloud" }, "key_protect": { "type": "boolean", "description": "A flag used to indicate whether bucket encryption is enabled via Key Protect. A single region must be specified in order to enable Key Protect.", "example": false }, "credentials": { "$ref": "#/components/schemas/ProjectsCloudObjectStorageCredentials" } } }, "ProjectsStorageGUID": { "type": "string", "pattern": "^[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "The project storage ID represented as a version 4 UUID. An ID is required only for the \"bmcos_object_storage\" storage type.", "example": "d0e410a0-b358-42fc-b402-dba83316413a" }, "ProjectsStorageType": { "type": "string", "description": "The project storage type.", "enum": [ "bmcos_object_storage", "assetfiles", "local_git_storage", "amazon_s3" ] }, "ProjectsProjectTag": { "type": "string", "pattern": "^[^,]+$", "description": "A tag associated with the project. The tag cannot contain a comma (,). The tag cannot contain any of the following characters unless escaped by character entities - left angle bracket (<)(<), right angle bracket (>)(>), single-quote (')('), double quote (\")("), ampersand (&)(&).", "minLength": 1, "maxLength": 30, "example": "development" }, "ProjectsAccessRestrictionsReporting": { "type": "object", "description": "Govern reporting tool access to project data. (e.g. \"wkc-bi-data-service\").", "required": [ "authorized" ], "properties": { "authorized": { "type": "boolean", "description": "Allow or deny reporting tool access to project data.", "default": false } } }, "ProjectsAmazonS3Credentials": { "type": "object", "description": "The temporary credentials used to access an Amazon S3 (Simple Storage Service) bucket. The temporary credentials are not specified statically on project creation; but, rather they are dynamically generated on demand when retrieving a project using the include=credentials query parameter.", "required": [ "access_key_id", "secret_access_key", "session_token", "expiration" ], "properties": { "access_key_id": { "type": "string", "description": "The Amazon S3 access key ID.", "example": "ASIATE72IZPHW6D4PKS5" }, "secret_access_key": { "type": "string", "description": "The Amazon S3 secret access key.", "example": "ZFQTTmB3Jl5CyPBHExz+J7oquSbxwn1n1k5R7OnZ" }, "session_token": { "type": "string", "description": "The Amazon S3 session token.", "example": "IQoJb3JpZ2luX2VjEEAaCXVzLWVhc3QtMSJHMEUCIQCz1WlH9O7lxO610RvbZm4yNEvRXe8wW1TH3kvn0qwWuQIgZU5cMhTvwcUt4uvfEWEYNILVi8A7g6jHNq+zxk4ElvsqsQIImP//////////ARACGgwyMTY4ODM4NDE5OTkiDMFc9fstm0X8ShB6CyqFAo7+Sp1QoI0IABZWgv7MklCiFrne7yXF7e5Flim9REH0vvfG1Fca565Z5SqVbO9ihmpwuFMSp+zuODqLf0q4LDd8ikQ06m+E1i0sdBA0QbINCbjJjufPPxOv/Bvv8Az6rIGOx9hbyuhN46vTqQhyCeQq2KzCAdGbFu5lxA/G501T48i09E7JrCsq+l+z2BZix+2SWo2TgZktYEvItD8MTZWYku2fZRZvfOzzpW/CaC/niPjFVeGKTDv0rmW96gR7azsTqz9v+bIDimMf7uHet4Z8jVOpUhrtGzoceAZu0U6Dcjja44jpheCSzVb/K3xOTRi2MfM69xqP6xgS8C8QS9y+AnWP9DCBgKyXBjqdAYLhcD4n9YDbokr/3eRX9tPuC56CoOk4W4DcNyCm/VqdMM8s2hJgKbtIaXiSptKIUxAulNH65stR/O79qyqhYTyBRi4X/mmubK52Lape3kXiAuMFgC5OfEHEsBz++nhcSWFDQQeFHdHAZ3Z+ucqEpmko9/5GoNEOJoNgQb5vjLftXQc6jsNGu4dfrQus/o41+AUSE9gQtzohcbvtB2I=" }, "expiration": { "type": "string", "description": "The expiration date and time for the Amazon S3 temporary credentials in UTC (ISO 8601).", "example": "2022-08-04T00:08:49.000Z" } } }, "ProjectsLocalGitStorageRepository": { "type": "object", "description": "The Git repository fields.", "required": [ "type", "url" ], "properties": { "type": { "type": "string", "description": "The Git repository type.", "enum": [ "azure_repos", "bitbucket", "bitbucket_enterprise", "github", "github_enterprise", "gitlab", "gitlab_self_managed" ], "example": "github" }, "url": { "type": "string", "description": "The Git repository URL.", "example": "https://github.com/nodejs/node.git" } } }, "ProjectsCloudObjectStorageCredentials": { "type": "object", "description": "The Bluemix Cloud Object Storage (BMCOS) credentials.", "required": [ "admin", "editor", "viewer" ], "properties": { "admin": { "$ref": "#/components/schemas/ProjectsBMCOSCredentialsAdmin" }, "editor": { "$ref": "#/components/schemas/ProjectsBMCOSCredentialsEditor" }, "viewer": { "$ref": "#/components/schemas/ProjectsBMCOSCredentialsEditor" } } }, "ProjectsBMCOSCredentialsEditor": { "type": "object", "description": "The Bluemix Cloud Object Storage (BMCOS) editor credentials..", "required": [ "api_key", "service_id" ], "properties": { "api_key": { "$ref": "#/components/schemas/ProjectsBMCOSAPIKey" }, "service_id": { "$ref": "#/components/schemas/ProjectsBMCOSServiceID" }, "access_key_id": { "$ref": "#/components/schemas/ProjectsBMCOSAccessKeyID" }, "secret_access_key": { "$ref": "#/components/schemas/ProjectsBMCOSSecretAccessKey" }, "resource_key_crn": { "$ref": "#/components/schemas/ProjectsBMCOSResourceKeyCRN" } } }, "ProjectsBMCOSCredentialsAdmin": { "type": "object", "description": "The Bluemix Cloud Object Storage (BMCOS) admin credentials..", "required": [ "api_key", "service_id" ], "properties": { "api_key": { "$ref": "#/components/schemas/ProjectsBMCOSAPIKey" }, "service_id": { "$ref": "#/components/schemas/ProjectsBMCOSServiceID" }, "access_key_id": { "$ref": "#/components/schemas/ProjectsBMCOSAccessKeyID" }, "secret_access_key": { "$ref": "#/components/schemas/ProjectsBMCOSSecretAccessKey" } } }, "ProjectsBMCOSResourceKeyCRN": { "type": "string", "description": "Resource key CRN. Must be provided with other HMAC credentials for non-admin entries.", "example": "crn:v1:bluemix:public:cloud-object-storage:global:a/b56585fe60e71be0a22e6587f781ed91:dc36b4a5-cf81-6541-b855-f68a6f321cac::" }, "ProjectsBMCOSSecretAccessKey": { "type": "string", "description": "HMAC secret access key for associated Cloud Object Storage and specific user role.", "example": "abcdefABCDEF0123456789abcdefABCDEF0123456789abcd" }, "ProjectsBMCOSAccessKeyID": { "type": "string", "description": "HMAC access key ID for associated Cloud Object Storage and specific user role.", "example": "abcdefABCDEF0123456789abcdefABCD" }, "ProjectsBMCOSServiceID": { "type": "string", "description": "IAM Service ID for specific user role. Should be a GUID prefixed with \"iam-ServiceId-\".", "example": "iam-ServiceId-dde7839f-1cca-4626-a499-889398b5d6dd" }, "ProjectsBMCOSAPIKey": { "type": "string", "description": "API key for specific user role. The key should be 44 characters long and contain only number, letters, underscores and dashes.", "example": "Nr0aWPAlj---hlfOMxTfPHe_OWrgH8kqAkqFhUUugqN8" }, "ProjectsProjectTotal": { "type": "object", "description": "The project total.", "properties": { "total": { "type": "integer", "description": "The project total.", "format": "int32", "minimum": 0, "example": 10 } } }, "ProjectsUpdateProjectBody": { "type": "object", "description": "The request body for updating an existing project.", "properties": { "name": { "$ref": "#/components/schemas/ProjectsProjectName" }, "description": { "$ref": "#/components/schemas/ProjectsProjectDescription" }, "type": { "$ref": "#/components/schemas/ProjectsProjectType" }, "public": { "$ref": "#/components/schemas/ProjectsProjectPublic" }, "catalog": { "$ref": "#/components/schemas/ProjectsProjectCatalog" }, "compute": { "$ref": "#/components/schemas/ProjectsProjectComputes" }, "tools": { "$ref": "#/components/schemas/ProjectsProjectTools" }, "github": { "$ref": "#/components/schemas/ProjectsProjectGithub" } } }, "ProjectsProjectTools": { "type": "array", "description": "The tools associated with the project.", "items": { "type": "string", "description": "The tools configured and associated with the project.", "enum": [ "jupyter_notebooks", "watson_visual_recognition", "dashboards", "streams_designer", "spss_modeler", "experiments", "data_refinery" ] }, "x-cli-flag-shorthand": "T" }, "ProjectsProjectMembers": { "type": "object", "description": "A list of project members.", "required": [ "members" ], "properties": { "members": { "type": "array", "description": "A list of project members.", "items": { "$ref": "#/components/schemas/ProjectsProjectMember" } } } }, "ProjectsUpdateMembersBody": { "type": "object", "description": "The request body for updating project members.", "required": [ "members" ], "properties": { "members": { "type": "array", "description": "A list of project members to update.", "items": { "$ref": "#/components/schemas/ProjectsUpdateMemberBody" } } } }, "ProjectsUpdateMemberBody": { "type": "object", "description": "A project member to update.", "required": [ "user_name", "role" ], "properties": { "user_name": { "$ref": "#/components/schemas/ProjectsMemberUserName" }, "id": { "$ref": "#/components/schemas/ProjectsMemberID" }, "role": { "$ref": "#/components/schemas/ProjectsMemberRole" }, "state": { "$ref": "#/components/schemas/ProjectsMemberState" } } }, "ProjectsMemberDerived": { "type": "boolean", "description": "A flag indicating whether the project member is derived from a resolved user group.", "default": false }, "ProjectsUpdateTagsBody": { "type": "array", "description": "A list of operations to add or remove project tags.", "items": { "$ref": "#/components/schemas/ProjectsUpdateTagsOperation" }, "example": [ { "op": "add", "tags": [ "development", "test" ] }, { "op": "remove", "tags": [ "production" ] } ] }, "ProjectsUpdateTagsOperation": { "type": "object", "description": "An operation to add or remove project tags.", "required": [ "op", "tags" ], "properties": { "op": { "$ref": "#/components/schemas/ProjectsTagOperation" }, "tags": { "$ref": "#/components/schemas/ProjectsProjectTags" } } }, "ProjectsTagOperation": { "type": "string", "description": "The tag operation.", "enum": [ "add", "remove" ], "example": "add" }, "TransactionalProjectsTransactionalProjectCreateImport": { "type": "object", "description": "Create transactional import project POST body schema.", "required": [ "file", "metadata" ], "properties": { "file": { "type": "string", "format": "binary", "description": "Watson Studio exported .zip file." }, "metadata": { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectMetadataImport" } } }, "TransactionalProjectsTransactionalProjectCreate": { "type": "object", "description": "Project metadata required to create a project.", "required": [ "name", "generator", "storage" ], "properties": { "name": { "type": "string", "description": "The name of the new project.\nThe name must be a non-empty String.\nThis does not need to be unique.", "example": "Project Name", "x-cli-flag-shorthand": "n" }, "description": { "type": "string", "description": "A description for the new project.", "example": "A project description.", "x-cli-flag-shorthand": "d" }, "type": { "type": "string", "default": "cpd", "description": "The project type. The \"cpd\" project type is used to classify IBM Cloud Pak for Data (CPD) projects. The \"wx\" project type is used to classify IBM watsonx projects. The \"wca\" project type is used to classify IBM watsonx Code Assistant projects. The \"dpx\" project type is used to classify IBM Data Product Exchange projects. The \"wxbi\" project type is used to classify IBM watsonx BI Assistant projects.", "x-cli-flag-shorthand": "y", "enum": [ "cpd", "wx", "wca", "dpx", "wxbi" ] }, "generator": { "type": "string", "description": "A tag to indicate where this project was generated. This is only intended for use in metrics. It does not need to be unique and all consumers of this API should use a consistent string for their 'generator' field. The value is stored in the project metadata for future consumption in metrics.", "example": "DAP-Projects", "x-cli-flag-shorthand": "g" }, "public": { "type": "boolean", "description": "A value of `true` makes the project public.", "default": false, "x-cli-flag-shorthand": "p" }, "tags": { "type": "array", "description": "List of user defined tags that are attached to the project.", "items": { "type": "string", "description": "User defined tags that are attached to the project. Note: Tags cannot contain whitespace characters." }, "x-cli-flag-shorthand": "t" }, "enforce_members": { "type": "boolean", "description": "Set to true of project members should be scoped to the account and/or SAML of the creator", "default": false, "x-cli-flag-shorthand": "e" }, "storage": { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectStorageObject" }, "compute": { "type": "array", "description": "List of computes to be associated with the project.", "items": { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectComputeObjectCloud" }, "x-cli-flag-shorthand": "c" }, "tools": { "type": "array", "description": "List of tools to be associated with the project.", "items": { "type": "string", "description": "Names of tools configured with this project.", "enum": [ "watson_visual_recognition", "jupyter_notebooks", "dashboards", "streams_designer", "spss_modeler", "experiments", "data_refinery" ] }, "x-cli-flag-shorthand": "T" } } }, "TransactionalProjectsHTTPErrorResponse": { "type": "object", "description": "General API error response", "required": [ "code", "error", "reason", "message", "description" ], "properties": { "code": { "type": "integer", "format": "int32", "description": "The HTTP status code." }, "error": { "type": "string", "description": "The HTTP status code name." }, "reason": { "type": "string", "description": "A error message." }, "message": { "type": "string", "description": "A detailed error message." }, "description": { "type": "string", "description": "The HTTP status description." } } }, "TransactionalProjectsCreateImportTransactionProjectResponse": { "type": "object", "description": "Description of create transactional import project API response body.", "properties": { "location": { "$ref": "#/components/schemas/TransactionalProjectsCreateProjectLocation" }, "transaction_detail": { "type": "object", "description": "Description of the transaction initiated by the API.", "properties": { "id": { "$ref": "#/components/schemas/TransactionalProjectsTransactionIdDetail" }, "links": { "type": "object", "description": "API url to get the status of the transaction.", "properties": { "self": { "$ref": "#/components/schemas/TransactionalProjectsTransactionLinkDetail" } } } } } } }, "TransactionalProjectsCreateTransactionProjectResponse": { "type": "object", "description": "Description of create transactional project API response body.", "properties": { "location": { "$ref": "#/components/schemas/TransactionalProjectsCreateProjectLocation" } } }, "TransactionalProjectsTransactionalProjectMetadataImport": { "type": "object", "description": "Project metadata required for transactional project import API.", "required": [ "name", "generator" ], "properties": { "name": { "type": "string", "description": "The name of the new project.\nThe name must be a non-empty String.\nThis does not need to be unique.", "example": "Project Name" }, "description": { "type": "string", "description": "A description for the new project.", "example": "A project description." }, "generator": { "type": "string", "description": "A tag to indicate where this project was generated. This is only intended for use in metrics. It does not need to be unique and all consumers of this API should use a consistent string for their 'generator' field. The value is stored in the project metadata for future consumption in metrics.", "example": "DAP-Projects" }, "public": { "type": "boolean", "description": "A value of `true` makes the project public.", "default": false }, "tags": { "type": "array", "description": "List of user defined tags that are attached to the project.", "items": { "type": "string", "description": "User defined tags that are attached to the project. Note: Tags cannot contain whitespace characters." } }, "enforce_members": { "type": "boolean", "description": "Set to true of project members should be scoped to the account and/or SAML of the creator", "default": false }, "storage": { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectStorageObjectImport" } } }, "TransactionalProjectsTransactionalProjectComputeObjectCloud": { "type": "object", "description": "Compute properties for the cloud.", "required": [ "type", "guid", "name" ], "properties": { "type": { "type": "string", "description": "The type of the associated project compute.", "default": "spark", "enum": [ "spark", "machine_learning", "aws_emr", "analytics_engine", "streaming_analytics", "watson" ] }, "guid": { "type": "string", "description": "Unique guid of the associated project compute (i.e. GUID of Spark or Machine Learning service instance).", "example": "eddc2f0c-4401-49d1-b632-dee2ec33dcc0" }, "crn": { "type": "string", "description": "The Cloud Resource Name (CRN) for the compute service associated with the project.", "example": "crn:v1:staging:public:watson-vision-combined:us-south:a/1438bf1daef49e20401d0179818ebef5:6874282b-42d6-40fa-869b-95a3c0f04125::" }, "name": { "type": "string", "description": "Display name of the compute instance associated with the project.", "example": "Apache Spark" }, "label": { "type": "string", "description": "Service label when compute type is 'watson'", "example": "watson_vision_combined" } } }, "TransactionalProjectsTransactionalProjectStorageObject": { "type": "object", "description": "Object storage properties to be associated with the project.", "required": [ "type" ], "properties": { "type": { "type": "string", "default": "bmcos_object_storage", "description": "The type of the associated project storage.", "enum": [ "bmcos_object_storage", "assetfiles", "local_git_storage", "amazon_s3" ] }, "guid": { "type": "string", "description": "Unique guid of the associated project storage object.", "example": "d0e410a0-b358-42fc-b402-dba83316413a" }, "plan_id": { "type": "string", "description": "The unique ID of the plan associated with the COS instance. The value is 1e4e33e4-cfa6-4f12-9016-be594a6d5f87 for the One Rate plan.", "example": "1e4e33e4-cfa6-4f12-9016-be594a6d5f87" }, "resource_crn": { "type": "string", "description": "A cloud resource name of the Cloud Object Storage instance in WSC (not required in CP4D or in AWS).", "example": "crn:v1:staging:public:cloud-object-storage:global:a/a7026b374f39f570d20984c1ac6ecf63:5778e94f-c8c7-46a8-9878-d5eeadb51161::" }, "delegated": { "type": "boolean", "default": false, "description": "Set to true of the COS instance is delegated by the account admin" }, "properties": { "oneOf": [ { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectStorageAmazonS3PropertiesObject" }, { "$ref": "#/components/schemas/TransactionalProjectsTransactionalProjectStorageLocalGitPropertiesObject" } ] } }, "x-cli-flag-shorthand": "s" }, "TransactionalProjectsTransactionLinkDetail": { "type": "string", "description": "API to access the status of the import transaction" }, "TransactionalProjectsTransactionIdDetail": { "type": "string", "description": "Transaction Id created to track the import process" }, "TransactionalProjectsCreateProjectLocation": { "type": "string", "description": "API to access the newly created project." }, "TransactionalProjectsTransactionalProjectStorageObjectImport": { "type": "object", "description": "Object storage properties to be associated with the import project.", "required": [ "type" ], "properties": { "type": { "type": "string", "default": "assetfiles", "description": "The type of the associated project storage.", "enum": [ "assetfiles" ] } } }, "TransactionalProjectsTransactionalProjectStorageLocalGitPropertiesObject": { "type": "object", "description": "Required Git repository information for the storage type \"local_git_storage\".", "required": [ "repository" ], "properties": { "repository": { "type": "object", "description": "Git repository information and user credentials.", "required": [ "type", "access_token", "url", "repo_branch" ], "properties": { "type": { "type": "string", "description": "The Git host for the repository.", "enum": [ "github", "github_enterprise", "bitbucket", "bitbucket_enterprise", "azure_repos", "gitlab", "gitlab_self_managed" ] }, "access_token": { "type": "string", "description": "Personal access token with the Git host.", "example": "ghp_abcdefghijklmnopqrstuvwxyzABCD012345" }, "url": { "type": "string", "description": "The repository's HTTPS clone URL that ends with .git.", "example": "https://github.com/myuser/myrepository.git" }, "repo_branch": { "type": "string", "description": "Branch name to check out. If the repository is empty, use \"master\" as the initial branch.", "example": "master" }, "domain": { "type": "string", "description": "Domain used to access the Git host.", "example": "https://github.com" }, "user_name": { "type": "string", "description": "User account name with the Git host." }, "ssl_cert": { "type": "string", "description": "Self-signed SSL certificate for the Git host in pem format." } } } } }, "TransactionalProjectsTransactionalProjectStorageAmazonS3PropertiesObject": { "type": "object", "description": "Optional storage properties for amazon_s3 storage type", "properties": { "shared": { "type": "boolean", "default": true, "description": "If true, project will use a shared S3 bucket within the BSS account" } } }, "TransactionalProjectsProjectIDParameter": { "type": "string", "example": "6ee2c24f-d0a9-4e30-b0fc-5ae36a66c1a8", "description": "The project ID represented as a version 4 UUID." }, "TransactionalProjectsTransactionStatusItem": { "type": "object", "description": "Description of import transactional status API response.", "properties": { "id": { "type": "string", "description": "Project GUID." }, "name": { "type": "string", "description": "Name of the project." }, "created_at": { "type": "string", "description": "The date and time the status was created in UTC (ISO 8601)" }, "updated_at": { "type": "string", "description": "The date and time the status was last updated in UTC (ISO 8601)" }, "status": { "type": "string", "description": "Last known status of the transaction" }, "description": { "type": "string", "description": "Description of the last know transaction status" }, "history": { "type": "array", "description": "Description of all last know import status.", "items": { "$ref": "#/components/schemas/TransactionalProjectsTransactionHistory" } } } }, "TransactionalProjectsTransactionHistory": { "type": "object", "description": "Description of import transaction history.", "properties": { "status": { "type": "string", "description": "Status of the transaction" }, "description": { "type": "string", "description": "Description of the transaction status" }, "updated_at": { "type": "string", "description": "The date and time the status was updated in UTC (ISO 8601)" } } }, "TransactionalProjectsTransactionIDParameter": { "type": "string", "example": "dcff12a9-3f9e-4d10-b4c4-f121f681d81b", "description": "The transaction ID represented as a version 4 UUID. The transaction ID is provided in the transactional import API response." }, "WorkflowPaginatedResource_Workflow": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "first": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "last": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "previous": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "next": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowWorkflow" } }, "total_count": { "type": "integer", "format": "int64" } } }, "WorkflowWorkflow": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/WorkflowWorkflowMetadata" }, "entity": { "$ref": "#/components/schemas/WorkflowWorkflowEntity" } } }, "WorkflowPagedResourcesLink": { "type": "object", "properties": { "href": { "type": "string" } } }, "WorkflowWorkflowEntity": { "type": "object", "properties": { "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowArtifact" } }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVariable" } }, "business_key": { "type": "string" }, "parent_id": { "type": "string" }, "relationship_type": { "type": "string", "enum": [ "dependent", "child" ] }, "workflow_template_id": { "type": "string" }, "workflow_template_key": { "type": "string" }, "workflow_template_version": { "type": "integer", "format": "int32" }, "start_form_properties": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowFormProperty" } }, "user_tasks": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowUserTask" } }, "workflow_state": { "type": "string" }, "last_action": { "type": "string", "enum": [ "create_draft", "get", "update", "publish" ] } } }, "WorkflowWorkflowMetadata": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string", "enum": [ "created", "running", "suspended", "cancelled", "completed", "deleted", "failed" ] }, "artifact_type": { "type": "string" }, "workflow_id": { "type": "string" }, "workflow_type_id": { "type": "string" }, "configuration_id": { "type": "string" }, "created_by": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "modified_by": { "type": "string" }, "modified_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time" } } }, "WorkflowUserTask": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/WorkflowUserTaskMetadata" }, "entity": { "$ref": "#/components/schemas/WorkflowUserTaskEntity" } } }, "WorkflowFormProperty": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "date", "enum", "enum_list", "long", "boolean", "double", "json" ] }, "value": { "type": "string" }, "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "required": { "type": "boolean" }, "kind": { "type": "string", "enum": [ "trigger", "config", "regular" ] }, "source": { "type": "string" }, "date_pattern": { "type": "string" }, "enum_values": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEnumValue" } }, "cpd_type": { "type": "string", "enum": [ "short_text", "long_text", "url", "date", "period", "radio", "dropdown", "multi_select", "wkc_category", "wkc_artifact_type", "wkc_draft_mode", "comment", "cpd_user", "wkc_asset", "cpd_group", "action", "start_form_properties" ] }, "optional_for_actions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "ignore_for_actions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "required_for_actions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "hide_in_ui": { "type": "boolean" } } }, "WorkflowVariable": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "object" } } }, "WorkflowArtifact": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/WorkflowArtifactMetadata" }, "workflow_data": { "$ref": "#/components/schemas/WorkflowArtifactWorkflowData" } } }, "WorkflowUserTaskEntity": { "type": "object", "properties": { "owner": { "type": "string" }, "assignee": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "variables": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVariable" } }, "task_title": { "type": "string" }, "task_instruction": { "type": "string" }, "claimed_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time" }, "due_date": { "type": "string", "format": "date-time" }, "task_definition_key": { "type": "string" }, "task_category": { "type": "string" }, "form_key": { "type": "string" }, "parent_task_id": { "type": "string" }, "workflow_template_id": { "type": "string" }, "form_properties": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowFormProperty" } }, "candidate_users": { "type": "array", "items": { "type": "string" } }, "candidate_groups": { "type": "array", "items": { "type": "string" } } } }, "WorkflowUserTaskMetadata": { "type": "object", "properties": { "name": { "type": "string" }, "state": { "type": "string", "enum": [ "created", "assigned", "completed" ] }, "artifact_type": { "type": "string" }, "task_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "workflow_id": { "type": "string" }, "workflow_type_id": { "type": "string" } } }, "WorkflowEnumValue": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "WorkflowArtifactWorkflowData": { "type": "object", "properties": { "workflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowWorkflow" } }, "base_url": { "type": "string" }, "draft_mode": { "type": "string", "enum": [ "created", "modified", "marked_for_deletion", "marked_for_archival", "import_modified", "import_create", "CREATE", "MODIFY", "DELETE", "IMPORT_CREATE", "IMPORT_MODIFY", "MOVE" ] }, "old_effective_start_date": { "type": "string", "format": "date-time" }, "old_effective_end_date": { "type": "string", "format": "date-time" }, "old_parent_category": { "$ref": "#/components/schemas/WorkflowCategory" }, "old_primary_category": { "$ref": "#/components/schemas/WorkflowCategory" } } }, "WorkflowArtifactMetadata": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "draft", "published", "archived" ] }, "name": { "type": "string" }, "artifact_type": { "type": "string" }, "artifact_id": { "type": "string" }, "version_id": { "type": "string" }, "effective_start_date": { "type": "string", "format": "date-time" }, "effective_end_date": { "type": "string", "format": "date-time" }, "published_ancestor_id": { "type": "string" }, "primary_category": { "$ref": "#/components/schemas/WorkflowCategory" } } }, "WorkflowCategory": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowCategory" } } } }, "WorkflowWorkflowQuery": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowQueryCondition" } } }, "description": "Query conditions" }, "WorkflowQueryCondition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "workflow_id" ] }, "values": { "type": "array", "items": { "type": "string" } } } }, "WorkflowUserTaskActionPayload": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "claim", "complete" ] }, "assignee": { "type": "string" }, "form_properties": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowFormPropertyInput" } } }, "description": "The action to be performed" }, "WorkflowFormPropertyInput": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "date_value": { "type": "string", "format": "date-time" }, "period_value": { "$ref": "#/components/schemas/WorkflowPeriod" }, "long_value": { "type": "integer", "format": "int64" }, "list_value": { "type": "array", "items": { "type": "string" } } } }, "WorkflowPeriod": { "type": "object", "properties": { "years": { "type": "integer", "format": "int32" }, "months": { "type": "integer", "format": "int32" }, "weeks": { "type": "integer", "format": "int32" }, "days": { "type": "integer", "format": "int32" }, "hours": { "type": "integer", "format": "int32" }, "minutes": { "type": "integer", "format": "int32" }, "seconds": { "type": "integer", "format": "int32" }, "millis": { "type": "integer", "format": "int32" }, "periodType": { "$ref": "#/components/schemas/WorkflowPeriodType" }, "period": { "$ref": "#/components/schemas/WorkflowReadablePeriod" }, "periodInternal": { "$ref": "#/components/schemas/WorkflowReadablePeriod" }, "values": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "fieldTypes": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDurationFieldType" } } } }, "WorkflowDurationFieldType": { "type": "object", "properties": { "name": { "type": "string" } } }, "WorkflowReadablePeriod": { "type": "object", "properties": { "periodType": { "$ref": "#/components/schemas/WorkflowPeriodType" } } }, "WorkflowPeriodType": { "type": "object", "properties": { "name": { "type": "string" } } }, "WorkflowMultiOperationResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowOperationResponse" } } } }, "WorkflowObjectIdList": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "description": "The list of task IDs to unclaim" }, "WorkflowOperationResponse": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } }, "WorkflowModifyCandidatesPayload": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowUser" } } }, "description": "The list of task IDs to add the given candidate users to" }, "WorkflowUser": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "group", "assignee", "requester", "permission", "platform_role", "category_role", "artifact_role" ] }, "id": { "type": "string" } } }, "WorkflowUserTaskBulkActionPayload": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "claim", "complete" ] }, "assignee": { "type": "string" }, "form_properties": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowFormPropertyInput" } }, "task_ids": { "type": "array", "items": { "type": "string" } } }, "description": "The task IDs and the action to be performed on the tasks" }, "WorkflowPaginatedResource_Artifact": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "first": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "last": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "previous": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "next": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowArtifact" } }, "total_count": { "type": "integer", "format": "int64" } } }, "WorkflowPaginatedResource_UserTask": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "first": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "last": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "previous": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "next": { "$ref": "#/components/schemas/WorkflowPagedResourcesLink" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowUserTask" } }, "total_count": { "type": "integer", "format": "int64" } } }, "WorkflowPlainResourcesListWorkflowTypeInfoWithTaskCategories": { "type": "object", "properties": { "resources": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowWorkflowTypeInfoWithTaskCategories" } } } }, "WorkflowWorkflowTypeInfoWithTaskCategories": { "type": "object", "properties": { "name": { "type": "string" }, "workflow_type_id": { "type": "string" }, "task_categories": { "type": "array", "items": { "type": "string" } } } }, "WorkflowPlainResourcesListString": { "type": "object", "properties": { "resources": { "type": "array", "items": { "type": "string" } } } } }, "requestBodies": { "AssetFilesCopyAssetFile": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetFilesCopyAssetFile" } } }, "description": "Information on the asset to copy." }, "EnvironmentsEnvironmentCreateBody": { "description": "Specification of the environment to be created.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsEnvironmentCreateBody" }, "examples": { "EnvironmentCreateBody": { "$ref": "#/components/examples/EnvironmentsEnvironmentCreateBody" } } } } }, "EnvironmentsEnvironmentUpdateBody": { "description": "Specification of changes.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsEnvironmentUpdateBody" }, "examples": { "EnvironmentUpdateBody": { "$ref": "#/components/examples/EnvironmentsEnvironmentUpdateBody" } } } } }, "EnvironmentsHardwareSpecificationCreateBody": { "description": "Specification of the hardware specification to be created.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationCreateBody" }, "examples": { "HardwareSpecificationCreateBody_0": { "$ref": "#/components/examples/EnvironmentsHardwareSpecificationCreateBody_0" }, "HardwareSpecificationCreateBody_1": { "$ref": "#/components/examples/EnvironmentsHardwareSpecificationCreateBody_1" }, "HardwareSpecificationCreateBody_2": { "$ref": "#/components/examples/EnvironmentsHardwareSpecificationCreateBody_2" } } } } }, "EnvironmentsHardwareSpecificationUpdateBody": { "description": "Specification of changes.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationUpdateBody" }, "examples": { "HardwareSpecificationUpdateBody_0": { "$ref": "#/components/examples/EnvironmentsHardwareSpecificationUpdateBody_0" }, "HardwareSpecificationUpdateBody_1": { "$ref": "#/components/examples/EnvironmentsHardwareSpecificationUpdateBody_1" }, "HardwareSpecificationUpdateBody_2": { "$ref": "#/components/examples/EnvironmentsHardwareSpecificationUpdateBody_2" } } } } }, "EnvironmentsSoftwareSpecificationCreateBody": { "description": "Specification of the software specification to be created.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationCreateBody" }, "examples": { "SoftwareSpecificationCreateBody_0": { "$ref": "#/components/examples/EnvironmentsSoftwareSpecificationCreateBody_0" }, "SoftwareSpecificationCreateBody_1": { "$ref": "#/components/examples/EnvironmentsSoftwareSpecificationCreateBody_1" } } } } }, "EnvironmentsSoftwareSpecificationUpdateBody": { "description": "Specification of the updates for a software specification.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationUpdateBody" }, "examples": { "SoftwareSpecificationUpdateBody": { "$ref": "#/components/examples/EnvironmentsSoftwareSpecificationUpdateBody" } } } } }, "EnvironmentsPackageExtensionCreateBody": { "description": "Specification of the package extension to be created.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionCreateBody" }, "examples": { "PackageExtensionCreateBody": { "$ref": "#/components/examples/EnvironmentsPackageExtensionCreateBody" } } } } }, "EnvironmentsPackageExtensionUpdateBody": { "description": "Specification of the updates for a package extension.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionUpdateBody" }, "examples": { "PackageExtensionUpdateBody": { "$ref": "#/components/examples/EnvironmentsPackageExtensionUpdateBody" } } } } }, "EnvironmentsRuntimeDefinitionCreateBody": { "description": "Specification of the runtime definition to be created.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinitionCreateBody" }, "examples": { "RuntimeDefinitionCreateBody": { "$ref": "#/components/examples/EnvironmentsRuntimeDefinitionCreateBody" } } } } }, "EnvironmentsRuntimeDefinitionUpdateBody": { "description": "Specification of the updates for a runtime definition.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinitionUpdateBody" }, "examples": { "RuntimeDefinitionUpdateBody": { "$ref": "#/components/examples/EnvironmentsRuntimeDefinitionUpdateBody" } } } } }, "GlossaryV3file_json": { "content": { "multipart/form-data": { "schema": { "type": "object", "description": "Schema for JSON file to import from.", "properties": { "file": { "type": "string", "format": "binary", "description": "File", "maxLength": 2147483647, "minLength": 1 } } } } }, "description": "JSON file to import from.", "required": true }, "GlossaryV3file_zip": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "File", "maxLength": 2147483647, "minLength": 1 } } } } }, "description": "ZIP file to import from.", "required": true }, "GlossaryV3file_csv": { "content": { "multipart/form-data": { "schema": { "type": "object", "description": "Schema for CSV file to import from.", "properties": { "file": { "type": "string", "format": "binary", "description": "File", "maxLength": 2147483647, "minLength": 1 } } } } }, "description": "CSV file to import from.", "required": true }, "ProjectsUpdateProjectBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsUpdateProjectBody" } } }, "required": true }, "ProjectsUpdateMembersBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsUpdateMembersBody" } } }, "required": true }, "ProjectsCreateMembersBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjectMembers" } } }, "required": true }, "ProjectsUpdateTagsBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsUpdateTagsBody" } } }, "required": true }, "ProjectsCreateTagsBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjectTags" } } }, "required": true }, "ProjectsCreateTagBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": false }, "ProjectsUpdateFoldersBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsSettingsGroupFolders" } } }, "required": true } }, "examples": { "DataQualityErrorContainer500": { "value": "{\"trace\":\"cwuhtyfus0m8f6e49e2g6m4hr\",\"status_code\":500,\"errors\":[{\"code\":\"internal_error\",\"message\":\"An IOException was caught when accessing asset 'cbf21aa7-cb89-4ee8-9817-0f1d86fbe0cd'.\"}]}" }, "DataQualityErrorContainer409": { "value": "{\"trace\":\"28izpw5l1a4orh823i6bkqmm\",\"status_code\":409,\"errors\":[{\"code\":\"already_exists\",\"message\":\"The dimension with name 'Completeness' already exists.\"}]}" }, "DataQualityErrorContainer403": { "value": "{\"trace\":\"3tirwt88tsejqwh801zw88lek\",\"status_code\":403,\"errors\":[{\"code\":\"not_authorized\",\"message\":\"User IBMid-341983Z157 with role null is not authorized to perform the operation CREATE.\"}]}" }, "DataQualityErrorContainer400": { "value": "{\"trace\":\"6vbjp9d2t4s9b2ckyspdw4vft\",\"status_code\":400,\"errors\":[{\"code\":\"missing_required_field\",\"message\":\"Bad Request: {\\\"trace\\\":\\\"8f7b7693-1f08-4b4a-b2bd-5732d06ad19e\\\", \\\"errors\\\":[{\\\"code\\\":\\\"invalid_parameter\\\", \\\"message\\\":\\\"COMSV3006E: Missing or Invalid asset id\\\", \\\"target\\\":{\\\"name\\\":\\\"asset\\\",\\\"type\\\":\\\"parameter\\\"}}]}\"}]}" }, "DataQualityAsset": { "value": "{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\",\"name\":\"CUSTOMERS\",\"type\":\"data_asset\",\"native_id\":\"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702\",\"weight\":1,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T10:51:02.000Z\"}" }, "DataQualityAssetPrototype": { "value": "{\"native_id\":\"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702\",\"name\":\"CUSTOMERS\",\"type\":\"data_asset\",\"weight\":1}" }, "DataQualityAssetCollection": { "value": "{\"total_count\":1,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/assets?limit=200\"},\"assets\":[{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\",\"name\":\"CUSTOMERS\",\"type\":\"data_asset\",\"native_id\":\"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702\",\"weight\":1,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T10:51:02.000Z\"}]}" }, "DataQualityErrorContainer404": { "value": "{\"trace\":\"cfkvi16tv9bimp2rqve666na0\",\"status_code\":404,\"errors\":[{\"code\":\"not_found\",\"message\":\"Requested resource was not found.\",\"more_info\":\"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data\",\"target\":{\"type\":\"field\",\"name\":\"name\"}}]}" }, "DataQualityJSONResourcePatchRequestModel": { "value": "[{\"op\":\"replace\",\"path\":\"/description\",\"value\":\"The proportion of data stored against the potential for 100% of the data.\"}]" }, "DataQualityCheck": { "value": "{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"check_uniqueness_of_id\",\"dimension\":{\"id\":\"371114cd-5516-4691-8b2e-1e66edf66486\",\"name\":\"COMPLETENESS\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"type\":\"data_rule\",\"native_id\":\"4cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"}" }, "DataQualityCheckPrototype": { "value": "{\"dimension\":{\"id\":\"371114cd-5516-4691-8b2e-1e66edf66486\"},\"name\":\"check_uniqueness_of_id\",\"type\":\"data_rule\",\"native_id\":\"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702\"}" }, "DataQualityCheckCollection": { "value": "{\"total_count\":1,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/checks?limit=200\"},\"checks\":[{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\",\"name\":\"check_uniqueness_of_id\",\"dimension\":{\"id\":\"371114cd-5516-4691-8b2e-1e66edf66486\",\"name\":\"COMPLETENESS\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"type\":\"data_rule\",\"native_id\":\"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T10:51:02.000Z\"}]}" }, "DataQualityDimension": { "value": "{\"id\":\"371114cd-5516-4691-8b2e-1e66edf66486\",\"name\":\"Completeness\",\"description\":\"The proportion of data stored against the potential for 100 percent.\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"}" }, "DataQualityDimensionPrototype": { "value": "{\"name\":\"Completeness10\",\"description\":\"The proportion of data stored against the potential for 100 percent represented as integer 10.\"}" }, "DataQualityDimensionCollection": { "value": "{\"total_count\":1,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/dimensions?limit=200\"},\"dimensions\":[{\"id\":\"371114cd-5516-4691-8b2e-1e66edf66486\",\"name\":\"Completeness\",\"description\":\"The proportion of data stored against the potential for 100 percent.\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"}]}" }, "DataQualityIssue": { "value": "{\"id\":\"046605b5-48d9-489e-b846-8ef96a7a1aba\",\"check\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"MY_RULE\",\"native_id\":\"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47\",\"type\":\"ANY\",\"created_at\":\"2022-02-02T14:00:45.000Z\",\"creator_id\":\"SYSTEM\"},\"reported_for\":{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\"},\"number_of_occurrences\":123,\"number_of_tested_records\":456789,\"status\":\"actual\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"}" }, "DataQualityIssuePrototype": { "value": "{\"check\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\"},\"reported_for\":{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\"},\"number_of_occurrences\":123,\"number_of_tested_records\":456789,\"status\":\"actual\",\"ignored\":false}" }, "DataQualityIssueCollection": { "value": "{\"total_count\":1,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/issues?limit=200\"},\"issues\":[{\"id\":\"046605b5-48d9-489e-b846-8ef96a7a1aba\",\"check\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"MY_RULE\",\"native_id\":\"cdcd4382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47\",\"type\":\"ANY\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"reported_for\":{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\",\"nativeId\":\"739e06f8-3gk2-4c4u-8ab7-e5682g06f05a\"},\"number_of_occurrences\":123,\"number_of_tested_records\":456789,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T10:51:02.000Z\"}]}" }, "DataQualityIssueCollectionItem": { "value": "{\"id\":\"046605b5-48d9-489e-b846-8ef96a7a1aba\",\"check\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"MY_RULE\",\"native_id\":\"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47\",\"type\":\"ANY\",\"created_at\":\"2022-02-02T14:00:45.000Z\",\"creator_id\":\"SYSTEM\"},\"reported_for\":{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\"},\"number_of_occurrences\":123,\"number_of_tested_records\":456789,\"status\":\"actual\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\",\"archived_issues\":[{\"id\":\"046605b5-48d9-489e-b846-8ef96a7a1aba\",\"check\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"MY_RULE\",\"native_id\":\"cdcd382-4e3a-4537-b7ae-09993acee4cf/3e51167c-6eb2-4069-96dc-5d6df808fd47\",\"type\":\"ANY\",\"created_at\":\"2022-02-02T14:00:45.000Z\",\"creator_id\":\"SYSTEM\"},\"reported_for\":{\"id\":\"894d01fd-bdfc-4a4f-b68b-62751e06e06a\"},\"number_of_occurrences\":123,\"number_of_tested_records\":456789,\"status\":\"archive\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T14:00:45.000Z\"}]}" }, "DataQualityIssuesBatchPrototype": { "value": "{\"issues\":[{\"check\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\"},\"reported_for\":{\"native_id\":\"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702\",\"type\":\"profile\"},\"number_of_occurrences\":123,\"number_of_tested_records\":456789,\"ignored\":false}],\"assets\":[{\"name\":\"CUSTOMERS\",\"type\":\"data_asset\",\"native_id\":\"8ddc659c-b155-498d-b310-4ac8cf629ccc/9a1f3644-3ad4-47be-8eb5-006d367c8702\",\"weight\":1}],\"existing_checks\":[{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\"}]}" }, "DataQualityScoreCollection": { "value": "{\"total_count\":100,\"asset\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"CUSTOMERS\"},\"scores\":[{\"status\":\"actual\",\"score\":0.8,\"number_of_checks\":1,\"timestamp\":\"2022-02-14T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"score\":0.4,\"timestamp\":\"2022-02-14T18:11:02Z\"},{\"dimension\":{\"id\":\"7be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"ACCURACY\",\"description\":\"Dimension related to accuracy\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"score\":0.7,\"timestamp\":\"2022-02-13T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.6,\"number_of_checks\":2,\"timestamp\":\"2022-02-12T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"score\":0.23,\"timestamp\":\"2022-02-12T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.7,\"number_of_checks\":2,\"timestamp\":\"2022-02-11T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"score\":0.23,\"timestamp\":\"2022-02-11T18:11:02Z\"}]}],\"children\":[{\"asset\":{\"id\":\"5be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"ID\"},\"scores\":[{\"status\":\"actual\",\"score\":0.8,\"number_of_checks\":1,\"timestamp\":\"2022-02-14T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"score\":0.4,\"timestamp\":\"2022-02-14T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.6,\"number_of_checks\":1,\"timestamp\":\"2022-02-12T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"score\":0.23,\"timestamp\":\"2022-02-12T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.7,\"number_of_checks\":1,\"timestamp\":\"2022-02-11T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"score\":0.23,\"timestamp\":\"2022-02-11T18:11:02Z\"}]}]}]}" }, "DataQualityScoreCollectionItems": { "value": "[{\"total_count\":100,\"asset\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"CUSTOMERS\"},\"scores\":[{\"status\":\"actual\",\"score\":0.8,\"number_of_checks\":1,\"timestamp\":\"2022-02-14T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45Z\"},\"score\":0.4,\"timestamp\":\"2022-02-14T18:11:02Z\"},{\"dimension\":{\"id\":\"7be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"ACCURACY\",\"description\":\"Dimension related to accuracy\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45Z\"},\"score\":0.7,\"timestamp\":\"2022-02-13T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.6,\"number_of_checks\":2,\"timestamp\":\"2022-02-12T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45Z\"},\"score\":0.23,\"timestamp\":\"2022-02-12T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.7,\"number_of_checks\":2,\"timestamp\":\"2022-02-11T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45Z\"},\"score\":0.23,\"timestamp\":\"2022-02-11T18:11:02Z\"}]}],\"children\":[{\"asset\":{\"id\":\"5be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"ID\"},\"scores\":[{\"status\":\"actual\",\"score\":0.8,\"number_of_checks\":1,\"timestamp\":\"2022-02-14T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45Z\"},\"score\":0.4,\"timestamp\":\"2022-02-14T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.6,\"number_of_checks\":1,\"timestamp\":\"2022-02-12T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45Z\"},\"score\":0.23,\"timestamp\":\"2022-02-12T18:11:02Z\"}]},{\"status\":\"archive\",\"score\":0.7,\"number_of_checks\":1,\"timestamp\":\"2022-02-11T18:11:02Z\",\"dimension_scores\":[{\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"description\":\"Dimension related to completeness\",\"is_default\":false,\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45Z\"},\"score\":0.23,\"timestamp\":\"2022-02-11T18:11:02Z\"}]}]}]}]" }, "DataQualitySLA": { "value": "{\"id\":\"999605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Customer address completeness\",\"description\":\"Makes sure that customers' addresses are reasonably complete\",\"filters\":[{\"type\":\"term\",\"native_id\":\"043405b5-48d9-489e-b846-8ef96a7a1abd\",\"name\":\"CUSTOMER\"},{\"type\":\"term\",\"native_id\":\"943405b5-48d9-489e-b846-8ef96a7a1abf\",\"name\":\"SUPPLIER\"}],\"conditions\":[{\"dimension\":{\"id\":\"888605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Completeness\"},\"threshold\":0.9}],\"children\":[{\"filters\":[{\"type\":\"name\",\"value\":\"address\"}],\"conditions\":[{\"dimension\":{\"id\":\"666605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Validity\"},\"threshold\":0.8}]},{\"filters\":[{\"type\":\"name\",\"value\":\"zip\"}],\"conditions\":[{\"dimension\":{\"id\":\"666605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Validity\"},\"threshold\":0.95}]}],\"actions\":[{\"type\":\"workflow\",\"native_id\":\"555605b5-48d9-489e-b846-8ef96a7a1ddd\"}],\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\",\"updater_id\":\"SYSTEM\",\"updated_at\":\"2022-02-03T16:12:42.000Z\"}" }, "DataQualitySLAPrototype": { "value": "{\"name\":\"Customer address completeness\",\"description\":\"Makes sure that customers' addresses are reasonably complete\",\"filters\":[{\"type\":\"term\",\"native_id\":\"043405b5-48d9-489e-b846-8ef96a7a1abd\",\"name\":\"CUSTOMER\"},{\"type\":\"term\",\"native_id\":\"943405b5-48d9-489e-b846-8ef96a7a1abf\",\"name\":\"SUPPLIER\"}],\"conditions\":[{\"dimension\":{\"id\":\"888605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Completeness\"},\"threshold\":0.9}],\"children\":[{\"filters\":[{\"type\":\"name\",\"value\":\"address\"}],\"conditions\":[{\"dimension\":{\"id\":\"666605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Validity\"},\"threshold\":0.8}]},{\"filters\":[{\"type\":\"name\",\"value\":\"zip\"}],\"conditions\":[{\"dimension\":{\"id\":\"666605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Validity\"},\"threshold\":0.95}]}],\"actions\":[{\"type\":\"workflow\",\"native_id\":\"555605b5-48d9-489e-b846-8ef96a7a1ddd\"}]}" }, "DataQualitySLACollection": { "value": "{\"total_count\":1,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/slas?limit=200\"},\"slas\":[{\"id\":\"999605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Customer address completeness\",\"description\":\"Makes sure that customers' addresses are reasonably complete\",\"filters\":[{\"type\":\"term\",\"native_id\":\"043405b5-48d9-489e-b846-8ef96a7a1abd\",\"name\":\"Address\"},{\"type\":\"term\",\"native_id\":\"943405b5-48d9-489e-b846-8ef96a7a1abf\",\"name\":\"Zip\"}],\"conditions\":[{\"dimension\":{\"id\":\"888605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Completeness\"},\"threshold\":0.9}],\"children\":[{\"filters\":[{\"type\":\"name\",\"value\":\"address\"}],\"conditions\":[{\"dimension\":{\"id\":\"666605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Validity\"},\"threshold\":0.8}]},{\"filters\":[{\"type\":\"name\",\"value\":\"zip\"}],\"conditions\":[{\"dimension\":{\"id\":\"666605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Validity\"},\"threshold\":0.95}]}],\"actions\":[{\"type\":\"workflow\",\"native_id\":\"555605b5-48d9-489e-b846-8ef96a7a1ddd\"}],\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"}]}" }, "DataQualitySLAAssessmentCollection": { "value": "{\"total_count\":1,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/slas/assessments?asset_id=333605b5-48d9-489e-b846-8ef96a7a1abc&limit=200\"},\"sla_assessments\":[{\"id\":\"222605b5-48d9-489e-b846-8ef96a7a1def\",\"asset\":{\"wkc_asset_id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"wkc_asset_type\":\"Table\",\"name\":\"CUSTOMERS\"},\"sla\":{\"id\":\"999605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Customer address SLA\"},\"is_latest\":true,\"num_violations\":3,\"violations_on_asset\":1,\"violations_on_children\":2,\"dimensions_with_violations\":[{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"Consistency\"},null],\"actions\":[{\"type\":\"workflow\",\"name\":\"DQ Remediation for customer US Government\",\"native_id\":\"255505b5-8888-489e-b846-8ef96a7a1def\",\"native_definition_id\":\"555605b5-48d9-489e-b846-8ef96a7a1ddd\",\"completed\":true,\"details\":\"{completed_on_time: true}\",\"created_at\":\"2023-02-01T18:11:02.000Z\"}],\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"}]}" }, "DataQualitySLAAssessment": { "value": "{\"id\":\"222605b5-48d9-489e-b846-8ef96a7a1def\",\"asset\":{\"wkc_asset_id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"wkc_asset_type\":\"Table\",\"name\":\"CUSTOMERS\"},\"sla\":{\"id\":\"999605b5-48d9-489e-b846-8ef96a7a1abc\",\"name\":\"Customer address SLA\"},\"is_latest\":true,\"num_violations\":3,\"violations_on_asset\":1,\"violations_on_children\":2,\"dimensions_with_violations\":[{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"Consistency\"},null],\"violations\":{\"total_count\":3,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/slas?limit=200\"},\"violations\":[{\"id\":\"6b744574-573a-4cf8-8ab7-e428506e4289\",\"asset\":{\"wkc_asset_id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"wkc_asset_type\":\"Table\",\"name\":\"CUSTOMERS\"},\"filter\":{\"type\":\"term\",\"native_id\":\"043405b5-48d9-489e-b846-8ef96a7a1abd\",\"name\":\"Address\"},\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"missed_threshold\":0.9,\"score\":0.4,\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"},{\"id\":\"6b744574-573a-4cf8-8ab7-e428506e4290\",\"asset\":{\"wkc_asset_id\":\"48e18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"AGE\",\"wkc_asset_type\":\"Column\"},\"filter\":{\"type\":\"name\",\"value\":\"age\"},\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"Freshness\"},\"missed_threshold\":1,\"score\":0.7,\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"},{\"id\":\"6b744574-573a-4cf8-8ab7-e428506e4291\",\"asset\":{\"wkc_asset_id\":\"46849374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"ZIP\",\"wkc_asset_type\":\"Column\"},\"filter\":{\"type\":\"term\",\"native_id\":\"043405b5-48d9-489e-b846-8ef96a7a1ccc\",\"name\":\"Zip\"},\"dimension\":{\"id\":\"45645632-573a-4cf8-8ab7-e428506e428b\",\"name\":\"Correctness\"},\"missed_threshold\":0.98,\"score\":0.8,\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"}]},\"actions\":[{\"type\":\"workflow\",\"name\":\"DQ Remediation\",\"native_id\":\"255505b5-8888-489e-b846-8ef96a7a1def\",\"native_definition_id\":\"555605b5-48d9-489e-b846-8ef96a7a1ddd\",\"completed\":true,\"details\":\"{completed_on_time: true}\",\"created_at\":\"2022-02-02T14:00:45.000Z\"}],\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"}" }, "DataQualitySLAViolationCollection": { "value": "{\"total_count\":3,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v4/slas?limit=200\"},\"violations\":[{\"id\":\"6b744574-573a-4cf8-8ab7-e428506e4289\",\"asset\":{\"wkc_asset_id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"wkc_asset_type\":\"Table\",\"name\":\"CUSTOMERS\"},\"filter\":{\"type\":\"term\",\"native_id\":\"043405b5-48d9-489e-b846-8ef96a7a1abd\",\"name\":\"Address\"},\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"COMPLETENESS\"},\"missed_threshold\":0.9,\"score\":0.4,\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"},{\"id\":\"6b744574-573a-4cf8-8ab7-e428506e4290\",\"asset\":{\"wkc_asset_id\":\"48e18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"AGE\",\"wkc_asset_type\":\"Column\"},\"filter\":{\"type\":\"name\",\"value\":\"age\"},\"dimension\":{\"id\":\"6be18374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"Freshness\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-02T14:00:45.000Z\"},\"missed_threshold\":1,\"score\":0.7,\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"},{\"id\":\"6b744574-573a-4cf8-8ab7-e428506e4291\",\"asset\":{\"wkc_asset_id\":\"46849374-573a-4cf8-8ab7-e428506e428b\",\"name\":\"ZIP\",\"wkc_asset_type\":\"Column\"},\"filter\":{\"type\":\"term\",\"native_id\":\"043405b5-48d9-489e-b846-8ef96a7a1ccc\",\"name\":\"Zip\"},\"dimension\":{\"id\":\"45645632-573a-4cf8-8ab7-e428506e428b\",\"name\":\"Correctness\"},\"missed_threshold\":0.98,\"score\":0.8,\"creator_id\":\"SYSTEM\",\"created_at\":\"2023-02-01T18:11:02.000Z\"}]}" }, "DataQualityBooleanStatus": { "value": "{\"status\":true}" }, "DataQualityErrorContainer": { "value": "{\"trace\":\"cfkvi16tv9bimp2rqve666na0\",\"status_code\":404,\"errors\":[{\"code\":\"not_found\",\"message\":\"Requested resource was not found.\",\"more_info\":\"https://www.ibm.com/docs/en/cloud-paks/cp-data/4.5.x?topic=rules-creating-data\",\"target\":{\"type\":\"field\",\"name\":\"name\"}}]}" }, "DataQualityRule": { "value": "{\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\",\"bound_expression\":[\"TEST.table1.col1<=TEST.table2.col2\"],\"is_valid\":true,\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf\",\"name\":\"table1.col1LessOrEqualTable2.col2\",\"description\":\"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2\",\"sampling\":{\"size\":2500,\"interval\":13,\"sampling_type\":\"every_nth\"},\"output\":{\"columns\":[{\"variable_name\":\"col1\",\"name\":\"out1\",\"type\":\"rule_variable\",\"disambiguator\":1},{\"name\":\"out2\",\"type\":\"column\",\"source_column\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col1\",\"type\":\"column\"}},{\"expression\":\"col1-col2\",\"name\":\"out4\",\"type\":\"rule_expression\",\"disambiguator\":2},{\"metric\":\"system_time\",\"name\":\"out5\",\"type\":\"metric\"}],\"database\":{\"records_type\":\"all_records\",\"update_type\":\"append\",\"location\":{\"connection\":{\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\"},\"schema_name\":\"TEST\",\"table_name\":\"output\"}},\"maximum_record_count\":500},\"input\":{\"definitions\":[{\"definition\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"disambiguator\":1,\"bindings\":[{\"variable_name\":\"col1\",\"target\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col1\",\"type\":\"column\"}}]},{\"definition\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"disambiguator\":2,\"bindings\":[{\"variable_name\":\"col2\",\"target\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col2\",\"type\":\"column\"}}]}]},\"joins\":[{\"type\":\"inner_join\",\"left_data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"right_data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93xyz\"},\"left_column_name\":\"col1\",\"right_column_name\":\"col2\"}],\"dimension\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"apply_all_present_dimensions\":false}" }, "DataQualityRulePrototype": { "value": "{\"name\":\"table1.col1LessOrEqualTable2.col2\",\"description\":\"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2\",\"sampling\":{\"size\":2500,\"interval\":13,\"sampling_type\":\"every_nth\"},\"output\":{\"columns\":[{\"variable_name\":\"col1\",\"name\":\"out1\",\"type\":\"rule_variable\",\"disambiguator\":1},{\"name\":\"out2\",\"type\":\"column\",\"source_column\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col1\",\"type\":\"column\"}},{\"expression\":\"col1-col2\",\"name\":\"out4\",\"type\":\"rule_expression\",\"disambiguator\":2},{\"metric\":\"system_time\",\"name\":\"out5\",\"type\":\"metric\"}],\"database\":{\"records_type\":\"all_records\",\"update_type\":\"append\",\"location\":{\"connection\":{\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\"},\"schema_name\":\"TEST\",\"table_name\":\"output\"}},\"maximum_record_count\":500},\"input\":{\"definitions\":[{\"definition\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"disambiguator\":1,\"bindings\":[{\"variable_name\":\"col1\",\"target\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col1\",\"type\":\"column\"}}]},{\"definition\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"disambiguator\":2,\"bindings\":[{\"variable_name\":\"col2\",\"target\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col2\",\"type\":\"column\"}}]}]},\"joins\":[{\"type\":\"inner_join\",\"left_data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"right_data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93xyz\"},\"left_column_name\":\"col1\",\"right_column_name\":\"col2\"}],\"dimension\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"apply_all_present_dimensions\":false}" }, "DataQualityRuleCollection": { "value": "{\"total_count\":100,\"limit\":50,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules?limit=50\"},\"rules\":[{\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\",\"bound_expression\":[\"TEST.table1.col1<=TEST.table2.col2\"],\"is_valid\":true,\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf\",\"name\":\"table1.col1LessOrEqualTable2.col2\",\"description\":\"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2\",\"sampling\":{\"size\":2500,\"interval\":13,\"sampling_type\":\"every_nth\"},\"output\":{\"columns\":[{\"variable_name\":\"col1\",\"name\":\"out1\",\"type\":\"rule_variable\",\"disambiguator\":1},{\"name\":\"out2\",\"type\":\"column\",\"source_column\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col1\",\"type\":\"column\"}},{\"expression\":\"col1-col2\",\"name\":\"out4\",\"type\":\"rule_expression\",\"disambiguator\":2},{\"metric\":\"system_time\",\"name\":\"out5\",\"type\":\"metric\"}],\"database\":{\"records_type\":\"all_records\",\"update_type\":\"append\",\"location\":{\"connection\":{\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\"},\"schema_name\":\"TEST\",\"table_name\":\"output\"}},\"maximum_record_count\":500},\"input\":{\"definitions\":[{\"definition\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"disambiguator\":1,\"bindings\":[{\"variable_name\":\"col1\",\"target\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col1\",\"type\":\"column\"}}]},{\"definition\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"disambiguator\":2,\"bindings\":[{\"variable_name\":\"col2\",\"target\":{\"data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"column_name\":\"col2\",\"type\":\"column\"}}]}]},\"joins\":[{\"type\":\"inner_join\",\"left_data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"right_data_asset\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93xyz\"},\"left_column_name\":\"col1\",\"right_column_name\":\"col2\"}],\"dimension\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"apply_all_present_dimensions\":false}]}" }, "DataQualityJSONResourcePatchRequestModel1": { "value": "[{\"op\":\"replace\",\"path\":\"/description\",\"value\":\"Column col1 has fewer or the same number of values as column col2\"}]" }, "DataQualityRuleExecution": { "value": "{\"name\":\"table1.col1LessOrEqualTable2.col2\",\"job\":{\"id\":\"aa398b69-3e91-4830-877a-91a8e21f56de\"},\"job_run\":{\"id\":\"aa398b69-3e91-4830-877a-91a8e21f5123\"},\"status\":{\"state\":\"analyzed\"},\"started_at\":\"2022-02-01T18:10:02.000Z\",\"ended_at\":\"2022-02-01T18:11:02.000Z\",\"run_by\":\"IBMid-270002ABCD\",\"sampling\":{\"size\":2500,\"interval\":13,\"sampling_type\":\"every_nth\"},\"input\":{\"definitions\":[{\"bound_expression\":\"TEST.table1.col1<=TEST.table2.col2\"}]},\"output\":{\"columns\":[{\"variable_name\":\"col1\",\"name\":\"out1\",\"type\":\"rule_variable\",\"disambiguator\":1},{\"name\":\"out2\",\"type\":\"column\",\"source_column\":{\"data_asset\":{\"id\":\"aa398b69-3e91-4830-877a-91a8e21f56de\"},\"column_name\":\"col1\",\"type\":\"column\"}},{\"expression\":\"col1-col2\",\"name\":\"out4\",\"type\":\"rule_expression\",\"disambiguator\":2},{\"metric\":\"system_time\",\"name\":\"out5\",\"type\":\"metric\"}],\"database\":{\"records_type\":\"all_records\",\"update_type\":\"append\",\"location\":{\"connection\":{\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\"},\"schema_name\":\"TEST\",\"table_name\":\"output\"}},\"maximum_record_count\":500},\"output_table\":{\"id\":\"5d4254a6-0c9e-4a02-bc24-4a89eee06f12\"},\"tested_record_count\":1000,\"passing_record_count\":987,\"failing_record_count\":13,\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\",\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf/executions/7b3f3a79-6412-480b-a20c-393a3f7adabc\"}" }, "DataQualityRuleExecutionCollection": { "value": "{\"limit\":20,\"total_count\":100,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/c19cde3a-5940-4c7a-ad0f-ee18f5f29c12/executions?limit=20\"},\"executions\":[{\"name\":\"table1.col1LessOrEqualTable2.col2\",\"description\":\"The column TEST.table1.col1 has fewer or the same number of values as column TEST.table2.col2\",\"job\":{\"id\":\"aa398b69-3e91-4830-877a-91a8e21f56de\"},\"job_run\":{\"id\":\"aa398b69-3e91-4830-877a-91a8e21f5123\"},\"status\":{\"state\":\"analyzed\"},\"started_at\":\"2022-02-01T18:10:02.000Z\",\"ended_at\":\"2022-02-01T18:11:02.000Z\",\"run_by\":\"IBMid-270002ABCD\",\"sampling\":{\"size\":2500,\"interval\":13,\"sampling_type\":\"every_nth\"},\"output\":{\"columns\":[{\"variable_name\":\"col1\",\"name\":\"out1\",\"type\":\"rule_variable\",\"disambiguator\":1},{\"name\":\"out2\",\"type\":\"column\",\"source_column\":{\"data_asset\":{\"id\":\"aa398b69-3e91-4830-877a-91a8e21f56de\"},\"column_name\":\"col1\",\"type\":\"column\"}},{\"expression\":\"col1-col2\",\"name\":\"out4\",\"type\":\"rule_expression\",\"disambiguator\":2},{\"metric\":\"system_time\",\"name\":\"out5\",\"type\":\"metric\"}],\"database\":{\"records_type\":\"all_records\",\"update_type\":\"append\",\"location\":{\"connection\":{\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\"},\"schema_name\":\"TEST\",\"table_name\":\"output\"}},\"maximum_record_count\":500},\"output_table\":{\"id\":\"5d4254a6-0c9e-4a02-bc24-4a89eee06f12\"},\"tested_record_count\":1000,\"bound_expression\":[\"TEST.table1.col1<=TEST.table2.col2\"],\"passing_record_count\":987,\"failing_record_count\":13,\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7addbf\",\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/rules/7b3f3a79-6412-480b-a20c-393a3f7addbf/executions/7b3f3a79-6412-480b-a20c-393a3f7adabc\"}]}" }, "DataQualityDefinition": { "value": "{\"description\":\"Column col1 has fewer or the same number of values as column col2\",\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7adoi\",\"name\":\"col1LessOrEqualCol2\",\"expression\":\"col1 <= col2\",\"dimension\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf\"}" }, "DataQualityDefinitionPrototype": { "value": "{\"name\":\"col1LessOrEqualCol2\",\"description\":\"Column col1 has fewer or the same number of values as column col2\",\"expression\":\"col1 <= col2\",\"dimension\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"}}" }, "DataQualityDefinitionCollection": { "value": "{\"total_count\":100,\"limit\":200,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions?limit=200\"},\"definitions\":[{\"description\":\"Column col1 has fewer or the same number of values as column col2\",\"id\":\"7b3f3a79-6412-480b-a20c-393a3f7adoi\",\"name\":\"col1LessOrEqualCol2\",\"expression\":\"col1 <= col2\",\"dimension\":{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93abc\"},\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/definitions/7b3f3a79-6412-480b-a20c-393a3f7addbf\"}]}" }, "DataQualityDefinitionValidation": { "value": "{\"variables\":[{\"name\":\"col1\",\"type\":\"numeric\",\"usage\":\"input_data\"},{\"name\":\"col2\",\"type\":\"numeric\",\"usage\":\"input_data\"}]}" }, "DataQualityDimensionCollection1": { "value": "{\"limit\":20,\"total_count\":100,\"first\":{\"href\":\"https://cloud.ibm.com/data_quality/v3/projects/c19cde3a-5940-4c7a-ad0f-ee18f5f29c00/dimensions?limit=20\"},\"dimensions\":[{\"id\":\"371114cd-5516-4691-8b2e-1e66edf66486\",\"name\":\"Completeness\",\"description\":\"The proportion of data stored against the potential for 100%.\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"},{\"id\":\"57561203-36e6-4bb0-adfb-ece981fba845\",\"name\":\"Uniqueness\",\"description\":\"No entity instance (`abc`) will be recorded more than once based on how `abc` is identified.\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"},{\"id\":\"a3134282-ed85-4140-ae61-e5f712a61985\",\"name\":\"Timeliness\",\"description\":\"The degree to which data represent reality from the required point in time.\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"},{\"id\":\"ec453723-669c-48bb-82c1-11b69b3b8c93\",\"name\":\"Validity\",\"description\":\"Data is valid if it conforms to the syntax (format, type, range) of its definition.\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"},{\"id\":\"5f66813e-adb1-4f3f-a65f-40e3066aac07\",\"name\":\"Accuracy\",\"description\":\"The degree to which data correctly describes the real world object or event being described.\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"},{\"id\":\"5f66813e-adb1-4f3f-a65f-40e3066aa123\",\"name\":\"Consistency\",\"description\":\"The absence of difference when comparing two or more representations of an object against a definition.\",\"creator_id\":\"SYSTEM\",\"created_at\":\"2022-02-01T18:11:02.000Z\"}]}" }, "DataQualitySettings": { "value": "{\"default_else_value\":true,\"ignore_trailing_spaces\":false,\"implicit_casting\":true,\"max_string_length\":1024,\"allow_quoted_variables\":false}" }, "DataQualitySettingsPrototype": { "value": "{\"default_else_value\":true,\"ignore_trailing_spaces\":false,\"implicit_casting\":true,\"max_string_length\":1024,\"allow_quoted_variables\":false}" }, "EnvironmentsRateLimitError": { "value": { "trace": "b12692e1-8582-4628-88ca-7a13fefb73e2", "errors": [ { "code": "rate_limit", "message": "The requests from IBMid-310000A00A exceeds rate limit. Please try again later." } ] } }, "EnvironmentsAuthorizationError": { "value": { "trace": "b12692e1-8582-4628-88ca-7a13fefb73e2", "errors": [ { "code": "endpoint_access_forbidden", "message": "max.mustermann@ibm.com is neither editor/admin of project b275be5f-10ff-47ee-bfc9-63f1ce5addbf nor allowlisted Service ID." } ] } }, "EnvironmentsAuthenticationError": { "value": { "trace": "b12692e1-8582-4628-88ca-7a13fefb73e2", "errors": [ { "code": "invalid_auth_token", "message": "The IAM bearer token is not valid.", "target": { "type": "header", "name": "Authentication" } } ] } }, "EnvironmentsBadRequestError": { "value": { "trace": "b12692e1-8582-4628-88ca-7a13fefb73e2", "errors": [ { "code": "invalid_type", "message": "The `project_id` field needs to be a uuid v4, but is 12345.", "target": { "type": "field", "name": "project_id" } } ] } }, "EnvironmentsEnvironment": { "summary": "An environment", "value": { "metadata": { "name": "my notebook environment", "description": "this is my notebook environment", "asset_type": "environment", "asset_id": "656ca7c3-d971-42c3-918b-a15023cd6b8e", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-10-12T09:18:34.000Z", "href": "/v2/environments/656ca7c3-d971-42c3-918b-a15023cd6b8e" }, "entity": { "environment": { "sub_type": "notebook", "display_name": "My Notebook Environment", "hardware_specification": { "metadata": { "name": "my hardware specification", "description": "this is my hardware specification", "asset_type": "hardware_specification", "asset_id": "2d5191ba-ff9b-4b48-a852-948d49dd9210", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "href": "/v2/hardware_specifications/2d5191ba-ff9b-4b48-a852-948d49dd9210" }, "entity": { "hardware_specification": { "nodes": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" }, "gpu": { "num_gpu": 2, "name": "v100", "gpu_profile": "generic", "mig_profile": "N/A" }, "num_nodes": 1, "num_drivers": 1, "drivers": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } } } } } }, "software_specification": { "metadata": { "name": "my software specification", "description": "this is my software specification", "asset_type": "software_specification", "asset_id": "555bd074-cc5b-4396-a7f8-5f03d336a8e5", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "life_cycle": { "deprecated": true, "wml": { "deprecated": false } }, "href": "/v2/software_specifications/555bd074-cc5b-4396-a7f8-5f03d336a8e5" }, "entity": { "software_specification": { "type": "derived", "display_name": "My Software Specification", "base_software_specification": { "guid": "ab9e1b80-f2ce-592c-a7d2-4f2344f77194" }, "package_extensions": [ { "metadata": { "name": "my package extension", "description": "this is my package extension", "asset_type": "package_extension", "asset_id": "461db2c9-effb-4bfb-8319-f4acf8ba06a3", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z" }, "entity": { "package_extension": { "type": "conda_yml", "interpreter": "mamba", "object_key": "package_extension/Package_Extension_9GShiX8H0.yml" } } } ], "software_configuration": { "included_packages": [ { "name": "ipython", "version": "7.22.0" } ], "platform": { "name": "spark", "version": 3.2 }, "language": { "name": "python", "version": 3.9 } } } } }, "tools_specification": { "supported_kernels": [ { "name": "python3", "language": "python", "version": 3.9, "display_name": "Python 3.9" } ] }, "runtime_definition": "204dac19-7d94-4692-a4c8-2acd77e28792", "spec_type": "referenced" } } } }, "EnvironmentsEnvironmentCreateBody": { "summary": "Create an environment", "value": { "type": "notebook", "name": "my notebook environment", "description": "this is my notebook environment", "display_name": "My Notebook Environment", "runtime_definition": "204dac19-7d94-4692-a4c8-2acd77e28792", "hardware_specification": { "guid": "2d5191ba-ff9b-4b48-a852-948d49dd9210" }, "software_specification": { "guid": "555bd074-cc5b-4396-a7f8-5f03d336a8e5" }, "tools_specification": { "supported_kernels": [ { "name": "python3", "language": "python", "version": 3.9, "display_name": "Python 3.9" } ] } } }, "EnvironmentsEnvironmentsList": { "summary": "A list of environments", "value": { "total_results": 1, "resources": [ { "metadata": { "name": "my notebook environment", "description": "this is my notebook environment", "asset_type": "environment", "asset_id": "656ca7c3-d971-42c3-918b-a15023cd6b8e", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-10-12T09:18:34.000Z", "href": "/v2/environments/656ca7c3-d971-42c3-918b-a15023cd6b8e" }, "entity": { "environment": { "sub_type": "notebook", "display_name": "My Notebook Environment", "hardware_specification": { "metadata": { "name": "my hardware specification", "description": "this is my hardware specification", "asset_type": "hardware_specification", "asset_id": "2d5191ba-ff9b-4b48-a852-948d49dd9210", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "href": "/v2/hardware_specifications/2d5191ba-ff9b-4b48-a852-948d49dd9210" }, "entity": { "hardware_specification": { "nodes": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" }, "gpu": { "num_gpu": 2, "name": "v100", "gpu_profile": "generic", "mig_profile": "N/A" }, "num_nodes": 1, "num_drivers": 1, "drivers": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } } } } } }, "software_specification": { "metadata": { "name": "my software specification", "description": "this is my software specification", "asset_type": "software_specification", "asset_id": "555bd074-cc5b-4396-a7f8-5f03d336a8e5", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "life_cycle": { "deprecated": true, "wml": { "deprecated": false } }, "href": "/v2/software_specifications/555bd074-cc5b-4396-a7f8-5f03d336a8e5" }, "entity": { "software_specification": { "type": "derived", "display_name": "My Software Specification", "base_software_specification": { "guid": "ab9e1b80-f2ce-592c-a7d2-4f2344f77194" }, "package_extensions": [ { "metadata": { "name": "my package extension", "description": "this is my package extension", "asset_type": "package_extension", "asset_id": "461db2c9-effb-4bfb-8319-f4acf8ba06a3", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z" }, "entity": { "package_extension": { "type": "conda_yml", "interpreter": "mamba", "object_key": "package_extension/Package_Extension_9GShiX8H0.yml" } } } ], "software_configuration": { "included_packages": [ { "name": "ipython", "version": "7.22.0" } ], "platform": { "name": "spark", "version": 3.2 }, "language": { "name": "python", "version": 3.9 } } } } }, "tools_specification": { "supported_kernels": [ { "name": "python3", "language": "python", "version": 3.9, "display_name": "Python 3.9" } ] }, "runtime_definition": "204dac19-7d94-4692-a4c8-2acd77e28792", "spec_type": "referenced" } } } ] } }, "EnvironmentsEnvironmentUpdateBody": { "summary": "Update an environment", "value": { "/metadata/name": "my updated notebook environment", "/metadata/description": "this is my updated notebook environment", "/entity/environment/display_name": "My Updated Notebook Environment", "/entity/environment/hardware_specification": { "guid": "2d5191ba-ff9b-4b48-a852-948d49dd9210" }, "/entity/environment/software_specification": { "guid": "555bd074-cc5b-4396-a7f8-5f03d336a8e5" }, "/entity/environment/runtime_idle_time": 3600000, "/entity/environment/environment_variables": { "key1": "value1", "key2": "value2" }, "/entity/environment/config_variables": { "key3": "value3", "key4": "value4" }, "/entity/environment/tools_specification": { "supported_kernels": [ { "name": "python3", "language": "python", "version": 3.9, "display_name": "Python 3.9" } ] } } }, "EnvironmentsConflictError": { "value": { "trace": "b12692e1-8582-4628-88ca-7a13fefb73e2", "errors": [ { "code": "conflict", "message": "Document already exists." } ] } }, "EnvironmentsHardwareSpecification": { "summary": "A hardware specification", "value": { "metadata": { "name": "my hardware specification", "description": "this is my hardware specification", "asset_type": "hardware_specification", "asset_id": "2d5191ba-ff9b-4b48-a852-948d49dd9210", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "href": "/v2/hardware_specifications/2d5191ba-ff9b-4b48-a852-948d49dd9210" }, "entity": { "hardware_specification": { "nodes": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" }, "gpu": { "num_gpu": 2, "name": "v100", "gpu_profile": "generic", "mig_profile": "N/A" }, "num_nodes": 1, "num_drivers": 1, "drivers": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } } } } } } }, "EnvironmentsHardwareSpecificationCreateBody_2": { "summary": "Create a hardware specification for DataStage", "value": { "name": "my hardware specification", "description": "this is my hardware specification", "datastage": { "num_conductors": 1, "num_computes": 2, "conductor": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } }, "compute": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } }, "instance": "instance-1" } } }, "EnvironmentsHardwareSpecificationCreateBody_1": { "summary": "Create a hardware specification for Spark", "value": { "name": "my hardware specification", "description": "this is my hardware specification", "spark": { "num_drivers": 1, "num_executors": 2, "driver": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } }, "executor": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } } } } }, "EnvironmentsHardwareSpecificationCreateBody_0": { "summary": "Create a hardware specification for nodes", "value": { "name": "my hardware specification", "description": "this is my hardware specification", "nodes": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" }, "gpu": { "num_gpu": 2, "name": "v100", "gpu_profile": "generic", "mig_profile": "N/A" }, "num_nodes": 1, "num_drivers": 1, "drivers": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } } } } }, "EnvironmentsHardwareSpecificationsList": { "summary": "A list of hardware specifications", "value": { "total_results": 1, "resources": [ { "metadata": { "name": "my hardware specification", "description": "this is my hardware specification", "asset_type": "hardware_specification", "asset_id": "2d5191ba-ff9b-4b48-a852-948d49dd9210", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "href": "/v2/hardware_specifications/2d5191ba-ff9b-4b48-a852-948d49dd9210" }, "entity": { "hardware_specification": { "nodes": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" }, "gpu": { "num_gpu": 2, "name": "v100", "gpu_profile": "generic", "mig_profile": "N/A" }, "num_nodes": 1, "num_drivers": 1, "drivers": { "cpu": { "units": "100m", "model": "string" }, "mem": { "size": "8Gi" } } } } } } ] } }, "EnvironmentsHardwareSpecificationUpdateBody_2": { "summary": "Update a hardware specification for DataStage", "value": { "/metadata/name": "my hardware specification", "/metadata/description": "this is my hardware specification", "/entity/hardware_specification/datastage/num_conductors": 1, "/entity/hardware_specification/datastage/num_computes": 2, "/entity/hardware_specification/datastage/conductor/cpu/units": "100m", "/entity/hardware_specification/datastage/conductor/cpu/model": "string", "/entity/hardware_specification/datastage/conductor/mem/size": "8Gi", "/entity/hardware_specification/datastage/compute/cpu/units": "100m", "/entity/hardware_specification/datastage/compute/cpu/model": "string", "/entity/hardware_specification/datastage/compute/mem/size": "8Gi", "/entity/hardware_specification/datastage/instance": "instance-1" } }, "EnvironmentsHardwareSpecificationUpdateBody_1": { "summary": "Update a hardware specification for Spark", "value": { "/metadata/name": "my hardware specification", "/metadata/description": "this is my hardware specification", "/entity/hardware_specification/spark/num_drivers": 1, "/entity/hardware_specification/spark/num_executors": 2, "/entity/hardware_specification/spark/driver/cpu/units": "100m", "/entity/hardware_specification/spark/driver/cpu/model": "string", "/entity/hardware_specification/spark/driver/mem/size": "8Gi", "/entity/hardware_specification/spark/executor/cpu/units": "100m", "/entity/hardware_specification/spark/executor/cpu/model": "string", "/entity/hardware_specification/spark/executor/mem/size": "8Gi" } }, "EnvironmentsHardwareSpecificationUpdateBody_0": { "summary": "Update a hardware specification for nodes", "value": { "/metadata/name": "my hardware specification", "/metadata/description": "this is my hardware specification", "/entity/hardware_specification/nodes/cpu/units": "100m", "/entity/hardware_specification/nodes/cpu/model": "string", "/entity/hardware_specification/nodes/mem/size": "8Gi", "/entity/hardware_specification/nodes/gpu/num_gpu": 2, "/entity/hardware_specification/nodes/gpu/name": "v100", "/entity/hardware_specification/nodes/num_nodes": 1 } }, "EnvironmentsSoftwareSpecification": { "summary": "A software specification", "value": { "metadata": { "name": "my software specification", "description": "this is my software specification", "asset_type": "software_specification", "asset_id": "555bd074-cc5b-4396-a7f8-5f03d336a8e5", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "life_cycle": { "deprecated": true, "wml": { "deprecated": false } }, "href": "/v2/software_specifications/555bd074-cc5b-4396-a7f8-5f03d336a8e5" }, "entity": { "software_specification": { "type": "derived", "display_name": "My Software Specification", "base_software_specification": { "guid": "ab9e1b80-f2ce-592c-a7d2-4f2344f77194" }, "package_extensions": [ { "metadata": { "name": "my package extension", "description": "this is my package extension", "asset_type": "package_extension", "asset_id": "461db2c9-effb-4bfb-8319-f4acf8ba06a3", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z" }, "entity": { "package_extension": { "type": "conda_yml", "interpreter": "mamba", "object_key": "package_extension/Package_Extension_9GShiX8H0.yml" } } } ], "software_configuration": { "included_packages": [ { "name": "ipython", "version": "7.22.0" } ], "platform": { "name": "spark", "version": 3.2 }, "language": { "name": "python", "version": 3.9 } } } } } }, "EnvironmentsSoftwareSpecificationCreateBody_1": { "summary": "Create a base software specification", "value": { "name": "my software specification", "description": "this is my software specification", "package_extensions": [ { "guid": "b82b95df-fc3e-4273-98f7-473d62a03c2b" } ], "software_configuration": { "included_packages": [ { "name": "ipython", "version": "7.22.0" } ], "platform": { "name": "spark", "version": 3.2 }, "language": { "name": "python", "version": 3.9 } }, "purpose": [ "notebook", "wml" ], "life_cycle": { "deprecated": true, "wml": { "deprecated": false } } } }, "EnvironmentsSoftwareSpecificationCreateBody_0": { "summary": "Create a derived software specification", "value": { "name": "my software specification", "description": "this is my software specification", "package_extensions": [ { "guid": "b82b95df-fc3e-4273-98f7-473d62a03c2b" } ], "base_software_specification": { "guid": "ab9e1b80-f2ce-592c-a7d2-4f2344f77194" } } }, "EnvironmentsSoftwareSpecificationsList": { "summary": "A list of software specifications", "value": { "total_results": 1, "resources": [ { "metadata": { "name": "my software specification", "description": "this is my software specification", "asset_type": "software_specification", "asset_id": "555bd074-cc5b-4396-a7f8-5f03d336a8e5", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z", "purpose": [ "notebook", "wml" ], "life_cycle": { "deprecated": true, "wml": { "deprecated": false } }, "href": "/v2/software_specifications/555bd074-cc5b-4396-a7f8-5f03d336a8e5" }, "entity": { "software_specification": { "type": "derived", "display_name": "My Software Specification", "base_software_specification": { "guid": "ab9e1b80-f2ce-592c-a7d2-4f2344f77194" }, "package_extensions": [ { "metadata": { "name": "my package extension", "description": "this is my package extension", "asset_type": "package_extension", "asset_id": "461db2c9-effb-4bfb-8319-f4acf8ba06a3", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z" }, "entity": { "package_extension": { "type": "conda_yml", "interpreter": "mamba", "object_key": "package_extension/Package_Extension_9GShiX8H0.yml" } } } ], "software_configuration": { "included_packages": [ { "name": "ipython", "version": "7.22.0" } ], "platform": { "name": "spark", "version": 3.2 }, "language": { "name": "python", "version": 3.9 } } } } } ] } }, "EnvironmentsSoftwareSpecificationUpdateBody": { "summary": "Update a software specification", "value": { "/metadata/name": "my updated software specification", "/metadata/description": "this is my updated software specification.", "/entity/software_specification/display_name": "My Updated Software Specification.", "/entity/software_specification/package_extensions": [ { "guid": "b82b95df-fc3e-4273-98f7-473d62a03c2b" } ] } }, "EnvironmentsPackageExtensionWithSignedURL": { "value": { "metadata": { "name": "my package extension", "description": "this is my package extension", "asset_type": "package_extension", "asset_id": "461db2c9-effb-4bfb-8319-f4acf8ba06a3", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z" }, "entity": { "package_extension": { "type": "conda_yml", "interpreter": "mamba", "href": "/package_extension/Package_Extension_9GShiX8H0.yml" } } } }, "EnvironmentsPackageExtensionCreateBody": { "summary": "Create a package extension", "value": { "name": "my package extension", "description": "this is my package extension", "type": "conda_yml", "interpreter": "mamba" } }, "EnvironmentsPackageExtensionsList": { "summary": "A list of package extensions", "value": { "total_results": 1, "resources": [ { "metadata": { "name": "my package extension", "description": "this is my package extension", "asset_type": "package_extension", "asset_id": "461db2c9-effb-4bfb-8319-f4acf8ba06a3", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z" }, "entity": { "package_extension": { "type": "conda_yml", "interpreter": "mamba", "object_key": "package_extension/Package_Extension_9GShiX8H0.yml" } } } ] } }, "EnvironmentsPackageExtensionFull": { "value": { "metadata": { "name": "my package extension", "description": "this is my package extension", "asset_type": "package_extension", "asset_id": "461db2c9-effb-4bfb-8319-f4acf8ba06a3", "project_id": "b275be5f-10ff-47ee-bfc9-63f1ce5addbf", "space_id": "1fd6d4b5-d592-4de2-a3e6-ae53a42d75d0", "owner_id": "IBMid-310000SG2Y", "created_at": "2021-08-02T12:00:24.269Z", "updated_at": "2021-08-02T12:00:24.269Z" }, "entity": { "package_extension": { "type": "conda_yml", "interpreter": "mamba", "object_key": "package_extension/Package_Extension_9GShiX8H0.yml", "href": "/package_extension/Package_Extension_9GShiX8H0.yml" } } } }, "EnvironmentsPackageExtensionUpdateBody": { "summary": "Update a package extension", "value": { "/metadata/name": "my updated package extension", "/metadata/description": "this is my updated package extension", "/entity/package_extension/type": "pip_zip" } }, "EnvironmentsRuntimeDefinition": { "summary": "A runtime definition", "value": { "metadata": { "guid": "c82b95df-fc3e-4273-98f7-473d62a03c2b", "created_at": "2021-07-01T00:00:00.000Z", "updated_at": "2021-07-01T00:00:00.000Z" }, "entity": { "name": "jupyter-py39", "display_name": "Runtime 22.1 on Python 3.9", "description": "Runtime 22.1 on Python 3.9", "project": "103d3fc4-2e46-4581-a23a-b4484e13519e", "author": "IBM", "tested": true, "is_service": true, "runtime_type": "jupyter-py39" } } }, "EnvironmentsRuntimeDefinitionCreateBody": { "summary": "Create a runtime definition", "value": { "name": "jupyter-py39", "display_name": "Runtime 22.1 on Python 3.9", "description": "Runtime 22.1 on Python 3.9", "author": "IBM", "tested": true, "is_service": true, "runtime_type": "jupyter-py39" } }, "EnvironmentsRuntimeDefinitionsList": { "summary": "A list of runtime definitions", "value": { "total_results": 1, "resources": [ { "metadata": { "guid": "c82b95df-fc3e-4273-98f7-473d62a03c2b", "created_at": "2021-07-01T00:00:00.000Z", "updated_at": "2021-07-01T00:00:00.000Z" }, "entity": { "name": "jupyter-py39", "display_name": "Runtime 22.1 on Python 3.9", "description": "Runtime 22.1 on Python 3.9", "project": "103d3fc4-2e46-4581-a23a-b4484e13519e", "author": "IBM", "tested": true, "is_service": true, "runtime_type": "jupyter-py39" } } ] } }, "EnvironmentsRuntimeDefinitionUpdateBody": { "summary": "Update a runtime definition", "value": { "name": "jupyter-py39", "display_name": "Runtime 22.1 on Python 3.9", "description": "Runtime 22.1 on Python 3.9", "author": "IBM", "tested": true, "is_service": true, "runtime_type": "jupyter-py39" } }, "EnvironmentsRuntimeDefinitionNotFound": { "value": { "trace": "b12692e1-8582-4628-88ca-7a13fefb73e2", "errors": [ { "code": "runtime_definition_not_found", "message": "DocumentNotFound" } ] } } }, "responses": { "EnvironmentsHTTP429Response": { "description": "The number of requests has exceeded the rate limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsErrorDefinition" }, "examples": { "RateLimitError": { "$ref": "#/components/examples/EnvironmentsRateLimitError" } } } } }, "EnvironmentsHTTP403Response": { "description": "Forbidden. User is not allowed to perform the target operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsErrorDefinition" }, "examples": { "AuthorizationError": { "$ref": "#/components/examples/EnvironmentsAuthorizationError" } } } } }, "EnvironmentsHTTP401Response": { "description": "Unauthorized. No/Malformed authentication provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsErrorDefinition" }, "examples": { "AuthenticationError": { "$ref": "#/components/examples/EnvironmentsAuthenticationError" } } } } }, "EnvironmentsHTTP400Response": { "description": "Bad request. One of the fields has invalid format/content.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsErrorDefinition" }, "examples": { "BadRequestError": { "$ref": "#/components/examples/EnvironmentsBadRequestError" } } } } }, "EnvironmentsEnvironmentCreateResponse": { "description": "Success. Created and returned a new environment asset. Format follows v2/assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsEnvironment" }, "examples": { "Environment": { "$ref": "#/components/examples/EnvironmentsEnvironment" } } } } }, "EnvironmentsEnvironmentsListResponse": { "description": "Success. Returned a list of environments. Format follows v2/assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsEnvironmentsList" }, "examples": { "EnvironmentsList": { "$ref": "#/components/examples/EnvironmentsEnvironmentsList" } } } } }, "EnvironmentsEnvironmentUpdateResponse": { "description": "Success. Updated the environment." }, "EnvironmentsEnvironmentDeleteResponse": { "description": "Success. The environment is deleted." }, "EnvironmentsEnvironmentRetrieveResponse": { "description": "Success. Returned the environment. Format follows v2/assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsEnvironment" }, "examples": { "Environment": { "$ref": "#/components/examples/EnvironmentsEnvironment" } } } } }, "EnvironmentsHTTP409Response": { "description": "Conflict. Specification already exists with given name. Restriction applicable only for global specifications.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsErrorDefinition" }, "examples": { "ConflictError": { "$ref": "#/components/examples/EnvironmentsConflictError" } } } } }, "EnvironmentsHardwareSpecificationCreateResponse": { "description": "Success. Created and returned a new hardware specification asset. Format follows v2/assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecification" }, "examples": { "HardwareSpecification": { "$ref": "#/components/examples/EnvironmentsHardwareSpecification" } } } } }, "EnvironmentsHardwareSpecificationsListResponse": { "description": "Success. Returned a list of hardware specifications. Format follows v2/assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecificationsList" }, "examples": { "HardwareSpecificationsList": { "$ref": "#/components/examples/EnvironmentsHardwareSpecificationsList" } } } } }, "EnvironmentsHardwareSpecificationUpdateResponse": { "description": "Success. Updated the hardware specification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecification" }, "examples": { "HardwareSpecification": { "$ref": "#/components/examples/EnvironmentsHardwareSpecification" } } } } }, "EnvironmentsHardwareSpecificationDeleteResponse": { "description": "Success. The hardware specification is deleted." }, "EnvironmentsHardwareSpecificationRetrieveResponse": { "description": "Success. Returned the hardware specification. Format follows v2/assets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsHardwareSpecification" }, "examples": { "HardwareSpecification": { "$ref": "#/components/examples/EnvironmentsHardwareSpecification" } } } } }, "EnvironmentsSoftwareSpecificationCreateResponse": { "description": "Success. Created and returned a new software specification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecification" }, "examples": { "SoftwareSpecification": { "$ref": "#/components/examples/EnvironmentsSoftwareSpecification" } } } } }, "EnvironmentsSoftwareSpecificationsListResponse": { "description": "Success. Returned a list of software specifications.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecificationsList" }, "examples": { "SoftwareSpecificationsList": { "$ref": "#/components/examples/EnvironmentsSoftwareSpecificationsList" } } } } }, "EnvironmentsSoftwareSpecificationDeleteResponse": { "description": "Success. Deleted the software specification." }, "EnvironmentsSoftwareSpecificationRetrieveResponse": { "description": "Success. Returned the given software specification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsSoftwareSpecification" }, "examples": { "SoftwareSpecification": { "$ref": "#/components/examples/EnvironmentsSoftwareSpecification" } } } } }, "EnvironmentsSoftwareSpecificationUpdateResponse": { "description": "Success. Updated the software specification." }, "EnvironmentsSoftwareSpecificationRemovePackageExtensionResponse": { "description": "Success. Removed the package extension from the software specification." }, "EnvironmentsSoftwareSpecificationAddPackageExtensionResponse": { "description": "Success. Added the package extension to the software specification." }, "EnvironmentsPackageExtensionCreateResponse": { "description": "Success. Created and returned a new package extension.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionWithSignedURL" }, "examples": { "PackageExtensionWithSignedURL": { "$ref": "#/components/examples/EnvironmentsPackageExtensionWithSignedURL" } } } } }, "EnvironmentsPackageExtensionsListResponse": { "description": "Success. Returned a list of Package Extensions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionsList" }, "examples": { "PackageExtensionsList": { "$ref": "#/components/examples/EnvironmentsPackageExtensionsList" } } } } }, "EnvironmentsPackageExtensionUploadCompleteResponse": { "description": "Success. Marked the upload complete, the package extension is now usable." }, "EnvironmentsPackageExtensionDeleteResponse": { "description": "Success. Deleted the package extension." }, "EnvironmentsPackageExtensionRetrieveResponse": { "description": "Success. Returned the given package extension.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsPackageExtensionFull" }, "examples": { "PackageExtensionFull": { "$ref": "#/components/examples/EnvironmentsPackageExtensionFull" } } } } }, "EnvironmentsPackageExtensionUpdateResponse": { "description": "Success. Updated the pacakge extension." }, "EnvironmentsRuntimeDefinitionCreateResponse": { "description": "Success. Created and returned a new runtime definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinition" }, "examples": { "RuntimeDefinition": { "$ref": "#/components/examples/EnvironmentsRuntimeDefinition" } } } } }, "EnvironmentsRuntimeDefinitionsListResponse": { "description": "Success. Returned a list of runtime definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinitionsList" }, "examples": { "RuntimeDefinitionsList": { "$ref": "#/components/examples/EnvironmentsRuntimeDefinitionsList" } } } } }, "EnvironmentsRuntimeDefinitionDeleteResponse": { "description": "Success. Deleted the runtime definition." }, "EnvironmentsRuntimeDefinitionUpdateResponse": { "description": "Success. Updated and returned a runtime definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsRuntimeDefinition" }, "examples": { "RuntimeDefinition": { "$ref": "#/components/examples/EnvironmentsRuntimeDefinition" } } } } }, "EnvironmentsHTTP404Response": { "description": "Not found. The requested resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsErrorDefinition" }, "examples": { "NotFoundError": { "$ref": "#/components/examples/EnvironmentsRuntimeDefinitionNotFound" } } } } }, "EnvironmentsRuntimeDefinitionRetrieveResponse": { "description": "Success. Returned the given runtime definition." }, "ProjectsHTTP429QueryResponse": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "429", "error": "Too Many Requests", "reason": "The number of requests has exceeded the rate limit. Requests: 61. Limit: 60. Category: query. Subject: zapp.brannigan@ibm.com (IBMid-55000353XF).", "message": "The client has sent too many requests in a given amount of time." } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP403Response": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "403", "error": "Forbidden", "reason": "Permission Denied: Authenticated user is not a member of the project: zapp.brannigan@ibm.com.", "message": "The target operation is strictly forbidden due to schema constraints." } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP401Response": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "401", "error": "Unauthorized", "reason": "Unable to verify token via IAM Auth server.", "message": "Authentication failed." } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsGetProjectsResponse": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjects" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP429ReadResponse": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "429", "error": "Too Many Requests", "reason": "The number of requests has exceeded the rate limit. Requests: 601. Limit: 600. Category: read. Subject: zapp.brannigan@ibm.com (IBMid-55000353XF).", "message": "The client has sent too many requests in a given amount of time." } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP400Response": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "400", "error": "Bad Request", "reason": "Entity body.name contains invalid characters.", "message": "The server cannot or will not process the request due to an apparent client error." } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsGetProjectTotalResponse": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjectTotal" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP429WriteResponse": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "429", "error": "Too Many Requests", "reason": "The number of requests has exceeded the rate limit. Requests: 451. Limit: 450. Category: write. Subject: zapp.brannigan@ibm.com (IBMid-55000353XF).", "message": "The client has sent too many requests in a given amount of time." } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP404Response": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "404", "error": "Not Found", "reason": "Failed to retrieve project: 47f11f98-1fc2-4478-ba38-d037094e761f.", "message": "The requested resource could not be found." } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsGetProjectResponse": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProject" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP204Response": { "description": "No Content", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsGetMembersResponse": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjectMembers" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsGetMemberResponse": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProjectsProjectMember" }, { "type": "object", "properties": { "derived": { "$ref": "#/components/schemas/ProjectsMemberDerived" } } } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsHTTP422Response": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsHTTPErrorResponse" }, "example": { "code": "422", "error": "Unprocessable Entity", "reason": "The number of projects created by the authenticated user exceeds the designated limit. Projects created by user (101) > Projects per user limit (100).", "message": "The request was well-formed but was unable to be followed due to semantic errors.", "id": "WSCPA0001E" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsUpdateTagsResponse": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjectTags" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsCreateTagsResponse": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjectTags" } } }, "headers": { "Location": { "$ref": "#/components/headers/ProjectsLocationHeader" }, "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsListTagsResponse": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsProjectTags" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "ProjectsGetFoldersResponse": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsSettingsGroupFolders" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/ProjectsRateLimitLimitHeader" }, "RateLimit-Remaining": { "$ref": "#/components/headers/ProjectsRateLimitRemainingHeader" }, "RateLimit-Reset": { "$ref": "#/components/headers/ProjectsRateLimitResetHeader" } } }, "TransactionalProjectsHTTP500Response": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsHTTPErrorResponse" }, "example": { "code": "500", "error": "Internal Server Error", "reason": "Error creating project: 522d3ffe-0787-4bee-a616-dc12a19c9a76", "message": "The API encountered an unexpected condition which prevented it from fulfilling the request.", "description": "[500] Internal Server Error: Error creating project: 522d3ffe-0787-4bee-a616-dc12a19c9a76." } } } }, "TransactionalProjectsHTTP404Response": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsHTTPErrorResponse" }, "example": { "code": "404", "error": "Not Found", "reason": "Transaction 09f5e19b-5a30-428d-95f4-ff93590f3c071 is not associated with project 522d3ffe-0787-4bee-a616-dc12a19c9a76", "message": "Resource requested by the client was not found.", "description": "[404] Not Found: Transaction 09f5e19b-5a30-428d-95f4-ff93590f3c071 is not associated with project 522d3ffe-0787-4bee-a616-dc12a19c9a76. Resource requested by the client was not found." } } } }, "TransactionalProjectsHTTP403Response": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsHTTPErrorResponse" }, "example": { "code": "403", "error": "Forbidden", "reason": "Invalid bearer token: Access token is invalid.", "message": "The target operation is strictly forbidden due to schema constraints.", "description": "[403] Forbidden: Invalid bearer token: Access token is invalid. The target operation is strictly forbidden due to schema constraints." } } } }, "TransactionalProjectsHTTP401Response": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsHTTPErrorResponse" }, "example": { "code": "401", "error": "Unauthorized", "reason": "Unable to verify token via IAM Auth server.", "message": "Authentication failed.", "description": "[401] Unauthorized: Authentication failed." } } } }, "TransactionalProjectsHTTP400Response": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsHTTPErrorResponse" }, "example": { "code": "400", "error": "Bad Request", "reason": "Error fetching projects. Status code: 400", "message": "The server cannot or will not process the request due to an apparent client error (e.g. malformed request syntax).", "description": "[400] Bad Request: Error fetching projects. Status code: 400. The server cannot or will not process the request due to an apparent client error (e.g. malformed request syntax)." } } } }, "TransactionalProjectsCreateImportTransactionProjectResponse": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsCreateImportTransactionProjectResponse" }, "example": { "location": "/v2/projects/b2549f22-7565-4193-9434-9b77e15757cc", "transaction_detail": { "id": "dcff12a9-3f9e-4d10-b4c4-f121f681d81b", "links": { "self": "/transactional/v2/projects/b2549f22-7565-4193-9434-9b77e15757cc/transactions/dcff12a9-3f9e-4d10-b4c4-f121f681d81b" } } } } } }, "TransactionalProjectsCreateTransactionProjectResponse": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionalProjectsCreateTransactionProjectResponse" }, "example": { "location": "/v2/projects/b2549f22-7565-4193-9434-9b77e15757cc" } } } } }, "headers": { "ProjectsRateLimitResetHeader": { "description": "The number of seconds remaining within the current time-window before it resets.", "schema": { "type": "integer", "example": 3600 } }, "ProjectsRateLimitRemainingHeader": { "description": "The number of client requests remaining within the current time-window.", "schema": { "type": "integer", "example": 599 } }, "ProjectsRateLimitLimitHeader": { "description": "The number of client requests allowed within the current time-window.", "schema": { "type": "integer", "example": 600 } }, "ProjectsLocationHeader": { "description": "Indicates the resource URL for redirection or after resource creation.", "schema": { "type": "string", "example": "/v2/projects/d122ffba-de9e-4c67-89c4-0091f1610076/tags" } } } } }