AlphaAlpha Docs
API Reference

Queue Agent

API calls concerning queue agents

Delete by list of ids in current tenant

DELETE
/queue-agents

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/queue-agents" \  -H "Content-Type: application/json" \  -d '[    "string"  ]'
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/queue-agents/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/queue-agents/find?ids=string"
[
  {
    "cpuName": "string",
    "cpuPercentage": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentJob": "string",
    "id": "string",
    "installedRevitVersions": [
      "string"
    ],
    "ipAddress": "string",
    "isActive": true,
    "lastSeen": "2019-08-24T14:15:22Z",
    "message": "string",
    "mode": "MANUAL",
    "name": "string",
    "os": "string",
    "ramPercentage": 0.1,
    "status": "IDLE",
    "tenantId": "string",
    "tenantLimitation": [
      "string"
    ],
    "totalRam": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "version": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/queue-agents/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/queue-agents/find-all"
[
  {
    "cpuName": "string",
    "cpuPercentage": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentJob": "string",
    "id": "string",
    "installedRevitVersions": [
      "string"
    ],
    "ipAddress": "string",
    "isActive": true,
    "lastSeen": "2019-08-24T14:15:22Z",
    "message": "string",
    "mode": "MANUAL",
    "name": "string",
    "os": "string",
    "ramPercentage": 0.1,
    "status": "IDLE",
    "tenantId": "string",
    "tenantLimitation": [
      "string"
    ],
    "totalRam": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "version": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/queue-agents/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/queue-agents/find/string"
{
  "cpuName": "string",
  "cpuPercentage": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currentJob": "string",
  "id": "string",
  "installedRevitVersions": [
    "string"
  ],
  "ipAddress": "string",
  "isActive": true,
  "lastSeen": "2019-08-24T14:15:22Z",
  "message": "string",
  "mode": "MANUAL",
  "name": "string",
  "os": "string",
  "ramPercentage": 0.1,
  "status": "IDLE",
  "tenantId": "string",
  "tenantLimitation": [
    "string"
  ],
  "totalRam": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/queue-agents/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/queue-agents/page"
{
  "content": [
    {
      "cpuName": "string",
      "cpuPercentage": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currentJob": "string",
      "id": "string",
      "installedRevitVersions": [
        "string"
      ],
      "ipAddress": "string",
      "isActive": true,
      "lastSeen": "2019-08-24T14:15:22Z",
      "message": "string",
      "mode": "MANUAL",
      "name": "string",
      "os": "string",
      "ramPercentage": 0.1,
      "status": "IDLE",
      "tenantId": "string",
      "tenantLimitation": [
        "string"
      ],
      "totalRam": 0,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "version": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Register agent

POST
/queue-agents/register

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/queue-agents/register" \  -H "Content-Type: application/json" \  -d '{    "installedRevitVersions": [      "string"    ],    "name": "string"  }'
{
  "cpuName": "string",
  "cpuPercentage": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currentJob": "string",
  "id": "string",
  "installedRevitVersions": [
    "string"
  ],
  "ipAddress": "string",
  "isActive": true,
  "lastSeen": "2019-08-24T14:15:22Z",
  "message": "string",
  "mode": "MANUAL",
  "name": "string",
  "os": "string",
  "ramPercentage": 0.1,
  "status": "IDLE",
  "tenantId": "string",
  "tenantLimitation": [
    "string"
  ],
  "totalRam": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/queue-agents/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/queue-agents/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Push Tokens

Previous Page

Queue Job

Next Page