Bulk Get Fragments

POST /rest/asset/v2/fragment/bulk/get

Retrieves multiple fragments by their IDs in a single request; each asset is returned in full, including its content. Maximum 20 assets per request.

Operation ID: bulkGetUsingPOST_fragment
Permissions: Read-Only Assets, Access Design Studio, Access Snippet
Request format: application/json
Returns: FragmentNewResponse, ErrorResponse

Parameters

Query 1

access_token string required

Token for Authorization

The Request Builder sends the token in the Authorization header instead, so it never appears in URLs.

Header 1

x-app-type string required

Application type header

Request body

application/json · required · BulkGetRequest · 1 properties

assetIds array of string required

Set of asset IDs to retrieve. Maximum 20 per request.

Responses

200 OK FragmentNewResponse

success boolean

requestId string

result array of FragmentDetailDTO

Model FragmentDetailDTO

id string

name string

description string

appType string

metadata ContentMetadataDTO

Model ContentMetadataDTO

createdBy string

createdAt string

createdById string

createdByAepId string

modifiedBy string

modifiedAt string

modifiedById string

modifiedByAepId string

settings FragmentSettingsDTO

Model FragmentSettingsDTO

fragmentType string required

fragmentSubType string

supportedChannels array of string required

thumbnail ThumbnailDTO

Model ThumbnailDTO

url string

Thumbnail image, typically a base64-encoded data URI.

status string

state string

virtualId string

associatedStates array of AssociatedStateDTO

Model AssociatedStateDTO

contentId string

externalId string

state string

appData AppDataDTO

Model AppDataDTO

editorType string

folderId string

workspaceId string

externalId string

editorContext EditorContextDto

Model EditorContextDto

dynamicContent object

scriptEngine string

themeId string

data DataDTO

Model DataDTO

html HtmlDataDTO

Model HtmlDataDTO

result › data › html

body string

text TextDataDTO

Model TextDataDTO

result › data › text

body string

syncFromHtml boolean

Generated example

{
  "success": true,
  "requestId": "123",
  "result": [
    {
      "id": "123",
      "name": "Example name",
      "description": "string",
      "appType": "string",
      "metadata": {
        "createdBy": "string",
        "createdAt": "string",
        "createdById": "123",
        "createdByAepId": "123",
        "modifiedBy": "string",
        "modifiedAt": "string",
        "modifiedById": "123",
        "modifiedByAepId": "123"
      },
      "settings": {
        "fragmentType": "string",
        "fragmentSubType": "string",
        "supportedChannels": [
          "string"
        ]
      },
      "thumbnail": {
        "url": "https://example.com"
      },
      "status": "string",
      "state": "string",
      "virtualId": "123",
      "associatedStates": [
        {
          "contentId": "123",
          "externalId": "123",
          "state": "string"
        }
      ],
      "appData": {
        "editorType": "string",
        "folderId": "123",
        "workspaceId": "123"
      },
      "externalId": "123",
      "editorContext": {
        "dynamicContent": {}
      },
      "scriptEngine": "string",
      "themeId": "123",
      "data": {
        "html": {
          "body": "string"
        },
        "text": {
          "body": "string",
          "syncFromHtml": true
        }
      }
    }
  ]
}

Default Error ErrorResponse

success boolean

requestId string

errors array of ContentWaveErrorDTO

Model ContentWaveErrorDTO

key string

message string

code string

dynamicMessage string

type string

Severity of the entry: info, warning, or error.

source string

Origin of the entry, e.g. validation, template, fragment, message_render, asset_publish.

errorMessage string

errorPosition object

Location in the content the entry refers to (for script/validation errors).

Generated example

{
  "success": true,
  "requestId": "123",
  "errors": [
    {
      "key": "string",
      "message": "string",
      "code": "string",
      "dynamicMessage": "string",
      "type": "string",
      "source": "string",
      "errorMessage": "string",
      "errorPosition": {
        "line": 123,
        "column": 123
      }
    }
  ]
}

Referenced models

Generated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.