WARNING

WARNING: These APIs are currently in an 'alpha' state and are likely to change over time. We recommend you not use them in a production setting at this time!


Create an Extension

Add an ExtensionPackage to Extension to a Property. Installation is an asynchronous action. After performing a request to add an Extension to a Property, an Extension response will be returned with an installation_status of pending. When the installation task has completed, the Extension will be updated with based on the success or failure of the task.

Extensions are processed asynchronously and have an installation_status attribute representing the current status of the Extension installation. There are three possible installation_status values:

pending

When an Extension is created, installation_status is set to pending. This indicates that DTM received the request to make the ExtensionPackage available as Extension to the specified Property, and will begin the installation process.

Extensions with an installation_status of pending are not available for use.

succeeded

When processing of the installation request for the Extension has completed, if the installation was successful, the installation_status will change to succeeded.

failed

When processing of the installation request for the Extension has completed, if the installation was not successful, the installation_status will change to failed.

Extensions with an installation_status of failed are not available for use.

Attributes

delegate_descriptor_id
string - optional
enabled
boolean - optional
settings
string - optional
Settings json object represented as a string

Definition

POST  /properties/:property_id/extensions

Example Request

curl https://mc-api-activation-reactor-integration.adobe.io/properties/:property_id/extensions \
  -H "Accept: application/vnd.api+json;revision=1" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer [TOKEN]" \
  -H "X-Api-Key: [KEY]" \
  -X POST \
  -d \
'
{
  "data": {
    "attributes": {
    },
    "relationships": {
      "extension_package": {
        "data": {
          "id": "EP27e9323eb585411fae6086fc78a3b70b",
          "type": "extension_packages"
        }
      }
    },
    "type": "extensions"
  }
}'

Example Response

201 Created
{
  "data": {
    "id": "EX80d74c24feb84ca596fd0cb0db5720c6",
    "type": "extensions",
    "attributes": {
      "created_at": "2018-08-31T16:48:59.586Z",
      "dirty": true,
      "enabled": true,
      "name": "kessel-test",
      "published": false,
      "published_at": null,
      "revision_number": 0,
      "updated_at": "2018-08-31T16:48:59.586Z",
      "delegate_descriptor_id": null,
      "display_name": "Kessel Test",
      "review_status": "unsubmitted",
      "version": "1.2.0",
      "settings": "{}"
    },
    "relationships": {
      "libraries": {
        "links": {
          "related": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6/libraries"
        }
      },
      "revisions": {
        "links": {
          "related": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6/revisions"
        }
      },
      "property": {
        "links": {
          "related": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6/property"
        },
        "data": {
          "id": "PR23b980791c7d4edcaad2c59fb046f737",
          "type": "properties"
        }
      },
      "origin": {
        "links": {
          "related": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6/origin"
        },
        "data": {
          "id": "EX80d74c24feb84ca596fd0cb0db5720c6",
          "type": "extensions"
        }
      },
      "updated_with_extension_package": {
        "links": {
          "related": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6/updated_with_extension_package"
        },
        "data": {
          "id": "EP27e9323eb585411fae6086fc78a3b70b",
          "type": "extension_packages"
        }
      },
      "extension_package": {
        "links": {
          "related": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6/extension_package"
        },
        "data": {
          "id": "EP27e9323eb585411fae6086fc78a3b70b",
          "type": "extension_packages"
        }
      }
    },
    "links": {
      "property": "http://localhost:9010/properties/PR23b980791c7d4edcaad2c59fb046f737",
      "origin": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6",
      "self": "http://localhost:9010/extensions/EX80d74c24feb84ca596fd0cb0db5720c6",
      "extension_package": "http://localhost:9010/extension_packages/EP27e9323eb585411fae6086fc78a3b70b",
      "latest_extension_package": "http://localhost:9010/extension_packages/EP27e9323eb585411fae6086fc78a3b70b"
    },
    "meta": {
      "latest_revision_number": 0
    }
  }
}