Internal Console API

InternalPalManager

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
  addDeploymentPal(String name, String palId, int deployOrder)

Adds the pal to the deployment group

  cancelMonitor(String monitorId)

Cancels the specified monitoring

boolean createDeploymentGroup(String name)

Creates a deployment group.

InternalPalChain createPalChain(Data data)

Creates a new PalChain. The PalChain name must be unique for the enterprise.

boolean deleteDeploymentGroup(String name)

Deletes the specified deployment group. Fails if the group has existing pal associations.

  deleteMonitor(String monitorId)

Deletes the specified monitoring and related details

boolean deletePalChain(String chainId)

Deletes specified PalChain.

String deployGroup(String name, String reason)

Kicks off a group deployment and returns a status check ID. See getDeploymentStatus.

SystemDataView getDeployedPalChains()

Returns the deployed PalChains for the enterprise.

SystemDataView getDeploymentGroups()

Returns a SystemDataView that can be used for accessing deployment groups

DataList getDeploymentPals(String name)

Returns a list of pals associated with the deployment group.

Payload getDeploymentStatus(String statusId)

Returns the deployment status for the group.

InternalDevelopmentPal getDevelopmentPal(String palId)

Returns the specified development pal.

InternalPalInfo getInternalPalInfo(String palId)

Returns the specified pal.

Payload getLogDetails(String palLogId)

Returns pal log details

InternalPalChain getPalChain(String chainId)

Returns specified PalChain.

SystemDataView getPalChains()

Returns the PalChains for the enterprise.

SystemDataView getPalLog(String palId)

Returns a SystemDataView that can be used for accessing pal log entries.

SystemDataView getPalMonitors()

Returns a SystemDataView that can be used for accessing monitors pals in this group.

SystemDataView getPals()

Returns a SystemDataView that can be used for accessing pals of the enterprise.

DataList getStoreRepositories()

Returns store repositories for this enterprise.

SystemDataView getTxPalLog(String txId)

Returns a SystemDataView that can be used for accessing transaction specific pal log entries.

boolean isPalChainNameUnique(String name)

Returns true if the PalChain name is unique for the enterprise.

boolean monitorPal(String palId, String purpose, String action, boolean activeUser, boolean allowWeb, int maxCount, Date startDateTime, Date endDateTime)

Enables monitoring for the specified pal

  removeDeploymentPal(String name, String palId)

Removes the pal from the deployment group

  setPalCubeAllocation(String palId, long allocationLimit)

Sets the allocation limit for the pal in bytes. Must be 0 or greater but less than the total storage allocated to this enterprise.

String toString()

Returns a description of this object.

Method Detail


addDeploymentPal(String name, String palId, int deployOrder)

Adds the pal to the deployment group

Parameters:

  • String   name
  • String   palId
  • int   deployOrder

Since: 07-03-2018

top

cancelMonitor(String monitorId)

Cancels the specified monitoring

Parameters:

  • String   monitorId Required parameter.

Since: 02-12-2015

top

boolean createDeploymentGroup(String name)

Creates a deployment group.

Parameters:

  • String   name

Returns:  boolean

Since: 07-03-2018

top

InternalPalChain createPalChain(Data data)

Creates a new PalChain. The PalChain name must be unique for the enterprise.

Parameters:

  • Data   data Required parameter.

Returns:  InternalPalChain

Since: 12-14-2010

top

boolean deleteDeploymentGroup(String name)

Deletes the specified deployment group. Fails if the group has existing pal associations.

Parameters:

  • String   name

Returns:  boolean

Since: 07-03-2018

top

deleteMonitor(String monitorId)

Deletes the specified monitoring and related details

Parameters:

  • String   monitorId Required parameter.

Since: 02-12-2015

top

boolean deletePalChain(String chainId)

Deletes specified PalChain.

Parameters:

  • String   chainId Required parameter.

Returns:  boolean

Since: 12-14-2010

top

String deployGroup(String name, String reason)

Kicks off a group deployment and returns a status check ID. See getDeploymentStatus.

Parameters:

  • String   name
  • String   reason Required parameter. Maximum allowed size of parameter: 255

Returns:  String

Since: 07-03-2018

top

SystemDataView getDeployedPalChains()

Returns the deployed PalChains for the enterprise.

Returns:  SystemDataView


DataList Name: DeployedPalChains
Tag Support: No
DataList Keys/Column Name Column Type Read Only
chainId Number  
name String  

Since: 12-14-2010

top

SystemDataView getDeploymentGroups()

Returns a SystemDataView that can be used for accessing deployment groups

Returns:  SystemDataView


DataList Name: DeploymentGroups
Tag Support: No
DataList Keys/Column Name Column Type Read Only
name String  
createDate Date  

Since: 07-03-2018

top

DataList getDeploymentPals(String name)

Returns a list of pals associated with the deployment group.

Parameters:

  • String   name

Returns:  DataList


DataList Name: pals
DataList Fields: palId, name, description, category, deploymentOrder

Since: 07-03-2018

top

Payload getDeploymentStatus(String statusId)

Returns the deployment status for the group.

Parameters:

  • String   statusId

Returns:  Payload

Since: 07-03-2018

top

InternalDevelopmentPal getDevelopmentPal(String palId)

Returns the specified development pal.

Parameters:

  • String   palId

Returns:  InternalDevelopmentPal

Since: 07-03-2018

top

InternalPalInfo getInternalPalInfo(String palId)

Returns the specified pal.

Parameters:

  • String   palId Required parameter.

Returns:  InternalPalInfo

Since: 11-24-2020

top

Payload getLogDetails(String palLogId)

Returns pal log details

Parameters:

  • String   palLogId Required parameter.

Returns:  Payload

Since: 02-12-2015

top

InternalPalChain getPalChain(String chainId)

Returns specified PalChain.

Parameters:

  • String   chainId Required parameter.

Returns:  InternalPalChain

Since: 12-14-2010

top

SystemDataView getPalChains()

Returns the PalChains for the enterprise.

Returns:  SystemDataView


DataList Name: PalChains
Tag Support: No
DataList Keys/Column Name Column Type Read Only
chainId Number  
name String  
type String  
createDate Date  
modifiedDate Date  
boundName String  
firstName String  
lastName String  
palCount Number  

Since: 12-14-2010

top

SystemDataView getPalLog(String palId)

Returns a SystemDataView that can be used for accessing pal log entries.

Parameters:

  • String   palId Required parameter.

Returns:  SystemDataView


DataList Name: PalLogs
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
action String  
eventDate Date  
eventSize Big Number  
eventDelta Number  
sysStorageCount Number  
sysStorageTime Number  
datasetStorageCount Number  
datasetStorageTime Number  
workflow String  
remoteCount Number  
remoteTime Number  
remoteSize Number  
type String  
commitCount Number  
worker String  
firstName String  
lastName String  
email String  
userAddress String  
userAgent String  
userOpSys String  
userAgentVersion String  

Since: 02-12-2015

top

SystemDataView getPalMonitors()

Returns a SystemDataView that can be used for accessing monitors pals in this group.

Returns:  SystemDataView


DataList Name: PalMonitors
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
purpose String  
cycles String  
maxCycles String  
createDate Date  
startDate Date  
endDate Date  
finished Boolean  
functionCount Big Number  
apiCount Big Number  
sysStorageCount Big Number  
sysStorageTime Big Number  
datasetStorageCount Big Number  
datasetStorageTime Big Number  
runtime Big Number  
palId String  
name String  
description String  
category String  
testPal Boolean  
modeConsole Boolean  
modeTransaction Boolean  
modeWeb Boolean  
type String  
consoleVisible Boolean  

Since: 02-12-2015

top

SystemDataView getPals()

Returns a SystemDataView that can be used for accessing pals of the enterprise.

Returns:  SystemDataView


DataList Name: PalManagerPals
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
name String  
description String  
category String  
createDate Date  
modifiedDate Date  
testPal Boolean  
modeConsole Boolean  
modeTransaction Boolean  
modeWeb Boolean  
type String  
consoleVisible Boolean  
cubePalLimit Big Number  

Since: 09-18-2012

top

DataList getStoreRepositories()

Returns store repositories for this enterprise.

Returns:  DataList


DataList Name: repositories
DataList Fields: palId, name

Since: 12-14-2010

top

SystemDataView getTxPalLog(String txId)

Returns a SystemDataView that can be used for accessing transaction specific pal log entries.

Parameters:

  • String   txId Required parameter.

Returns:  SystemDataView


DataList Name: TxPalLogs
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
action String  
eventDate Date  
eventSize Big Number  
eventDelta Number  
sysStorageCount Number  
sysStorageTime Number  
datasetStorageCount Number  
datasetStorageTime Number  
workflow String  
remoteCount Number  
remoteTime Number  
remoteSize Number  
type String  
commitCount Number  
worker String  
firstName String  
lastName String  
email String  
userAddress String  
userAgent String  
userOpSys String  
userAgentVersion String  

Since: 03-04-2015

top

boolean isPalChainNameUnique(String name)

Returns true if the PalChain name is unique for the enterprise.

Parameters:

  • String   name Required parameter.

Returns:  boolean

Since: 12-14-2010

top

boolean monitorPal(String palId, String purpose, String action, boolean activeUser, boolean allowWeb, int maxCount, Date startDateTime, Date endDateTime)

Enables monitoring for the specified pal

Parameters:

  • String   palId Required parameter.
  • String   purpose Required parameter. Maximum allowed size of parameter: 50
  • String   action  - Use * for all actions. Required parameter. Maximum allowed size of parameter: 100
  • boolean   activeUser Required parameter.
  • boolean   allowWeb Required parameter.
  • int   maxCount Required parameter.
  • Date   startDateTime Required parameter.
  • Date   endDateTime

Returns:  boolean

Since: 02-12-2015

top

removeDeploymentPal(String name, String palId)

Removes the pal from the deployment group

Parameters:

  • String   name
  • String   palId

Since: 07-03-2018

top

setPalCubeAllocation(String palId, long allocationLimit)

Sets the allocation limit for the pal in bytes. Must be 0 or greater but less than the total storage allocated to this enterprise.

Parameters:

  • String   palId
  • long   allocationLimit

Since: 08-19-2019

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-14-2010

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM