data_management

2024.11

2024.12

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


Catalog

2024.03

2023.10

2024.10

2024.08

2024.09

Get the headers for an Agent's execution history by its ID.

The desired representation for the response.

Accept

The desired item representation, the default is application/vnd.sas.metadata.bot.history+json.

Accept-Item

agentId

0-based Offset of first object to return.  Defaults to 0.

start

Maximum number of objects to return.  Defaults to 10.

limit

Filter criteria for returned objects. See [Filtering in REST APIs](https://developer.sas.com/rest-apis/catalog-v2/docs/getting-started/usage-notes#filtering).

filter

Content-Type

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.

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.

Get the headers for an Agent's execution history

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

Information about the contents of the Catalog

Catalog Statistics

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

Search Result Collection

Search Result

Facet Collection

Search Facet

Suggestion Collection

Instance Collection

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

Instance

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

Entity Instance

The classification in metadata used to categorize entities.

Classification Instance

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

Relationship 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

Parameters used to retrieve instance archive.

Archive Parameters

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

JSONPatch document

This is a collection of Type Definitions.

Type Definition Collection

A lightweight representation of a Type definition.


Type Definition Summary

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

Attribute Type Definition

Classification Type Definition is a representation of a Classification Definition.

Classification Type Definition

Entity Type Definition is a representation of a Entity Definition.

Entity Type Definition

Relationship Type Definition is a representation of a Relationship Definition.

Relationship Type Definition

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.


Type Definition Archive

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

Attribute Definition

Search Index Collection

Information about search index definition

Search Index Definition

View Collection

View Definition

Agent Collection

Agent Summary

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

A Catalog agent with scheduling information.

Scheduled Agent

Used to preview the enumeration phase of a bot run.

Agent Preview

Agent History Collection

Agent History is used to report agent execution metrics.

Agent History

Adhoc Analysis Job

Adhoc Analysis Job Collection

Tag Collection

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


Name	Type	Required	Description
filter	string<filter-criteria>	false	Filter criteria for returned objects. See Filtering in REST APIs.
limit	integer	false	Maximum number of objects to return. Defaults to 10.
start	integer	false	0-based Offset of first object to return. Defaults to 0.

Name	Type	Required	Description
Accept	string	false	The desired representation for the response. Allowed values: application/vnd.sas.collection+jsonapplication/json Default: application/vnd.sas.collection+json
Accept-Item	string	false	The desired item representation, the default is application/vnd.sas.metadata.bot.history+json. Allowed values: application/vnd.sas.metadata.bot.history+jsonapplication/json Default: application/vnd.sas.metadata.bot.history+json

Status	Meaning	Description
200	OK	The request succeeded.	Headers
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
415	Unsupported Media Type	Unsupported Media Type. Include a Content-Type header with a supported value in the request.		Schema

Get the headers for an Agent's execution history

Request Samples

Response Samples

Path Parameters

Query Parameters

Header Parameters

Responses