AlphaAlpha Docs
API Reference

Queue Job

API calls concerning queue jobs

Delete by list of ids in current tenant

DELETE
/queue-jobs

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-jobs" \  -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"
}

Clean up old completed jobs

DELETE
/queue-jobs/cleanup

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

olderThanDays?integer
Default7
Formatint64

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/queue-jobs/cleanup"
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"
}

Get all coverage jobs

GET
/queue-jobs/coverage

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/queue-jobs/coverage"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "completed": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentAgentId": "string",
    "description": "string",
    "id": "string",
    "message": "string",
    "name": "string",
    "priority": "LOW",
    "progress": 0.1,
    "retries": 0,
    "runAfter": "2019-08-24T14:15:22Z",
    "started": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "workerName": "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 list of ids in current tenant

GET
/queue-jobs/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-jobs/find?ids=string"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "completed": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentAgentId": "string",
    "description": "string",
    "id": "string",
    "message": "string",
    "name": "string",
    "priority": "LOW",
    "progress": 0.1,
    "retries": 0,
    "runAfter": "2019-08-24T14:15:22Z",
    "started": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "workerName": "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-jobs/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-jobs/find-all"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "completed": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentAgentId": "string",
    "description": "string",
    "id": "string",
    "message": "string",
    "name": "string",
    "priority": "LOW",
    "progress": 0.1,
    "retries": 0,
    "runAfter": "2019-08-24T14:15:22Z",
    "started": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "workerName": "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-jobs/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-jobs/find/string"
{
  "assets": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "completed": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currentAgentId": "string",
  "description": "string",
  "id": "string",
  "message": "string",
  "name": "string",
  "priority": "LOW",
  "progress": 0.1,
  "retries": 0,
  "runAfter": "2019-08-24T14:15:22Z",
  "started": "2019-08-24T14:15:22Z",
  "status": "PENDING",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "workerName": "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-jobs/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-jobs/page"
{
  "content": [
    {
      "assets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "completed": "2019-08-24T14:15:22Z",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currentAgentId": "string",
      "description": "string",
      "id": "string",
      "message": "string",
      "name": "string",
      "priority": "LOW",
      "progress": 0.1,
      "retries": 0,
      "runAfter": "2019-08-24T14:15:22Z",
      "started": "2019-08-24T14:15:22Z",
      "status": "PENDING",
      "tenantId": "string",
      "typeId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "workerName": "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"
}

Get coverage jobs for a type

GET
/queue-jobs/type/{typeId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

typeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/queue-jobs/type/string"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "completed": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentAgentId": "string",
    "description": "string",
    "id": "string",
    "message": "string",
    "name": "string",
    "priority": "LOW",
    "progress": 0.1,
    "retries": 0,
    "runAfter": "2019-08-24T14:15:22Z",
    "started": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "workerName": "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 active coverage jobs for a type

GET
/queue-jobs/type/{typeId}/active

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

typeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/queue-jobs/type/string/active"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "completed": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentAgentId": "string",
    "description": "string",
    "id": "string",
    "message": "string",
    "name": "string",
    "priority": "LOW",
    "progress": 0.1,
    "retries": 0,
    "runAfter": "2019-08-24T14:15:22Z",
    "started": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "workerName": "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"
}

Clear all jobs for a type

DELETE
/queue-jobs/type/{typeId}/clear

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

typeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/queue-jobs/type/string/clear"
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"
}

Delete by id in current tenant

DELETE
/queue-jobs/{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-jobs/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"
}

Cancel a job

POST
/queue-jobs/{jobId}/cancel

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

jobId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/queue-jobs/string/cancel"
{
  "assets": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "completed": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currentAgentId": "string",
  "description": "string",
  "id": "string",
  "message": "string",
  "name": "string",
  "priority": "LOW",
  "progress": 0.1,
  "retries": 0,
  "runAfter": "2019-08-24T14:15:22Z",
  "started": "2019-08-24T14:15:22Z",
  "status": "PENDING",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "workerName": "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"
}

Queue Agent

Previous Page

Recipient Lists

Next Page