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

The desired representation for the response.

Accept

indexId

Information about search index definition

Search Index Definition

Content-Type

A tag that identifies this revision of the object.

Etag

The time stamp in `EEE, dd MMM yyyy HH:mm:ss GMT` format when the object was last modified.

Last-Modified

The request could not be processed. When available, the error
response will contain additional details.


Error

application/vnd.sas.error

Bad request (the request is not well-formed).

Unauthorized. This request requires valid authentication.

The user does not have permission to complete this request.

The header field "Accept" does not have a supported value.

Not Acceptable. Include an Accept header with a supported value on the request.

Get a Search Index Definition by its ID

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

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.


Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	Bad request (the request is not well-formed).		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
406	Not Acceptable	Not Acceptable. Include an Accept header with a supported value on the request.		Schema

Get a Search Index Definition by its ID

Request Samples

Response Samples

Path Parameters

Header Parameters

Responses