/adobe-experience-manager-assets | Type: Application | PCID required: Yes
Tools
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
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
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
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
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 |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assetId": {
"type": "string",
"description": "ID of the asset"
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
}
},
"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
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 |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
Show inputSchema
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"
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
}
},
"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 |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
Show inputSchema
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"
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
}
},
"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. |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
Show inputSchema
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."
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
}
},
"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. |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
relationTypes | string[] | No | — | Comma-delimited list of relation types to filter the asset relations to include only the specified types. |
Show inputSchema
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."
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
},
"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. |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
Show inputSchema
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."
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
}
},
"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 |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
attachment | string | No | — | Setting this parameter to true forces “download” prompt in browser by adapting the Content-Disposition appropriately. Default is false. |
Show inputSchema
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"
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
},
"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 |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assetId": {
"type": "string",
"description": "ID of the asset"
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
}
},
"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. |
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
Show inputSchema
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."
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
}
},
"required": [
"PCID",
"importJobId"
]
}
adobe_experience_manager_assets_get_import_job_status
Get Import Job Status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
If-None-Match | string | No | — | The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110. |
importJobId | string | Yes | — | The identifier for an import job |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"If-None-Match": {
"type": "string",
"description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
},
"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
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",
"properties": {
"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."
},
"fileName": {
"type": "string",
"description": "Name of the file as it will appear in the repository after upload"
},
"mimeType": {
"type": "string",
"description": "The file format of the resource"
},
"fileSize": {
"type": "integer",
"format": "int64",
"description": "The size, in bytes, of the file to be imported"
},
"url": {
"type": "string",
"format": "uri",
"description": "The url from which to import"
}
},
"required": [
"fileName",
"url"
]
},
"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 |
If-Match | string | Yes | — | The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110. |
body | object[] | Yes | — | 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
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"
},
"If-Match": {
"type": "string",
"description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add",
"copy",
"move",
"remove",
"replace",
"test"
],
"description": "The operation to perform"
},
"path": {
"type": "string",
"description": "A JSON Pointer (RFC 6901) referencing the target location"
},
"value": {
"description": "The value to add/replace/test (required for add, replace, test operations)"
},
"from": {
"type": "string",
"description": "A JSON Pointer referencing the source location (required for copy and move operations)"
}
},
"required": [
"op",
"path"
]
},
"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",
"If-Match",
"body"
]
}