> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# 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`](#adobe_experience_manager_assets_create_asset_relations) | Create new asset relations for an asset |
| [`adobe_experience_manager_assets_delete_asset`](#adobe_experience_manager_assets_delete_asset) | Delete asset |
| [`adobe_experience_manager_assets_delete_asset_relation`](#adobe_experience_manager_assets_delete_asset_relation) | Delete an asset relation for an asset |
| [`adobe_experience_manager_assets_delete_asset_relations_for_relation_type`](#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`](#adobe_experience_manager_assets_get_asset) | Get an asset |
| [`adobe_experience_manager_assets_get_asset_job_status`](#adobe_experience_manager_assets_get_asset_job_status) | Get the status of an async job |
| [`adobe_experience_manager_assets_get_asset_metadata`](#adobe_experience_manager_assets_get_asset_metadata) | Delivers the specified asset's metadata |
| [`adobe_experience_manager_assets_get_asset_original`](#adobe_experience_manager_assets_get_asset_original) | Returns the originally uploaded binary for the asset |
| [`adobe_experience_manager_assets_get_asset_relation_types`](#adobe_experience_manager_assets_get_asset_relation_types) | Get the relation types for an asset |
| [`adobe_experience_manager_assets_get_asset_relations`](#adobe_experience_manager_assets_get_asset_relations) | Get the asset relations for an asset |
| [`adobe_experience_manager_assets_get_asset_relations_for_relation_type`](#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`](#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`](#adobe_experience_manager_assets_get_asset_renditions) | Returns a list of static renditions of an asset |
| [`adobe_experience_manager_assets_get_import_job_result`](#adobe_experience_manager_assets_get_import_job_result) | Get Import Job Result |
| [`adobe_experience_manager_assets_get_import_job_status`](#adobe_experience_manager_assets_get_import_job_status) | Get Import Job Status |
| [`adobe_experience_manager_assets_import_from_url`](#adobe_experience_manager_assets_import_from_url) | Import From Url |
| [`adobe_experience_manager_assets_patch_asset_metadata`](#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 |
```json theme={null}
{
"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 |
```json theme={null}
{
"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. |
```json theme={null}
{
"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 |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
```json theme={null}
{
"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 |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
| `relationTypes` | string\[] | No | — | Comma-delimited list of relation types to filter the asset relations to include only the specified types. |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
| `attachment` | string | No | — | Setting this parameter to `true` forces "download" prompt in browser by adapting the `Content-Disposition` appropriately. Default is `false`. |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match). |
| `importJobId` | string | Yes | — | The identifier for an import job |
```json theme={null}
{
"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 |
```json theme={null}
{
"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](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match). |
| `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](https://www.rfc-editor.org/rfc/rfc6902). |
```json theme={null}
{
"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"
]
}
```