Jump to

• Request
• Response

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(optional): 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 ()

Asset trashing, untrashing, or purging request metadata.

Root Schema : deleteRequest

Type: object

Asset trashing, untrashing, or purging request metadata.

Show Source

• actionComment: string
• dependencies: array deleteDependenciesArray
  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" ]

{
    "description":"Asset trashing, untrashing, or purging request metadata.",
    "type":"object",
    "properties":{
        "format":{
            "enum":[
                "short",
                "graph",
                "forced"
            ]
        },
        "actionComment":{
            "type":"string"
        },
        "dependencies":{
            "$ref":"#/definitions/deleteDependenciesArray"
        }
    }
}

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.

Show Source

• [0]: object deleteDependencies
  Asset with its dependencies for trashing, untrashing, and purging operations.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of assets to be trashed, untrashed, or purged with their direct and reverse (upstream) dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/deleteDependencies"
    }
}

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: array dependencies
  Minimum Number of Items: 0

  Artifacts that this asset depends on. Also referred to as downstream dependencies.
• reverseDependencies: array reverseDependencies
  Minimum Number of Items: 0

  Artifacts that depend on this artifact. Also referred to as upstream dependencies.

{
    "description":"Asset with its dependencies for trashing, untrashing, and purging operations.",
    "type":"object",
    "properties":{
        "reverseDependencies":{
            "minItems":0,
            "uniqueItems":false,
            "description":"Artifacts that depend on this artifact. Also referred to as upstream dependencies.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/deleteAsset"
            }
        },
        "asset":{
            "$ref":"#/definitions/deleteAsset"
        },
        "dependencies":{
            "minItems":0,
            "uniqueItems":false,
            "description":"Artifacts that this asset depends on. Also referred to as downstream dependencies.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/deleteAsset"
            }
        }
    },
    "required":[
        "asset"
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "properties":{
                "errors":{
                    "$ref":"#/definitions/deleteErrorArray"
                }
            }
        }
    ],
    "description":"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.",
    "type":"object",
    "required":[
        "id"
    ]
}

Nested Schema : dependencies

Type: array

Minimum Number of Items: 0

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

Show Source

• [0]: 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.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"Artifacts that this asset depends on. Also referred to as downstream dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/deleteAsset"
    }
}

Nested Schema : reverseDependencies

Type: array

Minimum Number of Items: 0

Artifacts that depend on this artifact. Also referred to as upstream dependencies.

Show Source

• [0]: 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.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"Artifacts that depend on this artifact. Also referred to as upstream dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/deleteAsset"
    }
}

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]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetUpdate"
        },
        {
            "$ref":"#/definitions/assetIdEtag"
        },
        {
            "$ref":"#/definitions/trash"
        },
        {
            "properties":{
                "modifiedOn":{
                    "type":"string"
                },
                "deletedOn":{
                    "type":"string"
                },
                "modifiedBy":{
                    "type":"string"
                },
                "links":{
                    "$ref":"#/definitions/entityLinksArray"
                },
                "published":{
                    "description":"An asset draft or published status representation.",
                    "type":"boolean"
                },
                "createdOn":{
                    "type":"string"
                },
                "deletedBy":{
                    "type":"string"
                }
            }
        }
    ],
    "description":"The asset representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : deleteAsset-allOf[1]

Type: object

Show Source

• errors: array deleteErrorArray
  Minimum Number of Items: 0

  An array of asset delete-dependency errors.

{
    "properties":{
        "errors":{
            "$ref":"#/definitions/deleteErrorArray"
        }
    }
}

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Show Source

• actionComment: string
• desc: string
  Maximum Length: 100
• max: boolean
  Default Value: false
• name: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
• namespace: string
  Applicable to APIs and implementations only. This value is null for all other asset types.
• title: string
  Maximum Length: 255
• version: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z0-9][\w.]*$

  Asset version.

{
    "description":"The asset representation for PUT requests.",
    "type":"object",
    "properties":{
        "max":{
            "default":false,
            "type":"boolean"
        },
        "namespace":{
            "description":"Applicable to APIs and implementations only. This value is null for all other asset types.",
            "type":"string"
        },
        "name":{
            "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$",
            "type":"string",
            "maxLength":100
        },
        "title":{
            "type":"string",
            "maxLength":255
        },
        "version":{
            "$ref":"#/definitions/version"
        },
        "actionComment":{
            "type":"string"
        },
        "desc":{
            "type":"string",
            "maxLength":100
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : assetIdEtag

Type: object

The asset ID and entity tag (ETag) values.

Show Source

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

{
    "description":"The asset ID and entity tag (ETag) values.",
    "type":"object",
    "properties":{
        "etag":{
            "description":"The asset entity tag (ETag) value, which you can use to detect concurrent modification.",
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Show Source

• inTrash: boolean

{
    "description":"Indicator of whether the asset is in the trash.",
    "type":"object",
    "properties":{
        "inTrash":{
            "type":"boolean"
        }
    }
}

Nested Schema : assetGet-allOf[3]

Type: object

Show Source

• createdOn: string
• deletedBy: string
• deletedOn: string
• links: array entityLinksArray
  Minimum Number of Items: 0

  An array of links for an entity's metadata.
• modifiedBy: string
• modifiedOn: string
• published: boolean
  An asset draft or published status representation.

{
    "properties":{
        "modifiedOn":{
            "type":"string"
        },
        "deletedOn":{
            "type":"string"
        },
        "modifiedBy":{
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/entityLinksArray"
        },
        "published":{
            "description":"An asset draft or published status representation.",
            "type":"boolean"
        },
        "createdOn":{
            "type":"string"
        },
        "deletedBy":{
            "type":"string"
        }
    }
}

Nested Schema : entityLinksArray

Type: array

Minimum Number of Items: 0

An array of links for an entity's metadata.

Show Source

• [0]: object items
  Link to the entity's metadata.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of links for an entity's metadata.",
    "type":"array",
    "items":{
        "description":"Link to the entity's metadata.",
        "type":"object",
        "properties":{
            "rel":{
                "description":"Link type.",
                "enum":[
                    "self",
                    "canonical"
                ]
            },
            "href":{
                "description":"Link value.",
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : items

Type: object

Link to the entity's metadata.

Show Source

• href: string
  Link value.
• rel:
  Allowed Values: [ "self", "canonical" ]

  Link type.

{
    "description":"Link to the entity's metadata.",
    "type":"object",
    "properties":{
        "rel":{
            "description":"Link type.",
            "enum":[
                "self",
                "canonical"
            ]
        },
        "href":{
            "description":"Link value.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Nested Schema : deleteErrorArray

Type: array

Minimum Number of Items: 0

An array of asset delete-dependency errors.

Show Source

• [0]: object deleteError
  The asset delete dependencies error metadata.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of asset delete-dependency errors.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/deleteError"
    }
}

Nested Schema : deleteError

Type: object

The asset delete dependencies error metadata.

Show Source

• detail: string
• errorCode: string
• params: array stringArray
  Minimum Number of Items: 0

  An array of string values.

{
    "description":"The asset delete dependencies error metadata.",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "params":{
            "$ref":"#/definitions/stringArray"
        }
    },
    "required":[
        "errorCode"
    ]
}

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Show Source

• [0]: string

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of string values.",
    "type":"array",
    "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

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  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: string
  The service's error code.
• o:errorDetails: object errorDetails
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer(int64)
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• detail: string
• o:errorDetails: object errorDetails
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}

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

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  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: string
  The service's error code.
• o:errorDetails: object errorDetails
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer(int64)
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• detail: string
• o:errorDetails: object errorDetails
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}