API V3 Documentation – EXP
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Endpoints
POST /API/V3/EXP/JavaScriptExport/:javaScriptExportDefinitionId/:objectType/:objectId
Output a file for a given JavaScript export definition
HTTP syntax
POST /API/V3/EXP/JavaScriptExport/:javaScriptExportDefinitionId/:objectType/:objectId?name=...
<- application/octet-stream Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionId |
UUID | The ID of the desired JavaScript export definition | ✔️ | 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 type of the desired object | ✔️ | 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 ID of the desired object | ✔️ | 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.) |
name |
string | The name of the export |
Result
This endpoint returns the following data: Binary
POST /API/V3/EXP/JavaScriptExport/:javaScriptExportDefinitionId/:objectType/:objectId/WithSettings
Output a file for a given JavaScript export definition, providing data about client settings
HTTP syntax
POST /API/V3/EXP/JavaScriptExport/:javaScriptExportDefinitionId/:objectType/:objectId/WithSettings?name=...
-> application/json
<- application/octet-stream Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionId |
UUID | The ID of the desired JavaScript export definition | ✔️ | 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 type of the desired object | ✔️ | 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 ID of the desired object | ✔️ | 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.) |
name |
string | The name of the export | ||
requestJson |
JSON | Raw content of mime type application/json | ✔️ |
Result
This endpoint returns the following data: Binary
GET /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId
Get a specific JavaScript export definition
HTTP syntax
GET /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId
<- application/json : JavaScriptExportDefinition JavaScript syntax
Pqf.exp.getExportDefinition(javaScriptExportDefinitionId) // returns JavaScriptExportDefinition Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionId |
UUID | The ID of the desired JavaScript export definition | ✔️ | 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: JavaScriptExportDefinition
GET /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId/WithTranslations
Get a specific JavaScript export definition and its translations
HTTP syntax
GET /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId/WithTranslations
<- application/json : JavaScriptExportDefinitionTranslated JavaScript syntax
Pqf.exp.getExportDefinitionTranslated(javaScriptExportDefinitionId) // returns JavaScriptExportDefinitionTranslated Required permission
Requires permission 159B865B6BC0444E92F82945D0F72BE1.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionId |
UUID | The ID of the desired JavaScript export definition | ✔️ | 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: JavaScriptExportDefinitionTranslated
PUT /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId/WithTranslations
Updates or creates a specific JavaScript export definition and its translations
HTTP syntax
PUT /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId/WithTranslations
-> application/json : JavaScriptExportDefinitionTranslated JavaScript syntax
Pqf.exp.putExportDefinitionTranslated(javaScriptExportDefinitionId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 159B865B6BC0444E92F82945D0F72BE1.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionId |
UUID | The ID of the desired JavaScript export definition | ✔️ | 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 |
JavaScriptExportDefinitionTranslated | JSON object of type JavaScriptExportDefinitionTranslated | ✔️ |
DELETE /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId/WithTranslations
Deletes a specific JavaScript export definition
HTTP syntax
DELETE /API/V3/EXP/JavaScriptExportDefinition/:javaScriptExportDefinitionId/WithTranslations JavaScript syntax
Pqf.exp.delExportDefinitionTranslated(javaScriptExportDefinitionId) // returns Number - the return code (HTTP 2xx code) of the call Required permission
Requires permission 159B865B6BC0444E92F82945D0F72BE1.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionId |
UUID | The ID of the desired JavaScript export definition | ✔️ | 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/EXP/JavaScriptExportDefinitions
Get references to all JavaScript export definitions
HTTP syntax
GET /API/V3/EXP/JavaScriptExportDefinitions?sort=...
<- application/json JavaScript syntax
Pqf.exp.getAllExportDefinitions(sort) // returns PF.Reference[]
// Overloads for optional parameters
Pqf.exp.getAllExportDefinitions() // returns PF.Reference[] 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 | 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/EXP/JavaScriptExportDefinitions/:javaScriptExportDefinitionIds
Returns some JavaScript export definitions specified by their IDs
HTTP syntax
GET /API/V3/EXP/JavaScriptExportDefinitions/:javaScriptExportDefinitionIds
<- application/json JavaScript syntax
Pqf.exp.getExportDefinitions(javaScriptExportDefinitionIds) // returns JavaScriptExportDefinition[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionIds |
array of UUID | The IDs of the desired JavaScript export definitions | ✔️ | 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 JavaScriptExportDefinition
GET /API/V3/EXP/JavaScriptExportDefinitions/:javaScriptExportDefinitionIds/WithTranslations
Returns some JavaScript export definitions specified by their IDs and their translations
HTTP syntax
GET /API/V3/EXP/JavaScriptExportDefinitions/:javaScriptExportDefinitionIds/WithTranslations
<- application/json JavaScript syntax
Pqf.exp.getExportDefinitionsTranslated(javaScriptExportDefinitionIds) // returns JavaScriptExportDefinitionTranslated[] Required permission
Requires permission 159B865B6BC0444E92F82945D0F72BE1.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
javaScriptExportDefinitionIds |
array of UUID | The IDs of the desired JavaScript export definitions | ✔️ | 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 JavaScriptExportDefinitionTranslated
GET /API/V3/EXP/ObjectType/:objectType/JavaScriptExportDefinitions
Get references to all JavaScript export definitions defined for an object type
HTTP syntax
GET /API/V3/EXP/ObjectType/:objectType/JavaScriptExportDefinitions
<- application/json JavaScript syntax
Pqf.exp.getExportDefinitionsForObjectType(objectType) // returns PF.Reference[] Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
objectType |
UUID | The type of the object | ✔️ | 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.) |
Result
This endpoint returns the following data: array of PF.Reference
Data types
EXP.JavaScriptExportDefinition
This is a structure data contract.
Information about a JavaScript export definition
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.) |
attachmentId |
string | Attachment file ID | matches '[0-9A-Z]{52} (The value, if present, must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).) |
|
sandboxId |
UUID | JavaScript source code ID | 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.) |
|
objectTypes |
array of string | Type of object for which the definition exists | null;non-null (The array is optional. Each element must not be null.) |
|
features |
array of string | the features (tabs) this export should be available in (null for all) | null;non-null (The array is optional. Each element must not be null.) |
|
views |
array of string | the views (screen areas) this export should be available in (null for all) | null;non-null (The array is optional. Each element must not be null.) |
|
includeInBackup |
boolean | Flag to indicate that an export should be included into backup files |
EXP.JavaScriptExportDefinitionTranslated
This is a structure data contract.
Information about a JavaScript export definition with translations
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 |
array of PF.TextTranslation | ✔️ | The name of the object in different languages | null;non-null (The array is optional. Each element must not be null.) |
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 |
array of PF.TextTranslation | ✔️ | A descriptive text about the object, may contain HTML (in different languages) | null;non-null (The array is optional. Each element must not be null.) |
color |
color | ✔️ | A color or any identifier of a color (which does not necessarily correspond to the W3C definitions) | |
iconRef |
array of PF.IconTranslation | ✔️ | 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/ |
null;non-null (The array is optional. Each element must not be null.) |
attachmentId |
string | Attachment file ID | matches '[0-9A-Z]{52} (The value, if present, must be a hashed ID (52 upper-case letters and digits, or 43 letters and digits).) |
|
sandboxId |
UUID | JavaScript source code ID | 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.) |
|
objectTypes |
array of string | Type of object for which the definition exists | null;non-null (The array is optional. Each element must not be null.) |
|
features |
array of string | the features (tabs) this export should be available in (null for all) | null;non-null (The array is optional. Each element must not be null.) |
|
views |
array of string | the views (screen areas) this export should be available in (null for all) | null;non-null (The array is optional. Each element must not be null.) |
|
includeInBackup |
boolean | Flag to indicate that an export should be included into backup files |