Collate · Schema
ApiService
CompanyDataMetadataData CatalogData GovernanceData DiscoveryData QualityData LineageOpen Source
Properties
| Name | Type | Description |
|---|---|---|
| id | string | |
| name | string | |
| fullyQualifiedName | string | |
| displayName | string | |
| serviceType | string | |
| description | string | |
| connection | object | |
| pipelines | array | |
| testConnectionResult | object | |
| tags | array | |
| followers | array | |
| version | number | |
| updatedAt | integer | |
| updatedBy | string | |
| impersonatedBy | string | |
| href | string | |
| owners | array | |
| changeDescription | object | |
| incrementalChangeDescription | object | |
| deleted | boolean | |
| entityStatus | string | |
| dataProducts | array | |
| dataContract | object | |
| domains | array | |
| ingestionRunner | object | |
| reviewers | array | |
| votes | object | |
| lifeCycle | object | |
| usageSummary | object | |
| experts | array | |
| certification | object | |
| sourceHash | string | |
| provider | string | |
| extension | object | |
| children | array | |
| service | object | |
| style | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/collate/json-schema/collate-api-service-schema.json",
"title": "ApiService",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/collate-api-services-api-openapi.yml#/components/schemas/ApiService",
"required": [
"id",
"name",
"serviceType"
],
"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"
},
"serviceType": {
"type": "string",
"enum": [
"Rest",
"WEBHOOK"
]
},
"description": {
"type": "string"
},
"connection": {
"$ref": "#/$defs/ApiConnection"
},
"pipelines": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"testConnectionResult": {
"$ref": "#/$defs/TestConnectionResult"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/$defs/TagLabel"
}
},
"followers": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"version": {
"type": "number",
"format": "double"
},
"updatedAt": {
"type": "integer",
"format": "int64"
},
"updatedBy": {
"type": "string"
},
"impersonatedBy": {
"type": "string"
},
"href": {
"type": "string",
"format": "uri"
},
"owners": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"changeDescription": {
"$ref": "#/$defs/ChangeDescription"
},
"incrementalChangeDescription": {
"$ref": "#/$defs/ChangeDescription"
},
"deleted": {
"type": "boolean"
},
"entityStatus": {
"type": "string",
"enum": [
"Draft",
"In Review",
"Approved",
"Archived",
"Deprecated",
"Rejected",
"Unprocessed"
]
},
"dataProducts": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"dataContract": {
"$ref": "#/$defs/EntityReference"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"ingestionRunner": {
"$ref": "#/$defs/EntityReference"
},
"reviewers": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"votes": {
"$ref": "#/$defs/Votes"
},
"lifeCycle": {
"$ref": "#/$defs/LifeCycle"
},
"usageSummary": {
"$ref": "#/$defs/UsageDetails"
},
"experts": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"certification": {
"$ref": "#/$defs/AssetCertification"
},
"sourceHash": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"system",
"user",
"automation"
]
},
"extension": {
"type": "object"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"service": {
"$ref": "#/$defs/EntityReference"
},
"style": {
"$ref": "#/$defs/Style"
}
},
"$defs": {
"AccessDetails": {
"required": [
"timestamp"
],
"type": "object",
"properties": {
"timestamp": {
"type": "integer",
"format": "int64"
},
"accessedBy": {
"$ref": "#/$defs/EntityReference"
},
"accessedByAProcess": {
"type": "string"
}
}
},
"ApiConnection": {
"type": "object",
"properties": {
"config": {
"type": "object"
}
}
},
"AssetCertification": {
"required": [
"appliedDate",
"expiryDate",
"tagLabel"
],
"type": "object",
"properties": {
"tagLabel": {
"$ref": "#/$defs/TagLabel"
},
"appliedDate": {
"type": "integer",
"format": "int64"
},
"expiryDate": {
"type": "integer",
"format": "int64"
}
}
},
"ChangeDescription": {
"type": "object",
"properties": {
"fieldsAdded": {
"type": "array",
"items": {
"$ref": "#/$defs/FieldChange"
}
},
"fieldsUpdated": {
"type": "array",
"items": {
"$ref": "#/$defs/FieldChange"
}
},
"fieldsDeleted": {
"type": "array",
"items": {
"$ref": "#/$defs/FieldChange"
}
},
"previousVersion": {
"type": "number",
"format": "double"
},
"changeSummary": {
"$ref": "#/$defs/ChangeSummaryMap"
}
}
},
"ChangeSummaryMap": {
"type": "object"
},
"CoverImage": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"position": {
"type": "string"
}
}
},
"Diagnosis": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"remediation": {
"type": "string"
},
"docUrl": {
"type": "string"
}
}
},
"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"
}
}
},
"FieldChange": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"oldValue": {
"type": "object"
},
"newValue": {
"type": "object"
}
}
},
"LifeCycle": {
"type": "object",
"properties": {
"created": {
"$ref": "#/$defs/AccessDetails"
},
"updated": {
"$ref": "#/$defs/AccessDetails"
},
"accessed": {
"$ref": "#/$defs/AccessDetails"
}
}
},
"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": "#/$defs/CoverImage"
}
}
},
"TagLabel": {
"required": [
"labelType",
"source",
"state",
"tagFQN"
],
"type": "object",
"properties": {
"tagFQN": {
"type": "string"
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"description": {
"type": "string"
},
"style": {
"$ref": "#/$defs/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": "#/$defs/TagLabelMetadata"
}
}
},
"TagLabelMetadata": {
"type": "object",
"properties": {
"recognizer": {
"$ref": "#/$defs/TagLabelRecognizerMetadata"
},
"expiryDate": {
"type": "integer",
"format": "int64"
}
}
},
"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": "#/$defs/PatternMatch"
}
}
}
},
"TestConnectionResult": {
"required": [
"steps"
],
"type": "object",
"properties": {
"lastUpdatedAt": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"enum": [
"Successful",
"Failed",
"Running"
]
},
"steps": {
"type": "array",
"items": {
"$ref": "#/$defs/TestConnectionStepResult"
}
}
}
},
"TestConnectionStepResult": {
"required": [
"mandatory",
"name",
"passed"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"mandatory": {
"type": "boolean"
},
"passed": {
"type": "boolean"
},
"message": {
"type": "string"
},
"errorLog": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"Queued",
"Running",
"Passed",
"Failed",
"Skipped",
"Warning"
]
},
"skipReason": {
"type": "string",
"enum": [
"NotImplemented",
"ConnectionNotEstablished"
]
},
"diagnosis": {
"$ref": "#/$defs/Diagnosis"
},
"durationMs": {
"type": "integer",
"format": "int32"
},
"executedCommand": {
"type": "string"
},
"resultSummary": {
"type": "string"
}
}
},
"UsageDetails": {
"required": [
"dailyStats",
"date"
],
"type": "object",
"properties": {
"dailyStats": {
"$ref": "#/$defs/UsageStats"
},
"weeklyStats": {
"$ref": "#/$defs/UsageStats"
},
"monthlyStats": {
"$ref": "#/$defs/UsageStats"
},
"date": {
"type": "string"
}
}
},
"UsageStats": {
"required": [
"count"
],
"type": "object",
"properties": {
"count": {
"minimum": 0,
"type": "integer",
"format": "int32"
},
"percentileRank": {
"type": "number",
"format": "double"
}
}
},
"Votes": {
"type": "object",
"properties": {
"upVotes": {
"type": "integer",
"format": "int32"
},
"downVotes": {
"type": "integer",
"format": "int32"
},
"upVoters": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
},
"downVoters": {
"type": "array",
"items": {
"$ref": "#/$defs/EntityReference"
}
}
}
}
}
}
Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/collate-api-service"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.