batch-action-controller

Get a list of dependency keys of all dependent entity objects for a specified source entity and bulk action.

Changed on

Get a list of dependency keys of all dependent entity objects for a specified source entity and bulk action. This can be used to verify depended objects for a certain bulk action to give a report of affected objects beforehand. For example for a delete action of a certain object, this gives all objects that will also be deleted within the deletion of the source object

get/admin-api/v1/batch-action/{modelId}/dependency

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/admin-api/v1/batch-action/{modelId}/dependency
  • Auth: oauth (defined in the document in a form this page cannot read)

Path parameters

modelIdstring required

The model identifier of the source entity object to geht the dependencies for.

Query parameters

bulkActionType'HARD_DELETE' | 'DEACTIVATE' | 'ACTIVATE' required

The bulk action type defining the type of action to get the dependencies for. This is the name of the enumeration

bulkActionAddIncludesboolean

Indicates if the following 'includes' parameter shall be processed or not. The default is false

bulkActionIncludesstring[]

A comma separated list of names of the EntityType enumeration that defines all entity types that shall be included in the result.

Response

OK

namestring
descriptionstring

Example response

[
  {
    "parent": {
      "modelId": "f91f9c0a-15a1-4c65-89c2-2b60310f2c12",
      "entityType": "USER"
    },
    "self": {
      "modelId": "f91f9c0a-15a1-4c65-89c2-2b60310f2c12",
      "entityType": "USER"
    }
  }
]

Changes

  • 94fd325fcb6cRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status