Class: Platform

Gitana. Platform

Platform


new Platform(cluster [, Object])

Parameters:
Name Type Argument Description
cluster Gitana.Cluster
Object <optional>

object json object (if no callback required for populating)

Source:

Extends

Members


getTenantPreviewUri

Generates a URI to a preview resource.

Source:

Methods


__copyState()

Override the Chain.__copyState method so that it utilizes a base method that we can override
on a per-class basis.

Inherited From:
Source:

accessChecks(checks, callback)

Retrieves authorities and permissions for multiple reference/principal combinations.

Example of entries array:

[{
"permissioned": "",
"principalId": ""
}]

The callback receives an array of results, example:

[{
"permissioned": "",
"principalId": "",
"permissionId|authorityId": "<permissionId|authorityId>",
"hasPermission|hasAuthority": true | false
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

accessLookups(checks, callback)

Retrieves authorities and permissions for multiple reference/principal combinations.

Example of entries array:

[{
"permissioned": "",
"principalId": ""
}]

The callback receives an array of results, example:

[{
"permissioned": "",
"principalId": "",
"authorities": [...],
"permissions": [...]
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

app(settings, callback)

Connects to a specific application on the platform. Preloads any application data and stack information
and then fires into a callback with context set to application helper.

Parameters:
Name Type Description
settings
callback
Source:

authenticate(config [, Function])

Logs in as the given user.

This delegates a call to the underlying driver.

Parameters:
Name Type Argument Description
config Object

login config

Function <optional>

authentication failure handler

Source:

chainCopyState(otherObject)

Override to include:

__system

Parameters:
Name Type Description
otherObject
Inherited From:
Source:

chainCreate(chainable, object, uri, params)

Creates an object on the server (write + read).
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
object
uri
params
Inherited From:
Source:

chainCreateEx(chainable, object, createUri, readUri)

Creates an object on the server using one URL and then reads it back using another URL.
This exists because the security responses don't include _doc fields like other responses.

Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
object
createUri
readUri
Inherited From:
Source:

chainDelete(chainable, uri, params)

Executes an HTTP delete for this object and continues the chain with the chainable.

Parameters:
Name Type Description
chainable
uri
params
Inherited From:
Source:

chainGet(chainable, uri, params)

Performs a GET from the server and populates the chainable.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
Inherited From:
Source:

chainGetResponse(chainable, uri, params)

Performs a GET to the server and pushes the response into the chain.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
Inherited From:
Source:

chainGetResponseRows(chainable, uri, params)

Performs a GET to the server and pushes the "rows" response attribute into the chain.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
Inherited From:
Source:

chainGetResponseText(chainable, uri, params)

Performs a GET to the server and pushes the text response to the callback.

Parameters:
Name Type Description
chainable
uri
params
Inherited From:
Source:

chainHasResponseRow(chainable, uri, value)

Performs a GET to the server and checks whether the "rows" array attribute of the response
has the given value.

Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
value
Inherited From:
Source:

chainPatch(chainable, uri, params, payload)

Performs a PATCH to the server and populates the chainable with results.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
payload
Inherited From:
Source:

chainPost(chainable, uri, params, payload)

Performs a POST to the server and populates the chainable with results.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
payload
Inherited From:
Source:

chainPostEmpty(chainable, uri, params, payload, contentType)

Performs a POST to the server. The response is not handled.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
payload

(optional)

contentType

(optional) - example "text/plain"

Inherited From:
Source:

chainPostResponse(chainable, uri, params)

Performs a POST to the server and pushes the response into the chain.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
Inherited From:
Source:

chainReload(uri, params)

Reloads this object from the server and then passes control to the chainable.

Parameters:
Name Type Description
uri
params
Inherited From:
Source:

chainUpdate(chainable, uri, params)

Executes an update (write + read) of this object and then passes control to the chainable.

Parameters:
Name Type Description
chainable
uri
params
Inherited From:
Source:

chainUpload(chainable, uri, params, contentType, payload)

Performs a POST to the server. The response is not handled.
Proceeds with the chain as bound to the chainable.

Parameters:
Name Type Description
chainable
uri
params
contentType

(optional) - example "text/plain"

payload

(optional)

Inherited From:
Source:

checkApplicationAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type vault.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkApplicationPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type vault.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkAuthenticationGrantAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type authentication grant.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkAuthenticationGrantPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type authentication grant.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkAuthority(principal, authorityId, callback)

Checks whether the given principal has a granted authority for this object.
This passes the result (true/false) to the chaining function.

Parameters:
Name Type Description
principal Gitana.Principal | String

the principal or the principal id

authorityId String

the id of the authority

callback
Inherited From:
Source:

checkBillingProviderConfigurationAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type billing provider configuration.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkBillingProviderConfigurationPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type billing provider configuration.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkClientAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type client.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkClientPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type client.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentPackageAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type deployment package.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentPackagePermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type deployment package.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentReceiverAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type deployment receiver.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentReceiverPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type deployment receiver.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentStrategyAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type deployment strategy.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentStrategyPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type deployment strategy.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentTargetAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type deployment target.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDeploymentTargetPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type deployment target.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDirectoryAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type directory.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDirectoryPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type directory.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDomainAuthorities(checks, callback)

Performs a bulk check of permissions against permissioned objects of type domain.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkDomainPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type domain.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkPermission(principal, permissionId, callback)

Checks whether the given principal has a permission against this object.
This passes the result (true/false) to the chaining function.

Parameters:
Name Type Description
principal Gitana.Principal | String

the principal or the principal id

permissionId String

the id of the permission

callback
Inherited From:
Source:

checkProjectAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type project.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkProjectPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type project.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkRegistrarAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type vault.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkRegistrarPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type vault.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkReportAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type report.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkReportPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type report.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkRepositoryAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type repository.

Example of checks array:

[{
"permissionedId": "",
"domainId": "", (optional)
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"domainId": "", (optional)
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkRepositoryPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type repository.

Example of checks array:

[{
"permissionedId": "",
"domainId": "", (optional)
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"domainId": "", (optional)
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkScheduledWorkAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type scheduled work.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkScheduledWorkPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type scheduled work.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkServiceDescriptorAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type external service descriptor.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkServiceDescriptorPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type external service descriptor.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkStackAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type stack.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkStackPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type stack.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkUIConfigAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type uiconfig.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkUIConfigPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type uiconfig.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkVaultAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type vault.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkVaultPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type vault.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWebHostAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type web host.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWebHostPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type web host.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowCommentAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type workflow task.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowCommentPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type workflow task.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowInstanceAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type workflow instance.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowInstancePermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type workflow instance.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowModelAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type workflow model.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowModelPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type workflow model.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowTaskAuthorities(checks, callback)

Performs a bulk check of authorities against permissioned objects of type workflow task.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"authorityId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"authorityId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

checkWorkflowTaskPermissions(checks, callback)

Performs a bulk check of permissions against permissioned objects of type workflow task.

Example of checks array:

[{
"permissionedId": "",
"principalId": "",
"permissionId": ""
}]

The callback receives an array of results, example:

[{
"permissionedId": "",
"principalId": "",
"permissionId": "",
"result": true
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

clone()

Source:

createApplication( [Object])

Create an application

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createAuthenticationGrant( [Object])

Create an authentication grant

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createBillingProviderConfiguration(providerId [, Object])

Create a billing provider configuration.

Parameters:
Name Type Argument Description
providerId String
Object <optional>

object JSON object

Source:

createClient( [Object])

Create a client

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createDeploymentReceiver( [Object])

Create a deployment receiver

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createDeploymentStrategy( [Object])

Create a deployment strategy.

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createDeploymentTarget( [Object])

Create a deployment target.

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createDirectory( [Object])

Create a directory.

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createDomain( [Object])

Create a domain

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createLogEntry(message, level, obj)

Creates and reads back a log entry.

Parameters:
Name Type Description
message
level
obj
Source:

createProject( [Object])

Create a project

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createRegistrar( [Object])

Create a registrar

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createReport( [Object])

Create a report

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createRepository( [Object])

Create a repository

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createRole(roleKey, object)

Creates a role.

Parameters:
Name Type Description
roleKey
object
Inherited From:
Source:

createScheduledWorkItem( [Object])

Create a scheduled work item

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createServiceDescriptor( [Object])

Create a service descriptor

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createStack( [Object])

Create a stack

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createTeam(teamKey, object)

Creates a team.

Parameters:
Name Type Description
teamKey
object
Inherited From:
Source:

createUIConfig( [Object])

Create a UI config instance

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createVault( [Object])

Create a vault

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createWebHost( [Object])

Create a web host.

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Source:

createWorkflow(workflowModelId [, Object])

Create a workflow

Parameters:
Name Type Argument Description
workflowModelId String

workflow id

Object <optional>

object JSON object

Source:

createWorkflowComment(workflowId [, String] [, Object])

Create a workflow comment

Parameters:
Name Type Argument Description
workflowId String
String <optional>

workflowTaskId

Object <optional>

object JSON object

Source:

createWorkflowModel(id [, Object])

Create a workflow model

Parameters:
Name Type Argument Description
id String
Object <optional>

object JSON object

Source:

del()

Source:

executeReport(reportId [, Object] [, Object], callback)

Executes a report.

Parameters:
Name Type Argument Description
reportId String

the id of the report to run

Object <optional>

config additional config

Object <optional>

pagination

callback function

callback to fire

Source:

exportDownloadUrl(exportId, index, useDispositionHeader)

Gets the download URL for a completed export.

Parameters:
Name Type Description
exportId
index
useDispositionHeader
Source:
Returns:
Type
string

extractPrincipalDomainQualifiedId(principal)

Helper to gets the principal id for a principal object, json structure or principal id itself.
This returns something like "domainId/principalId"

Parameters:
Name Type Description
principal
Inherited From:
Source:

extractPrincipalIdentifiers(principal, defaultDomainId)

Helper to gets the principal id for a principal object, json structure or principal id itself.
This returns something like "domainId/principalId"

Parameters:
Name Type Description
principal

principal object or string (principal id or domain qualified principal id)

defaultDomainId
Inherited From:
Source:

findStackForDataStore(datastoreType, datastoreId)

Finds a stack for a given data store.

Parameters:
Name Type Description
datastoreType
datastoreId
Source:

get(key)

Get a json property

Parameters:
Name Type Description
key
Inherited From:
Source:

getDescription()

The description for the object.

Inherited From:
Source:
Returns:

the description

Type
String

getId()

Hands back the ID ("_doc") of this object.

Inherited From:
Source:
Returns:

id

Type
String

getPlatform()

This method is provided to make the platform datastore compatible for teams.

Source:

getProxiedUri()

Hands back the URI of this object as referenced by the browser.

Inherited From:
Source:

getSystemMetadata()

Hands back the system metadata for this object.

Inherited From:
Source:
Returns:

system metadata

Type
Gitana.SystemMetadata

getTitle()

The title for the object.

Inherited From:
Source:
Returns:

the title

Type
String

getType()

Inherited From:
Overrides:
Source:

getUri()

Inherited From:
Overrides:
Source:

grantAuthority(principal, authorityId)

Grants an authority to a principal against this object.

Parameters:
Name Type Description
principal Gitana.Principal | String

the principal or the principal id

authorityId String

the id of the authority

Inherited From:
Source:

handleResponse(response)

Parameters:
Name Type Description
response
Inherited From:
Source:

handleSystemProperties()

Gets called after the response is handled and allows the object to pull out special values from
the "object" field so that they don't sit on the JSON object

Inherited From:
Source:

json()

Hands back a cleanup, properties-only JSON simple object.

Inherited From:
Source:

listActivities( [Object])

Lists activities.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Inherited From:
Source:

listAllWorkflowModels(pagination)

Lists all workflow models.

Parameters:
Name Type Description
pagination
Source:

listApplications( [Object])

Lists applications.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listApplicationTypes( [Object])

Lists the application types available for this platform.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listAuthorities(principal, callback)

Retrieve list of authorities and pass into chaining method.

Parameters:
Name Type Description
principal Gitana.Principal | String

the principal or the principal id

callback
Inherited From:
Source:

listBillingProviderConfigurations(pagination)

Lists the billing provider configurations.

Parameters:
Name Type Description
pagination
Source:

listClients(pagination)

Lists the clients.

Parameters:
Name Type Description
pagination
Source:

listDeploymentPackages(pagination)

Lists the deployment packages.

Parameters:
Name Type Description
pagination
Source:

listDeploymentReceivers(pagination)

Lists the deployment receivers.

Parameters:
Name Type Description
pagination
Source:

listDeploymentStrategies(pagination)

Lists the deployment strategies.

Parameters:
Name Type Description
pagination
Source:

listDeploymentTargets(pagination)

Lists the deployment targets.

Parameters:
Name Type Description
pagination
Source:

listDirectories( [Object])

Lists directories.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listDomains( [Object])

Lists domains.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listProjects(pagination)

Lists the projects.

Parameters:
Name Type Description
pagination
Source:

listProjectTypes( [Object])

Lists the project types available for this platform.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listRegistrars( [Object])

Lists registrars.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listReports(pagination)

Lists the reports.

Parameters:
Name Type Description
pagination
Source:

listRepositories( [Object])

Lists repositories.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listRoles(inherited)

Lists roles.

Parameters:
Name Type Description
inherited

whether to draw from inherited role containers

Inherited From:
Source:

listRuleActions(pagination)

Lists the available rule actions.

Parameters:
Name Type Description
pagination
Source:

listRuleConditions(pagination)

Lists the available rule conditions.

Parameters:
Name Type Description
pagination
Source:

listScheduledWorkItems(pagination)

Lists the scheduled work items.

Parameters:
Name Type Description
pagination
Source:

listServiceDescriptors(pagination)

Lists the service descriptors.

Parameters:
Name Type Description
pagination
Source:

listStacks(pagination)

Lists the stacks.

Parameters:
Name Type Description
pagination
Source:

listTasksForCurrentUser(filter, pagination)

Lists tasks for the current user.

Parameters:
Name Type Description
filter

empty or "assigned" or "unassigned"

pagination
Source:
Returns:
Type
*

listTeams()

Lists teams.

Inherited From:
Source:

listTenantAttachments()

Hands back a map of attachments for the platform's parent tenant.

Source:

listUIConfigs(pagination)

Lists the UI config instances.

Parameters:
Name Type Description
pagination
Source:

listVaults( [Object])

Lists vaults.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listWebHosts( [Object])

Lists web hosts.

Parameters:
Name Type Argument Description
Object <optional>

pagination pagination (optional)

Source:

listWorkflowComments(pagination)

Lists the workflow comments.

Parameters:
Name Type Description
pagination
Source:

listWorkflowModels(pagination)

Lists the deployed workflow models.

Parameters:
Name Type Description
pagination
Source:

listWorkflowModelVersions(id, pagination)

Lists the workflow model versions.

Parameters:
Name Type Description
id
pagination
Source:

listWorkflows(pagination)

Lists the workflows.

Parameters:
Name Type Description
pagination
Source:

listWorkflowTasks(pagination)

Lists the workflow tasks.

Parameters:
Name Type Description
pagination
Source:

loadACL(callback)

Retrieve full ACL and pass into chaining method.

Parameters:
Name Type Description
callback
Inherited From:
Source:

loadAuthorityGrants(callback)

Loads the authority grants for a given set of principals.

Parameters:
Name Type Description
callback
Inherited From:
Source:

loadFrom(anotherObject)

Helper method that loads this object from another object of the same type.

For example, loading a node from another loaded node.

Parameters:
Name Type Description
anotherObject
Inherited From:
Source:

loadInfo(callback)

Loads information about the platform.

Parameters:
Name Type Description
callback
Source:

loadWorkflowHistory(workflowId, workflowTaskId, pagination, callback)

Loads the history for a workflow.

Parameters:
Name Type Description
workflowId

the id of the workflow to load the history for

workflowTaskId

the current workflow task (or null if full history)

pagination
callback
Source:

logout(expireAccessToken)

Clears authentication against the server.

Parameters:
Name Type Description
expireAccessToken

(optional, assumed false)

Source:

postLogEntry(message, level, obj)

Performs a blind post create of a log entry. The result is not read back nor handled.

Parameters:
Name Type Description
message
level
obj
Source:

queryActivities(query [, Object])

Queries for activities.

Parameters:
Name Type Argument Description
query Object

query.

Object <optional>

pagination pagination (optional)

Inherited From:
Source:

queryAllWorkflowModels(query [, Object])

Queries for all (deployed and not deployed) workflow models.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryApplications(query [, Object])

Queries for an application.

Parameters:
Name Type Argument Description
query Object

Query for finding a vault.

Object <optional>

pagination pagination (optional)

Source:

queryAuthenticationGrants(query [, Object])

Queries for authentication grants.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryBillingProviderConfigurations(query [, Object])

Queries for billing provider configurations.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryClients(query [, Object])

Queries for clients.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryDeploymentPackages(query [, Object])

Queries for deployment packages

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryDeploymentReceivers(query [, Object])

Queries for deployment receivers.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryDeploymentStrategies(query [, Object])

Queries for deployment strategies

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryDeploymentTargets(query [, Object])

Queries for deployment targets

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryDirectories(query [, Object])

Queries for a directory.

Parameters:
Name Type Argument Description
query Object

Query for finding a directory.

Object <optional>

pagination pagination (optional)

Source:

queryDomains(query [, Object])

Queries for a domain.

Parameters:
Name Type Argument Description
query Object

Query for finding a domain.

Object <optional>

pagination pagination (optional)

Source:

queryLogEntries(query [, Object])

Queries for log entries.

Parameters:
Name Type Argument Description
query Object

Query for finding log entries.

Object <optional>

pagination pagination (optional)

Source:

queryProjects(query [, Object])

Queries for projects.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryRegistrars(query [, Object])

Queries for a registrar.

Parameters:
Name Type Argument Description
query Object

Query for finding a vault.

Object <optional>

pagination pagination (optional)

Source:

queryReports(query [, Object])

Queries for reports.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryRepositories(query [, Object])

Queries for a repository.

Parameters:
Name Type Argument Description
query Object

Query for finding a repository.

Object <optional>

pagination pagination (optional)

Source:

queryScheduledWorkItems(query [, Object])

Queries for scheduled work items.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryServiceDescriptors(query [, Object])

Queries for descriptors.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryStacks(query [, Object])

Queries for stacks.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryTasksForCurrentUser(filter, query, pagination)

Lists tasks for the current user.

Parameters:
Name Type Description
filter

empty or "assigned" or "unassigned"

query
pagination
Source:
Returns:
Type
*

queryUIConfigs(query [, Object])

Queries for UI configs.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryVaults(query [, Object])

Queries for a vault.

Parameters:
Name Type Argument Description
query Object

Query for finding a vault.

Object <optional>

pagination pagination (optional)

Source:

queryWebHosts(query [, Object])

Queries for web hosts.

Parameters:
Name Type Argument Description
query Object

Query for finding web hosts.

Object <optional>

pagination pagination (optional)

Source:

queryWorkflowComments(query [, Object])

Queries for workflow comments.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryWorkflowModels(query [, Object])

Queries for deployed workflow models.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryWorkflowModelVersions(id, query [, Object])

Queries for workflow model versions.

Parameters:
Name Type Argument Description
id String
query Object
Object <optional>

pagination pagination (optional)

Source:

queryWorkflows(query [, Object])

Queries for workflows.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

queryWorkflowTasks(query [, Object])

Queries for workflow tasks.

Parameters:
Name Type Argument Description
query Object
Object <optional>

pagination pagination (optional)

Source:

readActivity(activityId)

Read an activity.

Parameters:
Name Type Description
activityId String

the activity id

Inherited From:
Source:

readApplication(applicationId)

Read an application.

Parameters:
Name Type Description
applicationId String

the application id

Source:

readAuthenticationGrant(authenticationGrantId)

Reads an authentication grant.

Parameters:
Name Type Description
authenticationGrantId
Source:

readBillingProviderConfiguration(billingProviderConfigurationId)

Reads a billing provider configuration.

Parameters:
Name Type Description
billingProviderConfigurationId
Source:

readClient(clientId)

Reads a client.

Parameters:
Name Type Description
clientId
Source:

readCluster()

Reads the cluster.

Source:

readDeploymentPackage(deploymentPackageId)

Reads a deployment package

Parameters:
Name Type Description
deploymentPackageId
Source:

readDeploymentReceiver(deploymentReceiverId)

Reads a deployment receiver.

Parameters:
Name Type Description
deploymentReceiverId
Source:

readDeploymentStrategy(deploymentStrategyId)

Reads a deployment strategy.

Parameters:
Name Type Description
deploymentStrategyId
Source:

readDeploymentTarget(deploymentTargetId)

Reads a deployment target.

Parameters:
Name Type Description
deploymentTargetId
Source:

readDirectory(directoryId)

Read a directory.

Parameters:
Name Type Description
directoryId String

the directory id

Source:

readDomain(domainId)

Read a domain.

Parameters:
Name Type Description
domainId String

the domain id

Source:

readExportStatus(exportId, callback)

Retrieves the status for a running export job.
The status includes the "fileCount" field which indicates the total number of exported files.

Parameters:
Name Type Description
exportId
callback
Source:
Returns:
Type
*

readLog(callback)

Reads the last 100 lines of the log as text.
The callback receives the text as the argument.

Parameters:
Name Type Description
callback
Source:

readLogEntry(logEntryId)

Read a log entry.

Parameters:
Name Type Description
logEntryId String
Source:

readOwnersTeam()

Gets the owners team

Inherited From:
Source:

readPrimaryDomain()

Hands back the primary domain instance for this platform.

Source:

readProject(projectId)

Reads a project.

Parameters:
Name Type Description
projectId
Source:

readRegistrar(registrarId)

Read a registrar.

Parameters:
Name Type Description
registrarId String

the registrar id

Source:

readReport(reportId)

Reads a report.

Parameters:
Name Type Description
reportId
Source:

readRepository(repositoryId)

Read a repository.

Parameters:
Name Type Description
repositoryId String

the repository id

Source:

readRole(roleKeyOrId, inherited)

Reads a role.

Parameters:
Name Type Description
roleKeyOrId
inherited

whether to check inherited role containers

Inherited From:
Source:

readRuleAction(actioqnId)

Reads a rule action.

Parameters:
Name Type Description
actioqnId
Source:

readRuleCondition(conditionId)

Reads a rule condition.

Parameters:
Name Type Description
conditionId
Source:

readScheduledWorkItem(scheduledWorkId)

Reads a scheduled work item.

Parameters:
Name Type Description
scheduledWorkId
Source:

readServiceDescriptor(descriptorId)

Reads a service descriptor.

Parameters:
Name Type Description
descriptorId
Source:

readStack(stackId)

Reads a stack.

Parameters:
Name Type Description
stackId
Source:

readTeam(teamKey)

Reads a team.

Parameters:
Name Type Description
teamKey
Inherited From:
Source:

readUIConfig(uiConfigId)

Reads a UI config instance.

Parameters:
Name Type Description
uiConfigId
Source:

readVault(vaultId)

Read a vault.

Parameters:
Name Type Description
vaultId String

the vault id

Source:

readWebHost(webhostId)

Read a web host

Parameters:
Name Type Description
webhostId String

the web host id

Source:

readWorkflow(workflowId)

Reads a workflow.

Parameters:
Name Type Description
workflowId
Source:

readWorkflowComment(workflowCommentId)

Reads a workflow comment.

Parameters:
Name Type Description
workflowCommentId
Source:

readWorkflowModel(workflowModelId [, String])

Reads a workflow model.

Parameters:
Name Type Argument Description
workflowModelId String
String <optional>

workflowModelVersionId

Source:

readWorkflowTask(workflowTaskId)

Reads a workflow task.

Parameters:
Name Type Description
workflowTaskId
Source:

<abstract> ref()

Inherited From:
Source:
Returns:

a string denoting a reference to this datastore

Type
String

referenceDiff(sourceRef, targetRef, callback)

Calculates the JSON Patch diff between two objects.

Parameters:
Name Type Description
sourceRef
targetRef
callback
Source:

referenceMerge(sourceRef, diffObject, callback)

Applies a JSON Patch to an object to produce a patched object.

Parameters:
Name Type Description
sourceRef
diffObject
callback
Source:

referenceReads(checks, callback)

Reads one or more referenceable objects by reference id.

Example of entries array:

[{
"ref": ""
}]

The callback receives an array of results, example:

[{
"ref": "",
"entry": { ... object }
}]

The order of elements in the array will be the same for checks and results.

Parameters:
Name Type Description
checks
callback
Source:

reload()

Source:

replacePropertiesWith(object)

Replaces all of the properties of this object with those of the given object.
This method should be used to update the state of this object.

Any functions from the incoming object will not be copied.

Parameters:
Name Type Description
object Object

object containing the properties

Inherited From:
Source:

revokeAllAuthorities(principal)

Revokes all authorities for a principal against the server.

Parameters:
Name Type Description
principal Gitana.Principal | String

the principal or the principal id

Inherited From:
Source:

revokeAuthority(principal, authorityId)

Revokes an authority from a principal against this object.

Parameters:
Name Type Description
principal Gitana.Principal | String

the principal or the principal id

authorityId String

the id of the authority

Inherited From:
Source:

runExport(objects, configuration, callback)

Runs an export and waits for the export to complete.

This runs an asynchronous background poll checking status for the job to complete.
Once complete, the exportId and status are passed to the callback.

Parameters:
Name Type Description
objects
configuration
callback
Source:
Returns:
Type
*

set(key, value)

Set a json property

Parameters:
Name Type Description
key
value
Inherited From:
Source:

startCreateProject( [Object] [, Object])

Create a project asynchronously.
This runs a background job to do the actual project creation and hands back a job ID.

Parameters:
Name Type Argument Description
Object <optional>

object JSON object

Object <optional>

params request parameters

Source:

stringify(pretty)

Helper function to convert the object portion to JSON

Parameters:
Name Type Description
pretty
Inherited From:
Source:

tenantAttach(attachmentId, contentType, data)

Creates an attachment to this platform's parent tenant.

When using this method from within the JS driver, it really only works for text-based content such
as JSON or text.

Parameters:
Name Type Description
attachmentId

(use null or false for default attachment)

contentType
data
Source:

tenantAttachment(attachmentId)

Picks off a single attachment from this platform's parent tenant

Parameters:
Name Type Description
attachmentId
Source:

tenantUnattach(attachmentId)

Deletes an attachment from this platform's parent tenant.

Parameters:
Name Type Description
attachmentId
Source:

update()

Source: