List Fragments

GET /rest/asset/v2/fragment/filter

Filters and lists fragments by the given criteria.

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

Parameters

18 of 21 have no description in Adobe's specification.

Query 20

access_token string required

Token for Authorization

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

workspaceId string required

folderId string

folderType string

Values Folder Program

status array of string

pageIndex integer (int32)

pageSize integer (int32)

Maximum value is 50.

createdAtEnd string

createdAtStart string

modifiedAtStart string

modifiedAtEnd string

name string

fragmentType string

sortKey string

sortOrder string

Values ASC DESC

isCreatedByMe boolean

isModifiedByMe boolean

scriptEngine string

isValueNonNullable string

includeArchived boolean

Header 1

x-app-type string required

Application type header

Values marketo

Responses

200 OK FragmentFilterResponse

success boolean

requestId string

result FragmentFilterResult

Model FragmentFilterResult

totalItems integer (int32)

pageSize integer (int32)

currentPage integer (int32)

items array of FragmentContentDTO

Model FragmentContentDTO

id string

name string

description string

appType string

metadata ContentMetadataDTO

Model ContentMetadataDTO

result › items › metadata

createdBy string

createdAt string

createdById string

createdByAepId string

modifiedBy string

modifiedAt string

modifiedById string

modifiedByAepId string

settings FragmentSettingsDTO

Model FragmentSettingsDTO

result › items › settings

fragmentType string required

fragmentSubType string

supportedChannels array of string required

thumbnail ThumbnailDTO

Model ThumbnailDTO

result › items › thumbnail

url string

Thumbnail image, typically a base64-encoded data URI.

status string

state string

virtualId string

associatedStates array of AssociatedStateDTO

Model AssociatedStateDTO

result › items › associatedStates

contentId string

externalId string

state string

appData AppDataDTO

Model AppDataDTO

result › items › appData

editorType string

folderId string

workspaceId string

externalId string

editorContext EditorContextDto

Model EditorContextDto

result › items › editorContext

dynamicContent object

scriptEngine string

themeId string

Generated example

{
  "success": true,
  "requestId": "123",
  "result": {
    "totalItems": 123,
    "pageSize": 123,
    "currentPage": 123,
    "items": [
      {
        "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": [
            null
          ]
        },
        "thumbnail": {
          "url": "https://example.com"
        },
        "status": "string",
        "state": "string",
        "virtualId": "123",
        "associatedStates": [
          {
            "contentId": null,
            "externalId": null,
            "state": null
          }
        ],
        "appData": {
          "editorType": "string",
          "folderId": "123",
          "workspaceId": "123"
        },
        "externalId": "123",
        "editorContext": {
          "dynamicContent": {}
        },
        "scriptEngine": "string",
        "themeId": "123"
      }
    ]
  }
}

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.