@knora/api/src/api/v2/list/lists-endpoint.d.ts

JavaScript library that handles API requests to Knora

import { Observable } from "rxjs";
import { ApiResponseError } from "../../../models/api-response-error";
import { ListNodeV2 } from "../../../models/v2/lists/list-node-v2";
import { Endpoint } from "../../endpoint";
/**
 * Handles requests to the lists route of the Knora API.
 */
export declare class ListsEndpoint extends Endpoint {
    /**
     * Get a specific list node.
     *
     * @param nodeIri the Ir of the list node to be fetched.
     */
    getNode(nodeIri: string): Observable<ListNodeV2 | ApiResponseError>;
    /**
     * Get an entire list.
     *
     * @param rootNodeIri the list's root node Iri.
     */
    getList(rootNodeIri: string): Observable<ListNodeV2 | ApiResponseError>;
}