Delete purpose

DELETE /api/service/purposes/{id}

Delete purpose by its unique identifier.

Path parameters

  • id string Required

    Unique identifier of the purpose to delete.

Responses

  • 200

    Purpose was successfully deleted.

    Note that there is no content returned by this API when successful.

  • 400 object

    Bad request: typically because the purpose could not be found.

    • code integer

      Unique code for the type of error that occurred.

    • error string

      High-level description of the error. This will typically be the words keycloak error.

    • info string | null
    • message string

      More detailed message regarding the error that occurred.

DELETE /api/service/purposes/{id}
curl \
 -X DELETE https://tenant.atlan.com/api/service/purposes/3f35d508-4f43-48d3-84e3-889c13571123 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (400)
{
  "code": 1003,
  "error": "Object doesn't exists. Please check your request parameters",
  "info": null,
  "message": "",
  "requestId": "j8nvCWZkrustHyWwAiMHuAgYZC6YDqJM"
}