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

Handles requests to the resources route of the Knora API.

Hierarchy

Endpoint
- ResourcesEndpointV2

Index

Internal Constructors

constructor

Properties

Accessors

jsonWebToken

Methods

Internal Constructors

constructor

new ResourcesEndpointV2(knoraApiConfig: KnoraApiConfig, path: string, v2Endpoint: V2Endpoint): ResourcesEndpointV2

Overrides Endpoint.constructor
- Defined in src/api/v2/resource/resources-endpoint-v2.ts:25
category

Internal

Parameters
- knoraApiConfig: KnoraApiConfig
  
  the config object.
- path: string
  
  this endpoint's base path.
- v2Endpoint: V2Endpoint
  
  a reference to the v2 endpoint.
Returns ResourcesEndpointV2

Properties

jsonConvert

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

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

the config object.

Protected path

path: string

this endpoint's base path.

Accessors

jsonWebToken

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

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

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

Parameters
- value: string
Returns void

Methods

createResource

createResource(resource: CreateResource): Observable<ReadResource | ApiResponseError>

- Defined in src/api/v2/resource/resources-endpoint-v2.ts:87
Creates a new resource.

Parameters
- resource: CreateResource
  
  the resource to be created.
Returns Observable<ReadResource | ApiResponseError>

deleteResource

deleteResource(resource: DeleteResource): Observable<DeleteResourceResponse | ApiResponseError>

- Defined in src/api/v2/resource/resources-endpoint-v2.ts:164
Deletes a resource.

Parameters
- resource: DeleteResource
  
  the resource to be deleted.
Returns Observable<DeleteResourceResponse | ApiResponseError>

getResource

getResource(resourceIri: string): Observable<ReadResource | ApiResponseError>

- Defined in src/api/v2/resource/resources-endpoint-v2.ts:73
Given a resource IRI, gets the resource from Knora.

Parameters
- resourceIri: string
  
  Iri of the resource to get.
Returns Observable<ReadResource | ApiResponseError>

getResources

getResources(resourceIris: string[]): Observable<ReadResourceSequence | ApiResponseError>

- Defined in src/api/v2/resource/resources-endpoint-v2.ts:42
Given a sequence of resource IRIs, gets the resources from Knora.

Parameters
- resourceIris: string[]
  
  Iris of the resources to get.
Returns Observable<ReadResourceSequence | ApiResponseError>

Protected handleError

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

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

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

Protected httpDelete

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

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

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpGet

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

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

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpPatch

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

Inherited from Endpoint.httpPatch
- Defined in src/api/endpoint.ts:125
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.
Returns Observable<AjaxResponse>

Protected httpPost

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

Inherited from Endpoint.httpPost
- Defined in src/api/endpoint.ts:95
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.
Returns Observable<AjaxResponse>

Protected httpPut

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

Inherited from Endpoint.httpPut
- Defined in src/api/endpoint.ts:110
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.
Returns Observable<AjaxResponse>

updateResourceMetadata

updateResourceMetadata(resourceMetadata: UpdateResourceMetadata): Observable<UpdateResourceMetadataResponse | ApiResponseError>

- Defined in src/api/v2/resource/resources-endpoint-v2.ts:135
Updates a resource's metadata.

Parameters
- resourceMetadata: UpdateResourceMetadata
  
  the new metadata.
Returns Observable<UpdateResourceMetadataResponse | ApiResponseError>

Hierarchy

Index

Internal Constructors

Properties

Accessors

Methods

Internal Constructors

constructor

Parameters

knoraApiConfig: KnoraApiConfig

path: string

v2Endpoint: V2Endpoint

Returns ResourcesEndpointV2

Properties

jsonConvert

Protected knoraApiConfig

Protected path

Accessors

jsonWebToken

Returns string

Parameters

value: string

Returns void

Methods

createResource

Parameters

resource: CreateResource

Returns Observable<ReadResource | ApiResponseError>

deleteResource

Parameters

resource: DeleteResource

Returns Observable<DeleteResourceResponse | ApiResponseError>

getResource

Parameters

resourceIri: string

Returns Observable<ReadResource | ApiResponseError>

getResources

Parameters

resourceIris: string[]

Returns Observable<ReadResourceSequence | ApiResponseError>

Protected handleError

Parameters

error: AjaxError | DataError

Returns Observable<ApiResponseError>

Protected httpDelete

Parameters

Optional path: undefined | string

Returns Observable<AjaxResponse>

Protected httpGet

Parameters

Optional path: undefined | string

Returns Observable<AjaxResponse>

Protected httpPatch

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Returns Observable<AjaxResponse>

Protected httpPost

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" | "sparql" = "json"

Returns Observable<AjaxResponse>

Protected httpPut

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Returns Observable<AjaxResponse>

updateResourceMetadata

Parameters

resourceMetadata: UpdateResourceMetadata

Returns Observable<UpdateResourceMetadataResponse | ApiResponseError>