Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Perform the following PUT request to upload the push operations required for your content update into the Amazon S3 file container you got from Step 1 - Create a File Container.

Code Block
PUT <MyUploadURI>
 
<HTTPHeaders>
 
{
  "AddOrUpdate": [
    {
      <MyItemMetadata>*,
      "documentId": <MyItemToAddOrUpdateURI>,
      <"Data"|"CompressedBinaryData"|"CompressedBinaryDataFileId">: <MyItemDataOrFileId>,
      "compressionType": <"Uncompressed"|"Deflate"|"GZip"|"LZMA"|"ZLib">,
      "FileExtension": <MyItemDataFileExtension>,
      "Permissions": <MyItemPermissionModel>
    }*
  ],
  "Delete": [
    {
      "documentId": <MyItemToDeleteURI>,
      "deleteChildren": <true|false>
    }*
  ]
}

...

In the request body (see Item Models - BatchDocumentBody):

  • For each item you include in the AddOrUpdate array (see Item Models - DocumentBody):
    • Replace <MyItemMetadata>* by any number of arbitrary metadata key-values you want to include along with the item you are adding or updating (see Pushing Item Metadata).
    • Replace <MyItemToAddOrUpdateURI> by the URI of the item to add or update (e.g., http://www.example.com/toadd.html).
    • Replace <"Data"|"CompressedBinaryData"|"CompressedBinaryDataFileId"> by the property you want to use to push the item data. You must also replace <MyItemDataOrFileId> accordingly (see Pushing Item Data).
    • If you are using the CompressedBinaryData or the CompressedBinaryDataFileId property to push item data (see Using the CompressedBinaryData Property and Using the CompressedBinaryDataFileId Property):

      • Replace <"Uncompressed"|"Deflate"|"GZip"|"LZMA"|"ZLib"> by the actual compression algorithm that was applied to the item data.

        Note
        iconfalse
        titleImportant:

        The compressionType value is case sensitive.

      Otherwise, you do not need to include the compressionType property at all.
    • Replace <MyItemDataFileExtension> by the actual file extension which the Push API should use to interpret the item data (e.g., .txt.html, etc.). This value must include a preceding dot (.) character.

      Tip
      iconfalse
      titleBest Practice:

      While specifying a FileExtension is optional, doing so is considered best practice.

    • If you want to identify the item as the child of another item in the index, replace <MyItemParentId> by the URI of the parent item (see Understanding the ParentId Property).
      Otherwise, you do not need to include the ParentId property at all in your request body.
    • If the target Push source is SECURED:

      Otherwise, you do not need to include the Permissions property at all.

  • For each item you include in the Delete array (see Item Models - DeletedItem):
    • Replace <MyItemToDeleteURI> by the URI of the item to delete (e.g., http://www.example.com/todelete.html).
    • Set the deleteChildren property to true if you want to delete all items identified as descendants of the specified item to delete, or set it to false otherwise (see Understanding the ParentId Property).

      Info
      iconfalse
      titleNote:

      The deleteChildren property is set to false by default.

...

In the Authorization HTTP header:

...