Download OpenAPI specification:Download
Simulator.Company Public REST API.
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:
|
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 |
Scopes [control.events:actors.management]
control.events:actors.management
) type required | string Enum: "view" "comment" "rating" "done" "sign" "reject" "freeze" Reaction type |
actorId required | string Actor ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
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 | |
object Extra parameters |
{- "description": "Some comment text",
- "appId": "string",
- "appSettings": {
- "autorun": true
}, - "data": {
- "quote": "Some text quote",
- "rating": 5
}, - "parentId": "string",
- "metaInfo": {
- "originalUser": {
- "nick": "string",
- "avatar": "string"
}
}, - "extra": {
- "commentStyleType": "primary"
}
}
{- "data": {
- "treeInfo": {
- "name": "view",
- "branchId": { },
- "parentId": "string",
- "rootActorId": "string",
- "rootActorTitle": "string"
}, - "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.readonly]
control.events:reactions.readonly
) actorId required | string Actor ID |
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 |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/reactions/list/%7BactorId%7D
{- "data": [
- {
- "treeInfo": {
- "name": "view",
- "branchId": { },
- "parentId": "string",
- "rootActorId": "string",
- "rootActorTitle": "string"
}, - "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Actor ID to get reactions statistics |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/reactions/stats/%7BactorId%7D
{- "data": {
- "view": 1,
- "comment": 1,
- "sign": 1
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) rootActorId required | string Root actor ID (the actor to which the reaction belongs) |
Authorization required | string Authorization header. Bearer [AccessToken] |
actorId | string Reaction actor ID (which is being edited) |
description | string Comment text |
appId | string Script actor ID |
appSettings | object Script settings, e.g. autorun |
data | object Extra data for reaction |
{- "actorId": "string",
- "description": "Some comment text",
- "appId": "string",
- "appSettings": { },
- "data": {
- "quote": "Some text quote",
- "rating": 5
}
}
{- "data": {
- "treeInfo": {
- "name": "view",
- "branchId": { },
- "parentId": "string",
- "rootActorId": "string",
- "rootActorTitle": "string"
}, - "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) actorId required | string ID of the actor to which the reaction is linked |
actorId required | string Reaction actor ID |
{- "actorId": "string"
}
{- "data": {
- "treeInfo": {
- "name": "view",
- "branchId": { },
- "parentId": "string",
- "rootActorId": "string",
- "rootActorTitle": "string"
}, - "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) actorId required | string Actor ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
count | number Count of reactions to be mark as read |
time | number Reactions before this time will be mark as read |
{- "count": 0,
- "time": 0
}
{- "unreadReactions": [
- {
- "treeInfo": {
- "name": "view",
- "branchId": { },
- "parentId": "string",
- "rootActorId": "string",
- "rootActorTitle": "string"
}, - "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
], - "readTime": 0
}
Scopes [control.events:attachments.management]
control.events:attachments.management
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
File binary
file | string <binary> |
curl --request POST \ --url https://api.simulator.company/v/1.0/upload/%7BaccId%7D
{- "data": {
- "id": 0,
- "accId": "string",
- "fileName": "string",
- "type": "string",
- "userId": 0,
- "size": 0,
- "title": "string"
}
}
Scopes [control.events:attachments.management]
control.events:attachments.management
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
File binary
file | string <base64> File in base64 format |
originalName | string File name |
{- "file": "string",
- "originalName": "fileName.png"
}
{- "data": {
- "id": 0,
- "accId": "string",
- "fileName": "string",
- "type": "string",
- "userId": 0,
- "size": 0,
- "title": "string"
}
}
fileName required | string |
origin | boolean Default: false Specify true to download file with initial filename and extension. |
preview | boolean Default: false Specify true to show file preview only (without download). |
curl --request GET \ --url https://api.simulator.company/v/1.0/download/%7BfileName%7D
Scopes [control.events:attachments.management]
control.events:attachments.management
) accId required | string Workspace Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
title | string <= 500 characters |
callbackUrl | string |
Array of objects |
{- "title": "string",
- "callbackUrl": "string",
- "files": [
- {
- "type": "folder",
- "title": "string",
- "fileName": "string",
- "children": [
- { }
]
}
]
}
{- "data": {
- "taskId": 0
}
}
Scopes [control.events:attachments.readonly]
control.events:attachments.readonly
) accId required | string Workspace Id |
orderBy | string Enum: "created_at" "title" Attachments sorting mode |
orderValue | string Enum: "ASC" "DESC" Sorting vector |
limit | integer The total number of attachments to retrieve (used with offset) |
offset | integer The number of rows to skip when fetching list |
starred | boolean Get favorite attachments |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/attachments/%7BaccId%7D
{- "data": [
- {
- "id": 0,
- "accId": "string",
- "externalId": 0,
- "fileName": "string",
- "type": "string",
- "userId": 0,
- "actorId": "string",
- "actorTitle": "string",
- "size": 0,
- "title": "string",
- "starred": true,
- "createdAt": 0,
- "updatedAt": 0
}
]
}
Scopes [control.events:attachments.management]
control.events:attachments.management
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
attachId required | integer ID of uploaded file |
actorId required | string Actor ID |
[- {
- "attachId": 0,
- "actorId": "string"
}
]
{- "data": [
- {
- "attachId": 0,
- "actorId": "string"
}
]
}
Scopes [control.events:attachments.management]
control.events:attachments.management
) accId required | string Workspace ID |
attachId required | integer ID of uploaded file |
actorId required | string Actor ID |
[- {
- "attachId": 0,
- "actorId": "string"
}
]
{- "data": [
- {
- "attachId": 0,
- "actorId": "string"
}
]
}
Deleting files should not be attached to actors
Name of file to delete
[- "string"
]
{- "data": {
- "removed": [
- "string"
], - "errorRemove": [
- {
- "fileName": "string",
- "reason": "string"
}
]
}
}
Scopes [control.events:forms.readonly]
control.events:forms.readonly
) accId required | string Workspace Id |
limit | integer Default: 20 The total number of rows to retrieve (used with offset) |
offset | integer Default: 0 The number of rows to skip when fetching list |
noDefault | boolean Exclude default form |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/forms/templates/%7BaccId%7D
{- "data": [
- {
- "id": 0,
- "accId": "string",
- "title": "string",
- "color": "string",
- "ownerId": 0,
- "ownerName": "string",
- "ownerType": "string",
- "isSent": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
]
}
This API is used to get system forms:
Scopes [control.events:forms.readonly]
control.events:forms.readonly
) accId required | string Workspace Id |
formTypes | string Enum: "connector" "system" Example: formTypes=system |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url 'https://api.simulator.company/v/1.0/forms/templates/system/%7BaccId%7D?formTypes=system'
{- "data": [
- {
- "id": 1,
- "accId": "string",
- "title": "Events",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 2,
- "accId": "string",
- "title": "Reactions",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 3,
- "accId": "string",
- "title": "Tags",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 4,
- "accId": "string",
- "title": "Locations",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 5,
- "accId": "string",
- "title": "Graphs",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 6,
- "accId": "string",
- "title": "Layers",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 7,
- "accId": "string",
- "title": "Streams",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 8,
- "accId": "string",
- "title": "Widgets",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}, - {
- "id": 8,
- "accId": "string",
- "title": "Scripts",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "isSystem": true
}
]
}
Scopes [control.events:forms.management]
control.events:forms.management
) accId required | string Workspace ID |
isTemplate required | boolean Specify true if the form is a template; otherwise, false |
Authorization required | string Authorization header. Bearer [AccessToken] |
title | string |
description | string |
color | string |
sections | Array of objects |
settings | object |
tags | Array of objects |
{- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}
{- "data": {
- "id": 0,
- "accId": "string",
- "title": "string",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
}
Scopes [control.events:forms.management]
control.events:forms.management
) formId required | integer Form ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
status | string Enum: "verified" "rejected" "pending" null |
{- "status": "verified"
}
{- "data": {
- "id": 0,
- "accId": "string",
- "title": "string",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
}
Scopes [control.events:forms.readonly]
control.events:forms.readonly
) formId required | string Form ref |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/forms/ref/%7Bref%7D
{- "data": {
- "id": 0,
- "accId": "string",
- "title": "string",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
}
Scopes [control.events:forms.readonly]
control.events:forms.readonly
) formId required | integer Form ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/forms/%7BformId%7D
{- "data": {
- "id": 0,
- "accId": "string",
- "title": "string",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
}
Scopes [control.events:forms.management]
control.events:forms.management
) formId required | integer Form ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
title | string |
description | string |
color | string |
sections | Array of objects |
settings | object |
tags | Array of objects |
{- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}
{- "data": {
- "id": 0,
- "accId": "string",
- "title": "string",
- "description": "string",
- "color": "string",
- "form": {
- "title": "string",
- "description": "string",
- "color": "string",
- "sections": [
- { }
], - "settings": { },
- "tags": [
- { }
]
}, - "ownerId": 0,
- "isSent": true,
- "isTemplate": true,
- "isDefault": true,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
}
Scopes [control.events:forms.management]
control.events:forms.management
) formId required | integer Form ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/forms/%7BformId%7D
{- "data": "ok"
}
Helps to clear cache for form item options, where source type is 'api'.
Scopes [control.events:forms.management]
control.events:forms.management
) formId required | integer Form ID |
itemId required | string Form item ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/forms/item_cache/%7BformId%7D/%7BitemId%7D
{- "data": "ok"
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Actor ID |
edgeTypeId | any Link type ID from the list of available link types. |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/graph/linked_actors/%7BactorId%7D
{- "data": {
- "nodes": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
], - "edges": [
- {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Actor ID |
edgeTypeId | integer Link type ID from the list of available link types. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/graph/actor_links/%7BactorId%7D
{- "data": [
- {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) Authorization required | string Authorization header. Bearer [AccessToken] |
source required | string Source actor ID |
target required | string Target actor ID |
edgeTypeId required | integer Link type ID from the list of link types |
{- "source": "string",
- "target": "string",
- "edgeTypeId": 0
}
{- "data": [
- {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) type required | string Enum: "children" "parents" "linked" Type of relation to the actor, |
actorId required | string Actor ID |
edgeTypeId required | integer Link type ID from the list of available link types. |
formId | integer Form ID to filter linked actors |
exceptFormId | integer Form ID to exclude actors from the result |
orderBy | string Default: "createdAt" Enum: "createdAt" "formTitle" Actors sorting mode |
orderValue | string Default: "DESC" Enum: "ASC" "DESC" Sorting vector |
limit | integer Default: 20 The total number of actors to retrieve (used with offset) |
offset | integer Default: 0 The number of rows to skip when fetching list |
withForm | boolean Specify true to add form info to response data |
lastReaction | boolean Specify true to add last actor reaction to response data |
reactionsStats | boolean Specify true to add users' reactions statistics to response data |
starred | boolean |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/graph/%7Btype%7D/%7BactorId%7D
{- "data": {
- "total": 1,
- "list": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
]
}
}
Scopes [control.events:actors.readonly]
A layer is an actor created with system form Layers. This API retrieves all layer actor data together with it's nodes and links.
control.events:actors.readonly
) layerId required | string Layer ID |
noDuplicate | boolean Default: true Specify false to add all nodes copies on layer |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/graph_layers/%7BlayerId%7D
{- "data": {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}, - "nodes": [
- {
- "id": "string",
- "laId": 0,
- "title": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "layerStarred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "name": "string"
}
}
], - "edges": [
- {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "laId": 0,
- "laIdSource": 0,
- "laIdTarget": 0
}
]
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) layerId required | string Layer Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
List of actions
action | string Enum: "create" "delete" |
object |
[- {
- "action": "create",
- "data": {
- "id": "string",
- "type": "node",
- "laId": 0,
- "laIdSource": 0,
- "laIdTarget": 0,
- "position": {
- "x": 0,
- "y": 0
}, - "areaPicture": {
- "height": 0,
- "width": 0,
- "img": "string"
}
}
}
]
{- "data": {
- "id": 0,
- "accId": "string",
- "name": "string",
- "nodes": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
], - "edges": [
- {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "pinned": true,
- "ownerId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) layerId required | string Layer ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
id required | string Unique element ID on layer |
required | object New element position (x, y) |
[- {
- "id": 1234,
- "position": {
- "x": 100,
- "y": 350
}
}
]
{- "data": {
- "id": 0,
- "accId": "string",
- "name": "string",
- "nodes": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
], - "edges": [
- {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "pinned": true,
- "ownerId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) sourceLayerId required | string Source layer ID |
targetLayerId required | string Target layer ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
actorId required | string |
laId | integer Unique element ID on source layer |
object Actor position on target layer |
[- {
- "actorId": "string",
- "laId": 0,
- "position": {
- "x": 0,
- "y": 0
}
}
]
{- "data": {
- "id": 0,
- "accId": "string",
- "name": "string",
- "nodes": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
], - "edges": [
- {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "pinned": true,
- "ownerId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) layerId required | string Layer Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/graph_layers/clean/%7BlayerId%7D
{- "data": "ok"
}
Scopes [control.events:actors.readonly]
This method searches an element on the layer and returns a list of their layer-unique IDs.
control.events:actors.management
) layerId required | string Layer Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
id | string Element ID |
type | string Enum: "node" "edge" |
{- "id": "string",
- "type": "node"
}
[- {
- "id": "string",
- "laId": 0
}
]
Scopes [control.events:actors.readonly]
control.events:actors.management
) layerId required | string Layer ID |
query required | string >= 2 characters Search string |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
withForm | boolean Specify true to add form info to response data |
lastReaction | boolean Specify true to add last actor reaction to response data |
reactionsCount | boolean Specify true to add actor reactions count to response data |
reactionsStats | boolean Specify true to add users' reactions statistics to response data |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/layer_actors_filters/search/%7BlayerId%7D/%7Bquery%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
]
}
Scopes [control.events:actors.readonly]
This method returns all layer actors filtered by form ID.
control.events:actors.management
) layerId required | string Layer ID |
formId required | integer Form ID |
from required | integer Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to required | integer Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
limit | integer [ 0 .. 200 ] Default: 50 The total number of actors to retrieve (used with offset) |
offset | integer <= 10000 Default: 0 The number of rows to skip when fetching list |
orderBy | string Default: "created_at" Enum: "updated_at" "created_at" Actors sorting mode |
orderValue | string Default: "DESC" Enum: "ASC" "DESC" Sorting vector |
withForm | boolean Specify true to add form info to response data |
lastReaction | boolean Specify true to add last actor reaction to response data |
reactionsCount | boolean Specify true to add actor reactions count to response data |
reactionsStats | boolean Specify true to add users' reactions statistics to response data |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
members | string Example: members=12345=view,45678=modify Filter by user access rights, separated by commas |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/layer_actors_filters/%7BlayerId%7D/%7BformId%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
]
}
Scopes [control.events:actors.readonly]
This method retrieves all layers where the actor is added.
control.events:actors.management
) actorId required | string Actor Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/layers_links/actor_global/%7BactorId%7D
[- {
- "graphFolderId": "string",
- "graphName": "string",
- "layerId": "string",
- "layerName": "string"
}
]
Scopes [control.events:actors.management]
control.events:actors.management
) formId required | integer Form ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
ref | string [ 1 .. 255 ] characters A string value for making actors API requests by ref (must be unique within a form) |
title | string |
description | string |
picture | string |
data | object Form fields values |
appId | string Nullable Script actor ID |
object Nullable Script settings, e.g. autorun | |
cardActorId | string Actor ID to display its data card |
object Data for company card |
{- "ref": "string",
- "title": "string",
- "description": "string",
- "picture": "string",
- "data": { },
- "appId": "string",
- "appSettings": {
- "autorun": true,
- "expired": 2147483647,
- "users": [
- 999999
]
}, - "cardActorId": "string",
- "viewData": {
- "actors": {
- "widgetActor": {
- "actorId": "1da30185-ddsa-4b46-332a-535c409031f6"
}
}, - "accounts": [
- {
- "currencyId": "1da30185-ddsa-4b46-332a-535c409031f6",
- "nameId": "1da30185-ddsa-4b46-332a-535c409031f6",
- "currencyName": "USD",
- "accountName": "Cash",
- "displayCurrency": true
}
], - "actorFields": [
- {
- "icon": "string",
- "value": "string",
- "itemId": "string"
}
], - "formsField": [
- {
- "id": "1da30185-ddsa-4b46-332a-535c409031f6",
- "class": "edit",
- "title": "Field title",
- "value": null,
- "formId": 2665560,
- "itemId": "itemId",
- "formColor": null,
- "formTitle": "CompanyCard"
}
]
}
}
{- "data": {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Actor ID |
attachments | boolean Flag to add attachments list to response |
reactionsStats | boolean Flag to add actor reactions statistics by users to response |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/actors/%7BactorId%7D
{- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}, - "reactionsStats": {
- "<userId>": {
- "view": 1,
- "comment": 1,
- "sign": 1
}
}, - "attachments": [
- {
- "id": 0,
- "accId": "string",
- "externalId": 0,
- "fileName": "string",
- "type": "string",
- "userId": 0,
- "actorId": "string",
- "actorTitle": "string",
- "size": 0,
- "title": "string",
- "starred": true,
- "createdAt": 0,
- "updatedAt": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) actorId required | string Actor ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/actors/%7BactorId%7D
{- "data": "ok"
}
Scopes [control.events:actors.management]
control.events:actors.management
) Authorization required | string Authorization header. Bearer [AccessToken] |
id required | string Actor or link ID |
type required | string Enum: "node" "edge" |
[- {
- "id": "string",
- "type": "node"
}
]
{- "data": "ok"
}
Scopes [control.events:actors.management]
control.events:actors.management
) formId required | integer Form ID |
actorId required | string Actor ID |
replaceEmpty | boolean Specify false to update only those actor fields that are explicitly passed in the request body. Otherwise, non-passed fields will be cleared. |
Authorization required | string Authorization header. Bearer [AccessToken] |
ref | string [ 1 .. 255 ] characters A string value for making actors API requests by ref (must be unique within a form) |
title | string |
description | string |
picture | string |
data | object Form fields values |
appId | string Nullable Script actor ID |
object Nullable Script settings, e.g. autorun | |
cardActorId | string Actor ID to display its data card |
object Data for company card |
{- "ref": "string",
- "title": "string",
- "description": "string",
- "picture": "string",
- "data": { },
- "appId": "string",
- "appSettings": {
- "autorun": true,
- "expired": 2147483647,
- "users": [
- 999999
]
}, - "cardActorId": "string",
- "viewData": {
- "actors": {
- "widgetActor": {
- "actorId": "1da30185-ddsa-4b46-332a-535c409031f6"
}
}, - "accounts": [
- {
- "currencyId": "1da30185-ddsa-4b46-332a-535c409031f6",
- "nameId": "1da30185-ddsa-4b46-332a-535c409031f6",
- "currencyName": "USD",
- "accountName": "Cash",
- "displayCurrency": true
}
], - "actorFields": [
- {
- "icon": "string",
- "value": "string",
- "itemId": "string"
}
], - "formsField": [
- {
- "id": "1da30185-ddsa-4b46-332a-535c409031f6",
- "class": "edit",
- "title": "Field title",
- "value": null,
- "formId": 2665560,
- "itemId": "itemId",
- "formColor": null,
- "formTitle": "CompanyCard"
}
]
}
}
{- "data": {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) formId required | integer Form ID |
ref required | string Actor ref |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/actors/ref/%7BformId%7D/%7Bref%7D
{- "data": {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
objType required | string Value: "user" Object type |
objId required | int User ID to get system actor |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/actors/system/%7BaccId%7D/%7BobjType%7D/%7BobjId%7D
{- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) formId required | integer Form ID |
ref required | string Actor ref |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/actors/ref/%7B%7BformId%7D%7D/%7B%7Bref%7D%7D
{- "data": "ok"
}
Scopes [control.events:actors.management]
control.events:actors.management
) formId required | integer Form ID |
ref required | string Actor ref |
Authorization required | string Authorization header. Bearer [AccessToken] |
ref | string [ 1 .. 255 ] characters A string value for making actors API requests by ref (must be unique within a form) |
title | string |
description | string |
picture | string |
data | object Form fields values |
appId | string Nullable Script actor ID |
object Nullable Script settings, e.g. autorun | |
cardActorId | string Actor ID to display its data card |
object Data for company card |
{- "ref": "string",
- "title": "string",
- "description": "string",
- "picture": "string",
- "data": { },
- "appId": "string",
- "appSettings": {
- "autorun": true,
- "expired": 2147483647,
- "users": [
- 999999
]
}, - "cardActorId": "string",
- "viewData": {
- "actors": {
- "widgetActor": {
- "actorId": "1da30185-ddsa-4b46-332a-535c409031f6"
}
}, - "accounts": [
- {
- "currencyId": "1da30185-ddsa-4b46-332a-535c409031f6",
- "nameId": "1da30185-ddsa-4b46-332a-535c409031f6",
- "currencyName": "USD",
- "accountName": "Cash",
- "displayCurrency": true
}
], - "actorFields": [
- {
- "icon": "string",
- "value": "string",
- "itemId": "string"
}
], - "formsField": [
- {
- "id": "1da30185-ddsa-4b46-332a-535c409031f6",
- "class": "edit",
- "title": "Field title",
- "value": null,
- "formId": 2665560,
- "itemId": "itemId",
- "formColor": null,
- "formTitle": "CompanyCard"
}
]
}
}
{- "data": {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) actorId required | string Actor ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
status | string Enum: "verified" "rejected" "pending" null |
{- "status": "verified"
}
{- "data": {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace Id |
query required | string >= 2 characters Search string |
limit | integer Default: 20 The total number of actors to retrieve (used with offset) |
offset | integer Default: 0 The number of rows to skip when fetching list |
isSystem | boolean Specify true to filter only system actors, false - only custom actors. Don't pass this parameter to get both types of actors. |
formId | integer Form ID |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/actors_filters/search/%7BaccId%7D/%7Bquery%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) formId required | integer Form ID |
from required | integer Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to required | integer Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
limit | integer Default: 50 The total number of actors to retrieve (used with offset) |
offset | integer Default: 0 The number of rows to skip when fetching list |
scroll | boolean Specify true to retrieve large sets of results. The response will contain a scroll ID in the response body. You can then use the scroll ID to retrieve the next batch of results for the request. |
scrollId | string Scroll ID from the previous response to retrieve the next batch of results. Scroll ID expires in 1 minute. |
orderBy | string Default: "created_at" Enum: "created_at" "updated_at" Actors sorting mode |
orderByKey | string It`s the key by which the sorting will be performed |
accountNameId | string Filter by account name |
currencyId | string Filter by currency |
incomeType | string Enum: "debit" "credit" Use with accountNameId and currencyId, if it is null, filter will be applied to total balance |
orderValue | string Default: "DESC" Enum: "ASC" "DESC" Sorting vector |
isSystem | boolean Specify true to filter only system actors, false - only custom actors. Don't pass this parameter to get both types of actors. |
systemObjType | string Enum: "user" "tag" "location" Type of system object |
systemObjStatus | string Enum: "active" "removed" Status |
q | string Example: q=industry%3DRetail%26country%3DUSA&search=string, q=conditions.data.state=active&limit=2&offset=2, q=conditions.data.statusCond.ref=statusone URL-encoded query string consists of data values (template fields). Also use "search" to find actor by title. Multiple key-value pairs are separated by '&' (AND) or '||' (OR). To search by nested fields, use a dot, see the second example. To search by actor`s ref see third example. For fields of type calendar, you can use the symbols '>', '<', '>=', '<='. Example: dateOfBirth>{'startDate':71182800} Values can be empty string or array to check for empty/non-empty fields. Example: comment!=, data={}, users!=[] |
filter | string Example: filter=id,title,status,data.item_16357762770841362 Comma-separated list of fields we want to receive for every actor in response data.
To add actor's form fields ( |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/actors_filters/%7BformId%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "title": "string",
- "description": "string",
- "formId": 0,
- "formTitle": "string",
- "status": "verified",
- "starred": false,
- "readonly": false,
- "color": "string",
- "userId": 0,
- "picture": "string",
- "data": { },
- "isSystem": true,
- "systemObjId": 0,
- "systemObjType": "user",
- "systemObjStatus": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true,
- "sign": false,
- "execute": false
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
], - "user": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
source | string Source actor ID |
target | string Target actor ID |
edgeTypeId | integer Link type ID from the list of available link types. |
name | string Link name |
{- "source": "string",
- "target": "string",
- "edgeTypeId": 0,
- "name": "string"
}
{- "data": {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) accId required | string Workspace Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
source | string Source actor ID |
target | string Target actor ID |
edgeTypeId | integer Link type ID from the list of available link types. |
name | string Link name |
[- {
- "source": "string",
- "target": "string",
- "edgeTypeId": 0,
- "name": "string"
}
]
{- "data": {
- "id": "string",
- "name": "string",
- "source": "string",
- "target": "string",
- "edgeTypeId": 1,
- "edgeType": "hierarchy",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}
Scopes [control.events:actors.management]
control.events:actors.management
) edgeId required | string Link ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
name | string Link name |
{- "name": "string"
}
{- "data": "ok"
}
Scopes [control.events:actors.management]
control.events:actors.management
) edgeId required | string Link ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/actors/link/%7BedgeId%7D
{- "data": "ok"
}
Scopes [control.events:actors.management]
control.events:actors.management
) Authorization required | string Authorization header. Bearer [AccessToken] |
source | string Actor ID of link source |
target | string Actor ID of link target |
edgeTypeId | number Link type ID from the list of link types |
[- {
- "source": "string",
- "target": "string",
- "edgeTypeId": 0
}
]
{- "data": "ok"
}
Scopes [control.events:actors.readonly]
Link type is an attribute of every link between actors.
E.g., on the Economics layer - a link type with the name calculatedTree
is used, on other layers - a hierarchical link (with the name hierarchy
).
There is a set of specific link types used for links between actors in the accounts tree.
For every existing actor's account (unique pair of name and currency), there is a dedicated link type.
Such link type name is a concatenation of two ID fields: <nameId>_<currencyId>
(Learn more about account names, currencies)
control.events:actors.readonly
) accId required | string Workspace Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/edge_types/%7BaccId%7D
{- "data": [
- {
- "id": 0,
- "accId": "string",
- "name": "string",
- "userId": 0,
- "createdAt": 0,
- "isTree": true
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Actor ID |
accountType | string Enum: "fact" "plan" Type of account |
incomeType required | string Enum: "debit" "credit" |
from | integer Example: from=1662471080000 Start timestamp point for result, in milliseconds |
to | integer Example: to=1662816684000 End timestamp point for result, in milliseconds |
amountFrom | integer Example: amountFrom=0 Minimum amount to filter accounts for |
amountTo | integer Example: amountTo=9999 Maximum amount to filter accounts for |
tag | string Example: tag=f5ec6878-f4d1-4d80-89a3-0f0e56f562f0 Tags (system form) actor ID to filter actor accounts |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/%7BactorId%7D
{- "data": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) actorId required | string Actor ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
accountType | string Default: "fact" Enum: "fact" "plan" |
currencyId required | integer Currency ID from the list of available currencies |
nameId required | string Name ID from the list of available account names |
treeCalculation | boolean Default: true Flag to calculate account balance in accounts tree |
search | boolean Default: true Flag if account transactions are searchable |
minLimit | integer Minimum allowed account balance after transaction |
maxLimit | integer Maximum allowed account balance after transaction |
{- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
{- "data": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Actor ID |
currencyId required | integer Currency ID from the list of available currencies |
nameId required | string Name ID from the list of available account names |
accountType | string Enum: "fact" "plan" Type of account |
incomeType required | string Enum: "debit" "credit" |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/%7BactorId%7D/%7BcurrencyId%7D/%7BnameId%7D
{- "data": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Parent actor ID |
accountType | string Enum: "fact" "plan" Type of account |
from | integer Example: from=1662471080000 Start timestamp point for result, in milliseconds |
to | integer Example: to=1662816684000 End timestamp point for result, in milliseconds |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/children/%7BactorId%7D
{- "data": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) actorId required | string Actor ID |
currencyId required | integer Currency ID from the list of available currencies |
nameId required | string Name ID from the list of available account names |
accountType required | string Enum: "fact" "plan" Type of account |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/accounts/%7BactorId%7D/%7BcurrencyId%7D/%7BnameId%7D/%7BaccountType%7D
{- "data": "ok"
}
Scopes [control.events:actors.management]
control.events:actors.readonly
) actorId required | string Actor ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
nameId required | string Name ID from the list of available account names |
currencyId required | integer Currency ID from the list of available currencies |
type required | string Enum: "fact" "plan" Account type |
status required | string Enum: "active" "blocked" |
{- "nameId": "string",
- "currencyId": 0,
- "type": "fact",
- "status": "active"
}
{- "data": [
- "string",
- "string"
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) formId required | integer Form ID |
ref required | string Actor ref |
nameId required | string Name ID from the list of available account names |
currencyId required | integer Currency ID from the list of available currencies |
accountType | string Enum: "fact" "plan" Type of account |
incomeType required | string Enum: "debit" "credit" |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/single/ref/%7BformId%7D/%7Bref%7D
{- "data": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) formId required | integer Form ID |
ref required | string Actor ref |
accountType | string Enum: "fact" "plan" Type of account |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/ref/%7BformId%7D/%7Bref%7D
{- "data": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) formId required | integer Form ID |
ref required | string Actor ref |
Authorization required | string Authorization header. Bearer [AccessToken] |
accountType | string Enum: "fact" "plan" Account type |
nameId | string Name ID from the list of available account names |
currencyId | integer Currency ID from the list of available currencies |
{- "accountType": "fact",
- "nameId": "string",
- "currencyId": 0
}
{- "data": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
Gives opportunity to create account pair with name and currency.
control.events:actors.management
) accId required | string Workspace Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
accountName | string Name of the account to create |
currencyName | string Name of the currency to create |
{- "accountName": "string",
- "currencyName": "string"
}
{- "data": {
- "accountName": {
- "id": "string",
- "name": "string",
- "abbreviation": "string",
- "isSystem": true,
- "accId": "string",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0
}, - "currency": {
- "id": 0,
- "name": "string",
- "accId": "string",
- "symbol": "string",
- "type": "string",
- "isSystem": true,
- "userId": 0,
- "createdAt": 0,
- "precision": 0
}, - "access": [
- {
- "accId": "string",
- "userId": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}, - "saId": 0,
- "userType": "string",
- "name": "string"
}
]
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) formId required | integer Form ID |
ref required | string Actor ref |
accountType | string Enum: "fact" "plan" Type of account |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/children/ref/%7BformId%7D/%7Bref%7D
{- "data": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) formId required | integer Form ID |
ref required | string Actor ref |
currencyId required | integer Currency ID from the list of available currencies |
nameId required | string Name ID from the list of available account names |
accountType required | string Enum: "fact" "plan" Type of account |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request DELETE \ --url https://api.simulator.company/v/1.0/accounts/ref/%7BformId%7D/%7Bref%7D/%7BcurrencyId%7D/%7BnameId%7D/%7BaccountType%7D
{- "data": "ok"
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accountId required | string Account ID |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/single/%7BaccountId%7D
{- "data": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) from | integer Example: from=1662471080000 Start timestamp point for result, in milliseconds |
to | integer Example: to=1662816684000 End timestamp point for result, in milliseconds |
accountType | string Enum: "fact" "plan" Type of account |
incomeType required | string Enum: "debit" "credit" |
tag | string Example: tag=f5ec6878-f4d1-4d80-89a3-0f0e56f562f0 Tags (system form) actor ID to filter actor accounts |
amountFrom | integer Example: amountFrom=0 Minimum amount to filter accounts for |
amountTo | integer Example: amountTo=9999 Maximum amount to filter accounts for |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
actors | Array of strings array of actor IDs. [Max 20 actors] |
{- "actors": [
- "string"
]
}
[- {
- "actorId": "string",
- "accounts": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
]
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) currencyId required | integer Currency ID from the list of available currencies |
nameId required | string Name ID from the list of available account names |
accountType | string Enum: "fact" "plan" Type of account |
incomeType | string Enum: "debit" "credit" |
filter | string Example: filter=id,amount,incomeType ... Comma-separated list of fields we want to receive for every account in response data. Don't pass this parameter to get full accounts' info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
Array of objects array of actor Refs and formIds. [Max 200 actors] |
{- "actorsRefs": [
- {
- "ref": "string",
- "formId": 0
}
]
}
[- {
- "actorId": "string",
- "ref": "string",
- "accounts": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
]
Scopes [control.events:actors.management]
control.events:actors.management
) accountId required | string Account ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
amount required | integer Amount to set to account |
{- "amount": 2000
}
{- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 1000,
- "commission": 0,
- "comment": "string",
- "originalDate": 0,
- "actorId": "string",
- "accountAmount": 2000,
- "accountHoldAmount": 0,
- "accountMinLimit": 0,
- "accountMaxLimit": 0
}
'Scopes [control.events:actors.management]'
Supported functions syntax
sum(a, b, c, ...)
- returns the sum of all the arguments passed
mean(a, b, c, ...)
- returns a numeric value that is the arithmetic mean (average) of its arguments
Use account ID as an argument to calculate it's amount with formula.
control.events:actors.readonly
) accountId required | string Account ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
formula | string Nullable Formula for calculating account amount |
{- "formula": "sum({accountId_1},{accountId_2})/100"
}
{- "data": {
- "amount": 0,
- "error": true
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accountId required | string Account ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/accounts/formula_info/%7BaccountId%7D
{- "data": {
- "{accountId}1": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0,
- "accountName": "string",
- "actor": {
- "id": "string",
- "title": "string",
- "formColor": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}, - "{accountId}2": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0,
- "accountName": "string",
- "actor": {
- "id": "string",
- "title": "string",
- "formColor": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) actorId required | string Actor ID |
currencyId required | integer Currency ID from the list of available currencies |
nameId required | string Name ID from the list of available account names |
accountType | string Enum: "fact" "plan" Type of account |
incomeType required | string Enum: "debit" "credit" |
onlyRoot | boolean Default: true Specify false to get child transactions |
from required | integer Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to required | integer Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
limit | integer Default: 50 The total number of rows to retrieve (used with offset) |
offset | integer Default: 0 The number of transactions to skip when fetching transaction history |
filter | string Example: filter=id,amount,incomeType,data.param ... Comma-separated list of fields we want to receive for every transaction in response data. Pass data.[fieldName] to get specific field from transaction data. Don't pass this parameter to get full transaction`s info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/transactions/%7BactorId%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0,
- "incomeType": "debit",
- "actorId": "string",
- "title": "string",
- "children": 0
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) formId required | integer Form ID |
actorRef required | string Actor ref |
currencyId required | integer Currency ID from the list of available currencies |
nameId required | string Name ID from the list of available account names |
accountType | string Enum: "fact" "plan" Type of account |
incomeType required | string Enum: "debit" "credit" |
onlyRoot | boolean Default: true Specify false to get child transactions |
from required | integer Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to required | integer Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
limit | integer Default: 50 The total number of rows to retrieve (used with offset) |
offset | integer Default: 0 The number of transactions to skip when fetching transaction history |
filter | string Example: filter=id,amount,incomeType,data.param ... Comma-separated list of fields we want to receive for every transaction in response data. Pass data.[fieldName] to get specific field from transaction data. Don't pass this parameter to get full transaction`s info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/transactions/actor_ref/%7BformId%7D/%7BactorRef%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0,
- "incomeType": "debit",
- "actorId": "string",
- "title": "string",
- "children": 0
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accountId required | string Account ID |
from required | integer Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to required | integer Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
limit | integer Default: 50 The total number of rows to retrieve (used with offset) |
offset | integer Default: 0 The number of transactions to skip when fetching transaction history |
filter | string Example: filter=id,amount,incomeType,data.param ... Comma-separated list of fields we want to receive for every transaction in response data. Pass data.[fieldName] to get specific field from transaction data. Don't pass this parameter to get full transaction`s info. |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/transactions/list/%7BaccountId%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0,
- "incomeType": "debit",
- "actorId": "string",
- "title": "string",
- "children": 0
}
]
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accountId required | string Account ID |
ref required | string <= 255 characters Transaction ref |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/transactions/ref/%7BaccountId%7D/%7Bref%7D
{- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) transactionId required | string Transaction ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/transactions/children/%7BtransactionId%7D
{- "data": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) accountId required | string Actor's account ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
amount required | integer Transactions amount |
comment | string A comment for the transaction |
ref | string <= 255 characters A string value for making transactions API requests by ref (must be unique within an account) |
originalDate | integer <unixtime> The original date of the transaction |
addValues | Array of strings Array of actor Ids that will be added to the balance |
delValues | Array of strings Array of actor Ids that will be deleted from the balance |
{- "amount": 0,
- "comment": "string",
- "ref": "string",
- "originalDate": 0,
- "addValues": [
- "string"
], - "delValues": [
- "string"
]
}
{- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
Scopes [control.events:actors.management]
This API method ensures that every transaction is either explicitly committed or rolled back.
control.events:actors.management
) accId required | string Workspace Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
List of transactions
accountId required | string Actor's account ID |
amount required | integer Transactions amount |
comment | string A comment for the transaction |
ref | string <= 255 characters A string value for making transactions API requests by ref (must be unique within an account) |
originalDate | integer <unixtime> The original date of the transaction |
addValues | Array of strings Array of actor Ids that will be added to the balance |
delValues | Array of strings Array of actor Ids that will be deleted from the balance |
[- {
- "accountId": "string",
- "amount": 0,
- "comment": "string",
- "ref": "string",
- "originalDate": 0,
- "addValues": [
- "string"
], - "delValues": [
- "string"
]
}
]
{- "data": "1"
}
Scopes [control.events:actors.management]
This API supports two-step transactions, so you can first authorize, then wait to complete or cancel it later. Authorizing a transaction places a hold on the account for the specified amount.
Waiting for completion or cancellation can be limited with the expiration
parameter for an authorized transaction.
When the authorized transaction expires, the reversed transaction will be created automatically.
Save transaction ID, you will need it for a second step.
control.events:actors.management
) accountId required | string Actor's account ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
amount required | number Transaction amount |
expiration | integer UNIX timestamp when the authorized transaction expires |
comment | string A comment for the transaction |
createdAt | integer UNIX timestamp of the transaction (by default - current timestamp) |
data | object Some extra data of transaction |
ref | string <= 255 characters A string value for making transactions API requests by ref (must be unique within an account) |
{- "amount": 0,
- "expiration": 0,
- "comment": "string",
- "createdAt": 0,
- "data": { },
- "ref": "string"
}
{- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
Scopes [control.events:actors.management]
You can complete transaction that was previously authorized (use its ID). This is the second half of the two-step transaction flow.
You cannot complete an authorized transaction that has been already canceled or expired.
control.events:actors.management
) accountId required | string Actor's account ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
parentId required | number The ID of authorized transaction to complete |
amount required | number Final amount to complete transaction |
comment | string A comment for the transaction |
createdAt | integer UNIX timestamp of the transaction (by default - current timestamp) |
data | object Some extra data of transaction |
ref | string <= 255 characters A string value for making transactions API requests by ref (must be unique within an account) |
{- "parentId": 0,
- "amount": 0,
- "comment": "string",
- "createdAt": 0,
- "data": { },
- "ref": "string"
}
{- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "completed",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
Scopes [control.events:actors.management]
You can cancel transaction that was previously authorized (use its ID).
You cannot cancel an authorized transaction that has been already completed or expired.
control.events:actors.management
) accountId required | string Actor's account ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
parentId required | number The ID of authorized transaction to cancel |
comment | string A comment for the transaction |
createdAt | integer UNIX timestamp of the transaction (by default - current timestamp) |
data | object Some extra data of transaction |
ref | string <= 255 characters A string value for making transactions API requests by ref (must be unique within an account) |
{- "parentId": 0,
- "comment": "string",
- "createdAt": 0,
- "data": { },
- "ref": "string"
}
{- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "canceled",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) transferId required | string Transfer ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/transfers/%7BtransferId%7D
{- "id": "string",
- "ref": "string",
- "accId": "string",
- "type": "string",
- "userId": 0,
- "comment": "string",
- "declineReason": "string",
- "createdAt": 0,
- "transactions": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
], - "details": {
- "from": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}, - "to": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
name | string Link type name |
from | object Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to | object Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
limit | number >= 1 The total number of transfers names to retrieve (used with offset) |
offset | number >= 0 The number of rows to skip when fetching list |
accountType | string Account type |
Array of objects |
{- "name": "string",
- "from": { },
- "to": { },
- "limit": 1,
- "offset": 0,
- "accountType": "string",
- "accounts": [
- {
- "currencyId": "string",
- "nameId": "string"
}
]
}
[- {
- "id": "string",
- "ref": "string",
- "accId": "string",
- "type": "string",
- "userId": 0,
- "comment": "string",
- "declineReason": "string",
- "createdAt": 0,
- "transactions": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
], - "details": {
- "from": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}, - "to": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
}
]
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
Array of objects From | |
Array of objects To | |
type | string Default: "default" Enum: "default" "finance" For the finance type "from" should be a debit and all accounts "to" should be credit. Additionally, the amount should be positive for all accounts. |
comment | string Comment |
{- "from": [
- {
- "accountId": "string",
- "amount": 0
}
], - "to": [
- {
- "accountId": "string",
- "amount": 0
}
], - "type": "default",
- "comment": "string"
}
[- {
- "id": "string",
- "ref": "string",
- "accId": "string",
- "type": "string",
- "userId": 0,
- "comment": "string",
- "declineReason": "string",
- "createdAt": 0,
- "transactions": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
], - "details": {
- "from": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}, - "to": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
}
]
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
Array of objects From | |
Array of objects To | |
type | string Default: "default" Enum: "default" "finance" For the finance type "from" should be a debit and all accounts "to" should be credit. Additionally, the amount should be positive for all accounts. |
comment | string Comment |
transferId | string Transfer ID |
ref | string Reference |
data | object Data for actor creation |
{- "from": [
- {
- "accountId": "string",
- "amount": 0
}
], - "to": [
- {
- "accountId": "string",
- "amount": 0
}
], - "type": "default",
- "comment": "string",
- "transferId": "string",
- "ref": "string",
- "data": { }
}
[- {
- "id": "string",
- "ref": "string",
- "accId": "string",
- "type": "string",
- "userId": 0,
- "comment": "string",
- "declineReason": "string",
- "createdAt": 0,
- "transactions": [
- {
- "id": "string",
- "ref": "string",
- "accountId": "string",
- "parentId": "string",
- "userId": 0,
- "type": "authorized",
- "isDone": true,
- "amount": 0,
- "commission": 0,
- "comment": "string",
- "originalDate": 0
}
], - "details": {
- "from": {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}, - "to": [
- {
- "id": "string",
- "actorId": "string",
- "userId": 0,
- "incomeType": "debit",
- "amount": 0,
- "availableAmount": 0,
- "formula": "string",
- "systemType": "manual",
- "status": "active",
- "createdAt": 0,
- "updatedAt": 0,
- "accountType": "fact",
- "currencyId": 0,
- "nameId": "string",
- "treeCalculation": true,
- "search": true,
- "minLimit": 0,
- "maxLimit": 0
}
]
}
}
]
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace Id |
withStats | boolean Default: false We strongly recommend including withStats=false in your requests, otherwise the performance of the method will be significantly reduced |
limit | integer Default: 20 The total number of account names to retrieve (used with offset) |
offset | integer Default: 0 The number of rows to skip when fetching list |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/account_names/%7BaccId%7D
{- "data": [
- {
- "id": "string",
- "name": "string",
- "abbreviation": "string",
- "accId": "string",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) accId required | string Workspace Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
name | string |
abbreviation | string <= 255 characters |
{- "name": "string",
- "abbreviation": "string"
}
{- "data": {
- "id": "string",
- "name": "string",
- "abbreviation": "string",
- "accId": "string",
- "userId": 0,
- "createdAt": 0,
- "updatedAt": 0
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace Id |
withStats | boolean Default: false We strongly recommend including withStats=false in your requests, otherwise the performance of the method will be significantly reduced |
limit | integer Default: 20 The total number of currencies to retrieve (used with offset) |
offset | integer Default: 0 The number of rows to skip when fetching list |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/currencies/%7BaccId%7D
{- "data": [
- {
- "id": 0,
- "accId": "string",
- "name": "string",
- "userId": 0,
- "createdAt": 0
}
]
}
Scopes [control.events:actors.management]
control.events:actors.management
) accId required | string Workspace Id |
Authorization required | string Authorization header. Bearer [AccessToken] |
name | string Currency name |
{- "name": "string"
}
{- "data": {
- "id": 0,
- "accId": "string",
- "name": "string",
- "userId": 0,
- "createdAt": 0
}
}
The scope depends on what object do you want to manage access to.
Object type | Scope |
---|---|
formTemplate | [control.events:forms.readonly] |
actor | [control.events:actors.readonly] |
control.events:forms.readonly
control.events:actors.readonly
) objType required | string Enum: "formTemplate" "actor" "templateActors" "account" Object type |
objId required | string Object ID to get access info. For account use compound ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
curl --request GET \ --url https://api.simulator.company/v/1.0/access_rules/%7BobjType%7D/%7BobjId%7D
{- "data": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
The scope depends on what object do you want to manage access to.
Object type | Scope |
---|---|
formTemplate | [control.events:forms.management] |
actor | [control.events:actors.management] |
control.events:actors.management
control.events:forms.management
) objType required | string Enum: "formTemplate" "actor" "templateActors" "account" Object type |
objId required | string Object ID to share. For account use compound ID |
filterIncorrect | boolean Default: false If you pass true, the request will be successfully executed even if the user id in the user array contains a user id that is not in the workspace. |
Authorization required | string Authorization header. Bearer [AccessToken] |
action | string Enum: "create" "update" "delete" |
object |
[- {
- "action": "create",
- "data": {
- "userId": 0,
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
}
]
{- "data": [
- {
- "accId": "string",
- "userId": 0,
- "userType": "string",
- "name": "string",
- "privs": {
- "view": true,
- "modify": true,
- "remove": true
}
}
]
}
Scopes [control.events:users.management]
control.events:users.management
) actorId required | string Chat actor ID |
userId required | string Anonymous user ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
nick | string |
{- "nick": "string"
}
{- "data": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
Scopes [control.events:workspaces.readonly]
control.events:workspaces.readonly
) accId required | string Workspace Id |
name required | string Enum: "reactions.placeholder" "events.setActive" "events.typing" "scripts.toggle" Realtime packet name |
Authorization required | string Authorization header. Bearer [AccessToken] |
Array of objects [ 1 .. 100 ] items | |
object |
{- "receivers": [
- {
- "userId": 0
}
], - "user": {
- "id": 0,
- "nick": "string"
}
}
{- "data": {
- "id": 0,
- "nick": "string",
- "lang": "string",
- "type": "user",
- "role": "owner",
- "logins": [
- {
- "type": "string",
- "login": "string"
}
], - "createdAt": 0,
- "updatedAt": 0
}
}
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
type | string Enum: "counter" "uniqCounter" Type |
formId | number Form ID |
actorRef | string Actor's ref |
accountName | string Account name |
currency | string Currency |
incomeType | string Enum: "debit" "credit" |
amount | number Amount |
trsRef | string Transfer ref |
title | string Actor title |
data | object Data for actor creation |
[- {
- "type": "counter",
- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "debit",
- "amount": 0,
- "trsRef": "string",
- "title": "string",
- "data": { }
}
]
[- {
- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "string",
- "type": "string",
- "title": "string",
- "data": { }
}
]
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
from required | integer Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to required | integer Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
Authorization required | string Authorization header. Bearer [AccessToken] |
type | string Enum: "counter" "uniqCounter" Type |
formId | number Form ID |
actorRef | string Actor's ref |
accountName | string Account name |
currency | string Currency |
incomeType | string Enum: "debit" "credit" |
{- "type": "counter",
- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "debit"
}
[- {
- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "string",
- "type": "string",
- "title": "string",
- "amount": 0,
- "holdAmount": 0,
- "data": { }
}
]
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
Authorization required | string Authorization header. Bearer [AccessToken] |
formId | number Form ID |
actorRef | string Actor's ref |
accountName | string Account name |
currency | string Currency |
incomeType | string Enum: "debit" "credit" |
trsRef | string Transfer ref |
{- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "debit",
- "trsRef": "string"
}
[- {
- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "string",
- "type": "string",
- "title": "string",
- "createdAt": 0,
- "data": { }
}
]
Scopes [control.events:actors.readonly]
control.events:actors.readonly
) accId required | string Workspace ID |
from required | integer Unixtime from which to receive items. If not specified, unixtime will be set to start of the month. |
to required | integer Unixtime to which to receive items. If not specified, unixtime will be set to the end of the month. |
Authorization required | string Authorization header. Bearer [AccessToken] |
formId | number Form ID |
actorRef | string Actor's ref |
accountName | string Account name |
currency | string Currency |
incomeType | string Enum: "debit" "credit" |
{- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "debit"
}
[- {
- "formId": 0,
- "actorRef": "string",
- "accountName": "string",
- "currency": "string",
- "incomeType": "string",
- "type": "string",
- "title": "string",
- "data": { }
}
]