data_management

2025.08

2025.09

2025.10

2025.03

2025.11

2025.07

The Catalog API allows for the discovery, creation, and integration of metadata. This allows management of information about other information.


Catalog

2024.09

2024.03

Delete multiple objects based on a list of URIs.
This endpoint currently only supports deleting agents, instances, and locks; type definitions and search index definitions are not supported.


This request demonstrates deleting both an agent and a library instance. This is one way to remove an agent and the content introduced by the agent in a single request.

Selection

application/vnd.sas.selection

Content-Type

The desired representation for the response.

Accept

This response demonstrates a successful delete of the requested objects. If an error had occurred, the map value would contain error details.

The request succeeded, and the content's `resources` were empty or at least one of the `resources` was deleted successfully.  The response body is a mapping from each value in the `resources` of the content to an empty object if that deletion succeeded, or the error for that deletion if that deletion failed. If at least one deletion succeeded, errors for individual deletions do not result in an error status for the whole response.

A map from object ids to the individual errors for each object's operation.

Bad request; either the request is not well-formed, or all individual
operations failed.  In the latter case, the response body is an object
containing the errors as described above for a successful request; the
response code is 400 if all operation status codes are not the same, or
the shared status code if they are the same.


Unauthorized. This request requires valid authentication.

Error

application/vnd.sas.error

The user does not have permission to complete this request.

The header field "Content-Type" does not have a supported value.

Unsupported Media Type. Include a Content-Type header with a supported value in the request.

The Catalog service encountered an error.

Delete multiple objects based on a list of URIs

Adhoc Analysis Job

Adhoc Analysis Job Collection

A Catalog agent representation.
Note that this representation and a scheduled agent representation can refer to the same object. If the agent properties must be updated but the schedules do not, use this representation; the absence of scheduled triggers in this representation will not remove any schedules associated with the agent.


Agent

Agent Collection

Agent History is used to report agent execution metrics.

Agent History

Agent History Collection

Used to preview the enumeration phase of a bot run.

Agent Preview

Agent Summary

The list of links to top-level resources and operations available from the root of the API.

Parameters used to retrieve instance archive.

Archive Parameters

An Attribute Definition describes properties that can be managed in an Instance.

Attribute Definition

Attribute Type Definition is a representation of a property type maintained by a Type Definition.

Attribute Type Definition

Information about the contents of the Catalog

Catalog Statistics

The classification in metadata used to categorize entities.

Classification Instance

Classification Type Definition is a representation of a Classification Definition.

Classification Type Definition

The entity object in metadata with a resourceId to describe the source of metadata.

Entity Instance

Entity Type Definition is a representation of a Entity Definition.

Entity Type Definition

Facet Collection

The basic metadata attributes present on all instances with pointer to definition.

Instance

Collection of instance-related objects, separated by type. On input, the instances are created, updated, or deleted as appropriate; On output, the resulting object from the operation or an error is returned.

Instance Archive

Instance Collection

A JSONPatch document containing the path of the item to add or remove.

JSONPatch document

Lock

Lock Collection

Lock Update

The instance of a relationship definition which relates two entities or classifications.

Relationship Instance

Relationship Type Definition is a representation of a Relationship Definition.

Relationship Type Definition

A Catalog agent with scheduling information.

Scheduled Agent

Search Facet

Search Index Collection

Information about search index definition

Search Index Definition

Search Result

A collection of search results. Similar to a resource collection, but introduces a maxScore member.

Search Result Collection

Suggestion Collection

Information about a tag. Currently tags only supports tagging entities. Only `/catalog/instances/{id}` is accepted for the template property within members.


Tag Collection

An archive containing sets of JSON Patch operations to apply to Tags.

Tag Patch Archive

Type Definition Archive provides a structure containing the Attribute, Classification, Entity, and Relationship Type Definitions in the Catalog. This is typically used if the entire model is needed, or as an export format.


Name	Type	Required	Description
Content-Type	string	true	The representation in the request body. Allowed values: application/vnd.sas.selection+jsonapplication/json Default: application/vnd.sas.selection+json
Accept	string	false	The desired representation for the response. Allowed value: application/json Default: application/json

Name	Type	Required	Description
version	integer	true	The schema version number of this media type. This representation is version 1.
template	string	false	A URI template in which the {id} parameter can be replaced with a value from the "resources" array in order to yield the URI of the identified resource.
type	string	false	Specifies whether the resources array contains IDs, URIs, or both. Allowed values: idurimixed
resources	array [string]	true	An array of resource IDs or URIs
links	array [Link]	false	An array of links to related resources and actions.

Status	Meaning	Description
200	OK	The request succeeded, and the content's `resources` were empty or at least one of the `resources` was deleted successfully. The response body is a mapping from each value in the `resources` of the content to an empty object if that deletion succeeded, or the error for that deletion if that deletion failed. If at least one deletion succeeded, errors for individual deletions do not result in an error status for the whole response.	Headers	Schema
400	Bad Request	Bad request; either the request is not well-formed, or all individual operations failed. In the latter case, the response body is an object containing the errors as described above for a successful request; the response code is 400 if all operation status codes are not the same, or the shared status code if they are the same.		Schema
401	Unauthorized	Not authenticated.		Schema
403	Forbidden	The user does not have permission to complete this request.		Schema
404	Not Found	The specified resource was not found.		Schema
415	Unsupported Media Type	Unsupported Media Type. Include a Content-Type header with a supported value in the request.		Schema
500	Internal Server Error	The Catalog service encountered an error.		Schema

Delete multiple objects based on a list of URIs

Request Samples

Response Samples

Header Parameters

Request Body

Responses