Interface DominoBasisRestSession

Interface to perform BASIS Rest API operations.

interface DominoBasisRestSession {
    bulkCreateDocuments: (
        dataSource: string,
        docs: DocumentJSON[],
        richTextAs?: string,
    ) => Promise<DominoDocument[]>;
    bulkDeleteDocuments: (
        dataSource: string,
        docs: DominoDocument[],
        mode?: string,
    ) => Promise<DocumentStatusResponse[]>;
    bulkDeleteDocumentsByUNID: (
        dataSource: string,
        unids: string[],
        mode?: string,
    ) => Promise<DocumentStatusResponse[]>;
    bulkGetDocuments: (
        dataSource: string,
        unids: string[],
        options?: BulkGetDocumentsOptions,
    ) => Promise<(DominoDocument | BulkGetErrorResponse)[]>;
    bulkUpdateDocumentsByQuery: (
        dataSource: string,
        request: BulkUpdateDocumentsByQueryRequest,
        richTextAs?: string,
    ) => Promise<DominoDocument[] | DocumentStatusResponse[]>;
    createDocument: (
        dataSource: string,
        doc: DocumentJSON,
        options?: CreateDocumentOptions,
    ) => Promise<DominoDocument>;
    deleteDocument: (
        dataSource: string,
        doc: DominoRestDocument,
        mode?: string,
    ) => Promise<DocumentStatusResponse>;
    deleteDocumentByUNID: (
        dataSource: string,
        unid: string,
        mode?: string,
    ) => Promise<DocumentStatusResponse>;
    dominoAccess: DominoRestAccess;
    dominoConnector: DominoRestConnector;
    getDocument: (
        dataSource: string,
        unid: string,
        options?: GetDocumentOptions,
    ) => Promise<DominoDocument>;
    getDocumentsByQuery: (
        dataSource: string,
        request: GetDocumentsByQueryRequest,
        action: QueryActions,
        options?: GetDocumentsByQueryOptions,
    ) => Promise<
        | DominoDocument[]
        | QueryDocumentExplainResponse[]
        | QueryDocumentParseResponse[],
    >;
    getListViewEntry: (
        dataSource: string,
        listViewName: string,
        options?: GetListViewEntryOptions,
    ) => Promise<void | DominoDocument[] | ListViewEntryJSON[]>;
    getListViewPivotEntry: (
        dataSource: string,
        listViewName: string,
        pivotColumn: string,
        options?: GetListPivotViewEntryOptions,
    ) => Promise<PivotListViewResponse>;
    getListViews: (
        dataSource: string,
        options?: GetListViewOptions,
    ) => Promise<GetListViewJSON[]>;
    getRichtext: (
        dataSource: string,
        unid: string,
        richTextAs: string,
        options?: GetRichtextOptions,
    ) => Promise<string>;
    patchDocument: (
        dataSource: string,
        unid: string,
        docJsonPatch: DocumentBody,
        options?: UpdateDocumentOptions,
    ) => Promise<DominoDocument>;
    updateDocument: (
        dataSource: string,
        doc: DominoRestDocument,
        options?: UpdateDocumentOptions,
    ) => Promise<DominoDocument>;
}

Implemented by

Properties

bulkCreateDocuments bulkDeleteDocuments bulkDeleteDocumentsByUNID bulkGetDocuments bulkUpdateDocumentsByQuery createDocument deleteDocument deleteDocumentByUNID dominoAccess dominoConnector getDocument getDocumentsByQuery getListViewEntry getListViewPivotEntry getListViews getRichtext patchDocument updateDocument

Properties

bulkCreateDocuments

bulkCreateDocuments: (
    dataSource: string,
    docs: DocumentJSON[],
    richTextAs?: string,
) => Promise<DominoDocument[]>

Create documents with the provided document JSONs. Richtext return format can be specified (defaults to mime if not given).

Type declaration

    • (
          dataSource: string,
          docs: DocumentJSON[],
          richTextAs?: string,
      ): Promise<DominoDocument[]>

    • Parameters

      • dataSource: string

        the scope name

      • docs: DocumentJSON[]

        an array of JSON containing document data to be saved

      • OptionalrichTextAs: string

        the format which richtext fields will be returned as (defaults to mime if not given)

      Returns Promise<DominoDocument[]>

      a promise that resolves to an array of created documents.

Throws

an error if given array of document JSON is empty.

bulkDeleteDocuments

bulkDeleteDocuments: (
    dataSource: string,
    docs: DominoDocument[],
    mode?: string,
) => Promise<DocumentStatusResponse[]>

Delete all given DominoDocument in the given array. A mode can be provided if the operation needs to be done on other modes (default mode is default).

Type declaration

Throws

an error if given documents array is empty.

Throws

an error if one of given documents has empty UNID.

Throws

an error if one of given documents has invalid UNID.

bulkDeleteDocumentsByUNID

bulkDeleteDocumentsByUNID: (
    dataSource: string,
    unids: string[],
    mode?: string,
) => Promise<DocumentStatusResponse[]>

Delete all documents pointed by the given UNIDs. A mode can be provided if the operation needs to be done on other modes (default mode is default).

Type declaration

    • (
          dataSource: string,
          unids: string[],
          mode?: string,
      ): Promise<DocumentStatusResponse[]>

    • Parameters

      • dataSource: string

        the scope name

      • unids: string[]

        an array of UNIDs of the documents to be deleted.

      • Optionalmode: string

        the mode to perform the document access in. Defaults to default if missing

      Returns Promise<DocumentStatusResponse[]>

      a promise that resolves to an array of document status response.

Throws

an error if given UNIDs array is empty.

Throws

an error if one of given UNIDs is empty.

Throws

an error if one of given UNIDs is invalid.

bulkGetDocuments

bulkGetDocuments: (
    dataSource: string,
    unids: string[],
    options?: BulkGetDocumentsOptions,
) => Promise<(DominoDocument | BulkGetErrorResponse)[]>

Get all documents pointed by the given UNIDs. Additional request options can be given.

Type declaration

Throws

an error if given UNIDs array is empty.

Throws

an error if one of given UNIDs is empty.

Throws

an error if one of given UNIDs is invalid.

bulkUpdateDocumentsByQuery

bulkUpdateDocumentsByQuery: (
    dataSource: string,
    request: BulkUpdateDocumentsByQueryRequest,
    richTextAs?: string,
) => Promise<DominoDocument[] | DocumentStatusResponse[]>

Bulk update documents via specified request. Richtext return format can be specified (defaults to mime if not given).

Type declaration

Throws

an error if query in request is empty.

Throws

an error if replaceItems in request has no items.

createDocument

createDocument: (
    dataSource: string,
    doc: DocumentJSON,
    options?: CreateDocumentOptions,
) => Promise<DominoDocument>

Create a document with the provided document JSON. Additional request options can be provided.

Type declaration

deleteDocument

deleteDocument: (
    dataSource: string,
    doc: DominoRestDocument,
    mode?: string,
) => Promise<DocumentStatusResponse>

Delete the given DominoDocument. A mode can be provided if the operation needs to be done on other modes (default mode is default).

Type declaration

Throws

an error if given document has empty UNID.

Throws

an error if given document has invalid UNID.

deleteDocumentByUNID

deleteDocumentByUNID: (
    dataSource: string,
    unid: string,
    mode?: string,
) => Promise<DocumentStatusResponse>

Delete a document pointed by its UNID. A mode can be provided if the operation needs to be done on other modes (default mode is default).

Type declaration

    • (
          dataSource: string,
          unid: string,
          mode?: string,
      ): Promise<DocumentStatusResponse>

    • Parameters

      • dataSource: string

        the scope name

      • unid: string

        the UNID of the document to be deleted

      • Optionalmode: string

        the mode to perform the document access in. Defaults to default if not given

      Returns Promise<DocumentStatusResponse>

      a promise that resolves to a document status response.

Throws

an error if given UNID is empty.

Throws

an error if given UNID is invalid.

dominoAccess

dominoAccess: DominoRestAccess

Provides access to Domino REST API server.

dominoConnector

dominoConnector: DominoRestConnector

Provides accessible operations and its required parameters.

getDocument

getDocument: (
    dataSource: string,
    unid: string,
    options?: GetDocumentOptions,
) => Promise<DominoDocument>

Get a document via its UNID. Additional request options can be provided.

Type declaration

    • (
          dataSource: string,
          unid: string,
          options?: GetDocumentOptions,
      ): Promise<DominoDocument>

    • Parameters

      • dataSource: string

        the scope name

      • unid: string

        the UNID of the document to get

      • Optionaloptions: GetDocumentOptions

        options for get document operation

      Returns Promise<DominoDocument>

      a promise that resolves to the document fetched.

Throws

an error if given UNID is empty.

Throws

an error if given UNID is invalid.

getDocumentsByQuery

getDocumentsByQuery: (
    dataSource: string,
    request: GetDocumentsByQueryRequest,
    action: QueryActions,
    options?: GetDocumentsByQueryOptions,
) => Promise<
    | DominoDocument[]
    | QueryDocumentExplainResponse[]
    | QueryDocumentParseResponse[],
>

get documents via specified request based on the action provided.

Type declaration

Throws

an error if query in request is empty.

Throws

an error if action in request is empty.

getListViewEntry

getListViewEntry: (
    dataSource: string,
    listViewName: string,
    options?: GetListViewEntryOptions,
) => Promise<void | DominoDocument[] | ListViewEntryJSON[]>

Pulls in view data. Will return view entries unless options.documents is true, which will return DominoDocument instead. options.subscriber can also be provided, if instead of a response, you want the subscriber function to be called for each array item in the response.

Type declaration

Throws

an error if given scope name is empty.

Throws

an error if given list name is empty.

getListViewPivotEntry

getListViewPivotEntry: (
    dataSource: string,
    listViewName: string,
    pivotColumn: string,
    options?: GetListPivotViewEntryOptions,
) => Promise<PivotListViewResponse>

Processes view data as pivot.

Type declaration

Throws

an error if given scope name is empty.

Throws

an error if given list name is empty.

Throws

an error if pivot column is empty.

getListViews

getListViews: (
    dataSource: string,
    options?: GetListViewOptions,
) => Promise<GetListViewJSON[]>

Provide information on available views/folders.

Type declaration

Throws

an error if given scope name is empty.

getRichtext

getRichtext: (
    dataSource: string,
    unid: string,
    richTextAs: string,
    options?: GetRichtextOptions,
) => Promise<string>

Return a plain unformatted text from a Rich Text field.

Type declaration

    • (
          dataSource: string,
          unid: string,
          richTextAs: string,
          options?: GetRichtextOptions,
      ): Promise<string>

    • Parameters

      • dataSource: string

        the scope name

      • unid: string

        the UNID of the document to be deleted

      • richTextAs: string

        the format to return richtext field value

      • Optionaloptions: GetRichtextOptions

        optional parameters for GET /richtext/{richTextAs}/{unid} endpoint

      Returns Promise<string>

      A promise that resolves to a string of the richtext field value.

patchDocument

patchDocument: (
    dataSource: string,
    unid: string,
    docJsonPatch: DocumentBody,
    options?: UpdateDocumentOptions,
) => Promise<DominoDocument>

Update a document pointed by its UNID. Performs a PATCH on the document using the given document body JSON. Additional request options can be provided.

Type declaration

    • (
          dataSource: string,
          unid: string,
          docJsonPatch: DocumentBody,
          options?: UpdateDocumentOptions,
      ): Promise<DominoDocument>

    • Parameters

      • dataSource: string

        the scope name

      • unid: string

        the document's UNID where the patch will be made

      • docJsonPatch: DocumentBody

        JSON that contains what to patch on a document

      • Optionaloptions: UpdateDocumentOptions

        options for update document operation

      Returns Promise<DominoDocument>

      a promise that resolves to the updated document.

Throws

an error if given UNID is empty.

Throws

an error if given UNID is invalid.

updateDocument

updateDocument: (
    dataSource: string,
    doc: DominoRestDocument,
    options?: UpdateDocumentOptions,
) => Promise<DominoDocument>

Update the given DominoDocument (performs a PUT operation). Additional request options can be provided.

Type declaration

Throws

an error if given document has empty UNID.

Throws

an error if given document has invalid UNID.

Settings

Member Visibility

On This Page

Properties