Introduction to common core functionality APIs for Data and AI SaaS products You can use the common core functionality REST APIs for Data and AI SaaS products to work with assets and their workspaces:
| Method | Path | Summary |
|---|---|---|
| Archive the asset container | ||
| Get archive information of the asset container | ||
| Get configurations | ||
| Replace or create configurations | ||
| Restore the asset container | ||
| List all asset lists defined for an account | ||
| Create a new asset list | ||
| Delete asset lists | ||
| Retrieve an asset list identified by ID | ||
| Delete an asset list identified by ID | ||
| Update the metadata of an asset list | ||
| List the items of an asset list identified by ID | ||
| Retrieve an item in an asset list | ||
| Update an asset list item | ||
| Searches for relationship types | ||
| Creates an asset relationship type | ||
| Searches for relationship type ends | ||
| Finds relationship types that are used by an asset, column or governance artifact | ||
| deleteRelationshipType | ||
| Patches a relationship type | ||
| List all asset types defined for an account, catalog, project or space. | ||
| Creates an asset type in an account, catalog, project or space. | ||
| Retrieves an asset type of a given name. | ||
| Replace an asset type | ||
| Deletes an asset type | ||
| Finds relationship types for an asset type | ||
| Search for asset metadata within assets of the specified type | ||
| Get the status of an account scope or global scope asset type. | ||
| Create an asset | ||
| Get one or more assets. | ||
| Marks existing assets for delete | ||
| Copies one or more assets and, if deep copy option is on, their related assets from a source container to a target container. | ||
| Create one or more assets. | ||
| Patch one or more assets. | ||
| Gets the status of asset copy operation | ||
| Create a PUT signed url for an object or a file | ||
| Gets the status of a deep copy operation | ||
| Bulk search duplicate assets | ||
| Search duplicate assets | ||
| Get an ibm_data_source asset | ||
| Publish an asset from a project which is only referenced in that project | ||
| Get an asset | ||
| Marks an existing asset for delete | ||
| Update an asset | ||
| Clone an asset | ||
| Add/Update asset collaborators | ||
| Deep copies an asset and its related assets to a catalog, project, or space | ||
| Update the owner of an asset | ||
| Example Update Asset ROV Mode response. | ||
| Promote an asset | ||
| Publish an asset | ||
| Finds related assets | ||
| Searches for relationships | ||
| Create asset relationships | ||
| Deletes asset relationships | ||
| Finds relationship types used by an asset | ||
| Finds related assets | ||
| Create asset relationships | ||
| Deletes asset relationships | ||
| Determine if a relationship exists between an asset and a target asset or governance artifact | ||
| Determine if a relationship exists between an asset and a target asset or governance artifact | ||
| Create an attachment | ||
| Get an attachment | ||
| Delete an attachment | ||
| Update attachment metadata | ||
| Mark an attachment as transfer complete | ||
| Auto update attachment's datasource_type from connection asset | ||
| Get resources info for an attachment | ||
| Increase resources for an attachment | ||
| List all attributes | ||
| Create an attribute | ||
| Get an attribute | ||
| Delete an attribute | ||
| Update attributes | ||
| Get asset document conflicts | ||
| Delete asset document conflicts | ||
| Get the image of asset | ||
| Upload an image for asset | ||
| Delete the image of asset | ||
| Get asset or column notes | ||
| Create notes on an asset | ||
| Get an asset or column note | ||
| Delete an asset or a column note | ||
| Update an asset or column note | ||
| Get ratings of an asset | ||
| Rate an asset | ||
| Get the count of each rating value for the specified asset | ||
| Delete an asset rating | ||
| Use this API to update an asset rating. | ||
| Get a list of revisions for an asset | ||
| Commit a revision of an asset | ||
| Delete a revision | ||
| List all catalogs for a specific account | ||
| Create a catalog | ||
| Retrieve the default catalog | ||
| Create the default catalog | ||
| Rehome one or more synced assets. | ||
| Monitor status of rehome task | ||
| Get a catalog by catalog ID | ||
| Delete a catalog by catalog ID | ||
| Update catalog | ||
| List all properties of a catalog | ||
| Update catalog properties | ||
| Get a single property in a catalog | ||
| Update catalog connections | ||
| Get the catalog state | ||
| Export as a zip file containing appropriate csv files for the selected assets | ||
| Process an import asset | ||
| Request temporary security credentials | ||
| List all members of the catalog | ||
| Add members to a catalog | ||
| Delete members from a catalog | ||
| Create a data asset | ||
| Get a data asset | ||
| Get columns of a data asset | ||
| Create a folder asset | ||
| Get a folder asset | ||
| Get a signed URL of an item to be downloaded | ||
| List all assets in the trash (Marked for delete) | ||
| Get count of all assets in the trash (Marked for delete) | ||
| Delete all assets from trash | ||
| Get a soft-deleted object from trash | ||
| Delete an asset from the trash | ||
| Restore an asset from the trash | ||
| List defined connections | ||
| Define connection | ||
| Get connection | ||
| Delete connection | ||
| Update connection | ||
| Discover assets | ||
| Discover assets | ||
| Discover data asset | ||
| List actions | ||
| Perform action | ||
| Download a custom JDBC driver jar file | ||
| Upload a custom JDBC driver jar file (deprecated - use /v2/connections/streamed_files instead) | ||
| Delete a custom JDBC driver jar file | ||
| List custom JDBC drivers jar files | ||
| List defined types of data sources | ||
| Define data source type | ||
| Get details for type of data source | ||
| Delete data source type | ||
| Update datasource type | ||
| List environments. | ||
| Create a new environment. | ||
| Retrieve an environment. | ||
| Delete an environment. | ||
| Update an environment. | ||
| List hardware specifications. | ||
| Create a new hardware specification. | ||
| Retrieve a hardware specification. | ||
| Delete a hardware specification. | ||
| Update a hardware specification. | ||
| List software specifications. | ||
| Create a new software specification. | ||
| Update a software specification. | ||
| Retrieve a software specification. | ||
| Delete a software specification. | ||
| Add a package extension to a software specification. | ||
| Remove a package extension from a software specification. | ||
| List package extensions. | ||
| Create a new package extension. | ||
| Mark file upload complete. | ||
| Update a package extension. | ||
| Retrieve a package extension. | ||
| Delete a package extension. | ||
| A update operation allowing you to update artifacts based on a simple query. | ||
| Execute a query based on the Lucene Syntax | ||
| Structured search query conforming to the Elasticsearch Domain Specific Language. | ||
| This API will return all available pre search filters | ||
| Get list of jobs under a project or a space. | ||
| Create a new job. | ||
| Get the information of job identified by the ID. | ||
| Delete a specific job. | ||
| Update information of a job. | ||
| Get the availability of a given serving_name | ||
| Get list of runs of a job. | ||
| Start a run for a job. | ||
| Get a specific run of a job. | ||
| Delete a run. | ||
| Retrieve runtime log of a run. | ||
| Cancel a run. | ||
| Pause a run. | ||
| Resume a run. | ||
| List projects | ||
| Get project total | ||
| Get project | ||
| Update project | ||
| List members | ||
| Create members | ||
| Delete members | ||
| Update members | ||
| Get member | ||
| Delete member | ||
| Update project storage properties | ||
| List tags | ||
| Create tags | ||
| Delete tags | ||
| Update tags | ||
| Create tag | ||
| Delete tag | ||
| Get audit events settings | ||
| Update audit events settings | ||
| Get access restrictions settings | ||
| Update access restrictions settings | ||
| Get folders settings | ||
| Update folders settings | ||
| Get JupyterLab integration | ||
| Update JupyterLab integration | ||
| Delete JupyterLab integration | ||
| List tokens | ||
| Create token | ||
| Revoke all tokens | ||
| Get token | ||
| Revoke token | ||
| Introspect token | ||
| Create a new space | ||
| Retrieve the spaces | ||
| Retrieve the space | ||
| Delete the space | ||
| Update the space | ||
| Retrieve the space members | ||
| Add a member to space | ||
| Retrieve the space member information | ||
| Remove the space member | ||
| Update the space member | ||
| Retrieve the asset exports | ||
| Start the asset export process | ||
| Cancel the asset export process | ||
| Retrieve the asset export | ||
| Download the asset export content | ||
| Retrieve the asset imports | ||
| Start the asset import process | ||
| Cancel the asset import process | ||
| Retrieve the asset import | ||
| Create project as a transaction | ||
| Delete project as a transaction | ||
| Get status of import transaction |