WebAPI inherited from CDIFDataDescription

CDIFProvenance::Classes::WebAPI

Definition

Documentation

Original

Reference

schema:WebAPI

Definition

An application programming interface accessible over Web/Internet technologies.

Scope

Parent class(es): Service (https://schema.org/Service).

CDIF

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]	Documentation Original Reference schema:documentation Definition Further documentation describing the Web API in more detail. Scope Domain: WebAPI (https://schema.org/WebAPI). Range: CreativeWork (https://schema.org/CreativeWork), URL (https://schema.org/URL). CDIF Definition schema:documentation - URL of API documentation.
termsOfService	Reference	[0..1]	Documentation Original Reference schema:termsOfService Definition Human-readable terms of service documentation. Scope Domain: Service (https://schema.org/Service). Range: Text (https://schema.org/Text), URL (https://schema.org/URL). CDIF Definition schema:termsOfService - terms of service for using the API (URI or labeled reference).
serviceType	string	[0..1]	Documentation Original Reference schema:serviceType Definition The type of service being offered, e.g. veterans' benefits, emergency relief, etc. Scope Domain: Service (https://schema.org/Service). Range: GovernmentBenefitsType (https://schema.org/GovernmentBenefitsType), Text (https://schema.org/Text). CDIF Definition schema:serviceType - the type of the web API service.

Associations

Role	Target	Multiplicity	Kind
potentialAction	→ Action	[0..*]	association