REST API integration scenarios

These patterns combine existing APIs; they are not built-in automated workflows. Confirm authentication, deployment, scope, and owners first.

Enterprise portal and data dictionary

Help users understand an object's meaning, source, ownership, and standards.

1. Locate systems with /base/modelCategory/getModelCategories.
2. Find sources and objects with /metadata/models/fromre/page and /metadata/entities/searchMetadata.
3. Read /metadata/entities/{objectId}/get and /columns.
4. Add asset details while retaining catalog/object mappings.
5. Sample against DAM before scheduled synchronization.

Accept when names, schemas, descriptions, fields, and standards match and revoked permissions invalidate portal caches. Metadata visibility does not grant data downloads.

Standards for development and modeling

1. Read published standards by catalog and details by domainId.
2. Read associated reference values and revisions; code lists differ from value lists.
3. Display definition, type, length/precision, and value constraints.
4. Verify field associations and map standard > field > external model.
5. Compare modification time, revision, state, and effective scope.

Accept when definitions match effective revisions and changes have owners. Synchronization does not modify models or prove data compliance. See standards APIs.

Quality dashboards and tickets

1. Map technical rules and tasks to business objects.
2. Read results and events for actual instances.
3. Retain taskId, ruleId, jobResultId, batch, and verification state.
4. Synchronize summaries, owners, and DAM links by default; retrieve detail only with authorization.
5. Verify actual remediation and verification after external ticket updates.

Accept stable deduplication keys, separate execution and data results, and protected business detail. See quality APIs.

Pre-release lineage impact

1. Identify the DAM object and corresponding SQLink node.
2. Query bounded downstream lineage through /sqlink/lineageGraph/query.
3. Check expressions through /sqlink/lineageGraph/getTransform.
4. Review /sqlink/lineageGraph/getImpact with actual paths and owners.
5. Reharvest, parse, and regress downstream after release.

Accept verified identity, current parsing, explicit filters, and appropriate treatment of missing lineage. See lineage APIs.

Asset security guidance

1. Browse published assets within the integration identity's scope.
2. Read stewardship, ownership, classification, and level.
3. Use published security assets and category details; distinguish suggestions from reviewed decisions.
4. Direct consumers to formal requests and approved delivery.

Accept authorized visibility and traceable security information. Classification alone does not prove gateway enforcement. See asset APIs.

Trusted context for AI applications

1. If supported, discover assets using /graph/asset-access/v1/discovery/search.
2. Resolve complete returned assetKey values with /graph/asset-access/v1/context/resolve and inspect each result.
3. Supplement with graphs or SQLink, retaining freshness, scope, and truncation indicators.
4. For persistent governed context, follow DIG end-to-end governance to create, accept, and publish a space MCP.
5. Test same-name objects, missing evidence, unauthorized scope, and outdated files.

Accept answers traceable to authorized objects and valid evidence, with explicit uncertainty. REST calls and space MCP publication are separate implementations.

Release handoff

Area	Deliver
Contract	Methods, complete paths, parameter locations, versions, schemas
Identity	Authentication, scope, lifetime, rotation and revocation owners
Objects	Source systems and verified cross-service ID mappings
Synchronization	Full/incremental method, termination, state/revision handling, cache invalidation
Operations	Limits, backoff, timeout, instance tracking, alerts
Acceptance	Known and unauthorized samples, errors, UI/API comparisons
Upgrades	Contract differences, adaptations, regression results

Obtain actual rate limits, idempotency headers, page limits, and SLAs from deployment owners. Confirm workflow and contracts before extending writes, approvals, or schedules.