Collate Announcements API
Time-bound notifications for data assets
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/collate:collate-announcements-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: OpenMetadata Announcements API
description: Common types and API definition for OpenMetadata
contact:
name: OpenMetadata
url: https://open-metadata.org
email: openmetadata-dev@googlegroups.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 2.0.5
servers:
- url: /api
description: Current Host
- url: http://localhost:8585/api
description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: Announcements
description: Time-bound notifications for data assets
paths:
/v1/announcements:
get:
tags:
- Announcements
summary: List announcements
description: Get a list of announcements with optional filters.
operationId: listAnnouncements
parameters:
- name: fields
in: query
description: Fields to include in response
schema:
type: string
- name: entityLink
in: query
description: Filter by entity link
schema:
type: string
- name: status
in: query
description: Filter by status
schema:
type: string
enum:
- Active
- Expired
- Scheduled
- name: active
in: query
description: Filter active announcements
schema:
type: boolean
- name: domain
in: query
description: Filter by domain FQN
schema:
type: string
- name: limit
in: query
description: Limit the number results
schema:
maximum: 1000000
minimum: 0
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list before this cursor
schema:
type: string
- name: after
in: query
description: Returns list after this cursor
schema:
type: string
- name: include
in: query
description: Include deleted announcements
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
responses:
'200':
description: List of announcements
content:
application/json:
schema:
$ref: '#/components/schemas/AnnouncementList'
put:
tags:
- Announcements
summary: Create or update an announcement
operationId: createOrUpdateAnnouncement
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAnnouncement'
responses:
'200':
description: The announcement
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
post:
tags:
- Announcements
summary: Create an announcement
operationId: createAnnouncement
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAnnouncement'
responses:
'200':
description: The created announcement
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
/v1/announcements/{id}:
get:
tags:
- Announcements
summary: Get an announcement by ID
operationId: getAnnouncementById
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: fields
in: query
schema:
type: string
- name: include
in: query
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
responses:
'200':
description: The announcement
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
delete:
tags:
- Announcements
summary: Delete an announcement
operationId: deleteAnnouncement
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: hardDelete
in: query
schema:
type: boolean
default: false
responses:
'200':
description: Announcement deleted
patch:
tags:
- Announcements
summary: Update an announcement
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchAnnouncement
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
responses:
default:
description: default response
content:
application/json: {}
/v1/announcements/{id}/context:
get:
tags:
- Announcements
summary: Get the AI context for an entity by id
description: Retrieve the LLM-ready AI Context (Context Profile) for the entity — its attached business knowledge (glossary terms, Context Center articles, applied metrics), type-specific structural context, and depth-1 lineage — as an OKF-style markdown document (default) or the structured AIContext JSON (`?format=json`).
operationId: getEntityAiContextById_36
parameters:
- name: id
in: path
description: Entity id
required: true
schema:
type: string
format: uuid
- name: format
in: query
description: 'Output format: markdown (default) or json'
schema:
type: string
default: markdown
- name: query
in: query
description: Optional question; truncated knowledge items are excerpted to the passage most relevant to it instead of the positional lead
schema:
type: string
responses:
'200':
description: Entity AI context
'404':
description: Entity not found
/v1/announcements/name/{fqn}/context:
get:
tags:
- Announcements
summary: Get the AI context for an entity by fully qualified name
description: Retrieve the LLM-ready AI Context (Context Profile) for the entity by FQN — see getEntityAiContextById. Returns an OKF-style markdown document by default, or the structured AIContext JSON with `?format=json`.
operationId: getEntityAiContextByName_36
parameters:
- name: fqn
in: path
description: Entity fully qualified name
required: true
schema:
type: string
- name: format
in: query
description: 'Output format: markdown (default) or json'
schema:
type: string
default: markdown
- name: query
in: query
description: Optional question; truncated knowledge items are excerpted to the passage most relevant to it instead of the positional lead
schema:
type: string
responses:
'200':
description: Entity AI context
'404':
description: Entity not found
/v1/announcements/name/{fqn}:
get:
tags:
- Announcements
summary: Get an announcement by fully qualified name
operationId: getAnnouncementByFQN
parameters:
- name: fqn
in: path
required: true
schema:
type: string
- name: fields
in: query
schema:
type: string
- name: include
in: query
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
responses:
'200':
description: The announcement
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
/v1/announcements/{id}/versions/{version}:
get:
tags:
- Announcements
summary: Get a specific version of an announcement
operationId: getAnnouncementVersion
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: version
in: path
required: true
schema:
type: string
responses:
'200':
description: The announcement version
/v1/announcements/history:
get:
tags:
- Announcements
summary: List all entity versions within a time range
description: Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch.
operationId: listAllEntityVersionsByTimestamp_35
parameters:
- name: startTs
in: query
description: Start timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: endTs
in: query
description: End timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: limit
in: query
description: Limit the number of entity returned (1 to 1000000, default = 10)
schema:
maximum: 500
minimum: 1
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of entity versions before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of entity versions after this cursor
schema:
type: string
responses:
'200':
description: List of all versions
content:
application/json:
schema:
$ref: '#/components/schemas/ResultList'
/v1/announcements/{id}/versions:
get:
tags:
- Announcements
summary: List announcement versions
operationId: listAnnouncementVersions
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of announcement versions
/v1/announcements/restore:
put:
tags:
- Announcements
summary: Restore a soft deleted announcement
operationId: restoreAnnouncement
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreEntity'
responses:
default:
description: default response
content:
application/json: {}
components:
schemas:
TagLabel:
required:
- labelType
- source
- state
- tagFQN
type: object
properties:
tagFQN:
type: string
name:
type: string
displayName:
type: string
description:
type: string
style:
$ref: '#/components/schemas/Style'
source:
type: string
enum:
- Classification
- Glossary
labelType:
type: string
enum:
- Manual
- Propagated
- Automated
- Derived
- Generated
state:
type: string
enum:
- Suggested
- Confirmed
href:
type: string
format: uri
reason:
type: string
appliedAt:
type: string
format: date-time
appliedBy:
type: string
metadata:
$ref: '#/components/schemas/TagLabelMetadata'
EntityReference:
required:
- id
- type
type: object
properties:
id:
type: string
format: uuid
type:
type: string
name:
type: string
fullyQualifiedName:
type: string
description:
type: string
displayName:
type: string
deleted:
type: boolean
inherited:
type: boolean
href:
type: string
format: uri
RestoreEntity:
required:
- id
type: object
properties:
id:
type: string
format: uuid
TagLabelRecognizerMetadata:
required:
- recognizerId
- recognizerName
- score
type: object
properties:
recognizerId:
type: string
format: uuid
recognizerName:
type: string
score:
type: number
format: double
target:
type: string
enum:
- content
- column_name
patterns:
type: array
items:
$ref: '#/components/schemas/PatternMatch'
EntityError:
type: object
properties:
message:
type: string
entity:
type: object
CoverImage:
type: object
properties:
url:
type: string
position:
type: string
Paging:
required:
- total
type: object
properties:
before:
type: string
after:
type: string
offset:
type: integer
format: int32
limit:
type: integer
format: int32
total:
type: integer
format: int32
AccessDetails:
required:
- timestamp
type: object
properties:
timestamp:
type: integer
format: int64
accessedBy:
$ref: '#/components/schemas/EntityReference'
accessedByAProcess:
type: string
ChangeSummaryMap:
type: object
LifeCycle:
type: object
properties:
created:
$ref: '#/components/schemas/AccessDetails'
updated:
$ref: '#/components/schemas/AccessDetails'
accessed:
$ref: '#/components/schemas/AccessDetails'
JsonPatch:
type: object
ChangeDescription:
type: object
properties:
fieldsAdded:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsUpdated:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsDeleted:
type: array
items:
$ref: '#/components/schemas/FieldChange'
previousVersion:
type: number
format: double
changeSummary:
$ref: '#/components/schemas/ChangeSummaryMap'
ResultList:
required:
- data
type: object
properties:
data:
type: array
items:
type: object
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
AnnouncementList:
required:
- data
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Announcement'
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
UsageStats:
required:
- count
type: object
properties:
count:
minimum: 0
type: integer
format: int32
percentileRank:
type: number
format: double
FieldChange:
type: object
properties:
name:
type: string
oldValue:
type: object
newValue:
type: object
UsageDetails:
required:
- dailyStats
- date
type: object
properties:
dailyStats:
$ref: '#/components/schemas/UsageStats'
weeklyStats:
$ref: '#/components/schemas/UsageStats'
monthlyStats:
$ref: '#/components/schemas/UsageStats'
date:
type: string
Announcement:
required:
- description
- endTime
- id
- name
- startTime
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 256
minLength: 1
pattern: ^((?!::)[^>"\x00-\x1f])*$
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
displayName:
type: string
description:
type: string
entityLink:
pattern: (?U)^<#E::\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$
type: string
startTime:
type: integer
format: int64
endTime:
type: integer
format: int64
status:
type: string
enum:
- Active
- Expired
- Scheduled
createdBy:
type: string
updatedBy:
type: string
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
domains:
type: array
items:
$ref: '#/components/schemas/EntityReference'
reactions:
type: array
items:
$ref: '#/components/schemas/Reaction'
createdAt:
type: integer
format: int64
updatedAt:
type: integer
format: int64
version:
type: number
format: double
href:
type: string
format: uri
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
deleted:
type: boolean
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
dataProducts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
followers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
votes:
$ref: '#/components/schemas/Votes'
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
experts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
certification:
$ref: '#/components/schemas/AssetCertification'
extension:
type: object
children:
type: array
items:
$ref: '#/components/schemas/EntityReference'
service:
$ref: '#/components/schemas/EntityReference'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
style:
$ref: '#/components/schemas/Style'
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataContract:
$ref: '#/components/schemas/EntityReference'
usageSummary:
$ref: '#/components/schemas/UsageDetails'
entityStatus:
type: string
enum:
- Draft
- In Review
- Approved
- Archived
- Deprecated
- Rejected
- Unprocessed
sourceHash:
type: string
impersonatedBy:
type: string
provider:
type: string
enum:
- system
- user
- automation
PatternMatch:
required:
- name
- score
type: object
properties:
name:
type: string
regex:
type: string
score:
type: number
format: double
Style:
type: object
properties:
color:
type: string
iconURL:
type: string
coverImage:
$ref: '#/components/schemas/CoverImage'
Votes:
type: object
properties:
upVotes:
type: integer
format: int32
downVotes:
type: integer
format: int32
upVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
downVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
CreateAnnouncement:
required:
- description
- endTime
- startTime
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::)[^>"\x00-\x1f])*$
type: string
displayName:
type: string
description:
type: string
entityLink:
pattern: (?U)^<#E::\w+::(?:[^:<>|]|:[^:<>|])+(?:::(?:[^:<>|]|:[^:<>|])+)*>$
type: string
startTime:
type: integer
format: int64
endTime:
type: integer
format: int64
owners:
type: array
items:
type: string
AssetCertification:
required:
- appliedDate
- expiryDate
- tagLabel
type: object
properties:
tagLabel:
$ref: '#/components/schemas/TagLabel'
appliedDate:
type: integer
format: int64
expiryDate:
type: integer
format: int64
Reaction:
required:
- reactionType
- user
type: object
properties:
reactionType:
type: string
enum:
- thumbsUp
- thumbsDown
- hooray
- laugh
- confused
- heart
- rocket
- eyes
user:
$ref: '#/components/schemas/EntityReference'
TagLabelMetadata:
type: object
properties:
recognizer:
$ref: '#/components/schemas/TagLabelRecognizerMetadata'
expiryDate:
type: integer
format: int64
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-provenance:
method: harvested
publisher: Collate
source: https://sandbox.open-metadata.org/swagger.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)