records
Creates, updates, deletes, gets or lists a records resource.
Overview
| Name | records |
| Type | Resource |
| Id | pagerduty.enrichment.records |
Fields
The following fields are returned by SELECT queries:
- list
A page of enrichment records for the schema.
| Name | Datatype | Description |
|---|---|---|
record_id | string | Unique identifier for this enrichment record. |
created_at | string (date-time) | Timestamp when the record was created. |
enrichment_data | object | The enrichment data for this record, as key-value pairs keyed by field name. |
type | string | The type of the resource. (example: enrichment_record) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | schema_id | limit, cursor | Retrieves a page of enrichment records for a schema. Results are cursor-paginated.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.read<br /> |
delete | delete | schema_id, record_id | Deletes a single enrichment record by ID and returns the deleted record.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.write<br /> |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
record_id | string | The ID of the enrichment record. |
schema_id | string (uuid) | The ID of the enrichment schema. |
cursor | string | Pagination cursor returned by a previous list request. |
limit | integer | The maximum number of records to return per page (1-100). |
SELECT examples
- list
Retrieves a page of enrichment records for a schema. Results are cursor-paginated.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.read<br />
SELECT
record_id,
created_at,
enrichment_data,
type
FROM pagerduty.enrichment.records
WHERE schema_id = '{{ schema_id }}' -- required
AND limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
;
DELETE examples
- delete
Deletes a single enrichment record by ID and returns the deleted record.<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Scoped OAuth requires: contextual_data.write<br />
DELETE FROM pagerduty.enrichment.records
WHERE schema_id = '{{ schema_id }}' --required
AND record_id = '{{ record_id }}' --required
;