Class ListCreateRequest

The request object used when creating a new object list.

Constructors

constructor

Properties

customProperties? filterBranch? listFolderId? listPermissions? membershipSettings? name objectTypeId processingType attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

OptionalcustomProperties

customProperties?: {
    [key: string]: string;
}

The list of custom properties to tie to the list. Custom property name is the key, the value is the value.

OptionalfilterBranch

filterBranch?: PublicPropertyAssociationFilterBranchFilterBranchesInner

OptionallistFolderId

listFolderId?: number

The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.

OptionallistPermissions

listPermissions?: PublicListPermissions

OptionalmembershipSettings

membershipSettings?: PublicMembershipSettings

name

name: string

The name of the list, which must be globally unique across all public lists in the portal.

objectTypeId

objectTypeId: string

The object type ID of the type of objects that the list will store.

processingType

processingType: string

The processing type of the list. One of: SNAPSHOT, MANUAL, or DYNAMIC.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods