Manage staged migration data

Overview

This document explains how to retrieve staged migration data across domains and delete staged records when necessary. Each domain exposes its own staging endpoints. For a complete list of domain-specific endpoints and object schemas, check the API Schemas.

This guide uses the Migrate Agreements API as an example.

Retrieve staged data

You can retrieve staged data in one of the following ways, depending on your use case.

Stream staged data

Stream staged data for a specific migration as newline-delimited JSON (JSONL) or JSON Sequence. The response format depends on the Accept header. For more information, see Streaming data.

For example, to stream staged agreement data in the financing solution domain, send the following request:

GET /financing-solution/migrations/{migration-reference-id}/staging/agreements/stream

Include the following in the Accept headers:

• (Required) Specify your preferred format, either application/jsonl or application/json-seq.
• Specify the API version. We recommend including an API version to avoid breaking changes. Refer to API Versioning for more information.

Retrieve staged data by reference ID

Retrieve a specific staged record by its reference ID within a migration.

For example, to retrieve a staged agreement by its reference ID in the financing solution domain, send the following request:

GET /financing-solution/migrations/{migration-reference-id}/staging/agreements/{agreement-reference-id}

Delete staged data

You can delete specific staged records by providing their reference IDs.

For example, to delete one or more staged agreements, send the following request:

PUT /financing-solution/migrations/{migration-reference-id}/staging/agreements/delete

Include a stream of reference IDs in the request body, where each item is the reference ID of a staged record to delete. Provide the stream as either JSONL or JSON-seq format. For example:

a1b2c3d4-e5f6-1234-5678-9abcdef01234
ee61b850-5240-4978-9660-7b210f2bf70f