REST API Reference for Oracle Mobile Cloud Enterprise - Tooling APIs

Purge Assets From Trash

post

/mobile/tools/1.0/assets/purging

Purges requested assets from the trash.

Request

Supported Media Types

application/json

Header Parameters

If-Match: Type: string

For batch requests, this HTTP request header is used to force overwrite by passing the value *. If an overwrite value is not passed, then the REST call completes successfully if the ETag of the corresponding asset matches the value of ETag that's provided for the asset in the payload.

Body Parameter

Asset trashing, untrashing, or purging request metadata.

Root Schema : deleteRequest

Type: object

Asset trashing, untrashing, or purging request metadata.

Properties

actionComment: Type: string
dependencies: Type: array deleteDependenciesArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of assets to be trashed, untrashed, or purged with their direct and reverse (upstream) dependencies.
format: Allowed Values: [ "short", "graph", "forced" ]

Nested 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.

Items

Type: object deleteDependencies

Additional Properties Allowed:

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.

Properties

asset: Type: object deleteAsset

Required: true

Additional Properties Allowed:

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: Type: array dependencies

Additional Properties Allowed:

Minimum Number of Items: 0

Artifacts that this asset depends on. Also referred to as downstream dependencies.
reverseDependencies: Type: array reverseDependencies

Additional Properties Allowed:

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

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object deleteAsset-allOf[1]

Additional Properties Allowed:

Nested Schema : dependencies

Type: array

Minimum Number of Items: 0

Artifacts that this asset depends on. Also referred to as downstream dependencies.

Items

Type: object deleteAsset

Additional Properties Allowed:

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.

Items

Type: object deleteAsset

Additional Properties Allowed:

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

Type: object assetUpdate

Additional Properties Allowed:

The asset representation for PUT requests.
Type: object assetIdEtag

Additional Properties Allowed:

The asset ID and entity tag (ETag) values.
Type: object trash

Additional Properties Allowed:

Indicator of whether the asset is in the trash.
Type: object assetGet-allOf[3]

Additional Properties Allowed:

Nested Schema : deleteAsset-allOf[1]

Properties

errors: Type: array deleteErrorArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of asset delete-dependency errors.

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Properties

actionComment: Type: string
desc: Type: string

Maximum Length: 100
max: Type: boolean

Default Value: false
name: Type: string

Required: true

Maximum Length: 100

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
namespace: Type: string

Applicable to APIs and implementations only. This value is null for all other asset types.
title: Type: string

Maximum Length: 255
version: Type: 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.

Properties

etag: Type: string

The asset entity tag (ETag) value, which you can use to detect concurrent modification.
id: Type: string

Required: true

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Properties

inTrash: Type: boolean

Nested Schema : assetGet-allOf[3]

Properties

createdOn: Type: string
deletedBy: Type: string
deletedOn: Type: string
links: Type: array entityLinksArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of links for an entity's metadata.
modifiedBy: Type: string
modifiedOn: Type: string
published: Type: 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.

Items

Type: object items

Additional Properties Allowed:

Link to the entity's metadata.

Nested Schema : items

Type: object

Link to the entity's metadata.

Properties

href: Type: string

Required: true

Link value.
rel: Required: true

Allowed Values: [ "self", "canonical" ]

Link type.

Nested Schema : deleteErrorArray

Type: array

Minimum Number of Items: 0

An array of asset delete-dependency errors.

Items

Type: object deleteError

Additional Properties Allowed:

The asset delete dependencies error metadata.

Nested Schema : deleteError

Type: object

The asset delete dependencies error metadata.

Properties

detail: Type: string
errorCode: Type: string

Required: true
params: Type: array stringArray

Additional Properties Allowed:

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.

Items

Type: string

Response

Supported Media Types

application/json

204 Response

Assets were purged from the trash. No content was returned in this response.

400 Response

The operation failed because there were unresolvable dependencies or one or more dependencies couldn't be purged.

Body

Root Schema : error

Type: object

Properties

detail: Type: string

Required: true

Message that provides the error details.
o:ecid: Type: string

Required: true

Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
o:errorCode: Type: string

Required: true

The service's error code.
o:errorDetails: Type: object errorDetails

Additional Properties Allowed:
o:errorPath: Type: string

Required: true

The relative point in the API path where the error occurred.
status: Type: integer (int64)

Required: true

HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
title: Type: string

Required: true

Summary of the problem.
type: Type: string

Required: true

The URI to the link that provides details about the HTTP status code.

Nested Schema : errorDetails

Type: object

Properties

detail: Type: string

Required: true
o:errorDetails: Type: object errorDetails

Additional Properties Allowed:
title: Type: string

Required: true

Summary of the problem.
type: Type: string

Required: true

The URI to the link that provides details about the HTTP status code.

412 Response

The operation failed based on the `If-Match` condition. Typically, this is the result of concurrent modification detection. It also can be the result of improper values specified in the request headers.

Body

Root Schema : error

Type: object

Properties

detail: Type: string

Required: true

Message that provides the error details.
o:ecid: Type: string

Required: true

Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
o:errorCode: Type: string

Required: true

The service's error code.
o:errorDetails: Type: object errorDetails

Additional Properties Allowed:
o:errorPath: Type: string

Required: true

The relative point in the API path where the error occurred.
status: Type: integer (int64)

Required: true

HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
title: Type: string

Required: true

Summary of the problem.
type: Type: string

Required: true

The URI to the link that provides details about the HTTP status code.

Nested Schema : errorDetails

Type: object

Properties

detail: Type: string

Required: true
o:errorDetails: Type: object errorDetails

Additional Properties Allowed:
title: Type: string

Required: true

Summary of the problem.
type: Type: string

Required: true

The URI to the link that provides details about the HTTP status code.