observable:API leaf node


URI

https://unifiedcyberontology.org/ontology/uco/observable#API

Label

API

Description

An API (application programming interface) is a computing interface that defines interactions between multiple software or mixed hardware-software intermediaries. It defines the kinds of calls or requests that can be made, how to make them, the data formats that should be used, the conventions to follow, etc. [based on https://en.wikipedia.org/wiki/API]

Shapes (1)

Usage

Instances of observable:API can have the following properties:

PROPERTYTYPEDESCRIPTIONRANGE
From class core:UcoObject
investigation:wasDerivedFrom owl:ObjectProperty A re-implementation of the wasDerivedFrom property in W3C PROV-O. The definition of this property is 'A derivation is a transformation of an entity into another, an update of an entity resulting in a new one, or the construction of a new entity based on a pre-existing entity.' [Ref: https://www.w3.org/TR/prov-o/#wasDerivedFrom] core:UcoObject
From class owl:Thing
investigation:authorizationIdentifier owl:DatatypeProperty The identifier for a particular authorization (e.g. warrant number) xsd:string
investigation:authorizationType owl:DatatypeProperty A label categorizing a type of authorization (e.g. warrant) xsd:string
investigation:exhibitNumber owl:DatatypeProperty Specifies a unique identifier assigned to a given object at any stage of an investigation to differentiate it from all other objects. xsd:string
investigation:focus owl:DatatypeProperty Specifies the topical focus of an investigation. xsd:string
investigation:investigationForm owl:DatatypeProperty A label categorizing a type of investigation (case, incident, suspicious-activity, etc.) vocab:InvestigationFormVocab
investigation:investigationStatus owl:DatatypeProperty A label characterizing the status of an investigation (open, closed, etc.). xsd:string
investigation:relevantAuthorization owl:ObjectProperty Specifies an authorization relevant to a particular investigation. investigation:Authorization
investigation:rootExhibitNumber owl:DatatypeProperty Specifies a unique identifier assigned to a given object at the start of its treatment as part of an investigation. The first node in a provenance chain, which can be viewed as a heirarchical tree originating from a single root. xsd:string

Property Shapes

By the associated SHACL property shapes, instances of observable:API can have the following properties:

PROPERTY

PROPERTY TYPE

DESCRIPTION

MIN COUNT

MAX COUNT

LOCAL RANGE
(type range for property on this class)

GLOBAL RANGE
(type range for property globally)

observable:ObservableObject
observable:hasChanged owl:DatatypeProperty
0 1 xsd:boolean
xsd:boolean
observable:state owl:DatatypeProperty
0 1 xsd:string
xsd:string
core:UcoObject
core:createdBy owl:ObjectProperty The identity that created a characterization of a concept.
0 1 core:IdentityAbstraction
core:IdentityAbstraction
core:description owl:DatatypeProperty A description of a particular concept characterization.
0 * xsd:string
xsd:string
core:externalReference owl:ObjectProperty Specifies a reference to a resource outside of the UCO.
0 * core:ExternalReference
core:ExternalReference
core:hasFacet owl:ObjectProperty Further sets of properties characterizing a concept based on the particular context of the class and of the particular instance of the concept being characterized.
0 * core:Facet
core:Facet
core:id owl:DatatypeProperty A globally unique identifier for a characterization of a concept.
0 1 types:Identifier
types:Identifier
core:modifiedTime owl:DatatypeProperty Specifies the time that this particular version of the object was modified. The object creator can use the time it deems most appropriate as the time this version of the object was modified. The value of the modified property for a given object version MUST be later than or equal to the value of the created property. Object creators MUST update the modified property when creating a new version of an object. The modified timestamp MUST be precise to the nearest millisecond (exactly three digits after the decimal place in seconds).
0 * xsd:dateTime
xsd:dateTime
core:name owl:DatatypeProperty The name of a particular concept characterization.
0 1 xsd:string
xsd:string
core:objectCreatedTime owl:DatatypeProperty The time at which a characterization of a concept is created. This time pertains to the time of creating the record object, and is not an intrinsic characteristic of the concept.
0 1 xsd:dateTime
xsd:dateTime
core:objectMarking owl:ObjectProperty Marking definitions to be applied to a particular concept characterization in its entirety.
0 * core:MarkingDefinitionAbstraction
core:MarkingDefinitionAbstraction
core:specVersion owl:DatatypeProperty The version of UCO ontology or subontology specification used to characterize a concept.
0 1 xsd:string
xsd:string
core:tag owl:DatatypeProperty A generic tag/label.
0 * xsd:string
xsd:string
core:type owl:DatatypeProperty The explicitly-defined type of characterization of a concept.
0 * xsd:string
xsd:string

Implementation

@prefix observable: <https://unifiedcyberontology.org/ontology/uco/observable#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sh: <http://www.w3.org/ns/shacl#> .

observable:API a owl:Class,
        sh:NodeShape ;
    rdfs:label "API"@en ;
    rdfs:comment "An API (application programming interface) is a computing interface that defines interactions between multiple software or mixed hardware-software intermediaries. It defines the kinds of calls or requests that can be made, how to make them, the data formats that should be used, the conventions to follow, etc. [based on https://en.wikipedia.org/wiki/API]"@en ;
    rdfs:subClassOf observable:ObservableObject ;
    sh:targetClass observable:API .