API V3 Documentation – ATM
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
GET /API/V3/ATM/JavaScript/Console
Returns the JavaScript console with all entries
HTTP syntax
GET /API/V3/ATM/JavaScript/Console
<- application/json : JavaScriptConsoleJavaScript syntax
Pqf.atm.getJavaScriptConsole() // returns JavaScriptConsoleRequired license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Result
This endpoint returns the following data: JavaScriptConsole
GET /API/V3/ATM/JavaScript/Console/:sandboxId
Returns the JavaScript console with entries from a single script sandbox
HTTP syntax
GET /API/V3/ATM/JavaScript/Console/:sandboxId
<- application/json : JavaScriptConsole JavaScript syntax
Pqf.atm.getJavaScriptConsoleOfSandbox(sandboxId) // returns JavaScriptConsole Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The desired JavaScript console / sandbox ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: JavaScriptConsole
POST /API/V3/ATM/JavaScript/Console/:sandboxId/Clear
Clears all entries from the JavaScript console of a single script sandbox
HTTP syntax
POST /API/V3/ATM/JavaScript/Console/:sandboxId/Clear Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The desired JavaScript console / sandbox ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
POST /API/V3/ATM/JavaScript/Console/Clear
Clears all entries from the JavaScript console
HTTP syntax
POST /API/V3/ATM/JavaScript/Console/Clear Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
GET /API/V3/ATM/JavaScript/Libraries
Returns all available JavaScript libraries
HTTP syntax
GET /API/V3/ATM/JavaScript/Libraries
<- application/json JavaScript syntax
Pqf.atm.getJavaScriptLibraries() // returns JavaScriptLibrary[] Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Result
This endpoint returns the following data: array of JavaScriptLibrary
GET /API/V3/ATM/JavaScript/Performance/:sandboxId
Returns the JavaScript performance log of a single script sandbox collected during the last 24 hours or since last reset
HTTP syntax
GET /API/V3/ATM/JavaScript/Performance/:sandboxId
<- application/json : JavaScriptPerformanceStats JavaScript syntax
Pqf.atm.getJavaScriptSandboxPerformance(sandboxId) // returns JavaScriptPerformanceStats Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The desired JavaScript sandbox ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: JavaScriptPerformanceStats
POST /API/V3/ATM/JavaScript/Performance/:sandboxId/Clear
Clears the JavaScript performance log of a single script sandbox
HTTP syntax
POST /API/V3/ATM/JavaScript/Performance/:sandboxId/Clear Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The desired JavaScript sandbox ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/ATM/JavaScript/Quota
Returns information about the JavaScript usage during the last hour
HTTP syntax
GET /API/V3/ATM/JavaScript/Quota
<- application/json : JavaScriptQuotaJavaScript syntax
Pqf.atm.getJavaScriptQuota() // returns JavaScriptQuotaRequired license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Result
This endpoint returns the following data: JavaScriptQuota
GET /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTrigger/:triggerId
Returns a trigger for a given JavaScript sandbox
HTTP syntax
GET /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTrigger/:triggerId
<- application/json : JavaScriptChangeTrigger JavaScript syntax
Pqf.atm.getJavaScriptChangeTrigger(sandboxId, triggerId) // returns JavaScriptChangeTrigger Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
triggerId |
UUID | The trigger's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: JavaScriptChangeTrigger
DELETE /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTrigger/:triggerId
Deletes a trigger for a given JavaScript sandbox
HTTP syntax
DELETE /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTrigger/:triggerId Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
triggerId |
UUID | The trigger's ID | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTriggers
Returns all triggers for a given JavaScript sandbox
HTTP syntax
GET /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTriggers
<- application/json JavaScript syntax
Pqf.atm.getJavaScriptChangeTriggers(sandboxId) // returns JavaScriptChangeTrigger[] Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of JavaScriptChangeTrigger
POST /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTriggers/Add
Adds a trigger for a given JavaScript sandbox
HTTP syntax
POST /API/V3/ATM/JavaScript/Sandbox/:sandboxId/ChangeTriggers/Add?objectType=...&objectId=...&action=...
<- application/json : PF.Reference Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectType |
UUID | The object type to listen for changes | ✔️ | matches '[ (The value must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
objectId |
UUID | The object ID to listen for changes (null for all objects of given type) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
action |
PF.Action | The action that triggers the program (null for all actions) |
Result
This endpoint returns the following data: PF.Reference
GET /API/V3/ATM/JavaScript/Sandbox/:sandboxId/CompileErrors
Gets a list with the first errors of some JavaScript source code. Note that it may not be complete
HTTP syntax
GET /API/V3/ATM/JavaScript/Sandbox/:sandboxId/CompileErrors
<- application/json JavaScript syntax
Pqf.atm.getJavaScriptSandboxCompileErrors(sandboxId) // returns CompileError[] Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of CompileError
POST /API/V3/ATM/JavaScript/Sandbox/:sandboxId/Run
Executes some JavaScript source code
HTTP syntax
POST /API/V3/ATM/JavaScript/Sandbox/:sandboxId/Run?waitForFinish=... Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion | Default, if omitted |
|---|---|---|---|---|---|
sandboxId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
waitForFinish |
boolean | Wait for script to finish | false |
POST /API/V3/ATM/JavaScript/Sandbox/:sandboxId/Trigger
Executes some JavaScript source code, triggered from within another script
JavaScript syntax
Pqf.atm.triggerJavaScriptSandbox(sandboxId) // returns Number - the return code (HTTP 2xx code) of the call Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sandboxId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/ATM/JavaScript/Source/:javaScriptSourceId
Returns some JavaScript source code
HTTP syntax
GET /API/V3/ATM/JavaScript/Source/:javaScriptSourceId
<- application/json : JavaScriptSource JavaScript syntax
Pqf.atm.getJavaScriptSource(javaScriptSourceId) // returns JavaScriptSource Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptSourceId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: JavaScriptSource
PUT /API/V3/ATM/JavaScript/Source/:javaScriptSourceId
Creates or updates some JavaScript source code
HTTP syntax
PUT /API/V3/ATM/JavaScript/Source/:javaScriptSourceId
-> application/json : JavaScriptSource Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptSourceId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
requestJson |
JavaScriptSource | JSON object of type JavaScriptSource | ✔️ |
DELETE /API/V3/ATM/JavaScript/Source/:javaScriptSourceId
Deletes some JavaScript source code
HTTP syntax
DELETE /API/V3/ATM/JavaScript/Source/:javaScriptSourceId Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptSourceId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
GET /API/V3/ATM/JavaScript/Source/:javaScriptSourceId/Timeline
Returns the timeline of JavaScript source changes
HTTP syntax
GET /API/V3/ATM/JavaScript/Source/:javaScriptSourceId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline JavaScript syntax
Pqf.atm.getJavaScriptSourceTimeline(javaScriptSourceId, limit, until, from, granularity) // returns PF.VersionTimeline
// Overloads for optional parameters
Pqf.atm.getJavaScriptSourceTimeline(javaScriptSourceId, limit, until, from) // returns PF.VersionTimeline
Pqf.atm.getJavaScriptSourceTimeline(javaScriptSourceId, limit, until) // returns PF.VersionTimeline
Pqf.atm.getJavaScriptSourceTimeline(javaScriptSourceId, limit) // returns PF.VersionTimeline
Pqf.atm.getJavaScriptSourceTimeline(javaScriptSourceId) // returns PF.VersionTimeline Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptSourceId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
limit |
int? | Limits the number of slots | i > 0 (The value, if present, must be greater than 0.) |
|
until |
datetime | Latest date of the timeline | ||
from |
datetime | Earliest date of the timeline | ||
granularity |
PF.CalendarGranularity | The granularity of the timeline |
Result
This endpoint returns the following data: PF.VersionTimeline
GET /API/V3/ATM/JavaScript/Source/:javaScriptSourceId/Version/:versionId
Returns a specific version of some JavaScript source code
HTTP syntax
GET /API/V3/ATM/JavaScript/Source/:javaScriptSourceId/Version/:versionId
<- application/json : JavaScriptSource JavaScript syntax
Pqf.atm.getJavaScriptSourceVersion(javaScriptSourceId, versionId) // returns JavaScriptSource Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptSourceId |
UUID | The ID of the source code / sandbox | ✔️ | matches '[ (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | The version to get | ✔️ | matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.) |
Result
This endpoint returns the following data: JavaScriptSource
GET /API/V3/ATM/JavaScript/Sources
Get References to all JavaScript sources
HTTP syntax
GET /API/V3/ATM/JavaScript/Sources?sort=...
<- application/json JavaScript syntax
Pqf.atm.getAllJavaScriptSources(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.atm.getAllJavaScriptSources() // returns PF.Reference[] Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
sort |
array of string | Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, createdAt, modifiedAt, name, code, description, color, apiVersion, shareAsLibrary | pqforce.performance.sort.max >= length > 0;non-null & matches '[ (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".) |
Result
This endpoint returns the following data: array of PF.Reference
GET /API/V3/ATM/JavaScript/Sources/:javaScriptSourceIds
Returns some JavaScript sources specified by their IDs
HTTP syntax
GET /API/V3/ATM/JavaScript/Sources/:javaScriptSourceIds
<- application/json JavaScript syntax
Pqf.atm.getJavaScriptSources(javaScriptSourceIds) // returns JavaScriptSource[] Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptSourceIds |
array of UUID | The IDs of the source codes / sandboxes | ✔️ | pqforce.performance.bulk.max >= length > 0;non-null & matches '[ (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
Result
This endpoint returns the following data: array of JavaScriptSource
Data types
ATM.CompileError
This is a structure data contract.
Information about a compilation error of programming code
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
sourceId |
UUID | The source file or ID | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
line |
int? | The line on which the error occurred | ||
message |
string | A descriptive text about the error |
ATM.JavaScriptApiPerformanceStats
This is a structure data contract.
Contains JavaScript performance statistics for a specific API call
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
endpoint |
string | The name of the API endpoint | non-null (The value is required.) |
|
count |
int | Contains the number of calls | ||
totalRunTimeMs |
long | Contains the total run time in milliseconds (over all calls) |
ATM.JavaScriptChangeTrigger
This is a structure data contract.
Describes when to trigger a JavaScript program automatically
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
objectType |
UUID | The object type to listen for changes | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
|
objectId |
UUID | The object ID to listen for changes (null for all objects of given type) | matches '[ (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
action |
PF.Action | The action that triggers the program (null for all actions) |
ATM.JavaScriptConsole
This is a structure data contract.
Contains lines with JavaScript console logs
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
logs |
array of JavaScriptConsoleLog | The lines ordered by timestamp | non-null;non-null (The array is required. Each element must not be null.) |
ATM.JavaScriptConsoleLog
This is a structure data contract.
A line of JavaScript console log
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
timestamp |
datetime | The time when the log was done | non-null (The value is required.) |
|
sandboxId |
UUID | The ID of the sandbox / script | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
type |
JavaScriptConsoleLogType | The type of log | non-null (The value is required.) |
|
text |
string | The text that was logged |
ATM.JavaScriptConsoleLogType
This is an enumeration data contract.
The different types for JavaScript logs
Enum values
| ID | Description |
|---|---|
START |
Marks the start time of a script |
LOG |
This is a console log / output that was programmatically triggered |
FINISH |
Marks the end time of a script execution |
WARN |
This is a warning (compile / runtime) in a script |
ERROR |
This is an error (compile / runtime) in a script |
ATM.JavaScriptLibrary
This is a structure data contract.
Describes a JavaScript library
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
name |
string | The name of the library | non-null & matches '.+' (The value is required and must be a single line that is not empty.) |
|
version |
string | The version of the library | ||
authors |
string | The authors of the library | ||
license |
string | The license of the library | ||
url |
URI | The url to the homepage with further information |
ATM.JavaScriptPerformanceStats
This is a structure data contract.
Contains JavaScript performance statistics
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
successful |
int | Contains the number of successful completions | ||
failed |
int | Contains the number of failed attempts to complete | ||
totalRunTimeMs |
long | Contains the total run time in milliseconds (over all attempts) | ||
totalApiStats |
array of JavaScriptApiPerformanceStats | Contains the total run time in milliseconds for each API that was called (over all attempts) | non-null;non-null (The array is required. Each element must not be null.) |
|
totalJavaScriptRunTimeMs |
long | Contains the total JavaScript run time in milliseconds (over all attempts) |
ATM.JavaScriptQuota
This is a structure data contract.
Contains information about the JavaScript quota
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
max |
duration | The maximum running time per hour | non-null (The value is required.) |
|
used |
duration | The running time during the last hour | non-null (The value is required.) |
ATM.JavaScriptSource
This is a structure data contract.
A JavaScript program
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
type |
UUID | ✔️ | The type of the object (used for change notifications) | non-null & matches '[ (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.) |
id |
UUID | ✔️ | The ID of the object (often a UUID, but not necessarily) | non-null & matches '[ (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
versionId |
UUID | ✔️ | A unique identifier for the version, a UUID | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
historic |
boolean | ✔️ | true, if there is a more recent version of this object; false, if this is the most recent version of this object | |
createdAt |
datetime | ✔️ | The point in time when the object was created | |
createdBy |
PF.Reference | ✔️ | Reference to the user that created this object | |
modifiedAt |
datetime | ✔️ | The point in time when the object was modified | |
modifiedBy |
PF.Reference | ✔️ | Reference to the user that modified this object | |
name |
string | ✔️ | The name of the object (in the user's language, if translations are available) | |
code |
string | ✔️ | A short code which may be unique over all objects of the same type | matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.) |
description |
string | ✔️ | A descriptive text about the object, may contain HTML | |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
URI | ✔️ | value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/ |
matches '(?:/ (The value, if present, must match the regular expression shown.) |
apiVersion |
PF.ApiVersion | The version of the PQFORCE API to be used | non-null (The value is required.) |
|
libraryIds |
array of UUID | The libraries in use | non-null;non-null & matches '[ (The array is required. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.) |
|
shareAsLibrary |
boolean | Set this flag, if source can be included by others as library | ||
permissionOverride |
boolean | Set this flag, if source should be executed with same permissions as last modifying user, even if ran or triggered by someone else | ||
authors |
string | The authors of the script (which do not necessarily need to be one of the users that created or modified it) | ||
sourceCode |
string | The JavaScript source code | non-null (The value is required.) |