Home

Get Community Edition - FREE
LOG IN
Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Delete task log data

  • Updated: 2021/04/02
    • Automation 360 v.x
    • Optimize
    • RPA Workspace
    • API docs

Delete task log data

Delete the business data that is logged in the Bot Insight database on a deployed bot.

Prerequisites

Note: View the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.
  • All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON web token. See Authentication API.
  • You must have the AAE_Bot Insight Admin role and the Bot Insight license.

To delete data from the Bot Insight database, you provide the following information to the API in the request body:

Parameter Required Type Description
botname yes string Name of the bot for which you retrieve data
repositorypath yes string Control Room repository path of the bot
environment yes string Specifies the environment: DEV or PROD
runId no string ID number that is generated when the bot runs.

Use the get task log data to retrieve the runId: Get task log data.
fromDate no date Start date of the period for which to retrieve the data

Format: yyyy-mm-ddThh:mm:ss

If you do not provide this parameter, the API will return all available data.

Note: Do not provide this parameter if you provide the runId parameter.
toDate no date End date of the period for which to retrieve the data
  • Format: yyyy-mm-ddThh:mm:ss
  • Default: current date
Note: Do not provide this parameter if you provide the runId parameter.

Procedure

  1. Add the authentication token to the request header.
  2. Use the DELETE method and endpoint URL:<control_room_url>/v2/botinsight/data/api/deletetasklogdata
    Request body:
    {
    "botName": "AnalyticsMortgageProcessing",
    "runId": "a4e706f2-6806-49eb-8d8f-4b915f9a67b0_aaa8b68b1ef888a0",
    "repositoryPath": "repository:///Automation%20Anywhere/Bots/folder8092/AnalyticsMortgageProcessing?fileId=40642&workspace=PRIVATE",
    "environment": "Prod"
}
  3. Send the request.
    Response body: This example response returns the one thousand rows of data that were deleted.
    {
    "botName": "AnalyticsMortgageProcessing",
    "repositoryPath": "repository:///Automation%20Anywhere/Bots/folder8092/AnalyticsMortgageProcessing?fileId=40642&workspace=PRIVATE",
    "deleteCount": 1000
}
    The REST API responds to each request with an HTTP response code. For response codes, see API response codes.
Send Feedback