-
Notifications
You must be signed in to change notification settings - Fork 32
05. Metadata Type Support
Jörn Berkefeld edited this page Jun 7, 2024
·
8 revisions
The following metadata types are currently supported:
| MetadataType | CLI argument | Retrieved by Default | retrieve |
deploy (create) |
deploy (update) |
delete |
changeKey |
buildTemplate |
retrieveAsTemplate |
Description |
|---|---|---|---|---|---|---|---|---|---|---|
| Asset | asset |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Assets from Content Builder grouped into subtypes. |
| Data Designer Attribute Groups | attributeGroup |
Yes | Yes | - | - | - | - | - | - | Groupings of Attribute Sets (Data Extensions) in Data Designer. |
| Data Designer Attribute Sets | attributeSet |
Yes | Yes | - | - | - | - | - | - | Data Extensions linked together in Attribute Groups in Data Designer. |
| Automation | automation |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Used via Automation Studio directly - or indirectly via Journey Builder & MC Connect. |
| Campaign Tag | campaign |
- | Yes | - | - | - | - | - | - | Way of tagging/categorizing emails, journeys and alike. |
| Content Area (Classic) | contentArea |
- | Yes | - | - | - | - | - | - | DEPRECATED: Old way of saving Content Blocks; please migrate these to new Content Blocks (Asset: ...). |
| Data Extension | dataExtension |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Database table schemas. |
| Data Extension Template | dataExtensionTemplate |
- | Yes | - | - | - | - | - | - | Templates used for special DE use cases like Triggered Send. |
| Delivery Profile | deliveryProfile |
- | Yes | - | - | - | - | - | - | Delivery profiles specify details such as IP address, domain, header inclusion, and footer; Via API we can only check for their existence but not see any details. |
| Automation: Data Extract Activity | dataExtract |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Creates zipped files in your FTP directory or convert XML into CSV. |
| Data Extract Type | dataExtractType |
- | Yes | - | - | - | - | - | - | Types of Data Extracts enabled for a specific business unit. This normally should not be stored. |
| API Discovery | discovery |
- | Yes | - | - | - | - | - | - | Description of all API endpoints accessible via REST API; only relevant for developers of Accenture SFMC DevTools. |
| E-Mail (Classic) | email |
- | Yes | - | - | - | - | - | - | DEPRECATED: Old way of saving E-Mails; please migrate these to new E-Mail (Asset: message). |
| E-Mail Send Definition | emailSend |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | Mainly used in Automations as "Send Email Activity". |
| Journey: Entry Event Definition | event |
Yes | Yes (beta) | Yes (beta) | Yes (beta) | Yes | Yes | Yes | Yes | Used in Journeys (Interactions) to define Entry Events. |
| File Location | fileLocation |
Yes | Yes | - | - | - | - | - | - | Used for export or import of files to/from Marketing Cloud. Previously this was labeled ftpLocation. |
| Automation: File Transfer Activity | fileTransfer |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Unzip, decrypt a file or move a file from secure location into FTP directory. |
| Automation: Filter Activity | filter |
- | Yes (beta) | - | - | - | - | - | - | BETA: Part of how filtered Data Extensions are created. Depends on type "FilterDefinitions". |
| Folder | folder |
- | Yes | Yes | Yes | - | - | Yes | - | Used to structure all kinds of other metadata. |
| Automation: Import File Activity | importFile |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Reads files in FTP directory for further processing. |
| Journey | journey |
Yes | Yes (beta) | Yes (beta) | Yes (beta) | Yes | - | Yes | - | Journey (internally called "Interaction"). |
| List | list |
Yes | Yes | - | - | Yes | - | - | - | Old way of storing data. Still used for central Email Subscriber DB. |
| Mobile Code | mobileCode |
Yes | Yes | - | - | - | - | - | - | Used to send SMS Messages |
| Mobile Keyword | mobileKeyword |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Used for managing subscriptions for Mobile numbers in Mobile Connect |
| MobileConnect SMS | mobileMessage |
Yes | Yes | Yes | Yes | Yes | - | Yes | - | Used by Journey Builder and to send SMS from MobileConnect triggered by API or manually on-the-fly |
| Automation: SQL Query Activity | query |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Select & transform data using SQL. |
| Role | role |
Yes | Yes | Yes | Yes | - | Yes | Yes | - | User Roles define groups that are used to grant users access to SFMC systems. |
| Automation: Script Activity | script |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Execute more complex tasks via SSJS or AMPScript. |
| Send Classification | sendClassification |
- | Yes | Yes | Yes | Yes | Yes | Yes | - | Lets admins define Delivery Profile, Sender Profile and CAN-SPAM for an email job in a central location. |
| Sender Profile | senderProfile |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | Specifies the From information for a send in a central location. |
| Transactional Email | transactionalEmail |
Yes | Yes | Yes | Yes | Yes | - | Yes | - | Lets you send immediate Email messages via API events |
| Transactional Push | transactionalPush |
Yes | Yes | Yes | Yes | Yes | - | Yes | - | Lets you send immediate Push messages via API events |
| Transactional SMS | transactionalSMS |
Yes | Yes | Yes | Yes | Yes | - | Yes | - | Lets you send immediate SMS messages via API events |
| Triggered Send | triggeredSend |
Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | DEPRECATED: Sends emails via API or DataExtension Event. |
| User | user |
- | Yes | Yes | Yes | - | Yes | Yes | - | Users and Installed Packages including their assigned Roles, BUs and personal permissions |
| Automation: Verification Activity | verification |
Yes | Yes | Yes | Yes | Yes | - | Yes | - | Check DataExtension for a row count |
Copyright (c) 2020-2024 Accenture. MIT licensed. Main contributors: Jörn Berkefeld, Doug Midgley