--- title: "GetBlueprintPolicy" method: GET path: "/processing-platforms/{platformId}/tables/{tableId}/blueprint-policy" tags: ["ProcessingPlatformsService"] --- # GetBlueprintPolicy `GET /processing-platforms/{platformId}/tables/{tableId}/blueprint-policy` 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. ## Path parameters - `platformId` string, required - `tableId` string, required ## Response `200` OK - GetBlueprintPolicyResponse - `dataPolicy` DataPolicy - `id` string - `metadata` DataPolicyMetadata - `createTime` string, date-time - `description` string - `lastApplyTime` string, date-time — The last time the policy was applied to the target(s). - `tags` string[] - `title` string - `updateTime` string, date-time - `version` integer — For new policies, the version does not need to be set. When updating a policy, the version must match the current version. The version is then automatically incremented. - `platform` DataPolicyProcessingPlatform - `id` string — An arbitrary but unique identifier for the platform. This matches the id from the PACE app configuration. - `platformType` 'PLATFORM_TYPE_UNSPECIFIED' | 'DATABRICKS' | 'SNOWFLAKE' | 'BIGQUERY' | 'POSTGRES', enum - `ruleSets` DataPolicyRuleSet[] - `fieldTransforms` RuleSetFieldTransform[] — Zero or more field transforms. Any field for which no field transform is specified will be included as-is. - `field` DataPolicyField - `nameParts` string[] — Instead of using "nodes", nesting can be expressed by specifying multiple name parts. A flat table (e.g. csv file) will only contain a single name part for all fields. - `required` boolean — Whether the field is required. If not, the field may be null. - `tags` string[] - `type` string — The data type of the field. - `transforms` FieldTransformTransform[] — The last condition in the list must have 0 principals, as this acts as the default / else condition. Transforms should have mutually exclusive sets of principals. - `detokenize` TransformDetokenize - `tokenField` DataPolicyField - … - `tokenSourceRef` string — Full reference to the token source, e.g. a fully qualified table name. - `valueField` DataPolicyField - … - `fixed` TransformFixed - `value` string - `hash` TransformHash - `seed` string - `identity` TransformIdentity - `nullify` TransformNullify - `numericRounding` TransformNumericRounding - `ceil` NumericRoundingCeil - … - `floor` NumericRoundingFloor - … - `round` NumericRoundingRound - … - `principals` DataPolicyPrincipal[] — The principals (e.g. groups) for which this transform will be applied. - `group` string - `regexp` TransformRegexp - `regexp` string - `replacement` string — Use dollar signs to reference capturing groups in the replacement, e.g. "my-replacement-$1-$2". If the replacement is left empty, the regexp match result (full match or first capturing group) is used. - `sqlStatement` TransformSqlStatement - `statement` string - `filters` RuleSetFilter[] — Zero or more filters. Records that match the conditions are included in the result. When no filters are defined, all records are always included. - `genericFilter` FilterGenericFilter - `conditions` GenericFilterCondition[] — The last condition in the list must have 0 principals, as this acts as the default / else condition. - `condition` string — A (platform-specific) SQL expression. If it evaluates to true, the principals are allowed to access the data. - `principals` DataPolicyPrincipal[] — The principals (e.g. groups) that apply to this condition. - … - `retentionFilter` FilterRetentionFilter - `conditions` RetentionFilterCondition[] — The last condition in the list must have 0 principals, as this acts as the default / else condition. - `period` RetentionFilterPeriod - … - `principals` DataPolicyPrincipal[] — The principals (e.g. groups) that apply to this condition. - … - `field` DataPolicyField - `nameParts` string[] — Instead of using "nodes", nesting can be expressed by specifying multiple name parts. A flat table (e.g. csv file) will only contain a single name part for all fields. - `required` boolean — Whether the field is required. If not, the field may be null. - `tags` string[] - `type` string — The data type of the field. - `target` DataPolicyTarget - `fullname` string — The full and unique name to be used in the target platform. E.g. the view name. - `type` 'TARGET_TYPE_UNSPECIFIED' | 'SQL_VIEW', enum - `source` DataPolicySource - `fields` DataPolicyField[] — A representation of the source data schema. Nested fields are supported. - `nameParts` string[] — Instead of using "nodes", nesting can be expressed by specifying multiple name parts. A flat table (e.g. csv file) will only contain a single name part for all fields. - `required` boolean — Whether the field is required. If not, the field may be null. - `tags` string[] - `type` string — The data type of the field. - `ref` string — The ref is an identifier for the source, unique at the source platform level. - `tags` string[] - `violation` BadRequestFieldViolation — A message type used to describe a single bad request field. - `description` string — A description of why the request element is bad. - `field` string — A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[1].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[3].type[2]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message. ## Other responses - `default` — Default error response ## Changes - **2023-11-17** `04d64891152e` — 1 info - endpoint added [Change history](https://skmtc.dev/getstrm/apis/pace-api/changes/processing-platforms/:platformId/tables/:tableId/blueprint-policy/get.md) --- [API](https://skmtc.dev/getstrm/apis/pace-api.md) · [All operations](https://skmtc.dev/getstrm/apis/pace-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getstrm/pace-api/revisions/04d64891152e/schema)