Retrieve Asset Purge Dependencies
post
/mobile/tools/1.0/assets/purgeDependencies
Returns the assets that should also be purged or will be affected by purging of the specified assets.
Request
Supported Media Types
- application/json
Query Parameters
-
format(optional): string
The level of details returned for the purge dependencies request: * `short` includes the the requested assets, the blocking dependencies, and error messages. * `graph` includes the requested assets, and all upstream and downstream dependencies to support the dependencies graph in the UI. * `forced` includes the requested assets and all downstream dependencies recursively.Default Value:
short
Allowed Values:[ "short", "graph", "forced" ]
An array of asset IDs to use to get trashing, untrashing, or purging dependencies.
Root Schema : deleteDependenciesRequest
Type:
object
An array of asset IDs to use to get trashing, untrashing, or purging dependencies.
Show Source
-
ids:
array stringArray
Minimum Number of Items:
0
An array of string values.
Nested Schema : stringArray
Type:
array
Minimum Number of Items:
0
An array of string values.
Show Source
Response
Supported Media Types
- application/json
200 Response
The asset purging dependencies.
An array of assets to be trashed, untrashed, or purged with their direct and reverse (upstream) dependencies.
Root Schema : deleteDependenciesArray
Type:
array
Minimum Number of Items:
0
An array of assets to be trashed, untrashed, or purged with their direct and reverse (upstream) dependencies.
Show Source
-
Array of:
object deleteDependencies
Asset with its dependencies for trashing, untrashing, and purging operations.
Nested Schema : deleteDependencies
Type:
object
Asset with its dependencies for trashing, untrashing, and purging operations.
Show Source
-
asset:
object deleteAsset
The asset representation for delete-dependency requests and responses. For a request body, you must include the asset ID and, optionally, the ETag. No other attributes are necessary. The response body contains the generic asset details.
-
dependencies(optional):
array dependencies
Minimum Number of Items:
0
Artifacts that this asset depends on. Also referred to as downstream dependencies. -
reverseDependencies(optional):
array reverseDependencies
Minimum Number of Items:
0
Artifacts that depend on this artifact. Also referred to as upstream dependencies.
Nested Schema : deleteAsset
Type:
object
The asset representation for delete-dependency requests and responses. For a request body, you must include the asset ID and, optionally, the ETag. No other attributes are necessary. The response body contains the generic asset details.
Match All
Show Source
-
object assetGet
The asset representation for GET requests.
-
object deleteAsset-allOf[1]
Nested Schema : dependencies
Type:
array
Minimum Number of Items:
0
Artifacts that this asset depends on. Also referred to as downstream dependencies.
Show Source
-
Array of:
object deleteAsset
The asset representation for delete-dependency requests and responses. For a request body, you must include the asset ID and, optionally, the ETag. No other attributes are necessary. The response body contains the generic asset details.
Nested Schema : reverseDependencies
Type:
array
Minimum Number of Items:
0
Artifacts that depend on this artifact. Also referred to as upstream dependencies.
Show Source
-
Array of:
object deleteAsset
The asset representation for delete-dependency requests and responses. For a request body, you must include the asset ID and, optionally, the ETag. No other attributes are necessary. The response body contains the generic asset details.
Nested Schema : assetGet
Type:
object
The asset representation for GET requests.
Match All
Show Source
-
object assetUpdate
The asset representation for PUT requests.
-
object assetIdEtag
The asset ID and entity tag (ETag) values.
-
object trash
Indicator of whether the asset is in the trash.
-
object assetGet-allOf[3]
Nested Schema : deleteAsset-allOf[1]
Type:
Show Source
object
-
errors(optional):
array deleteErrorArray
Minimum Number of Items:
0
An array of asset delete-dependency errors.
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
Show Source
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetIdEtag
Type:
object
The asset ID and entity tag (ETag) values.
Show Source
-
etag(optional):
string
The asset entity tag (ETag) value, which you can use to detect concurrent modification.
-
id:
string
Nested Schema : assetGet-allOf[3]
Type:
Show Source
object
-
createdOn(optional):
string
-
deletedBy(optional):
string
-
deletedOn(optional):
string
-
links(optional):
array entityLinksArray
Minimum Number of Items:
0
An array of links for an entity's metadata. -
modifiedBy(optional):
string
-
modifiedOn(optional):
string
-
published(optional):
boolean
An asset draft or published status representation.
Nested Schema : entityLinksArray
Type:
array
Minimum Number of Items:
0
An array of links for an entity's metadata.
Show Source
-
Array of:
object items
Link to the entity's metadata.
Nested Schema : items
Type:
object
Link to the entity's metadata.
Show Source
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical" ]
Link type.
Nested Schema : deleteErrorArray
Type:
array
Minimum Number of Items:
0
An array of asset delete-dependency errors.
Show Source
-
Array of:
object deleteError
The asset delete dependencies error metadata.
Nested Schema : deleteError
Type:
object
The asset delete dependencies error metadata.
Show Source
-
detail(optional):
string
-
errorCode:
string
-
params(optional):
array stringArray
Minimum Number of Items:
0
An array of string values.
Nested Schema : stringArray
Type:
array
Minimum Number of Items:
0
An array of string values.
Show Source