Hydrate a revision

Authorizations

X-Api-Key

string

header

required

Path Parameters

projectIdOrName

string

required

The Ampersand project ID or project name.

integrationId

string

required

The integration ID.

revisionId

string

required

The revision ID.

Query Parameters

connectionId

string

required

The connection ID.

Response

Hydrated revision

string

required

The revision ID.

Example:

"revision-id-1"

specVersion

string

required

The spec version string.

Example:

"1.0.0"

createTime

string<date-time>

required

The time the revision was created.

content

Hydrated Integration · object

required

Show child attributes

content.name

string

required

content.provider

string

required

content.displayName

string

content.module

string

content.read

Hydrated Read Integration · object

Show child attributes

content.read.objects

Hydrated Integration Object · object[]

Show child attributes

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.error

string

Error message if there was an issue hydrating this object.

Example:

"Failed to fetch fields from provider"

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

(Hydrated Integration Field · object | Integration Field Mapping · object)[]

Hydrated Integration Field
Integration Field Mapping

Show child attributes

content.read.objects.requiredFields.fieldName

string

required

content.read.objects.requiredFields.displayName

string

required

content.read.objects.requiredFields.mapToName

string

The field name to map to in the destination.

Example:

"account_id"

content.read.objects.requiredFields.mapToDisplayName

string

The display name to map to in the destination.

Example:

"Account ID"

content.read.objects.optionalFields

(Hydrated Integration Field · object | Integration Field Mapping · object)[]

Hydrated Integration Field
Integration Field Mapping

Show child attributes

content.read.objects.optionalFields.fieldName

string

required

content.read.objects.optionalFields.displayName

string

required

content.read.objects.optionalFields.mapToName

string

The field name to map to in the destination.

Example:

"account_id"

content.read.objects.optionalFields.mapToDisplayName

string

The display name to map to in the destination.

Example:

"Account ID"

content.read.objects.optionalFieldsAuto

enum<string>

Available options:

all

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.

Show child attributes

content.read.objects.allFieldsMetadata.{key}

Field Metadata · object

Metadata about a field. Please note that different providers have different levels of support for field metadata. Please reach out to [email protected] if need expanded support for a particular provider.

Show child attributes

content.read.objects.allFieldsMetadata.{key}.fieldName

string

required

The name of the field from the provider API.

Example:

"Account ID"

content.read.objects.allFieldsMetadata.{key}.displayName

string

required

The display name of the field from the provider API.

Example:

"Account ID"

content.read.objects.allFieldsMetadata.{key}.valueType

enum<string>

A normalized field type

Available options:

string,

boolean,

singleSelect,

multiSelect,

date,

datetime,

int,

float,

other

content.read.objects.allFieldsMetadata.{key}.providerType

string

Raw field type from the provider API.

Example:

"timestamp"

content.read.objects.allFieldsMetadata.{key}.readOnly

boolean

Whether the field is read-only.

Example:

false

content.read.objects.allFieldsMetadata.{key}.isCustom

boolean

Whether the field is custom field.

Example:

false

content.read.objects.allFieldsMetadata.{key}.isRequired

boolean

Whether the field is required when creating a new record.

Example:

false

content.read.objects.allFieldsMetadata.{key}.values

Field Value · object[]

If the valueType is singleSelect or multiSelect, this is a list of possible values

Show child attributes

content.read.objects.allFieldsMetadata.{key}.values.value

string

required

The internal value used by the system

Example:

"outbound"

content.read.objects.allFieldsMetadata.{key}.values.displayValue

string

required

The human-readable display value

Example:

"Outbound Campaign"

content.read.objects.allFields

(Hydrated Integration Field · object | Integration Field Mapping · object)[]

deprecated

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

Hydrated Integration Field
Integration Field Mapping

Show child attributes

content.read.objects.allFields.fieldName

string

required

content.read.objects.allFields.displayName

string

required

content.read.objects.allFields.mapToName

string

The field name to map to in the destination.

Example:

"account_id"

content.read.objects.allFields.mapToDisplayName

string

The display name to map to in the destination.

Example:

"Account ID"

content.read.objects.backfill

Backfill · object

Show child attributes

content.read.objects.backfill.defaultPeriod

Default Period · object

required

Show child attributes

content.read.objects.backfill.defaultPeriod.days

integer

Number of days in past to backfill from. 0 is no backfill. e.g) if 10, then backfill last 10 days of data. Required if fullHistory is not set.

Required range: x >= 0

Example:

30

content.read.objects.backfill.defaultPeriod.fullHistory

boolean

If true, backfill all history. Required if days is not set.

Example:

false

content.write

object

Show child attributes

content.write.objects

object[]

Show child attributes

content.write.objects.objectName

string

required

content.write.objects.displayName

string

required

content.write.objects.valueDefaults

Value Defaults · object

Configuration to set default write values for object fields.

Show child attributes

content.write.objects.valueDefaults.allowAnyFields

boolean

If true, users can set default values for any field.

Example:

true

content.proxy

Hydrated Proxy Integration · object

Show child attributes

content.proxy.enabled

boolean

content.proxy.useModule

boolean

Default is false. If this is set to true, the base URL for the proxy action will be the module's base URL. Otherwise, it is assumed that the base URL is the provider's root base URL.

Authentication

WRITE API

READ API

PLATFORM API

Hydrate a revision

Authorizations

Path Parameters

Query Parameters

Response