Skip to content

Prune retired contributions products

POST /api/v1/products/prune-retired-contributions: request fields and declared response contract.

POST/api/v1/products/prune-retired-contributions

Authorization
PropertyValue
Permissionproducts.install
Workspace scoperequired
Scope targetworkspace

Request body

Request body fields
FieldTypeRequiredNullableDefault
installationIdstringrequirednon-null—
expectedInstallUpdatedAtstringrequirednon-null—
dryRunbooleanoptionalnon-null—
deleteRecordsbooleanoptionalnon-null—

Response

201

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.outcome"pruned" | "dry_run" | "refused"requirednon-null—
data.installationIdstringrequirednon-null—
data.dryRunbooleanrequirednon-null—
data.deleteRecordsbooleanrequirednon-null—
data.countsobjectrequirednon-null—
data.counts.partyRecordsintegerrequirednon-null—
data.counts.resourcePoliciesintegerrequirednon-null—
data.counts.dashboardsintegerrequirednon-null—
data.counts.workflowTemplatesintegerrequirednon-null—
data.counts.savedQueriesintegerrequirednon-null—
data.counts.assetDefinitionsintegerrequirednon-null—
data.counts.relationshipDefinitionsintegerrequirednon-null—
data.counts.agentsintegerrequirednon-null—
data.counts.slotBindingsintegerrequirednon-null—
data.counts.tagValuesintegerrequirednon-null—
data.counts.tagKeysintegerrequirednon-null—
data.counts.signalDescriptorsintegerrequirednon-null—
data.counts.partyKindsintegerrequirednon-null—
data.counts.lineageRowsintegerrequirednon-null—
data.removedobjectrequirednon-null—
data.removed.partyRecordsobjectrequirednon-null—
data.removed.partyRecords.idsarrayrequirednon-null—
data.removed.partyRecords.totalintegerrequirednon-null—
data.removed.resourcePoliciesobjectrequirednon-null—
data.removed.resourcePolicies.idsarrayrequirednon-null—
data.removed.resourcePolicies.totalintegerrequirednon-null—
data.removed.dashboardsobjectrequirednon-null—
data.removed.dashboards.idsarrayrequirednon-null—
data.removed.dashboards.totalintegerrequirednon-null—
data.removed.workflowTemplatesobjectrequirednon-null—
data.removed.workflowTemplates.idsarrayrequirednon-null—
data.removed.workflowTemplates.totalintegerrequirednon-null—
data.removed.savedQueriesobjectrequirednon-null—
data.removed.savedQueries.idsarrayrequirednon-null—
data.removed.savedQueries.totalintegerrequirednon-null—
data.removed.assetDefinitionsobjectrequirednon-null—
data.removed.assetDefinitions.idsarrayrequirednon-null—
data.removed.assetDefinitions.totalintegerrequirednon-null—
data.removed.relationshipDefinitionsobjectrequirednon-null—
data.removed.relationshipDefinitions.idsarrayrequirednon-null—
data.removed.relationshipDefinitions.totalintegerrequirednon-null—
data.removed.agentsobjectrequirednon-null—
data.removed.agents.idsarrayrequirednon-null—
data.removed.agents.totalintegerrequirednon-null—
data.removed.slotBindingsobjectrequirednon-null—
data.removed.slotBindings.idsarrayrequirednon-null—
data.removed.slotBindings.totalintegerrequirednon-null—
data.removed.tagValuesobjectrequirednon-null—
data.removed.tagValues.idsarrayrequirednon-null—
data.removed.tagValues.totalintegerrequirednon-null—
data.removed.tagKeysobjectrequirednon-null—
data.removed.tagKeys.idsarrayrequirednon-null—
data.removed.tagKeys.totalintegerrequirednon-null—
data.removed.signalDescriptorsobjectrequirednon-null—
data.removed.signalDescriptors.idsarrayrequirednon-null—
data.removed.signalDescriptors.totalintegerrequirednon-null—
data.removed.partyKindsobjectrequirednon-null—
data.removed.partyKinds.idsarrayrequirednon-null—
data.removed.partyKinds.totalintegerrequirednon-null—
data.removed.lineageRowsobjectrequirednon-null—
data.removed.lineageRows.idsarrayrequirednon-null—
data.removed.lineageRows.totalintegerrequirednon-null—
data.refusedItemsarrayrequirednon-null—
data.preservedarrayrequirednon-null—
data.retainedobjectrequirednon-null—
data.schedulesToReconcilearrayrequirednon-null—
data.subscriptionIndexRecomputedbooleanrequirednon-null—

Declared failures

Declared failures
PropertyValue
PRODUCT_OPERATION_FAILED500 — not retryable
PRODUCT_REQUIRES_RESOLUTION409 — not retryable
PRODUCT_STALE409 — not retryable

Readback

Read the result back with:

  • products.inspectInstalled

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

POST /api/v1/products/prune-retired-contributions HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json

{
  "installationId": "<installationId>",
  "expectedInstallUpdatedAt": "<expectedInstallUpdatedAt>"
}