DOCS
Ask or search…
K
Links

REST API

get
/data-policies
ListDataPolicies

Lists all DataPolicies for all platforms.

Parameters
Query
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/catalogs
ListCatalogs

Lists all configured catalogs.

Parameters
Query
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/catalogs/{catalogId}/blueprint-policy
GetBlueprintPolicy

Returns a data policy without any rule sets, based on the given table's data structure in the catalog. Extend this blueprint policy with field transforms and/or rule sets to create a complete data policy. Use the UpsertDataPolicy endpoint to save and enforce the policy.

Parameters
Path
catalogId*
string
Query
databaseId
string
schemaId
string
tableId
string
fqn
string
Responses
200: OK
OK
default
Default error response
get
/v1alpha/catalogs/{catalogId}/databases
ListDatabases

Lists all databases for the given catalog.

Parameters
Path
catalogId*
string
Query
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/catalogs/{catalogId}/schemas
ListSchemas

Lists all schemas (for a given database, if applicable).

Parameters
Path
catalogId*
string
Query
databaseId
string
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/catalogs/{catalogId}/tables
ListTables

Lists all tables (for a given schema and database, if applicable).

Parameters
Path
catalogId*
string
Query
databaseId
string
schemaId
string
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
post
/v1alpha/data-policies
UpsertDataPolicy

Creates or updates a DataPolicy in PACE and optionally applies it to the processing platform.

Parameters
No parameters
Body
Example
Schema
{
"apply": true,
"dataPolicy": {
"metadata": {
"createTime": "2024-02-25T04:30:17.620Z",
"description": "string",
"lastApplyTime": "2024-02-25T04:30:17.620Z",
"tags": [
"string"
],
"title": "string",
"updateTime": "2024-02-25T04:30:17.620Z",
"version": 0
},
"ruleSets": [
{
"fieldTransforms": [
{
"field": {
"nameParts": [
"string"
],
"required": true,
"tags": [
"string"
],
"type": "string"
},
"transforms": [
{
"aggregation": {
"avg": {
"castTo": "string",
"precision": 0
},
"max": {},
"min": {},
"partitionBy": [
null
],
"sum": {}
},
"detokenize": {
"tokenField": {},
"tokenSourceRef": "string",
"valueField": {}
},
"fixed": {
"value": "string"
},
"hash": {
"seed": "string"
},
"identity": {},
"nullify": {},
"numericRounding": {
"ceil": {
"divisor": 0
},
"floor": {
"divisor": 0
},
"round": {
"divisor": 0,
"precision": 0
}
},
"principals": [
{
"group": "string",
"permission": "string",
"role": "string"
}
],
"regexp": {
"regexp": "string",
"replacement": "string"
},
"sqlStatement": {
"statement": "string"
}
}
]
}
],
"filters": [
{
"genericFilter": {
"conditions": [
{
"condition": "string",
"principals": [
null
]
}
]
},
"retentionFilter": {
"conditions": [
{
"period": {
"days": "string"
},
"principals": [
null
]
}
],
"field": {}
}
}
],
"target": {
"ref": {
"catalog": {
"databases": [
{
"displayName": "string",
"id": "string",
"processingPlatform": {
"id": "string",
"platformType": "PLATFORM_TYPE_UNSPECIFIED"
},
"schemas": [
{
"id": "string",
"name": "string",
"tables": [
{
"id": "string",
"name": "string",
"schema": {},
"tags": [
"string"
]
}
],
"tags": [
"string"
]
}
],
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"tags": [
"string"
],
"type": "TYPE_UNSPECIFIED"
},
"integrationFqn": "string",
"resourcePath": [
{
"displayName": "string",
"isLeaf": true,
"name": "string",
"platformName": "string"
}
]
},
"type": "TARGET_TYPE_UNSPECIFIED"
}
}
],
"source": {
"fields": [
null
],
"ref": {},
"tags": [
"string"
]
}
}
}
Responses
200: OK
OK
default
Default error response
get
/v1alpha/data-policies/lineage
ScanLineage
Parameters
Query
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
post
/v1alpha/data-policies/transpile
TranspileDataPolicy
Parameters
No parameters
Body
Example
Schema
{
"dataPolicyRef": {
"dataPolicyId": "string",
"platformId": "string"
},
"inlineDataPolicy": {
"metadata": {
"createTime": "2024-02-25T04:30:17.623Z",
"description": "string",
"lastApplyTime": "2024-02-25T04:30:17.623Z",
"tags": [
"string"
],
"title": "string",
"updateTime": "2024-02-25T04:30:17.623Z",
"version": 0
},
"ruleSets": [
{
"fieldTransforms": [
{
"field": {
"nameParts": [
"string"
],
"required": true,
"tags": [
"string"
],
"type": "string"
},
"transforms": [
{
"aggregation": {
"avg": {
"castTo": "string",
"precision": 0
},
"max": {},
"min": {},
"partitionBy": [
null
],
"sum": {}
},
"detokenize": {
"tokenField": {},
"tokenSourceRef": "string",
"valueField": {}
},
"fixed": {
"value": "string"
},
"hash": {
"seed": "string"
},
"identity": {},
"nullify": {},
"numericRounding": {
"ceil": {
"divisor": 0
},
"floor": {
"divisor": 0
},
"round": {
"divisor": 0,
"precision": 0
}
},
"principals": [
{
"group": "string",
"permission": "string",
"role": "string"
}
],
"regexp": {
"regexp": "string",
"replacement": "string"
},
"sqlStatement": {
"statement": "string"
}
}
]
}
],
"filters": [
{
"genericFilter": {
"conditions": [
{
"condition": "string",
"principals": [
null
]
}
]
},
"retentionFilter": {
"conditions": [
{
"period": {
"days": "string"
},
"principals": [
null
]
}
],
"field": {}
}
}
],
"target": {
"ref": {
"catalog": {
"databases": [
{
"displayName": "string",
"id": "string",
"processingPlatform": {
"id": "string",
"platformType": "PLATFORM_TYPE_UNSPECIFIED"
},
"schemas": [
{
"id": "string",
"name": "string",
"tables": [
{
"id": "string",
"name": "string",
"schema": {},
"tags": [
"string"
]
}
],
"tags": [
"string"
]
}
],
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"tags": [
"string"
],
"type": "TYPE_UNSPECIFIED"
},
"integrationFqn": "string",
"resourcePath": [
{
"displayName": "string",
"isLeaf": true,
"name": "string",
"platformName": "string"
}
]
},
"type": "TARGET_TYPE_UNSPECIFIED"
}
}
],
"source": {
"fields": [
null
],
"ref": {},
"tags": [
"string"
]
}
}
}
Responses
200: OK
OK
default
Default error response
get
/v1alpha/data-policies/{dataPolicyId}/{platformId}
GetDataPolicy

Returns the latest policy for a given id and platform.

Parameters
Path
dataPolicyId*
string
platformId*
string
Responses
200: OK
OK
default
Default error response
post
/v1alpha/data-policies/{dataPolicyId}/{platformId}
ApplyDataPolicy

Applies an existing DataPolicy to the processing platform.

Parameters
Path
dataPolicyId*
string
platformId*
string
Responses
200: OK
OK
default
Default error response
post
/v1alpha/data-policies/{data_policy_id}/{platform_id}/evaluate
EvaluateDataPolicy

Evaluates a previously upserted DataPolicy against a provided data sample. Platform-specific data types, transforms and nested fields are not supported.

Parameters
Path
data_policy_id*
string
platform_id*
string
Body
Example
Schema
{
"csvSample": {
"csv": "string"
},
"dataPolicyRef": {
"dataPolicyId": "string",
"platformId": "string"
},
"inlineDataPolicy": {
"metadata": {
"createTime": "2024-02-25T04:30:17.626Z",
"description": "string",
"lastApplyTime": "2024-02-25T04:30:17.626Z",
"tags": [
"string"
],
"title": "string",
"updateTime": "2024-02-25T04:30:17.626Z",
"version": 0
},
"ruleSets": [
{
"fieldTransforms": [
{
"field": {
"nameParts": [
"string"
],
"required": true,
"tags": [
"string"
],
"type": "string"
},
"transforms": [
{
"aggregation": {
"avg": {
"castTo": "string",
"precision": 0
},
"max": {},
"min": {},
"partitionBy": [
null
],
"sum": {}
},
"detokenize": {
"tokenField": {},
"tokenSourceRef": "string",
"valueField": {}
},
"fixed": {
"value": "string"
},
"hash": {
"seed": "string"
},
"identity": {},
"nullify": {},
"numericRounding": {
"ceil": {
"divisor": 0
},
"floor": {
"divisor": 0
},
"round": {
"divisor": 0,
"precision": 0
}
},
"principals": [
{
"group": "string",
"permission": "string",
"role": "string"
}
],
"regexp": {
"regexp": "string",
"replacement": "string"
},
"sqlStatement": {
"statement": "string"
}
}
]
}
],
"filters": [
{
"genericFilter": {
"conditions": [
{
"condition": "string",
"principals": [
null
]
}
]
},
"retentionFilter": {
"conditions": [
{
"period": {
"days": "string"
},
"principals": [
null
]
}
],
"field": {}
}
}
],
"target": {
"ref": {
"catalog": {
"databases": [
{
"displayName": "string",
"id": "string",
"processingPlatform": {
"id": "string",
"platformType": "PLATFORM_TYPE_UNSPECIFIED"
},
"schemas": [
{
"id": "string",
"name": "string",
"tables": [
{
"id": "string",
"name": "string",
"schema": {},
"tags": [
"string"
]
}
],
"tags": [
"string"
]
}
],
"tags": [
"string"
],
"type": "string"
}
],
"id": "string",
"tags": [
"string"
],
"type": "TYPE_UNSPECIFIED"
},
"integrationFqn": "string",
"resourcePath": [
{
"displayName": "string",
"isLeaf": true,
"name": "string",
"platformName": "string"
}
]
},
"type": "TARGET_TYPE_UNSPECIFIED"
}
}
],
"source": {
"fields": [
null
],
"ref": {},
"tags": [
"string"
]
}
},
"principals": [
null
]
}
Responses
200: OK
OK
default
Default error response
get
/v1alpha/global-transforms
ListGlobalTransforms
Parameters
Body
*
array
Responses
200: OK
OK
default
Default error response
post
/v1alpha/global-transforms
UpsertGlobalTransform
Parameters
No parameters
Body
Example
Schema
{
"transform": {
"description": "string",
"tagTransform": {
"tagContent": "string",
"transforms": [
{
"aggregation": {
"avg": {
"castTo": "string",
"precision": 0
},
"max": {},
"min": {},
"partitionBy": [
{
"nameParts": [
"string"
],
"required": true,
"tags": [
"string"
],
"type": "string"
}
],
"sum": {}
},
"detokenize": {
"tokenField": {},
"tokenSourceRef": "string",
"valueField": {}
},
"fixed": {
"value": "string"
},
"hash": {
"seed": "string"
},
"identity": {},
"nullify": {},
"numericRounding": {
"ceil": {
"divisor": 0
},
"floor": {
"divisor": 0
},
"round": {
"divisor": 0,
"precision": 0
}
},
"principals": [
{
"group": "string",
"permission": "string",
"role": "string"
}
],
"regexp": {
"regexp": "string",
"replacement": "string"
},
"sqlStatement": {
"statement": "string"
}
}
]
}
}
}
Responses
200: OK
OK
default
Default error response
get
/v1alpha/global-transforms/{ref}/{type}
GetGlobalTransform
Parameters
Path
ref*
string
this ref refers to the primary key in the oneof transform, so its use depends on which one it is. TAG_TRANSFORM -> TagTransform.tag_content no others defined (yet).
type*
string
Responses
200: OK
OK
default
Default error response
delete
/v1alpha/global-transforms/{ref}/{type}
DeleteGlobalTransform
Parameters
Path
ref*
string
type*
string
Body
Example
Schema
{
"ref": "string",
"type": "string"
}
Responses
200: OK
OK
default
Default error response
get
/v1alpha/plugins
ListPlugins
Parameters
No parameters
Responses
200: OK
OK
default
Default error response
post
/v1alpha/plugins/{pluginId}/actions/{action.type}
InvokePlugin
Parameters
Path
pluginId*
string
The identifier of the plugin to invoke.
action.type*
string
Body
Example
Schema
{
"action": {
"invokable": true,
"type": "ACTION_UNSPECIFIED"
},
"dataPolicyGeneratorParameters": {
"payload": "string"
},
"pluginId": "string",
"sampleDataGeneratorParameters": {
"payload": "string"
}
}
Responses
200: OK
OK
default
Default error response
get
/v1alpha/plugins/{pluginId}/actions/{action.type}/payload-json-schema
GetPayloadJSONSchema
Parameters
Path
pluginId*
string
The identifier of the plugin to get the payload json schema for
Query
action.type
string
The type of action that this plugin supports
action.invokable
boolean
Whether this action can be invoked through the API
Responses
200: OK
OK
default
Default error response
get
/v1alpha/processing-platforms
ListProcessingPlatforms

Lists all configured processing platforms.

Parameters
No parameters
Responses
200: OK
OK
default
Default error response
get
/v1alpha/processing-platforms/{platformId}/databases
ListDatabases

Lists all databases for the given processing_platform.

Parameters
Path
platformId*
string
Query
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/processing-platforms/{platformId}/groups
ListGroups

Lists all available user groups for the given platform.

Parameters
Path
platformId*
string
Query
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/processing-platforms/{platformId}/schemas
ListSchemas

Lists all schemas (for a given database, if applicable).

Parameters
Path
platformId*
string
Query
databaseId
string
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/processing-platforms/{platformId}/tables
ListTables

Lists all available table names for the given platform.

Parameters
Path
platformId*
string
Query
databaseId
string
schemaId
string
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Responses
200: OK
OK
default
Default error response
get
/v1alpha/processing-platforms/{platformId}/tables/{fqn}/lineage
GetLineage
Parameters
Path
platformId*
string
fqn*
string
Responses
200: OK
OK
default
Default error response
get
/v1alpha/processing-platforms/{platformId}/tables/{table_id}/blueprint-policy
GetBlueprintPolicy

Returns a data policy without any rule sets, based on the given table's data structure in the platform. Extend this blueprint policy with field transforms and/or rule sets to create a complete data policy. Use the UpsertDataPolicy endpoint to save and enforce the policy.

Parameters
Path
platformId*
string
table_id*
string
Query
table.id
string
The id used by the catalog.
table.name
string
table.schema.id
string
The id used by the catalog.
table.schema.name
string
table.schema.database.id
string
The id of the database
table.schema.database.type
string
table.schema.database.displayName
string
table.schema.database.catalog.id
string
An arbitrary but unique identifier for the catalog. This matches the id from the PACE app configuration.
table.schema.database.catalog.type
string
table.schema.database.processingPlatform.platformType
string
table.schema.database.processingPlatform.id
string
An arbitrary but unique identifier for the platform. This matches the id from the PACE app configuration.
fqn
string
Body
*
array
*
array
*
array
*
array
Responses
200: OK
OK
default
Default error response
get
/v1alpha/resources
ListResources
Parameters
Query
integrationId
string
A processing platform or data catalog id as configured in your PACE server
pageParameters.skip
integer
The provided skip value of the request. skip represents records to skip before returning results. If empty, skip is 0.
pageParameters.pageSize
integer
The provided page_size value of the request. If empty, page_size is 10.
pageParameters.pageToken
string
use this to start from a certain page.
Body
*
array
Responses
200: OK
OK
default
Default error response