API V3 Documentation – MAIN
Diese Dokumentation gibt es nur auf Englisch.
Vorschau: Diese Dokumentation beschreibt PQFORCE 4.26.6, das noch nicht veröffentlicht ist.
Endpoints
GET /API/V3/MAIN/ApiDescription/OpenApi/Json
Returns an Open API 3.2.0 JSON definition of the API V3
HTTP syntax
GET /API/V3/MAIN/ApiDescription/OpenApi/Json?modules=...
<- application/json Hint: This endpoint is static. This means that every call to the same URL will return exactly the same result. Therefore the reposne may be cached. When sending an ETag in the HTTP headers (If-None-Match header), the result 304indicates that the content in cache is still valid.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
modules |
array of string | Possibility to filter by module to decrease file size for systems that can't handle real OpenApi files | null;non-null (The array is optional. Each element must not be null.) |
Result
This endpoint returns the following data: JSON
GET /API/V3/MAIN/ApiDescription/OpenApi/Yaml
Returns an Open API 3.2.0 YAML definition of the API V3
HTTP syntax
GET /API/V3/MAIN/ApiDescription/OpenApi/Yaml?modules=...
<- text/plain; charset=utf-8 Hint: This endpoint is static. This means that every call to the same URL will return exactly the same result. Therefore the reposne may be cached. When sending an ETag in the HTTP headers (If-None-Match header), the result 304indicates that the content in cache is still valid.
Parameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
modules |
array of string | Possibility to filter by module to decrease file size for systems that can't handle real OpenApi files | null;non-null (The array is optional. Each element must not be null.) |
Result
This endpoint returns the following data: string
GET /API/V3/MAIN/ApiDescription/TypeScript
Returns a TypeScript definition of the API V3
HTTP syntax
GET /API/V3/MAIN/ApiDescription/TypeScript
<- text/x-typescript; charset=utf-8 JavaScript syntax
Pqf.main.getTypeScriptDefinition() // returns String Required license
This endpoint requires the following licenses:
- javascript
Required permission
Requires permission 5B576F18795B436792E11839A6408A14.
Result
This endpoint returns the following data: string
GET /API/V3/MAIN/ClientUI/Urls/Home
Returns the main PQFORCE URL of this instance and tenant
JavaScript syntax
Pqf.main.getHomeUrl() // returns StringResult
This endpoint returns the following data: string
GET /API/V3/MAIN/ClientUI/Urls/Object/:type/:id
Returns the PQFORCE URL of a specific object
JavaScript syntax
Pqf.main.getObjectUrl(type, id) // returns StringParameters
| Name | Type | Description | Required | Assertion |
|---|---|---|---|---|
type |
UUID | The type of 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.) |
id |
UUID | The ID of the 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.) |
Result
This endpoint returns the following data: string
GET /API/V3/MAIN/ThirdPartyComponents
Returns the third-party components shipped with the PQFORCE server, with their project URL and licenses (versions are deliberately not disclosed)
HTTP syntax
GET /API/V3/MAIN/ThirdPartyComponents
<- application/json Hint: This endpoint is static. This means that every call to the same URL will return exactly the same result. Therefore the reposne may be cached. When sending an ETag in the HTTP headers (If-None-Match header), the result 304indicates that the content in cache is still valid.
JavaScript syntax
Pqf.main.getThirdPartyComponents() // returns ThirdPartyComponent[] Result
This endpoint returns the following data: array of ThirdPartyComponent
GET /API/V3/MAIN/Versions
Returns information about the PQFORCE server and its versions (Release, API), this step is recommended to check API compatibility
HTTP syntax
GET /API/V3/MAIN/Versions
<- application/json : ServerVersionJavaScript syntax
Pqf.main.getVersion() // returns ServerVersionResult
This endpoint returns the following data: ServerVersion
Data types
MAIN.ServerVersion
This is a structure data contract.
Version information about this PQFORCE instance
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
productName |
string | The name of the product | ||
productVersion |
string | The version of the product | ||
apiGeneration |
string | The generation of API | ||
apiVersion |
string | The version of the API (three numbers divided by dots) | ||
apiFingerprint |
string | The fingerprint of the API (28 alphanumeric characters with dashes) | matches '[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}' (The value, if present, must match the regular expression shown.) |
MAIN.ThirdPartyComponent
This is a structure data contract.
A third-party component shipped with the PQFORCE server
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
organization |
string | The organization (group ID) that publishes the component | ||
name |
string | The name (artifact ID) of the component | ||
url |
string | The URL of the component's project home page, if known | ||
licenses |
array of ThirdPartyLicense | The licenses the component is published under | ||
direct |
boolean | Whether the component is a direct dependency of the server (false: it is included by another component) | ||
category |
ThirdPartyComponentCategory | Whether the component is a server library, a runtime environment or a JavaScript library | non-null (The value is required.) |
MAIN.ThirdPartyComponentCategory
This is an enumeration data contract.
The kind of a third-party component shipped with the PQFORCE server
Enum values
| ID | Description |
|---|---|
ServerLibrary |
A Java or Scala library the server is built from |
RuntimeEnvironment |
The runtime environment the server runs on (the Java runtime) |
JavaScriptLibrary |
A JavaScript library the server bundles for its scripts |
MAIN.ThirdPartyLicense
This is a structure data contract.
A license a third-party component is published under
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
name |
string | The name of the license as stated by the component | ||
url |
string | The URL of the license text, if known |