Inputs: Assets

GraphQL input types for asset creation, update, deletion, folders, repositories, and publishing in the Amplience GraphQL Management API.

Assets

CreateAssetInput

Field	Type	Default	Description
src	String		URL path to the input file, e.g. https://ampproduct.a.bigcontent.io/v1/static/Hero-Banner-720-model2
type	AssetType!		Type of media to create
name	String!		Name of the asset. This should be a unique name across the account as it will be used when publishing
filename	String!		Original filename
assetRepositoryId	ID!		ID of the assetRepository to create this asset in
label	String		Friendly label for the asset, this is what a customer will see. If not specified this will default to srcName
assetFolderId	ID		ID of the folder this asset is contained within. Empty ID means it is created in the assetRepository root level
contents	[ID!]		A list of assetIds included in a set
localeGroup	String		Name of the localeGroup the asset belongs to. Defaults to asset name
locale	String		UUID corresponding to the locale of the asset
workflowAssignedTo	ID		ID of the assigned workflow user
workflowStatus	WorkflowStatus		Status of the workflow
tags	[String!]		A list of tags
thumbFile	String		The UUID of an existing file to assign as a thumbnail

CreateUpdateAssetInput

Field	Type	Default	Description
src	String		Url path to the input file, e.g. https://ampproduct.a.bigcontent.io/v1/static/Hero-Banner-720-model2
filename	String		Original filename
label	String		Friendly label for the asset, this is what a customer will see
assetFolderId	ID		ID of the folder this asset is contained within
workflowAssignedTo	ID		ID of the assigned workflow user
workflowStatus	WorkflowStatus		Status of the workflow
contents	[ID!]		A list of asset IDs included in a set
localeGroup	String		Name of the localeGroup the asset should belong to
locale	String		Locale of the asset
tags	[String!]		A list of tags
thumbFile	String		The UUID of an existing file to assign as a thumbnail
name	String!		The name of the asset. This should be a unique name across the account as it will be used when publishing
assetRepositoryId	ID!		ID of the assetRepository
type	AssetType		Type of media to create

UpdateAssetInput

Field	Type	Default	Description
src	String		Url path to the input file, e.g. https://ampproduct.a.bigcontent.io/v1/static/Hero-Banner-720-model2
filename	String		Original filename
label	String		Friendly label for the asset, this is what a customer will see
assetFolderId	ID		ID of the folder this asset is contained within
workflowAssignedTo	ID		ID of the assigned workflow user
workflowStatus	WorkflowStatus		Status of the workflow
contents	[ID!]		A list of asset IDs included in a set
localeGroup	String		Name of the localeGroup the asset should belong to
locale	String		Locale of the asset
tags	[String!]		A list of tags
thumbFile	String		The UUID of an existing file to assign as a thumbnail
id	ID!		ID of the asset
name	String		The name of the asset. This should be a unique name across the account as it will be used when publishing
assetRepositoryId	ID		ID of the assetRepository

UpdateAssetMetadataInput

Asset field filtering

Field	Type	Default	Description
id	ID!		ID of the asset
metadataSchemaName	String!		The name of the metadata schema
relationshipName	String		The explicit name of the relationship to add. We will try to infer the relationship if this is not provided.
metadata	JSON!		Metadata properties to update as key/value pairs. Must be valid for the specified metadata schema

DeleteAssetInput

Field	Type	Default	Description
id	ID		ID of the asset to delete
assetId	String		UUID of the asset to delete

DeleteAssetsInput

Field	Type	Default	Description
id	[ID!]		ID of the assets
assetId	[String!]		UUID of the assets

FilterFields

Asset field filtering

Field	Type	Default	Description
tags	[String!]		Tags that have been assigned to the asset
tagsCaseSensitive	[String!]		Tags that have been assigned to the asset - case sensitive
mimeType	[String!]		Mimetype file descriptors
status	AssetStatus		Active status
lastPublishStatus	AssetPublishStatus		Last publish status
lastSuccessfulPublishStatus	AssetPublishStatus		Last successful publish status
assetRepositoryId	[ID!]		IDs of the repositories
assetFolderId	[ID!]		IDs of the folders
locale	String		Locale (IETF language tag)
localeGroup	String		Locale group name
type	AssetType		Type of asset
subType	String		Sub type of asset
workflowAssignedBy	String		Assigned by
workflowAssignedTo	String		Assigned to
createdDate	DateRange		Creation date
updatedDate	DateRange		Last update date
published	Boolean		Published status
lastPublishDate	DateRange		Last publish date
lastSuccessfulPublishDate	DateRange		Last successful publish date

SortableFields

Asset field sorting priority

Field	Type	Default	Description
id	SortDirection		ID
name	SortDirection		Name
label	SortDirection		Label
tags	SortDirection		Tags
mimeType	SortDirection		Mimetype
createdDate	SortDirection		Created date
updatedDate	SortDirection		Updated date
published	SortDirection		Published date
lastPublishDate	SortDirection		Last published date
lastPublishStatus	SortDirection		Last published status
lastSuccessfulPublishDate	SortDirection		Last successful publish date
lastSuccessfulPublishStatus	SortDirection		Last successful publish status
locale	SortDirection		Locale

RestoreAssetsInput

Field	Type	Default	Description
id	[ID!]		ID of the assets
assetId	[String!]		UUID of the assets

Publishing

PublishAssetInput

Field	Type	Default	Description
id	ID!		ID of the asset to publish
jobId	[String!]		The IDs of the jobs to wait for

UnpublishAssetInput

Field	Type	Default	Description
id	ID!		ID of the asset to unpublish

UnpublishAssetsInput

Field	Type	Default	Description
id	[ID!]		ID of the assets
assetId	[String!]		UUID of the assets

Folders & repositories

CreateFolderInput

Field	Type	Default	Description
label	String!		The label of the folder.
parentId	ID		The folder ID of the parent folder. The new folder will be created under the provided parent.
assetRepositoryId	ID		The asset repository ID. If not provided we will create the folder in the default asset repository.

CreateAssetRepositoryInput

Field	Type	Default	Description
label	String!		The name of the new asset repository, used when referencing it from Dynamic Media.

UpdateAssetRepositoryInput

Field	Type	Default	Description
id	ID!		The ID of the asset repository to update
label	String!		The name of the asset repository, used when referencing it from Dynamic Media.

DeleteAssetRepositoryInput

Field	Type	Default	Description
id	ID!		The ID of the asset repository to delete