Simulator.Company REST API (1.0)

Download OpenAPI specification:Download

Simulator.Company Public REST API.

Authentication

OAuth2

Control Events use the OAuth 2.0 protocol for authentication and authorization. Control Events supports common OAuth 2.0 scenarios such as those for web server, installed, and client-side applications.

If you want to make requests on behalf of other control.events users, you can register an OAuth application and have them grant permissions to your app.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://account.corezoid.com/oauth2/authorize
Token URL: https://account.corezoid.com/oauth2/token
Scopes:
  • control.events:users.readonly -

    View workspace users information

  • control.events:workspaces.readonly -

    View all your workspaces

  • control.events:forms.readonly -

    View forms

  • control.events:forms.management -

    Create, update, and delete forms

  • control.events:actors.readonly -

    View actors info

  • control.events:actors.management -

    Create, update, and delete actors

  • control.events:attachments.readonly -

    View attachments

  • control.events:attachments.management -

    Create, update, and delete attachments

BearerAuth

You can generate an API access_token for your workspace on the Account (Account -> API Keys).

To use an API access_token to authenticate an API request, just replace access_token in the following API endpoints with the string key, and pass the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

reactions

Reactions API

Create reaction

Scopes [control.events:actors.management]

Authorizations:
OAuth2 (control.events:actors.management)
path Parameters
type
required
string
Enum: "view" "comment" "rating" "done" "sign" "reject" "freeze"

Reaction type

actorId
required
string

Actor ID

header Parameters
Authorization
required
string

Authorization header. Bearer [AccessToken]

Request Body schema: application/json
description
string

Comment text

appId
string

Script actor ID

appSettings
object

Script settings, e.g. autorun

data
object

Extra data for reaction

parentId
string

Parent reaction ID (reply to a comment)

object

Meta information

Responses

Request samples

Content type
application/json
{
  • "description": "Some comment text",
  • "appId": "string",
  • "appSettings": {
    },
  • "data": {
    },
  • "parentId": "string",
  • "metaInfo": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get all actor reactions

Scopes [control.events:actors.readonly]

Authorizations:
OAuth2 (control.events:reactions.readonly)
path Parameters
actorId
required
string

Actor ID

query Parameters
orderValue
string
Default: "ASC"
Enum: "ASC" "DESC"

Sorting vector

limit
integer
Default: 20

The total number of reactions to retrieve (used with offset)

offset
integer
Default: 0

The number of rows to skip when fetching list

header Parameters
Authorization
required
string

Authorization header. Bearer [AccessToken]

Responses