Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Targets

26 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List target columns

GET/api/target-columns/

API key permissionDestination: Read-onlydestination:read

Query parameters

  • namestring
  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

Responses

200OKapplication/json

Response schema

object PaginatedSchemaColumnCompatibilityList

  • countintegerrequired

    Example 123

  • nextstring · urinullable

    Example "http://api.example.org/accounts/?page=4"

  • previousstring · urinullable

    Example "http://api.example.org/accounts/?page=2"

  • resultsarray of objectrequired
    Items · SchemaColumnCompatibility
    • idinteger
    • namestringrequired

      Max length 200

    • usagestring
    • mappingsstring · urirequiredread-only
    • typestringrequired

      One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

    • lengthintegernullable

      Min -2147483648 · Max 2147483647

    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

    • descriptionstringnullable

      Max length 1000

    • urlstring · urirequiredread-only

Create target columns

POST/api/target-columns/

API key permissionDestination: Writedestination:write

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object SchemaColumnCompatibility

  • idinteger
  • namestringrequired

    Max length 200

  • usagestring
  • typestringrequired

    One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

  • lengthintegernullable

    Min -2147483648 · Max 2147483647

  • measureone of
    Attributes

    • MeasureEnum

    • BlankEnum

    • NullEnum

  • descriptionstringnullable

    Max length 1000

Responses

201Createdapplication/json

Response schema

object SchemaColumnCompatibility

  • idinteger
  • namestringrequired

    Max length 200

  • usagestring
  • mappingsstring · urirequiredread-only
  • typestringrequired

    One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

  • lengthintegernullable

    Min -2147483648 · Max 2147483647

  • measureone of
    Attributes

    • MeasureEnum

    • BlankEnum

    • NullEnum

  • descriptionstringnullable

    Max length 1000

  • urlstring · urirequiredread-only

Get target columns

GET/api/target-columns/{id}/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • idintegerrequired

    A unique integer value identifying this Target Field.

Responses

200OKapplication/json

Response schema

object SchemaColumnCompatibility

  • idinteger
  • namestringrequired

    Max length 200

  • usagestring
  • mappingsstring · urirequiredread-only
  • typestringrequired

    One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

  • lengthintegernullable

    Min -2147483648 · Max 2147483647

  • measureone of
    Attributes

    • MeasureEnum

    • BlankEnum

    • NullEnum

  • descriptionstringnullable

    Max length 1000

  • urlstring · urirequiredread-only

Replace target columns

PUT/api/target-columns/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    A unique integer value identifying this Target Field.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object SchemaColumnCompatibility

  • idinteger
  • namestringrequired

    Max length 200

  • usagestring
  • typestringrequired

    One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

  • lengthintegernullable

    Min -2147483648 · Max 2147483647

  • measureone of
    Attributes

    • MeasureEnum

    • BlankEnum

    • NullEnum

  • descriptionstringnullable

    Max length 1000

Responses

200OKapplication/json

Response schema

object SchemaColumnCompatibility

  • idinteger
  • namestringrequired

    Max length 200

  • usagestring
  • mappingsstring · urirequiredread-only
  • typestringrequired

    One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

  • lengthintegernullable

    Min -2147483648 · Max 2147483647

  • measureone of
    Attributes

    • MeasureEnum

    • BlankEnum

    • NullEnum

  • descriptionstringnullable

    Max length 1000

  • urlstring · urirequiredread-only

Update target columns

PATCH/api/target-columns/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    A unique integer value identifying this Target Field.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedSchemaColumnCompatibility

  • idinteger
  • namestring

    Max length 200

  • usagestring
  • typestring

    One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

  • lengthintegernullable

    Min -2147483648 · Max 2147483647

  • measureone of
    Attributes

    • MeasureEnum

    • BlankEnum

    • NullEnum

  • descriptionstringnullable

    Max length 1000

Responses

200OKapplication/json

Response schema

object SchemaColumnCompatibility

  • idinteger
  • namestringrequired

    Max length 200

  • usagestring
  • mappingsstring · urirequiredread-only
  • typestringrequired

    One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

  • lengthintegernullable

    Min -2147483648 · Max 2147483647

  • measureone of
    Attributes

    • MeasureEnum

    • BlankEnum

    • NullEnum

  • descriptionstringnullable

    Max length 1000

  • urlstring · urirequiredread-only

Delete target columns

DELETE/api/target-columns/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    A unique integer value identifying this Target Field.

Responses

204No response body

List target columns mappings

GET/api/target-columns/{parent_lookup_schema_column_id}/mappings/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • parent_lookup_schema_column_idintegerrequired

Query parameters

  • is_key_columnboolean
  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • source_column_namestring
  • source_content_typeinteger

Responses

200OKapplication/json

Response schema

object PaginatedDefaultSchemaMappingList

  • countintegerrequired

    Example 123

  • nextstring · urinullable

    Example "http://api.example.org/accounts/?page=4"

  • previousstring · urinullable

    Example "http://api.example.org/accounts/?page=2"

  • resultsarray of objectrequired
    Items · DefaultSchemaMapping
    • idintegerrequiredread-only
    • source_column_namestringrequired

      Max length 200

    • source_content_typeintegerrequired
    • target_columnobjectrequiredread-only
      Attributes · SchemaColumnCompatibility
      • idinteger
      • namestringrequired

        Max length 200

      • usagestring
      • mappingsstring · urirequiredread-only
      • typestringrequired

        One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

      • lengthintegernullable

        Min -2147483648 · Max 2147483647

      • measureone of
        Attributes

        • MeasureEnum

        • BlankEnum

        • NullEnum

      • descriptionstringnullable

        Max length 1000

      • urlstring · urirequiredread-only
    • is_key_columnboolean

Create target columns mappings

POST/api/target-columns/{parent_lookup_schema_column_id}/mappings/

API key permissionDestination: Writedestination:write

Path parameters

  • parent_lookup_schema_column_idintegerrequired

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object DefaultSchemaMapping

  • source_column_namestringrequired

    Max length 200

  • source_content_typeintegerrequired
  • target_column_idintegerrequiredwrite-only
  • is_key_columnboolean

Responses

201Createdapplication/json

Response schema

object DefaultSchemaMapping

  • idintegerrequiredread-only
  • source_column_namestringrequired

    Max length 200

  • source_content_typeintegerrequired
  • target_columnobjectrequiredread-only
    Attributes · SchemaColumnCompatibility
    • idinteger
    • namestringrequired

      Max length 200

    • usagestring
    • mappingsstring · urirequiredread-only
    • typestringrequired

      One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

    • lengthintegernullable

      Min -2147483648 · Max 2147483647

    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

    • descriptionstringnullable

      Max length 1000

    • urlstring · urirequiredread-only
  • is_key_columnboolean

400The request body failed validation. Beyond the usual missing or malformed fields, this covers a target column id that does not resolve, and a source field or target column that is already mapped for this source type. On create it also covers a target column id that disagrees with the target column in the URL; an update may still move a mapping to another column.

409The mapping was not written. Usually a concurrent write claimed this source field or target column between validation and the write; a referenced target column or source type deleted in the same window is reported the same way. Re-read the mappings for this source type before retrying.application/json

Response schema

object DuplicateDefaultSchemaMapping

  • detailstringrequired

Get target columns mappings

GET/api/target-columns/{parent_lookup_schema_column_id}/mappings/{id}/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • idintegerrequired

    A unique integer value identifying this Default Data Mapping.

  • parent_lookup_schema_column_idintegerrequired

Responses

200OKapplication/json

Response schema

object DefaultSchemaMapping

  • idintegerrequiredread-only
  • source_column_namestringrequired

    Max length 200

  • source_content_typeintegerrequired
  • target_columnobjectrequiredread-only
    Attributes · SchemaColumnCompatibility
    • idinteger
    • namestringrequired

      Max length 200

    • usagestring
    • mappingsstring · urirequiredread-only
    • typestringrequired

      One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

    • lengthintegernullable

      Min -2147483648 · Max 2147483647

    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

    • descriptionstringnullable

      Max length 1000

    • urlstring · urirequiredread-only
  • is_key_columnboolean

Replace target columns mappings

PUT/api/target-columns/{parent_lookup_schema_column_id}/mappings/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    A unique integer value identifying this Default Data Mapping.

  • parent_lookup_schema_column_idintegerrequired

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object DefaultSchemaMapping

  • source_column_namestringrequired

    Max length 200

  • source_content_typeintegerrequired
  • target_column_idintegerrequiredwrite-only
  • is_key_columnboolean

Responses

200OKapplication/json

Response schema

object DefaultSchemaMapping

  • idintegerrequiredread-only
  • source_column_namestringrequired

    Max length 200

  • source_content_typeintegerrequired
  • target_columnobjectrequiredread-only
    Attributes · SchemaColumnCompatibility
    • idinteger
    • namestringrequired

      Max length 200

    • usagestring
    • mappingsstring · urirequiredread-only
    • typestringrequired

      One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

    • lengthintegernullable

      Min -2147483648 · Max 2147483647

    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

    • descriptionstringnullable

      Max length 1000

    • urlstring · urirequiredread-only
  • is_key_columnboolean

400The request body failed validation. Beyond the usual missing or malformed fields, this covers a target column id that does not resolve, and a source field or target column that is already mapped for this source type.

409The mapping was not written. Usually a concurrent write claimed this source field or target column between validation and the write; a referenced target column or source type deleted in the same window is reported the same way. Re-read the mappings for this source type before retrying.application/json

Response schema

object DuplicateDefaultSchemaMapping

  • detailstringrequired

Update target columns mappings

PATCH/api/target-columns/{parent_lookup_schema_column_id}/mappings/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    A unique integer value identifying this Default Data Mapping.

  • parent_lookup_schema_column_idintegerrequired

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedDefaultSchemaMapping

  • source_column_namestring

    Max length 200

  • source_content_typeinteger
  • target_column_idintegerwrite-only
  • is_key_columnboolean

Responses

200OKapplication/json

Response schema

object DefaultSchemaMapping

  • idintegerrequiredread-only
  • source_column_namestringrequired

    Max length 200

  • source_content_typeintegerrequired
  • target_columnobjectrequiredread-only
    Attributes · SchemaColumnCompatibility
    • idinteger
    • namestringrequired

      Max length 200

    • usagestring
    • mappingsstring · urirequiredread-only
    • typestringrequired

      One of String Long Float Date DateTime Boolean Percentage Currency JSON Formula Duration Timestamp

    • lengthintegernullable

      Min -2147483648 · Max 2147483647

    • measureone of
      Attributes

      • MeasureEnum

      • BlankEnum

      • NullEnum

    • descriptionstringnullable

      Max length 1000

    • urlstring · urirequiredread-only
  • is_key_columnboolean

400The request body failed validation. Beyond the usual missing or malformed fields, this covers a target column id that does not resolve, and a source field or target column that is already mapped for this source type.

409The mapping was not written. Usually a concurrent write claimed this source field or target column between validation and the write; a referenced target column or source type deleted in the same window is reported the same way. Re-read the mappings for this source type before retrying.application/json

Response schema

object DuplicateDefaultSchemaMapping

  • detailstringrequired

Delete target columns mappings

DELETE/api/target-columns/{parent_lookup_schema_column_id}/mappings/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    A unique integer value identifying this Default Data Mapping.

  • parent_lookup_schema_column_idintegerrequired

Responses

204No response body

List target types

GET/api/target-types/

API key permissionDestination: Read-onlydestination:read

Query parameters

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    A search term.

Responses

200OKapplication/json

Response schema

object PaginatedBaseTargetTypeList

  • countintegerrequired

    Example 123

  • nextstring · urinullable

    Example "http://api.example.org/accounts/?page=4"

  • previousstring · urinullable

    Example "http://api.example.org/accounts/?page=2"

  • resultsarray of objectrequired
    Items · BaseTargetType
    • idintegerrequiredread-only
    • namestringrequiredread-only
    • slugstringrequiredread-only
    • canonical_namestringrequiredread-only
    • urlstring · urirequiredread-only
    • targetsstring · urirequiredread-only

Get target types

GET/api/target-types/{id}/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • idintegerrequired

    A unique integer value identifying this content type.

Responses

200OKapplication/json

Response schema

object BaseTargetType

  • idintegerrequiredread-only
  • namestringrequiredread-only
  • slugstringrequiredread-only
  • canonical_namestringrequiredread-only
  • urlstring · urirequiredread-only
  • targetsstring · urirequiredread-only

List target types targets

GET/api/target-types/{parent_lookup_type_id}/targets/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/.

Query parameters

  • namestring
  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • stack_idinteger

Responses

200OKapplication/json

Response schema

object PaginatedPolymorphicTargetBaseList

  • countintegerrequired

    Example 123

  • nextstring · urinullable

    Example "http://api.example.org/accounts/?page=4"

  • previousstring · urinullable

    Example "http://api.example.org/accounts/?page=2"

  • resultsarray of objectrequired
    Items · PolymorphicTargetBase
    • idintegerrequiredread-only
    • stackintegerrequired
    • logo_urlstringrequiredread-only
    • is_schema_mapping_requiredbooleanrequiredread-only
    • namestringrequired

      Max length 60

Create target types targets

POST/api/target-types/{parent_lookup_type_id}/targets/

API key permissionDestination: Writedestination:write

Path parameters

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PolymorphicTargetBase

  • stackintegerrequired
  • namestringrequired

    Max length 60

Responses

201Createdapplication/json

Response schema

object PolymorphicTargetBase

  • idintegerrequiredread-only
  • stackintegerrequired
  • logo_urlstringrequiredread-only
  • is_schema_mapping_requiredbooleanrequiredread-only
  • namestringrequired

    Max length 60

Get target types targets

GET/api/target-types/{parent_lookup_type_id}/targets/{id}/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/.

Responses

200OKapplication/json

Response schema

object PolymorphicTargetBase

  • idintegerrequiredread-only
  • stackintegerrequired
  • logo_urlstringrequiredread-only
  • is_schema_mapping_requiredbooleanrequiredread-only
  • namestringrequired

    Max length 60

Replace target types targets

PUT/api/target-types/{parent_lookup_type_id}/targets/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PolymorphicTargetBase

  • stackintegerrequired
  • namestringrequired

    Max length 60

Responses

200OKapplication/json

Response schema

object PolymorphicTargetBase

  • idintegerrequiredread-only
  • stackintegerrequired
  • logo_urlstringrequiredread-only
  • is_schema_mapping_requiredbooleanrequiredread-only
  • namestringrequired

    Max length 60

Update target types targets

PATCH/api/target-types/{parent_lookup_type_id}/targets/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedPolymorphicTargetBase

  • stackinteger
  • namestring

    Max length 60

Responses

200OKapplication/json

Response schema

object PolymorphicTargetBase

  • idintegerrequiredread-only
  • stackintegerrequired
  • logo_urlstringrequiredread-only
  • is_schema_mapping_requiredbooleanrequiredread-only
  • namestringrequired

    Max length 60

Delete target types targets

DELETE/api/target-types/{parent_lookup_type_id}/targets/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/.

Responses

204No response body

List target types targets mappings

GET/api/target-types/{parent_lookup_type_id}/targets/{parent_lookup_target_id}/mappings/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • parent_lookup_target_idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/. Not checked on this route. Only parent_lookup_target_id selects the destination.

Query parameters

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

Responses

200OKapplication/json

Response schema

object PaginatedTargetBindingBaseList

  • countintegerrequired

    Example 123

  • nextstring · urinullable

    Example "http://api.example.org/accounts/?page=4"

  • previousstring · urinullable

    Example "http://api.example.org/accounts/?page=2"

  • resultsarray of objectrequired
    Items · TargetBindingBase
    • idintegerrequiredread-only
    • targetintegerrequiredread-only
    • datastreamintegerrequired
    • enabledboolean

Create target types targets mappings

POST/api/target-types/{parent_lookup_type_id}/targets/{parent_lookup_target_id}/mappings/

API key permissionDestination: Writedestination:write

Path parameters

  • parent_lookup_target_idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/. Not checked on this route. Only parent_lookup_target_id selects the destination.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object TargetBindingBase

  • datastreamintegerrequired
  • enabledboolean

Responses

201Createdapplication/json

Response schema

object TargetBindingBase

  • idintegerrequiredread-only
  • targetintegerrequiredread-only
  • datastreamintegerrequired
  • enabledboolean

Get target types targets mappings

GET/api/target-types/{parent_lookup_type_id}/targets/{parent_lookup_target_id}/mappings/{id}/

API key permissionDestination: Read-onlydestination:read

Path parameters

  • idintegerrequired

    The binding id.

  • parent_lookup_target_idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/. Not checked on this route. Only parent_lookup_target_id selects the destination.

Responses

200OKapplication/json

Response schema

object TargetBindingBase

  • idintegerrequiredread-only
  • targetintegerrequiredread-only
  • datastreamintegerrequired
  • enabledboolean

Replace target types targets mappings

PUT/api/target-types/{parent_lookup_type_id}/targets/{parent_lookup_target_id}/mappings/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    The binding id.

  • parent_lookup_target_idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/. Not checked on this route. Only parent_lookup_target_id selects the destination.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object TargetBindingBase

  • datastreamintegerrequired
  • enabledboolean

Responses

200OKapplication/json

Response schema

object TargetBindingBase

  • idintegerrequiredread-only
  • targetintegerrequiredread-only
  • datastreamintegerrequired
  • enabledboolean

Update target types targets mappings

PATCH/api/target-types/{parent_lookup_type_id}/targets/{parent_lookup_target_id}/mappings/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    The binding id.

  • parent_lookup_target_idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/. Not checked on this route. Only parent_lookup_target_id selects the destination.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedTargetBindingBase

  • datastreaminteger
  • enabledboolean

Responses

200OKapplication/json

Response schema

object TargetBindingBase

  • idintegerrequiredread-only
  • targetintegerrequiredread-only
  • datastreamintegerrequired
  • enabledboolean

Delete target types targets mappings

DELETE/api/target-types/{parent_lookup_type_id}/targets/{parent_lookup_target_id}/mappings/{id}/

API key permissionDestination: Writedestination:write

Path parameters

  • idintegerrequired

    The binding id.

  • parent_lookup_target_idintegerrequired

    The destination id.

  • parent_lookup_type_idstringrequired

    The destination type: its integer id or its canonical_name, as listed by GET /api/target-types/. Not checked on this route. Only parent_lookup_target_id selects the destination.

Responses

204No response body