WebAPI
CDIFCore::Classes::WebAPI
Definition
schema:WebAPI - an API distribution endpoint. Used as an alternative to schema:DataDownload for service-mediated access. Inherits identifier/name/description from AbstractDistribution.
Diagram
Inheritance
Generalizes: AbstractDistribution
Attributes
| Name | Type | Multiplicity | Description |
|---|---|---|---|
| documentation | Reference | [0..1] | schema:documentation - URL of API documentation. |
| termsOfService | Reference | [0..1] | schema:termsOfService - terms of service for using the API (URI or labeled reference). |
| serviceType | string | [0..1] | schema:serviceType - the type of the web API service. |
Associations
| Role | Target | Multiplicity | Kind |
|---|---|---|---|
| potentialAction | → Action | [0..*] | association |