NDEx JavaScript Client API Reference - v0.6.0-alpha.5
    Preparing search index...

    Interface NetworkSummaryV3

    NetworkSummaryV3 - Network summary for NDEx API v3

    Extends NetworkSummaryV2 but uses CX2-style properties format instead of CX1 format. The main difference is in how network properties are structured:

    Aspect NetworkSummaryV2 NetworkSummaryV3
    Properties Format CX1NetworkProperty[] (array) CX2NetworkProperties (object)
    Structure CX1-style array of property objects CX2-style key-value map
    Example [{predicateString: "name", value: "My Network"}] {name: {t: "string", v: "My Network"}} 
    // V2 properties format (array of objects)
    const v2Summary: NetworkSummaryV2 = {
      externalId: "12345",
      name: "Sample Network",
      properties: [
        { predicateString: "description", value: "A sample network", dataType: "string" },
        { predicateString: "nodeCount", value: "100", dataType: "integer" }
      ]
    };

    // V3 properties format (object map)
    const v3Summary: NetworkSummaryV3 = {
      externalId: "12345", 
      name: "Sample Network",
      properties: {
        description: { t: "string", v: "A sample network" },
        nodeCount: { t: "integer", v: 100 }
      }
    };
    interface NetworkSummaryV3 {
        externalId: string;
        name: string;
        description?: string;
        nodeCount: number;
        edgeCount: number;
        visibility: Visibility;
        owner: string;
        ownerUUID: string;
        creationTime: number;
        modificationTime: number;
        version?: string;
        isReadOnly: boolean;
        isValid: boolean;
        warnings?: string[];
        hasLayout: boolean;
        hasSample: boolean;
        updatedBy: string;
        errorMessage?: string;
        cxFormat?: string;
        cxFileSize?: number;
        cx2FileSize?: number;
        isShowcase?: boolean;
        isCompleted?: boolean;
        doi?: string;
        isCertified?: boolean;
        indexLevel?: NetworkIndexLevel;
        parentDirUUID?: string;
        showInTrash?: boolean;
        subnetworkIds?: string[];
        reference?: string;
        organism?: string;
        disease?: string;
        tissue?: string;
        networkType?: string[];
        rightsHolder?: string;
        rights?: string;
        sourceFormat?: string;
        properties?: CX2NetworkProperties;
    }

    Hierarchy

    Index

    Properties

    externalId name description? nodeCount edgeCount visibility owner ownerUUID creationTime modificationTime version? isReadOnly isValid warnings? hasLayout hasSample updatedBy errorMessage? cxFormat? cxFileSize? cx2FileSize? isShowcase? isCompleted? doi? isCertified? indexLevel? parentDirUUID? showInTrash? subnetworkIds? reference? organism? disease? tissue? networkType? rightsHolder? rights? sourceFormat? properties?

    Properties

    externalId: string
    name: string
    description?: string
    nodeCount: number
    edgeCount: number
    visibility: Visibility
    owner: string
    ownerUUID: string
    creationTime: number
    modificationTime: number
    version?: string
    isReadOnly: boolean
    isValid: boolean
    warnings?: string[]
    hasLayout: boolean
    hasSample: boolean
    updatedBy: string
    errorMessage?: string
    cxFormat?: string
    cxFileSize?: number
    cx2FileSize?: number
    isShowcase?: boolean
    isCompleted?: boolean
    doi?: string
    isCertified?: boolean
    indexLevel?: NetworkIndexLevel
    parentDirUUID?: string
    showInTrash?: boolean
    subnetworkIds?: string[]
    reference?: string
    organism?: string
    disease?: string
    tissue?: string
    networkType?: string[]
    rightsHolder?: string
    rights?: string
    sourceFormat?: string
    properties?: CX2NetworkProperties

    Settings

    Member Visibility

    On This Page

    Properties