Model Sync

Get Target Creation Property Values

Changed on

Returns the valid values for a target-creation property on a connection that supports creating new target objects.

Connections which support creating new sync target objects (destinations) will return target_creation with their target object list. This endpoint will return possible values for properties where enum is true.

If the connection does not support creating new target objects, an HTTP 404 will be returned.

The values array lists the valid options (and labels) for the property. Each member of the values array has a label and value. For exaample,

{
  "data": [
    {
      "id": "account",
      "title": "Account ID",
      "enum": true,
      "values": [
        {
          "value": "1234567::urn:li:organization:987654",
          "label": "Polytomic Inc. (1234567)"
        }
      ]
    }
  ]
}

The value for the selected option should be passed when creating a sync.

get/api/connections/{id}/modelsync/targetobjects/properties/{property}

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Connection ID

Example:248df4b7-aa70-47b8-a036-33ac447e668d
propertystring required

Target-creation property ID

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "enum": true,
    "id": "account",
    "title": "Account ID",
    "values": [
      "account1",
      "account2"
    ]
  }
}

Changes

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status