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

Handles requests to the values route of the Knora API.

Hierarchy

Endpoint
- ValuesEndpointV2

Index

Internal Constructors

constructor

Properties

Accessors

jsonWebToken

Methods

Internal Constructors

constructor

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

Overrides Endpoint.constructor
- Defined in src/api/v2/values/values-endpoint-v2.ts:27
category

Internal

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

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

the config object.

maxRetries

maxRetries: 5 = 5

Protected path

path: string

this endpoint's base path.

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

createValue

createValue(resource: UpdateResource<CreateValue>): Observable<WriteValueResponse | ApiResponseError>

- Defined in src/api/v2/values/values-endpoint-v2.ts:95
Creates a new value.

Parameters
- resource: UpdateResource<CreateValue>
  
  The resource with the value to be created.
Returns Observable<WriteValueResponse | ApiResponseError>

deleteValue

deleteValue(resource: UpdateResource<DeleteValue>): Observable<DeleteValueResponse | ApiResponseError>

- Defined in src/api/v2/values/values-endpoint-v2.ts:127
Deletes a value.

Parameters
- resource: UpdateResource<DeleteValue>
  
  The resource with the value to be deleted.
Returns Observable<DeleteValueResponse | ApiResponseError>

getValue

getValue(resourceIri: string, valueUuid: string): Observable<ReadResource | ApiResponseError>

- Defined in src/api/v2/values/values-endpoint-v2.ts:45
Reads a value from Knora.

Parameters
- resourceIri: string
  
  the Iri of the resource the value belongs to.
- valueUuid: string
  
  the value's UUID.
Returns Observable<ReadResource | 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>

updateValue

updateValue(resource: UpdateResource<UpdateValue>): Observable<WriteValueResponse | ApiResponseError>

- Defined in src/api/v2/values/values-endpoint-v2.ts:68
Updates an existing value.

Parameters
- resource: UpdateResource<UpdateValue>
  
  The resource with the value to be updated.
Returns Observable<WriteValueResponse | ApiResponseError>

Hierarchy

Index

Internal Constructors

Properties

Accessors

Methods

Internal Constructors

constructor

Parameters

knoraApiConfig: KnoraApiConfig

path: string

v2Endpoint: V2Endpoint

Returns ValuesEndpointV2

Properties

delay

jsonConvert

Protected knoraApiConfig

maxRetries

Protected path

retryOnErrorStatus

Accessors

jsonWebToken

Returns string

Parameters

value: string

Returns void

Methods

createValue

Parameters

resource: UpdateResource<CreateValue>

Returns Observable<WriteValueResponse | ApiResponseError>

deleteValue

Parameters

resource: UpdateResource<DeleteValue>

Returns Observable<DeleteValueResponse | ApiResponseError>

getValue

Parameters

resourceIri: string

valueUuid: string

Returns Observable<ReadResource | 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

Optional path: undefined | string

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpPatch

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpPost

Parameters

Optional path: undefined | string

Optional body: any

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

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpPut

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

updateValue

Parameters

resource: UpdateResource<UpdateValue>

Returns Observable<WriteValueResponse | ApiResponseError>