Policy Management API

Use the Policy Management APIs to perform specific tasks on objects (code analysis, policies and rules) that you have permission to access in the Control Room. Policy management module consists of policy creation section and the policy assignment section at admin level, and the code analysis of automations section for control room user with the corresponding permissions.

Note:
Code analysis should be enabled in control room settings, and rules availability may change based on your license

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 2.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

CodeAnalysis

Up

post /analysis/details

Runs code analysis over an specific bot automation (analysisDetailsPost)

Runs code analysis over an specific bot automation, getting a plenty detail violations report

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body CodeAnalysisRequest (required)

Body Parameter —

Return type

BotCodeAnalysisDetailResponse

Example data

Content-Type: application/json

[ {
  "ruleLabel" : "ruleLabel",
  "ruleName" : "ruleName",
  "ruleErrorMessage" : "ruleErrorMessage",
  "ruleSeverity" : "LOW"
}, {
  "ruleLabel" : "ruleLabel",
  "ruleName" : "ruleName",
  "ruleErrorMessage" : "ruleErrorMessage",
  "ruleSeverity" : "LOW"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK BotCodeAnalysisDetailResponse

400

500

Up

post /analysis

Runs code analysis over an specific bot automation (analysisPost)

Runs code analysis over an specific bot automation, getting a violations summary