Hydrate a revision

GET

projects

{projectIdOrName}

integrations

{integrationId}

revisions

{revisionId}

:hydrate

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>",
    "displayName": "<string>",
    "provider": "<string>",
    "read": {
      "objects": [
        {
          "objectName": "<string>",
          "displayName": "<string>",
          "mapToName": "people",
          "mapToDisplayName": "People",
          "destination": "<string>",
          "schedule": "<string>",
          "requiredFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "optionalFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "optionalFieldsAuto": "all",
          "allFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "allFieldsMetadata": {},
          "backfill": {
            "defaultPeriod": {
              "days": 30,
              "fullHistory": false
            }
          }
        }
      ]
    },
    "write": {
      "objects": [
        {
          "objectName": "<string>",
          "displayName": "<string>",
          "valueDefaults": {
            "allowAnyFields": true
          }
        }
      ]
    },
    "proxy": {
      "enabled": true
    }
  }
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

projectIdOrName

string

required

integrationId

string

required

revisionId

string

required

Query Parameters

connectionId

string

required

Response

200

application/json

Hydrated revision

string

required

The revision ID.

Example:

"revision-id-1"

specVersion

string

required

The spec version string.

Example:

"1.0.0"

createTime

string

required

The time the revision was created.

content

object

required

content.name

string

required

content.provider

string

required

content.displayName

string

content.read

object

content.read.objects

object[]

content.read.objects.objectName

string

required

content.read.objects.displayName

string

required

content.read.objects.destination

string

required

content.read.objects.schedule

string

required

content.read.objects.mapToName

string

An object name to map to.

Example:

"people"

content.read.objects.mapToDisplayName

string

A display name to map to.

Example:

"People"

content.read.objects.requiredFields

object[]

content.read.objects.optionalFields

object[]

content.read.objects.optionalFieldsAuto

enum<string>

Available options:

all

content.read.objects.allFields

object[]

This is a list of all fields on the object for a particular SaaS instance, including their display names.

content.read.objects.allFieldsMetadata

object

This is a map of all fields on the object including their metadata (such as display name and type), the keys of the map are the field names.

content.read.objects.backfill

object

content.write

object

content.proxy

object

Was this page helpful?

Suggest edits Raise issue

Create a new revision List installations

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>",
    "displayName": "<string>",
    "provider": "<string>",
    "read": {
      "objects": [
        {
          "objectName": "<string>",
          "displayName": "<string>",
          "mapToName": "people",
          "mapToDisplayName": "People",
          "destination": "<string>",
          "schedule": "<string>",
          "requiredFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "optionalFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "optionalFieldsAuto": "all",
          "allFields": [
            {
              "fieldName": "<string>",
              "displayName": "<string>",
              "mapToName": "account_id",
              "mapToDisplayName": "Account ID"
            }
          ],
          "allFieldsMetadata": {},
          "backfill": {
            "defaultPeriod": {
              "days": 30,
              "fullHistory": false
            }
          }
        }
      ]
    },
    "write": {
      "objects": [
        {
          "objectName": "<string>",
          "displayName": "<string>",
          "valueDefaults": {
            "allowAnyFields": true
          }
        }
      ]
    },
    "proxy": {
      "enabled": true
    }
  }
}

Authentication

WRITE API

READ API

PLATFORM API

Hydrate a revision

Authorizations

Path Parameters

Query Parameters

Response