OntologiesEndpointV2 | @dasch-swiss/dsp-js API Documentation

Handles requests to the ontologies route of the Knora API.

Hierarchy

Endpoint
- OntologiesEndpointV2

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Constructors

constructor

new OntologiesEndpointV2(knoraApiConfig: KnoraApiConfig, path: string): OntologiesEndpointV2

Inherited from Endpoint.constructor
- Defined in src/api/endpoint.ts:56
Constructor.

Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
Returns OntologiesEndpointV2

Properties

delay

delay: 500 = 500

jsonConvert

jsonConvert: JsonConvert = new JsonConvert(OperationMode.ENABLE,ValueCheckingMode.DISALLOW_NULL,false,PropertyMatchingRule.CASE_STRICT)

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

maxRetries

maxRetries: 5 = 5

Protected path

path: string

retryOnErrorStatus

retryOnErrorStatus: number[] = [0, 500]

Accessors

jsonWebToken

get jsonWebToken(): string
set jsonWebToken(value: string): void

Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:47
The session token

Returns string
Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:54
The session token

Parameters
- value: string
Returns void

Methods

addCardinalityToResourceClass

addCardinalityToResourceClass(addCardinalityToResourceClass: UpdateOntology<UpdateResourceClassCardinality>): Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:416
Adds cardinalities for properties to a resource class.

Parameters
- addCardinalityToResourceClass: UpdateOntology<UpdateResourceClassCardinality>
  
  the cardinalities to be added.
Returns Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

createOntology

createOntology(ontology: CreateOntology): Observable<OntologyMetadata | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:117
Creates a new ontology.

Parameters
- ontology: CreateOntology
  
  The ontology to be created
Returns Observable<OntologyMetadata | ApiResponseError>

createResourceClass

createResourceClass(resourceClass: UpdateOntology<CreateResourceClass>): Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:243
Creates a resource class without cardinalities.

Parameters
- resourceClass: UpdateOntology<CreateResourceClass>
  
  The resource class to be created.
Returns Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

createResourceProperty

createResourceProperty(resourceProperties: UpdateOntology<CreateResourceProperty>): Observable<ResourcePropertyDefinitionWithAllLanguages | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:351
Creates a resource property.

Parameters
- resourceProperties: UpdateOntology<CreateResourceProperty>
  
  the resource property to be created.
Returns Observable<ResourcePropertyDefinitionWithAllLanguages | ApiResponseError>

deleteOntology

deleteOntology(ontology: DeleteOntology): Observable<DeleteOntologyResponse | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:140
Deletes an ontology.

Parameters
- ontology: DeleteOntology
  
  the ontology to be deleted.
Returns Observable<DeleteOntologyResponse | ApiResponseError>

deleteOntologyComment

deleteOntologyComment(ontologyMetadata: UpdateOntologyMetadata): Observable<OntologyMetadata | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:199
Removes the comment from the metadata of an ontology.

Parameters
- ontologyMetadata: UpdateOntologyMetadata
  
  The ontology metadata to be updated
Returns Observable<OntologyMetadata | ApiResponseError>

deleteResourceClass

deleteResourceClass(deleteResourceClass: DeleteResourceClass): Observable<OntologyMetadata | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:328
Deletes a resource class.

Parameters
- deleteResourceClass: DeleteResourceClass
  
  with class IRI.
Returns Observable<OntologyMetadata | ApiResponseError>

deleteResourceProperty

deleteResourceProperty(deleteResourceProperty: DeleteResourceProperty): Observable<OntologyMetadata | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:394
Deletes a resource property.

Parameters
- deleteResourceProperty: DeleteResourceProperty
  
  with property IRI.
Returns Observable<OntologyMetadata | ApiResponseError>

getOntologiesByProjectIri

getOntologiesByProjectIri(projectIri: string): Observable<OntologiesMetadata | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:96
Requests metadata about all ontologies from a specific project.

Parameters
- projectIri: string
  
  the IRI of the project.
Returns Observable<OntologiesMetadata | ApiResponseError>

getOntologiesMetadata

getOntologiesMetadata(): Observable<OntologiesMetadata | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:47
Requests metadata about all ontologies from Knora.

Returns Observable<OntologiesMetadata | ApiResponseError>

getOntology

getOntology(ontologyIri: string, allLanguages?: boolean): Observable<ReadOntology | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:69
Requests an ontology from Knora.

Parameters
- ontologyIri: string
  
  the IRI of the ontology to be requested.
- Default value allLanguages: boolean = false
  
  gets labels and comments in all languages, if set to true.
Returns Observable<ReadOntology | ApiResponseError>

Protected handleError

handleError(error: AjaxError | DataError): Observable<ApiResponseError>

Inherited from Endpoint.handleError
- Defined in src/api/endpoint.ts:159
Handles parsing errors.

Parameters
- error: AjaxError | DataError
  
  the error class provided by us
Returns Observable<ApiResponseError>

Protected httpDelete

httpDelete(path?: undefined | string, headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpDelete
- Defined in src/api/endpoint.ts:144
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpGet

httpGet(path?: undefined | string, headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpGet
- Defined in src/api/endpoint.ts:70
Performs a general GET request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpPatch

httpPatch(path?: undefined | string, body?: any, contentType?: "json", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpPatch
- Defined in src/api/endpoint.ts:127
Performs a general PATCH request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpPost

httpPost(path?: undefined | string, body?: any, contentType?: "json" | "sparql", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpPost
- Defined in src/api/endpoint.ts:89
Performs a general POST request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request, if any.
- Default value contentType: "json" | "sparql" = "json"
  
  content content type of body, if any.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpPut

httpPut(path?: undefined | string, body?: any, contentType?: "json", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpPut
- Defined in src/api/endpoint.ts:108
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

replaceCardinalityOfResourceClass

replaceCardinalityOfResourceClass(replaceCardinalityOfResourceClass: UpdateOntology<UpdateResourceClassCardinality>): Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:448
Adds cardinalities for properties to a resource class.

Parameters
- replaceCardinalityOfResourceClass: UpdateOntology<UpdateResourceClassCardinality>
  
  the cardinalities to be added.
Returns Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

replaceGuiOrderOfCardinalities

replaceGuiOrderOfCardinalities(replaceGuiOrder: UpdateOntology<UpdateResourceClassCardinality>): Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:483
Updates gui order of cardinalities

Parameters
- replaceGuiOrder: UpdateOntology<UpdateResourceClassCardinality>
Returns Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

updateOntology

updateOntology(ontologyMetadata: UpdateOntologyMetadata): Observable<OntologyMetadata | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:163
Updates the metadata of an ontology.

Parameters
- ontologyMetadata: UpdateOntologyMetadata
  
  The ontology metadata to be updated
Returns Observable<OntologyMetadata | ApiResponseError>

updateResourceClass

updateResourceClass(updateResourceClass: UpdateOntology<UpdateResourceClassLabel | UpdateResourceClassComment>): Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:276
Updates a resource class's label or comment.

Parameters
- updateResourceClass: UpdateOntology<UpdateResourceClassLabel | UpdateResourceClassComment>
  
  the new label or comment.
Returns Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

updateResourceProperty

updateResourceProperty(updateProperty: UpdateOntology<UpdateResourcePropertyLabel | UpdateResourcePropertyComment>): Observable<ResourcePropertyDefinitionWithAllLanguages | ApiResponseError>

- Defined in src/api/v2/ontology/ontologies-endpoint-v2.ts:302
Updates a property's label or comment.

Parameters
- updateProperty: UpdateOntology<UpdateResourcePropertyLabel | UpdateResourcePropertyComment>
  
  the new label or comment.
Returns Observable<ResourcePropertyDefinitionWithAllLanguages | ApiResponseError>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

knoraApiConfig: KnoraApiConfig

path: string

Returns OntologiesEndpointV2

Properties

delay

jsonConvert

Protected knoraApiConfig

maxRetries

Protected path

retryOnErrorStatus

Accessors

jsonWebToken

Returns string

Parameters

value: string

Returns void

Methods

addCardinalityToResourceClass

Parameters

addCardinalityToResourceClass: UpdateOntology<UpdateResourceClassCardinality>

Returns Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

createOntology

Parameters

ontology: CreateOntology

Returns Observable<OntologyMetadata | ApiResponseError>

createResourceClass

Parameters

resourceClass: UpdateOntology<CreateResourceClass>

Returns Observable<ResourceClassDefinitionWithAllLanguages | ApiResponseError>

createResourceProperty

Parameters

resourceProperties: UpdateOntology<CreateResourceProperty>

Returns Observable<ResourcePropertyDefinitionWithAllLanguages | ApiResponseError>

deleteOntology

Parameters

ontology: DeleteOntology

Returns Observable<DeleteOntologyResponse | ApiResponseError>

deleteOntologyComment

Parameters

ontologyMetadata: UpdateOntologyMetadata

Returns Observable<OntologyMetadata | ApiResponseError>

deleteResourceClass

Parameters

deleteResourceClass: DeleteResourceClass

Returns Observable<OntologyMetadata | ApiResponseError>

deleteResourceProperty

Parameters

deleteResourceProperty: DeleteResourceProperty

Returns Observable<OntologyMetadata | ApiResponseError>

getOntologiesByProjectIri

Parameters

projectIri: string

Returns Observable<OntologiesMetadata | ApiResponseError>

getOntologiesMetadata

Returns Observable<OntologiesMetadata | ApiResponseError>

getOntology

Parameters

ontologyIri: string

Default value allLanguages: boolean = false

Returns Observable<ReadOntology | ApiResponseError>

Protected handleError

Parameters

error: AjaxError | DataError

Returns Observable<ApiResponseError>

Protected httpDelete

Parameters

Optional path: undefined | string

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpGet

Parameters