agINFRA Web Services vocabulary

RDF/XML version of this vocabulary. Turtle version of this vocabulary.

Last update:

13 March 2015

Namespace URI:

http://vocabularies.aginfra.eu/ws#

Abstract

An RDF vocabulary for representing web services and web-based APIs, from RESTful APIs (including RSS feeds, OAI-PMH endpoints, SPARQL endpoints etc.) to SOAP web services to XML/RPC web services etc.

All terms at a glance

Overview diagram

An RDF vocabulary for representing web services and web-based APIs, from RESTful APIs (including RSS feeds, OAI-PMH endpoints, SPARQL endpoints etc.) to SOAP web services to XML/RPC web services etc.

Classes

Class: ws:MethodOrResource

Method or ResourceA class for the individual methods of the web service / API or, in REST terms, the resource paths.

URI:
http://vocabularies.aginfra.eu/ws#MethodOrResource
Properties include:
ws:requestTemplate, ws:responseExample, ws:parameter, ws:methodPath, ws:responseDataType, ws:responseRangeClass, ws:responseRangeAuthority, ws:responseRangeList, ws:responseFormat, ws:responseElementsReference, ws:responseResourcesType, ws:httpMethod
Used with:
ws:method

Class: ws:ParameterOrResourceId

Parameter or Resource IDA class for the parameters accepted by a method or, in REST terms, the ID required by a resource path.

URI:
http://vocabularies.aginfra.eu/ws#ParameterOrResourceId
Properties include:
ws:paramContext, ws:paramName, ws:paramDataType, ws:paramRangeClass, ws:paramRangeAuthority, ws:paramRangeList, ws:paramFormat, ws:paramSourceFormat, ws:paramSourceElementsReference, ws:paramSourceResourcesType
Used with:
ws:parameter

Class: ws:WebService

Web ServiceA class for the web service / API as a whole.

URI:
http://vocabularies.aginfra.eu/ws#WebService
Properties include:
ws:method, ws:baseUrl, ws:type, ws:license, ws:cost
Superclasses:
dctype:Service, rdfs:Resource, doap:Project

Properties

Property: ws:baseUrl

Base URLThe base URL of the web service / API.

URI:
http://vocabularies.aginfra.eu/ws#baseUrl
Type:
owl:FunctionalProperty
Domain:
ws:WebService
Range:
xsd:anyURI

Property: ws:cost

CostThis property indicates the cost of the service if access to the web service is subject to payment of a fee.

URI:
http://vocabularies.aginfra.eu/ws#cost
Domain:
ws:WebService
Range:
rdfs:Literal

Property: ws:httpMethod

HTTP MethodThe HTTP method (GET, POST...) used to call this method. Use either the literal corresponding to one of the standard methods or the URI of a skos>Concept or rdfs:Resource describing the method.

URI:
http://vocabularies.aginfra.eu/ws#httpMethod
Domain:
ws:MethodOrResource

Property: ws:license

License

URI:
http://vocabularies.aginfra.eu/ws#license
Domain:
ws:WebService
Superproperty:
dct:license

Property: ws:method

Has methodA method exposed by the web service / API. Repeatable.

URI:
http://vocabularies.aginfra.eu/ws#method
Domain:
ws:WebService
Range:
ws:MethodOrResource

Property: ws:methodPath

Method PathPath to add to the API base URL to execute the method; if empty, root path = API base URL.

URI:
http://vocabularies.aginfra.eu/ws#methodPath
Type:
owl:FunctionalProperty
Domain:
ws:MethodOrResource
Range:
xsd:normalizedString

Property: ws:paramContext

Parameter ContextSpecifies whether the parameter is part of a name-value pair (&name=value) or slash-separated fragment of resource path (according to the RESTful API syntax) or matrix URL fragment. Use the URI of a resource defining the type of parameter.

URI:
http://vocabularies.aginfra.eu/ws#paramContext
Domain:
ws:ParameterOrResourceId
Ranges:
rdfs:Resource, skos:Concept

Property: ws:paramDataType

Parameter Data TypeThe data type expected for the parameter (text, numeric, date, coordinates, object, ID…).

URI:
http://vocabularies.aginfra.eu/ws#paramDataType
Domain:
ws:ParameterOrResourceId
Ranges:
rdfs:Resource, skos:Concept

Property: ws:paramFormat

Parameter FormatThe format expected for the parameter value (plain, XML, CSV, fixed length values, Json...)

URI:
http://vocabularies.aginfra.eu/ws#paramFormat
Domain:
ws:ParameterOrResourceId
Ranges:
rdfs:Resource, skos:Concept
Superproperty:
dct:format

Property: ws:paramName

Parameter NameThe name of the parameter IF it is a name-value pair.

URI:
http://vocabularies.aginfra.eu/ws#paramName
Domain:
ws:ParameterOrResourceId
Range:
xsd:normalizedString

Property: ws:paramRangeAuthority

Parameter Range AuthorityThe range of allowed values for the paramater: If the parameter value is expected to belong to an external Concept Scheme or authority file, indicate the URI of the collection of allowed values.

URI:
http://vocabularies.aginfra.eu/ws#paramRangeAuthority
Domain:
ws:ParameterOrResourceId
Ranges:
rdfs:Resource, skos:ConceptScheme

Property: ws:paramRangeClass

Parameter Range ClassThe range of allowed values for the parameter: If the parameter value is expected to be a resource of a specific RDF class, indicate the URI of the class.

URI:
http://vocabularies.aginfra.eu/ws#paramRangeClass
Domain:
ws:ParameterOrResourceId
Range:
rdfs:Class
Superproperty:
rdfs:domain

Property: ws:paramRangeList

Paramater Range ListRange of allowed values for the parameter: a hard-coded comma-separated list of controlled values.

URI:
http://vocabularies.aginfra.eu/ws#paramRangeList
Domain:
ws:ParameterOrResourceId
Range:
xsd:string

Property: ws:paramSourceElementsReference

Parameter Source Elements ReferenceIF parameter data type is "URL of dataset": Reference to the definition (namespace / definition URI or skos:Concept referring to a vocabulary) of the metadata set / dimensions that the input dataset should contain.

URI:
http://vocabularies.aginfra.eu/ws#paramSourceElementsReference
Domain:
ws:ParameterOrResourceId
Ranges:
rdfs:Resource, owl:Ontology, dct:Standard, skos:Concept

Property: ws:paramSourceFormat

Parameter Source FormatIF parameter data type is "URL of dataset": The format expected for the source referred by the URL (plain, XML, CSV, fixed length values, Json...)

URI:
http://vocabularies.aginfra.eu/ws#paramSourceFormat
Domain:
ws:ParameterOrResourceId
Ranges:
rdfs:Resource, skos:Concept, dcterms:MediaType
Superproperty:
dct:format

Property: ws:paramSourceResourcesType

Parameter Source Resources TypeIF parameter data type is "URL of dataset": the type of data that the dataset should contain (time series, germplasm data, bibliographic resources...)

URI:
http://vocabularies.aginfra.eu/ws#paramSourceResourcesType
Domain:
ws:ParameterOrResourceId
Ranges:
rdfs:Resource, skos:Concept
Superproperty:
dct:coverage

Property: ws:parameter

Has parameterA parameter that this method accepts. Repeatable.

URI:
http://vocabularies.aginfra.eu/ws#parameter
Domain:
ws:MethodOrResource
Range:
ws:ParameterOrResourceId

Property: ws:requestTemplate

Request TemplateThe template of the method including parameters between {}. Example: transform/{id}/{schema}

URI:
http://vocabularies.aginfra.eu/ws#requestTemplate
Domain:
ws:MethodOrResource
Range:
xsd:string

Property: ws:responseDataType

Response Data TypeThe data type returned by the method (text, numeric, date, coordinates, ID, URL, dataset…).

URI:
http://vocabularies.aginfra.eu/ws#responseDataType
Domain:
ws:MethodOrResource
Ranges:
rdfs:Resource, skos:Concept
Superproperty:
dct:type

Property: ws:responseElementsReference

Response Elements ReferenceReference to the definition (namespace / definition URI or skos:Concept referring to a vocabulary) of the metadata set / dimensions that the returned dataset contains.

URI:
http://vocabularies.aginfra.eu/ws#responseElementsReference
Domain:
ws:MethodOrResource
Ranges:
rdfs:Resource, owl:Ontology, dct:Standard

Property: ws:responseExample

Response ExampleA property to provide an example of a typical response returned by this method.

URI:
http://vocabularies.aginfra.eu/ws#responseExample
Domain:
ws:MethodOrResource
Range:
rdfs:Literal

Property: ws:responseFormat

Response FormatThe format of the response that the method provides (plain text, XML, Json, CSV...)

URI:
http://vocabularies.aginfra.eu/ws#responseFormat
Domain:
ws:MethodOrResource
Ranges:
rdfs:Resource, skos:Concept
Superproperty:
dct:format

Property: ws:responseRangeAuthority

Response Range AuthorityThe range of possible values for the response IF the returned value belongs to an external Concept Scheme or authority file.

URI:
http://vocabularies.aginfra.eu/ws#responseRangeAuthority
Domain:
ws:MethodOrResource
Ranges:
rdfs:Resource, skos:ConceptScheme
Superproperty:
rdfs:range

Property: ws:responseRangeClass

Response Range ClassThe range of possible values for the response: IF the returned value is a resource of a specific RDF class, provide the URI of the class.

URI:
http://vocabularies.aginfra.eu/ws#responseRangeClass
Domain:
ws:MethodOrResource
Range:
rdfs:Class
Superproperty:
rdfs:range

Property: ws:responseRangeList

Response Range ListA hard-coded comma-separated list of controlled values.

URI:
http://vocabularies.aginfra.eu/ws#responseRangeList
Domain:
ws:MethodOrResource
Range:
xsd:string
Superproperty:
rdfs:range

Property: ws:responseResourcesType

Response Resources TypeThe type of content / data that the returned dataset contains or refers to (time series, germplasm data, bibliographic resources...)

URI:
http://vocabularies.aginfra.eu/ws#responseResourcesType
Domain:
ws:MethodOrResource
Ranges:
rdfs:Resource, skos:Concept, dcterms:MediaType
Superproperty:
dct:type

Property: ws:type

TypeThe type of web service (e.g. REST, SOAP...)

URI:
http://vocabularies.aginfra.eu/ws#type
Domain:
ws:WebService
Ranges:
rdfs:Resource, skos:Concept
Superproperty:
dct:type