Use the Team Management APIs to create and manage teams, team members, team roles, team configurations, team member assignments and visibility settings in Automation Co-Pilot.

Prerequisites:

Access to Automation Co-Pilot.
Assign the system-created AAE_Robotic_Interface Admin role to the Co-Pilot Admin user.

All API calls must contain either an authentication token from the Authentication API (generates a JSON Web Token) or a bearer token from OAuth services. You cannot use both in the same API call.

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

TeamMembers

put /teams/{teamId}/members/add
put /teams/{teamId}/members/remove

TeamMembers

Up

put /teams/{teamId}/members/add

Add members to a team (addTeamMember)

Use this endpoint to add users or roles to an existing team. You can include both in the same request. Specify the user ID and team role for user addition and role ID for role addition.

Path parameters

teamId (required)

Path Parameter — Unique identifier of the team to which the users or roles must be added.

Consumes

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

application/json

Request body

body AddTeamMembersRequest (required)

Body Parameter — Contains list of users and roles to be added to the team.

Return type

String

Example data

Content-Type: application/json

"OK"

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

Members added successfully. String

400

Bad Request Error

401

Authentication required. Provide a valid authentication token. Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /teams/{teamId}/members/remove

Remove members from a team (removeTeamMember)

Use this endpoint to remove users or roles from an existing team. You can include both in the same request. Specify the user ID for user removal and role ID for role removal.

Path parameters

teamId (required)

Path Parameter — Unique identifier of the team from which the users or roles must be removed.

Consumes

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

application/json

Request body

body RemoveTeamMembersRequest (required)

Body Parameter — Contains list of users and roles to be removed to the team.

Return type

String

Example data

Content-Type: application/json

"OK"

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

Members removed successfully. String

400

Bad Request Error

401

Authentication required. Provide a valid authentication token. Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Teams

Up

post /teams

Create a team (createTeam)

<p>Use this endpoint to create a new Automation Co-Pilot team with specified members and roles.<br></p> <p><b>Important:</b> The following fields are mandatory when creating a team:<br></p> <ul> <li>Team name</li> <li>Request visibility</li> <li>Team admins</li> </ul>

Consumes

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

application/json

Request body

body CreateTeamRequest (required)

Body Parameter — Contains the details required to create a team, including team name, description, visibility of the team and list of user IDs with their assigned roles.

Return type

CreateTeamResponse

Example data

Content-Type: application/json

{
  "ref" : "9",
  "id" : 10
}

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

201

Returns the details of the created team. CreateTeamResponse

400

Bad Request Error

401

Authentication required. Provide a valid authentication token. Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

delete /teams/{teamId}

Delete a team (deleteTeam)

Use this endpoint to delete a team by specifying the team ID.

Path parameters

teamId (required)

Path Parameter — Unique identifier of the team to be deleted.

Return type

String

Example data

Content-Type: application/json

"OK"

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

Team deleted successfully. String

401

Authentication required. Provide a valid authentication token. Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Models

Methods

Table of Contents

AddTeamMembersRequest
CreateTeamRequest
CreateTeamResponse
Error
RemoveTeamMembersRequest
RequestVisibility
TeamRole
TeamUserRequest

`AddTeamMembersRequest` Up

users (optional)

array[TeamUserRequest] List of users to be added to the team. Each entry contains a user ID and a team role.

roles (optional)

array[Object] List of roles to be added to the team.

`CreateTeamRequest` Up

name

String Name of the team.

example: Team API

description (optional)

String A brief summary of the team's purpose.

example: A team created through API

requestVisibility

RequestVisibility

users

array[TeamUserRequest] List of users to be added to the team. Each entry contains a user ID and a team role.

`CreateTeamResponse` Up

id (optional)

Integer Unique identifier of the created team.

example: 10

ref (optional)

String Reference identifier of the created team.

example: 9

`Error` Up

code (optional)

Integer HTTP status code of the error.

message (optional)

String Message describing the error.

`RemoveTeamMembersRequest` Up

userIds (optional)

array[Integer] List of user IDs to be removed from the team.

roleIds (optional)

array[Integer] List of role IDs to be removed from the team.

`RequestVisibility` Up

Request visibility setting for the team.

`TeamRole` Up

Role assigned to the user in the team.

`TeamUserRequest` Up

userId

Integer Unique identifier of the user to be added to the team.

example: 124

teamRole

TeamRole

Automation 360

Team Management API