@hcl-software/domino-rest-sdk-node
    Preparing search index...

    Interface DominoRestScope

    Domino REST API scope interface.

    interface DominoRestScope {
        "@meta"?: DominoDocumentMeta;
        $Revisions?: string;
        $UpdatedBy?: string[];
        apiName: string;
        description?: string;
        Form?: string;
        icon?: string;
        iconName?: string;
        isActive?: boolean;
        maximumAccessLevel?: string;
        name?: string;
        nsfPath: string;
        schemaName: string;
        server?: string;
        toJson: () => Partial<ScopeBody>;
        toScopeJson: () => ScopeJSON;
        Type?: string;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    @meta? $Revisions? $UpdatedBy? apiName description? Form? icon? iconName? isActive? maximumAccessLevel? name? nsfPath schemaName server? toJson toScopeJson Type?

    Properties

    "@meta"?: DominoDocumentMeta

    Document metadata.

    $Revisions?: string

    Last updated date in ISO format.

    $UpdatedBy?: string[]

    The user who update the doc.

    apiName: string

    Name that is used in dataSource parameter to access mapped resource.

    description?: string

    Explanation of the scope.

    Form?: string

    Always has value KeepDatabase for scopes.

    icon?: string

    Base64 encoded icon (preferably SVG).

    iconName?: string

    Alternate text for icon.

    isActive?: boolean

    Allows to enable/disable API access without removing configuration.

    maximumAccessLevel?: string

    Limits, but not extends the access level granted to an API user. Mirrors the MaximumInternetAccess in DB ACLs. Default if not provided is Editor.

    name?: string

    Always has value KeepDatabase for scopes.

    nsfPath: string

    Path relative to Domino data directory to NSF database.

    schemaName: string

    Name (without .json extension) of schema file in NSF REST file resources.

    server?: string

    Domino server name that this scope is enabled on. Empty or '*' mean that this scope is enabled on all Domino servers.

    toJson: () => Partial<ScopeBody>

    Transform scope properties to JSON.

    Type declaration

      • (): Partial<ScopeBody>

      • Returns Partial<ScopeBody>

        JSON representation of all scope properties.

    toScopeJson: () => ScopeJSON

    Transform scope properties without the base properties to JSON.

    Type declaration

    Type?: string

    Always has value KeepDatabase for scopes.

    Settings

    Member Visibility

    On This Page

    Properties