JSON File Format for Content in an Enhanced CMS Workspace

Content Properties for content.json

The format of the content.json file depends on the content type—news, image, document, audio, video, or custom content. Each one has different properties. Enhanced CMS workspaces consider image, document, audio, and video content types as media, and those content types have similar content body properties.

All content.json files have these fields. You can omit optional fields from the JSON.

Media Content Body Properties

The sfdc_cms__image, sfdc_cms__document, sfdc_cms__audio, and sfdc_cms__video types have these content body (contentBody) properties.

The source field represents a managed content media source node (MediaSource) within the sfdc_cms__image, sfdc_cms__document, sfdc_cms__audio, and sfdc_cms__video content types. A source field is required.

Here’s an example of the JSON structure for importing an image content record. Salesforce CMS assigns a content key to new content after import.

{
  "type" : "sfdc_cms__image",
  "title" : "Trailhead",
  "contentBody" : {
    "sfdc_cms:media" : {
      "source" : {
        "type" : "file",
        "mimeType" : "image/png"
      }
    }
  }
}

Here’s an example of the JSON structure for importing a document content record. Salesforce CMS assigns a content key to new content after import.

{
  "type" : "sfdc_cms__document",
  "title" : "Unveiling the Mysteries of Stars_ Exploring the Heart of the Cosmopolitans",
  "contentBody" : {
    "sfdc_cms:media" : {
      "source" : {
        "mimeType" : "application/pdf",
        "ref" : "0sNX200000007r7MAA",
        "type" : "file",
      },
      "url" : ""
    }
  }
}

sfdc_cms__news Content Body Properties

The sfdc_cms__news type has these content body (contentBody) properties.

The bannerImage field represents an image node (IMG) within the sfdc_cms__news content type.

Here’s an example of the JSON structure for a news item that references an image by using the image’s content key.

{
  "type" : "sfdc_cms__news",
  "title" : "Astronomers Unveil New Stellar Marvel: The Lumina Nova",
  "contentBody" : {
    "bannerImage" : {
      "altText" : "Blue sky with many stars.",
            "source" : {
        "ref" : {
          "contentKey" : "MCDB6GUACSNNGTZAEAI5PGSHA7UY"
        },
        "type" : "imageReference"
      },
      "url" : "/cms/media/MCDB6GUACSNNGTZAEAI5PGSHA7UY"
    },
    "body" : "<div><em>By Xena Bobina, Contributing Writer</em></div><div><br /></div><div>In a groundbreaking discovery that promises to reshape our understanding of the cosmos, astronomers have announced the identification of a previously unknown star, dubbed Lumina Nova.</div><div>Located in the distant reaches of the Milky Way galaxy, Lumina Nova shines with a brilliance unmatched by any other stellar object in its vicinity. Its luminosity far surpasses that of our own Sun, captivating scientists with its dazzling display.</div><div>Dr. Jonathan Reyes, lead astronomer on the research team, described the moment of discovery as nothing short of extraordinary. ,
    "excerpt" : "It's a thrilling opportunity to deepen our understanding of the universe."
  }
}

Custom Content Body Properties

Your content needs a name, but the rest of the content type properties are up to you. You can set any nodes depending on the type of content that you want to import. Here are some example properties.

Note For custom content type, all optional fields can be defined as required.

The dateTimeNode field represents a managed content date and time node (DateTime) within the custom content type.

Here’s an example of the JSON structure for importing a custom content item. Salesforce CMS assigns a content key after import.

{
    "content": [{
        "type": "customContentType",
        "body": {
            "nameNode": "CustomContentImportTest",
            "urlNode": "http://www.exampletube.com/myVideo",
            "dateNode": "1994-07-01",
            "dateTimeNode": {
                "dateTimeValue": "2008-09-15T15:53:00.000Z",
                "timeZone": "America/Los_Angeles"
            }
        }
    }]
}

Content Properties for _meta.json

The _meta.json file is optional, depending on whether the content is existing or new. If the _meta.json file isn’t included in the .zip archive for import, the content defined in the content.json file is assigned a new content key and put in the workspace root folder.

Here’s an example of the JSON structure for importing a content item with taxonomy tags and specifying which enhanced CMS workspace folder that you want the content to import into.

{
  "contentKey" : "MCLYY5A5UXOBH6RHTICCNTAKEXR4",
  "path" : "",
  "taxonomyTerms" : ["Term 1", "Term 2"]
}

Note Sometimes, the JSON file might start with a hidden character called a byte order mark. This character is not visible in all text editors and it can cause the import to fail with a file read error. To fix this, save the file using a text editor that lets you choose the encoding UTF-8.