adobe-experience-manager-assets

Adobe AEM Assets - asset metadata, renditions, relations, and import

Server path: /adobe-experience-manager-assets | Type: Application | PCID required: Yes

Tools

Tool	Description
adobe_experience_manager_assets_create_asset_relations	Create new asset relations for an asset
adobe_experience_manager_assets_delete_asset	Delete asset
adobe_experience_manager_assets_delete_asset_relation	Delete an asset relation for an asset
adobe_experience_manager_assets_delete_asset_relations_for_relation_type	Delete all asset relations of the given relation type for an asset
adobe_experience_manager_assets_get_asset	Get an asset
adobe_experience_manager_assets_get_asset_job_status	Get the status of an async job
adobe_experience_manager_assets_get_asset_metadata	Delivers the specified asset’s metadata
adobe_experience_manager_assets_get_asset_original	Returns the originally uploaded binary for the asset
adobe_experience_manager_assets_get_asset_relation_types	Get the relation types for an asset
adobe_experience_manager_assets_get_asset_relations	Get the asset relations for an asset
adobe_experience_manager_assets_get_asset_relations_for_relation_type	Get the asset relations for an asset filtered by relation type
adobe_experience_manager_assets_get_asset_rendition	Returns a pre-generated (on AEM Assets authoring environment) rendition of the asset
adobe_experience_manager_assets_get_asset_renditions	Returns a list of static renditions of an asset
adobe_experience_manager_assets_get_import_job_result	Get Import Job Result
adobe_experience_manager_assets_get_import_job_status	Get Import Job Status
adobe_experience_manager_assets_import_from_url	Import From Url
adobe_experience_manager_assets_patch_asset_metadata	Updates the asset’s assetMetadata properties

---

adobe_experience_manager_assets_create_asset_relations

Create new asset relations for an asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access
items	any[]	Yes	—	Related assets to be added to the asset

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    },
    "items": {
      "type": "array",
      "description": "Related assets to be added to the asset"
    }
  },
  "required": [
    "PCID",
    "assetId",
    "items"
  ]
}

---

adobe_experience_manager_assets_delete_asset

Delete asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset
force	boolean	No	—	If true, delete the asset even if it is referenced

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset"
    },
    "force": {
      "type": "boolean",
      "description": "If true, delete the asset even if it is referenced"
    }
  },
  "required": [
    "PCID",
    "assetId"
  ]
}

---

adobe_experience_manager_assets_delete_asset_relation

Delete an asset relation for an asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access
relationType	string	Yes	—	Name of relation type for asset relation to be deleted.
relatedAssetId	string	Yes	—	ID of the related asset to be deleted.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    },
    "relationType": {
      "type": "string",
      "description": "Name of relation type for asset relation to be deleted."
    },
    "relatedAssetId": {
      "type": "string",
      "description": "ID of the related asset to be deleted."
    }
  },
  "required": [
    "PCID",
    "assetId",
    "relationType",
    "relatedAssetId"
  ]
}

---

adobe_experience_manager_assets_delete_asset_relations_for_relation_type

Delete all asset relations of the given relation type for an asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access
relationType	string	Yes	—	Name of relation type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    },
    "relationType": {
      "type": "string",
      "description": "Name of relation type"
    }
  },
  "required": [
    "PCID",
    "assetId",
    "relationType"
  ]
}

---

adobe_experience_manager_assets_get_asset

Get an asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset"
    }
  },
  "required": [
    "PCID",
    "assetId"
  ]
}

---

adobe_experience_manager_assets_get_asset_job_status

Get the status of an async job

Parameters:

Parameter	Type	Required	Default	Description
jobId	string	Yes	—	ID of an asynchronous job

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "ID of an asynchronous job"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

---

adobe_experience_manager_assets_get_asset_metadata

Delivers the specified asset’s metadata

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    }
  },
  "required": [
    "PCID",
    "assetId"
  ]
}

---

adobe_experience_manager_assets_get_asset_original

Returns the originally uploaded binary for the asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset
seoName	string	Yes	—	any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset"
    },
    "seoName": {
      "type": "string",
      "description": "any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots"
    }
  },
  "required": [
    "PCID",
    "assetId",
    "seoName"
  ]
}

---

adobe_experience_manager_assets_get_asset_relation_types

Get the relation types for an asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    }
  },
  "required": [
    "PCID",
    "assetId"
  ]
}

---

adobe_experience_manager_assets_get_asset_relations

Get the asset relations for an asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
relationTypes	string[]	No	—	Comma-delimited list of relation types to filter the asset relations to include only the specified types.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "relationTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Comma-delimited list of relation types to filter the asset relations to include only the specified types."
    }
  },
  "required": [
    "PCID",
    "assetId"
  ]
}

---

adobe_experience_manager_assets_get_asset_relations_for_relation_type

Get the asset relations for an asset filtered by relation type

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access
relationType	string	Yes	—	Name of relation type
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    },
    "relationType": {
      "type": "string",
      "description": "Name of relation type"
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    }
  },
  "required": [
    "PCID",
    "assetId",
    "relationType"
  ]
}

---

adobe_experience_manager_assets_get_asset_rendition

Returns a pre-generated (on AEM Assets authoring environment) rendition of the asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset
renditionName	string	Yes	—	any url-encoded or alphanumeric, non-whitespace set of characters that need to match one of the renditions uploaded/created for the specified asset. may contain hyphens and dots
seoName	string	Yes	—	any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots
attachment	string	No	—	Setting this parameter to true forces “download” prompt in browser by adapting the Content-Disposition appropriately. Default is false.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset"
    },
    "renditionName": {
      "type": "string",
      "description": "any url-encoded or alphanumeric, non-whitespace set of characters that need to match one of the renditions uploaded/created for the specified asset. may contain hyphens and dots"
    },
    "seoName": {
      "type": "string",
      "description": "any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots"
    },
    "attachment": {
      "type": "string",
      "description": "Setting this parameter to `true` forces \"download\" prompt in browser by adapting the `Content-Disposition` appropriately.  Default is `false`.",
      "enum": [
        "true",
        "1",
        "false",
        "0"
      ]
    }
  },
  "required": [
    "PCID",
    "assetId",
    "renditionName",
    "seoName"
  ]
}

---

adobe_experience_manager_assets_get_asset_renditions

Returns a list of static renditions of an asset

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset"
    }
  },
  "required": [
    "PCID",
    "assetId"
  ]
}

---

adobe_experience_manager_assets_get_import_job_result

Get Import Job Result

Parameters:

Parameter	Type	Required	Default	Description
importJobId	string	Yes	—	The identifier for an import job
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "importJobId": {
      "type": "string",
      "description": "The identifier for an import job"
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    }
  },
  "required": [
    "PCID",
    "importJobId"
  ]
}

---

adobe_experience_manager_assets_get_import_job_status

Get Import Job Status

Parameters:

Parameter	Type	Required	Default	Description
importJobId	string	Yes	—	The identifier for an import job

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "importJobId": {
      "type": "string",
      "description": "The identifier for an import job"
    }
  },
  "required": [
    "PCID",
    "importJobId"
  ]
}

---

adobe_experience_manager_assets_import_from_url

Import From Url

Parameters:

Parameter	Type	Required	Default	Description
assetMetadata	object	No	—	Metadata properties and values that should be applied to assets that are part of the import. Client should use the assetMetadata properties as exposed by the metadata API endpoints.
files	object[]	Yes	—	The files value
folder	string	Yes	—	The ID or path for the folder into which to import the assets in AEM.
sourceName	string	No	—	A user-friendly display name for the source of the assets

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetMetadata": {
      "type": "object",
      "description": "Metadata properties and values that should be applied to assets that are part of the import. Client should use the assetMetadata properties as exposed by the metadata API endpoints."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "The files value"
    },
    "folder": {
      "type": "string",
      "description": "The ID or path for the folder into which to import the assets in AEM."
    },
    "sourceName": {
      "type": "string",
      "description": "A user-friendly display name for the source of the assets"
    }
  },
  "required": [
    "PCID",
    "files",
    "folder"
  ]
}

---

adobe_experience_manager_assets_patch_asset_metadata

Updates the asset’s assetMetadata properties

Parameters:

Parameter	Type	Required	Default	Description
assetId	string	Yes	—	ID of the asset to access
body	object[]	No	—	JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The application/json-patch+json media type is used to identify such patch documents. For more details check RFC 6902.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset to access"
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents.  For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)."
    }
  },
  "required": [
    "PCID",
    "assetId"
  ]
}