API V3 Documentation – TDP

PQFORCE 4.26.6 Preview

Preview: this documents PQFORCE 4.26.6, which has not been released yet.

Endpoints

GET /API/V3/TDP/AssignableObjectType/:objectType

Returns a single PQFORCE object type to which external objects may be assigned

HTTP syntax

GET /API/V3/TDP/AssignableObjectType/:objectType
<- application/json : AssignableObjectType

JavaScript syntax

Pqf.tdp.getAssignableObjectType(objectType) // returns AssignableObjectType

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: AssignableObjectType

GET /API/V3/TDP/AssignableObjectTypes

Returns all PQFORCE object types to which external objects may be assigned

HTTP syntax

GET /API/V3/TDP/AssignableObjectTypes
<- application/json

JavaScript syntax

Pqf.tdp.getAllAssignableObjectTypes() // returns AssignableObjectType[]

Result

This endpoint returns the following data: array of AssignableObjectType

GET /API/V3/TDP/ExternalObject/:objectType/:externalObjectId

Get a object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object

HTTP syntax

GET /API/V3/TDP/ExternalObject/:objectType/:externalObjectId
<- application/json : ExternalObject

JavaScript syntax

Pqf.tdp.getExternalObject(objectType, externalObjectId) // returns ExternalObject

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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: ExternalObject

PUT /API/V3/TDP/ExternalObject/:objectType/:externalObjectId

Update an existing object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object

HTTP syntax

PUT /API/V3/TDP/ExternalObject/:objectType/:externalObjectId
-> application/json : ExternalObject

JavaScript syntax

Pqf.tdp.putExternalObject(objectType, externalObjectId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission UPDATE or CREATE on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ExternalObject JSON object of type ExternalObject ✔️

DELETE /API/V3/TDP/ExternalObject/:objectType/:externalObjectId

Delete a object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object

HTTP syntax

DELETE /API/V3/TDP/ExternalObject/:objectType/:externalObjectId

JavaScript syntax

Pqf.tdp.delExternalObject(objectType, externalObjectId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission DELETE on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)

DELETE /API/V3/TDP/ExternalObject/:objectType/:externalObjectId/Assign

Takes a single external object away from a PQFORCE object, leaving the other assignments of that object alone

HTTP syntax

DELETE /API/V3/TDP/ExternalObject/:objectType/:externalObjectId/Assign?objectId=...

JavaScript syntax

Pqf.tdp.unassignExternalObject(objectType, externalObjectId, objectId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /3rdPartyRef and ID specified in parameter objectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The external object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
objectId UUID The ID of the PQFORCE object the external object should be taken away from (required) ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/TDP/ExternalObject/:objectType/:externalObjectId/Assign

Assigns a single external object to a PQFORCE object, leaving the other assignments of that object alone

HTTP syntax

POST /API/V3/TDP/ExternalObject/:objectType/:externalObjectId/Assign?objectId=...

JavaScript syntax

Pqf.tdp.assignExternalObject(objectType, externalObjectId, objectId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /3rdPartyRef and ID specified in parameter objectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The external object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
objectId UUID The ID of the PQFORCE object the external object should be assigned to (required) ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/TDP/ExternalObject/:objectType/:externalObjectId/Identification

Get a object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object identification

HTTP syntax

GET /API/V3/TDP/ExternalObject/:objectType/:externalObjectId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.tdp.getExternalObjectIdentification(objectType, externalObjectId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.tdp.getExternalObjectIdentification(objectType, externalObjectId) // returns PF.IdentificationExtended

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Parameters

Name Type Description Required Assertion Default, if omitted
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

GET /API/V3/TDP/ExternalObject/:objectType/:externalObjectId/Timeline

Get a object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's version timeline

HTTP syntax

GET /API/V3/TDP/ExternalObject/:objectType/:externalObjectId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.tdp.getExternalObjectTimeline(objectType, externalObjectId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.tdp.getExternalObjectTimeline(objectType, externalObjectId, limit, until, from) // returns PF.VersionTimeline
Pqf.tdp.getExternalObjectTimeline(objectType, externalObjectId, limit, until) // returns PF.VersionTimeline
Pqf.tdp.getExternalObjectTimeline(objectType, externalObjectId, limit) // returns PF.VersionTimeline
Pqf.tdp.getExternalObjectTimeline(objectType, externalObjectId) // returns PF.VersionTimeline

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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/TDP/ExternalObject/:objectType/:externalObjectId/Version/:versionId

Get a object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's specific (historic) version

HTTP syntax

GET /API/V3/TDP/ExternalObject/:objectType/:externalObjectId/Version/:versionId
<- application/json : ExternalObject

JavaScript syntax

Pqf.tdp.getExternalObjectVersion(objectType, externalObjectId, versionId) // returns ExternalObject

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID specified in parameter externalObjectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectId UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 retrieve ✔️ 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: ExternalObject

GET /API/V3/TDP/ExternalObjectByKey/:objectType/:externalKey

Returns the external object the external system identifies by the given key

HTTP syntax

GET /API/V3/TDP/ExternalObjectByKey/:objectType/:externalKey
<- application/json : ExternalObject

JavaScript syntax

Pqf.tdp.getExternalObjectByKey(objectType, externalKey) // returns ExternalObject

Required permission

Requires permission 89B9C145181848B0ABDF8AF6E03B0749.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalKey string The key the external system uses for the object ✔️ non-null & matches '.{1,255}' (The value is required and must be a single line of 1 to 255 characters.)

Result

This endpoint returns the following data: ExternalObject

PUT /API/V3/TDP/ExternalObjectByKey/:objectType/:externalKey

Creates or updates the external object the external system identifies by the given key

HTTP syntax

PUT /API/V3/TDP/ExternalObjectByKey/:objectType/:externalKey
-> application/json : ExternalObject

JavaScript syntax

Pqf.tdp.putExternalObjectByKey(objectType, externalKey, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 89B9C145181848B0ABDF8AF6E03B0749.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalKey string The key the external system uses for the object ✔️ non-null & matches '.{1,255}' (The value is required and must be a single line of 1 to 255 characters.)
requestJson ExternalObject JSON object of type ExternalObject ✔️

DELETE /API/V3/TDP/ExternalObjectByKey/:objectType/:externalKey

Deletes the external object the external system identifies by the given key

HTTP syntax

DELETE /API/V3/TDP/ExternalObjectByKey/:objectType/:externalKey

JavaScript syntax

Pqf.tdp.delExternalObjectByKey(objectType, externalKey) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission 89B9C145181848B0ABDF8AF6E03B0749.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalKey string The key the external system uses for the object ✔️ non-null & matches '.{1,255}' (The value is required and must be a single line of 1 to 255 characters.)

GET /API/V3/TDP/ExternalObjects/:objectType

Returns references to the external objects mirrored for a PQFORCE object type, the assigned ones, the unassigned ones or both; each reference carries the key of the external system, and an assigned one the PQFORCE object it is assigned to as its parent. tdp.getExternalObjects reads the objects themselves by ID

HTTP syntax

GET /API/V3/TDP/ExternalObjects/:objectType?assigned=...&unassigned=...&sort=...
<- application/json

JavaScript syntax

Pqf.tdp.getAllExternalObjects(objectType, assigned, unassigned, sort) // returns ExternalObjectReference[]

// Overloads for optional parameters
Pqf.tdp.getAllExternalObjects(objectType, assigned, unassigned) // returns ExternalObjectReference[]
Pqf.tdp.getAllExternalObjects(objectType, assigned) // returns ExternalObjectReference[]
Pqf.tdp.getAllExternalObjects(objectType) // returns ExternalObjectReference[]

Required permission

The returned array is filtered and contains only objects with permission READ.

Parameters

Name Type Description Required Assertion Default, if omitted
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
assigned boolean Return the external objects that are assigned to a PQFORCE object true
unassigned boolean Return the external objects that are not assigned to any PQFORCE object true
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, externalKey, name, code, description, assignedTo pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (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 ExternalObjectReference

GET /API/V3/TDP/ExternalObjects/:objectType/:externalObjectIds

Get multiple object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE objects

HTTP syntax

GET /API/V3/TDP/ExternalObjects/:objectType/:externalObjectIds
<- application/json

JavaScript syntax

Pqf.tdp.getExternalObjects(objectType, externalObjectIds) // returns ExternalObject[]

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID in specified in parameter externalObjectIds.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectIds array of UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 ExternalObject

GET /API/V3/TDP/ExternalObjects/:objectType/:externalObjectIds/Identification

Get multiple object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object identifications

HTTP syntax

GET /API/V3/TDP/ExternalObjects/:objectType/:externalObjectIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.tdp.getExternalObjectIdentifications(objectType, externalObjectIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.tdp.getExternalObjectIdentifications(objectType, externalObjectIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type external object

This endpoint is part of a group of endpoints manipulating objects of type external object. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type specified in parameter objectType prefixed with 3rdPartyRef/ and ID in specified in parameter externalObjectIds.

Parameters

Name Type Description Required Assertion Default, if omitted
objectType UUID The PQFORCE object type that carries external objects ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
externalObjectIds array of UUID The object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: array of PF.IdentificationExtended

GET /API/V3/TDP/Object/:objectType/:objectId/ExternalObjects

Returns the external objects assigned to a PQFORCE object

HTTP syntax

GET /API/V3/TDP/Object/:objectType/:objectId/ExternalObjects
<- application/json

JavaScript syntax

Pqf.tdp.getExternalObjectAssignments(objectType, objectId) // returns PF.Reference[]

Required permission

Requires permission READ on object of type specified in parameter objectType suffixed with /3rdPartyRef and ID specified in parameter objectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object's type ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
objectId UUID The PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 PF.Reference

PUT /API/V3/TDP/Object/:objectType/:objectId/ExternalObjects

Replaces the set of external objects assigned to a PQFORCE object

HTTP syntax

PUT /API/V3/TDP/Object/:objectType/:objectId/ExternalObjects
-> application/json

JavaScript syntax

Pqf.tdp.putExternalObjectAssignments(objectType, objectId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type specified in parameter objectType suffixed with /3rdPartyRef and ID specified in parameter objectId.

Parameters

Name Type Description Required Assertion
objectType UUID The PQFORCE object's type ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
objectId UUID The PQFORCE object's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 array of PF.Reference JSON object of type array of Reference ✔️

Data types

TDP.AssignableObjectType

This is a structure data contract.

A PQFORCE object type to which objects of an external system may be assigned

Members

Name Type Inherited Description Assertion
type UUID The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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: the third party reference group type followed by the PQFORCE object type. That is longer than an ordinary ID may be, which is why this contract declares type and ID itself instead of deriving them from pf.Reference non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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.)
objectType UUID The PQFORCE object type that carries external objects, the value to pass as objectType in the TDP endpoints matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
maxCount int? How many external objects may be assigned to one PQFORCE object of this type, null if there is no limit

TDP.ExternalObject

This is a structure data contract.

An object of an external system mirrored in PQFORCE, optionally assigned to a PQFORCE object

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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 object on the external system
code string The code of the object on the external system, often identical with its key
description string The description of the object on the external system
iconUrl URI The icon of the object on the external system; unlike iconRef of a PQFORCE object this is an arbitrary URL of the external system
externalKey string The key the external system uses for the object; it is immutable and determines the id together with the PQFORCE object type matches '.{1,255}' (The value, if present, must be a single line of 1 to 255 characters.)
assignedTo PF.Reference The PQFORCE object this external object is assigned to, null if it is assigned to none. On a write, null keeps the current assignment, and naming a different PQFORCE object while one is assigned is refused with 400 - unassign it first
additionalData string Data that PQFORCE stores but does not interpret, at the disposal of the integrating agent

TDP.ExternalObjectReference

This is a structure data contract.

A reference to an external object mirrored in PQFORCE, with the key it carries in the external system and the PQFORCE object it is assigned to

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (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 '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (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.)
parent PF.Reference ✔️ A reference to a parent (if any)
externalKey string The key the external system uses for the object; it is immutable and determines the id together with the PQFORCE object type matches '.{1,255}' (The value, if present, must be a single line of 1 to 255 characters.)
↑

Notification

Portal tour

A guided tour walks you through the page step by step, highlighting one control at a time and explaining what it does. You can stop at any point and pick up later.

    Tours can be restarted at any time.

    Release notes are automatically translated into German.