cURL
curl --request GET \ --url https://api.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/revisions/{revisionId}:hydrate \ --header 'X-Api-Key: <api-key>'
{ "id": "revision-id-1", "specVersion": "1.0.0", "createTime": "2023-11-07T05:31:56Z", "content": { "name": "<string>", "provider": "<string>", "displayName": "<string>", "module": "<string>", "read": { "objects": [ { "objectName": "<string>", "displayName": "<string>", "destination": "<string>", "schedule": "<string>", "error": "Failed to fetch fields from provider", "mapToName": "people", "mapToDisplayName": "People", "requiredFields": [ { "fieldName": "<string>", "displayName": "<string>", "mapToName": "account_id", "mapToDisplayName": "Account ID" } ], "optionalFields": [ { "fieldName": "<string>", "displayName": "<string>", "mapToName": "account_id", "mapToDisplayName": "Account ID" } ], "optionalFieldsAuto": "all", "allFieldsMetadata": {}, "allFields": [ { "fieldName": "<string>", "displayName": "<string>", "mapToName": "account_id", "mapToDisplayName": "Account ID" } ], "backfill": { "defaultPeriod": { "days": 30, "fullHistory": false } } } ] }, "write": { "objects": [ { "objectName": "<string>", "displayName": "<string>", "valueDefaults": { "allowAnyFields": true } } ] }, "proxy": { "enabled": true, "useModule": true } } }
Hydrate a revision with information from the consumer’s SaaS instance.
The Ampersand project ID or project name.
The integration ID.
The revision ID.
The connection ID.
Hydrated revision
"revision-id-1"
The spec version string.
"1.0.0"
The time the revision was created.
Show child attributes
Was this page helpful?