Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 5.61 KB

function_ontology.md

File metadata and controls

86 lines (58 loc) · 5.61 KB
Raw

Function Ontology

Title: Function Ontology

Description: Ontology for function invocations.

Creator: @drcgjung

Contributor: @obalandi

Date: 2023-06-29

Version: 1.11.0

Imports: file:common_ontology.ttl , file:core_ontology.ttl

Link to ontology: https://w3id.org/catenax/ontology/function

classDiagram 
   class ConceptualObject~core~{
   } 
   class Application~common~{
   } 
   class Function~function~{
       argument string
   } 
   class Result~function~{
       returnValue string
   } 
   Function --> Result : output
   Function --|> Application
   Result --|> ConceptualObject
Loading

Classes

Name Description Datatype properties Object properties Subclass of
Function A function defines a calculation that is called through an API. For example, a prediction function for entered engine data. argument output Application
Result Result describes the expected result of a function. returnValue ConceptualObject

Data Properties

Name Description Domain Range Subproperty of
argument Argument defines the input parameters of a function, and a function can have zero or more arguments. Function xsd:string
returnValue Return value describes the type of values returned by a function. Result xsd:string

Object Properties

Name Descriptions Domain Range Subproperty of
output Refers to the result of a function. Function Result

Annotation Properties

Name Descriptions Domain Range Subproperty of
argumentConfigurationProperty API configuration property for arguments. argument
argumentName Determines the name or index of the function argument. argument xsd:string argumentConfigurationProperty
dataType Determines the data type of an argument or return value. argument xsd:anyType argumentConfigurationProperty
default Determines a default for the given argument which is taken if this is a mandatory argument argument xsd:anyType argumentConfigurationProperty
inputProperty Determines a path/name in the input document under which all input arguments are encoded. Default is '.' argument xsd:string argumentConfigurationProperty
priority Determines the priority with which the argument is processed. Default is '10' argument xsd:integer argumentConfigurationProperty
valuePath Determines a path in the output response under which a return value is transmitted. argument xsd:string argumentConfigurationProperty
functionConfigurationProperty API configuration property for Function. Function
batch Determines maximal batch size for function invocations. Default is '1' which means that each invocation is done separately Function xsd:long functionConfigurationProperty
callbackProperty Determines a (set of) paths in the input document and the output response under which the callback address (see https://w3id.org/catenax/ontology/function#callbackAddress) and the referring callback id will be transmitted. Function xsd:string functionConfigurationProperty
invocationIdProperty Determines a (set of) paths in the input document under which the IRI of the invocation (instance of Function) will be transmitted. Function xsd:string functionConfigurationProperty
invocationMethod Determines the invocation method of the function in case that the target service provides several possibilities (DEFAULT, GET, POST-JSON , POST-JSON-MF , POST-XML , POST-XML-MF). Function xsd:string functionConfigurationProperty
targetUri The target URI of the function should resolve to some existing service (URL). xsd:string functionConfigurationProperty
resultConfigurationProperty API configuration property for Result. Result
outputProperty Determines a path/name in the output response under which all output arguments are encoded. Default is '.' Result xsd:string resultConfigurationProperty
resultIdProperty Determines a path in the output response under which the IRI of the result component will be transmitted. Result xsd:string resultConfigurationProperty