@labkey/api
    Preparing search index...

    Interface Container

    interface Container {
        activeModules: string[];
        effectivePermissions?: string[];
        folderType: string;
        formats: {
            dateFormat: string;
            dateTimeFormat: string;
            numberFormat: string;
            timeFormat: string;
        };
        hasRestrictedActiveModule: boolean;
        iconHref: string;
        id: string;
        isArchived: boolean;
        isContainerTab: boolean;
        isWorkbook: boolean;
        name: string;
        parentId: string;
        parentPath: string;
        path: string;
        sortOrder: number;
        startUrl: string;
        title: string;
        type: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeModules effectivePermissions? folderType formats hasRestrictedActiveModule iconHref id isArchived isContainerTab isWorkbook name parentId parentPath path sortOrder startUrl title type

    Properties

    activeModules: string[]

    Names of active modules in the container.

    effectivePermissions?: string[]

    Permissions the requesting user has in the container. Only available when explicitly requested via Security.getContainers().

    folderType: string

    The name of the container's folder type.

    formats: {
        dateFormat: string;
        dateTimeFormat: string;
        numberFormat: string;
        timeFormat: string;
    }

    Date format settings for this container.

    hasRestrictedActiveModule: boolean

    True if any active modules in this container require site permissions.

    iconHref: string

    Server relative icon URL for this container.

    id: string

    GUID of this container.

    isArchived: boolean

    Indicates if this container is archived. (lockstate == 'archived').

    isContainerTab: boolean

    Indicates if this container is a Container Tab.

    isWorkbook: boolean

    Indicates if this container is a workbook.

    name: string

    Name of the container. This is used in the container's path.

    parentId: string

    GUID of this container's parent container.

    parentPath: string

    Path of this container's parent container.

    path: string

    Path of this container.

    sortOrder: number

    The relative sort order of the requested container

    startUrl: string

    Server relative start URL for this container.

    title: string

    An optional non-unique title for the container.

    type: string

    Type of this container. (e.g. "project", "folder").

    Settings

    Member Visibility

    On This Page

    Properties