AlphaAlpha Docs
API Reference

Support Tickets

Support Ticket API

Create a ticket

POST
/support/tickets

Authorization

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

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/support/tickets" \  -F data="{\n  \"description\": \"string\",\n  \"subject\": \"string\"\n}"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Download Csv_ Ticket

GET
/support/tickets/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/support/tickets/csv-export"
"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 a list of entities by their IDs

DELETE
/support/tickets/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/support/tickets/delete-list?ids=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"
}

Dynamic Search_ Ticket

GET
/support/tickets/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/support/tickets/dynamic-search"
{
  "content": [
    {
      "accessTokenHash": "string",
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "category": "string",
      "clientId": "string",
      "closedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "escalatedAt": "2019-08-24T14:15:22Z",
      "escalatedToEmployeeId": "string",
      "escalatedToTaskId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstResponseAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "messages": [
        {
          "attachments": [
            {
              "blobId": "string",
              "created": "2019-08-24T14:15:22Z",
              "extension": "string",
              "fileSize": 0,
              "name": "string",
              "type": "IMAGE"
            }
          ],
          "content": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "id": "string",
          "internal": true,
          "senderId": "string",
          "senderName": "string",
          "senderType": "CLIENT"
        }
      ],
      "priority": "LOW",
      "projectId": "string",
      "resolvedAt": "2019-08-24T14:15:22Z",
      "serviceOwnerId": "string",
      "solution": "string",
      "solutionRecordedAt": "2019-08-24T14:15:22Z",
      "solverIds": [
        "string"
      ],
      "status": "PENDING_VERIFICATION",
      "subject": "string",
      "tenantId": "string",
      "ticketNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "verificationTokenHash": "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"
}

Dynamic Search Post_ Ticket

POST
/support/tickets/dynamic-search

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/support/tickets/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "accessTokenHash": "string",
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "category": "string",
      "clientId": "string",
      "closedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "escalatedAt": "2019-08-24T14:15:22Z",
      "escalatedToEmployeeId": "string",
      "escalatedToTaskId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstResponseAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "messages": [
        {
          "attachments": [
            {
              "blobId": "string",
              "created": "2019-08-24T14:15:22Z",
              "extension": "string",
              "fileSize": 0,
              "name": "string",
              "type": "IMAGE"
            }
          ],
          "content": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "id": "string",
          "internal": true,
          "senderId": "string",
          "senderName": "string",
          "senderType": "CLIENT"
        }
      ],
      "priority": "LOW",
      "projectId": "string",
      "resolvedAt": "2019-08-24T14:15:22Z",
      "serviceOwnerId": "string",
      "solution": "string",
      "solutionRecordedAt": "2019-08-24T14:15:22Z",
      "solverIds": [
        "string"
      ],
      "status": "PENDING_VERIFICATION",
      "subject": "string",
      "tenantId": "string",
      "ticketNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "verificationTokenHash": "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"
}

Find by list of ids in current tenant

GET
/support/tickets/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/support/tickets/find?ids=string"
[
  {
    "accessTokenHash": "string",
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "category": "string",
    "clientId": "string",
    "closedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "escalatedAt": "2019-08-24T14:15:22Z",
    "escalatedToEmployeeId": "string",
    "escalatedToTaskId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstResponseAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "messages": [
      {
        "attachments": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ],
        "content": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "internal": true,
        "senderId": "string",
        "senderName": "string",
        "senderType": "CLIENT"
      }
    ],
    "priority": "LOW",
    "projectId": "string",
    "resolvedAt": "2019-08-24T14:15:22Z",
    "serviceOwnerId": "string",
    "solution": "string",
    "solutionRecordedAt": "2019-08-24T14:15:22Z",
    "solverIds": [
      "string"
    ],
    "status": "PENDING_VERIFICATION",
    "subject": "string",
    "tenantId": "string",
    "ticketNumber": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "verificationTokenHash": "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
/support/tickets/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/support/tickets/find-all"
[
  {
    "accessTokenHash": "string",
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "category": "string",
    "clientId": "string",
    "closedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "escalatedAt": "2019-08-24T14:15:22Z",
    "escalatedToEmployeeId": "string",
    "escalatedToTaskId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstResponseAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "messages": [
      {
        "attachments": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ],
        "content": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "internal": true,
        "senderId": "string",
        "senderName": "string",
        "senderType": "CLIENT"
      }
    ],
    "priority": "LOW",
    "projectId": "string",
    "resolvedAt": "2019-08-24T14:15:22Z",
    "serviceOwnerId": "string",
    "solution": "string",
    "solutionRecordedAt": "2019-08-24T14:15:22Z",
    "solverIds": [
      "string"
    ],
    "status": "PENDING_VERIFICATION",
    "subject": "string",
    "tenantId": "string",
    "ticketNumber": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "verificationTokenHash": "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 a list of entities by their IDs

GET
/support/tickets/find-list

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/support/tickets/find-list"
[
  {
    "accessTokenHash": "string",
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "category": "string",
    "clientId": "string",
    "closedAt": "2019-08-24T14:15:22Z",
    "contactEmail": "string",
    "contactName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "escalatedAt": "2019-08-24T14:15:22Z",
    "escalatedToEmployeeId": "string",
    "escalatedToTaskId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstResponseAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "messages": [
      {
        "attachments": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ],
        "content": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "internal": true,
        "senderId": "string",
        "senderName": "string",
        "senderType": "CLIENT"
      }
    ],
    "priority": "LOW",
    "projectId": "string",
    "resolvedAt": "2019-08-24T14:15:22Z",
    "serviceOwnerId": "string",
    "solution": "string",
    "solutionRecordedAt": "2019-08-24T14:15:22Z",
    "solverIds": [
      "string"
    ],
    "status": "PENDING_VERIFICATION",
    "subject": "string",
    "tenantId": "string",
    "ticketNumber": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "verificationTokenHash": "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
/support/tickets/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/support/tickets/find/string"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToTaskId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "tenantId": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "verificationTokenHash": "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
/support/tickets/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/support/tickets/page"
{
  "content": [
    {
      "accessTokenHash": "string",
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "category": "string",
      "clientId": "string",
      "closedAt": "2019-08-24T14:15:22Z",
      "contactEmail": "string",
      "contactName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "escalatedAt": "2019-08-24T14:15:22Z",
      "escalatedToEmployeeId": "string",
      "escalatedToTaskId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstResponseAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "messages": [
        {
          "attachments": [
            {
              "blobId": "string",
              "created": "2019-08-24T14:15:22Z",
              "extension": "string",
              "fileSize": 0,
              "name": "string",
              "type": "IMAGE"
            }
          ],
          "content": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "id": "string",
          "internal": true,
          "senderId": "string",
          "senderName": "string",
          "senderType": "CLIENT"
        }
      ],
      "priority": "LOW",
      "projectId": "string",
      "resolvedAt": "2019-08-24T14:15:22Z",
      "serviceOwnerId": "string",
      "solution": "string",
      "solutionRecordedAt": "2019-08-24T14:15:22Z",
      "solverIds": [
        "string"
      ],
      "status": "PENDING_VERIFICATION",
      "subject": "string",
      "tenantId": "string",
      "ticketNumber": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "verificationTokenHash": "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 enriched ticket detail

GET
/support/tickets/{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/support/tickets/string"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Update ticket fields

PATCH
/support/tickets/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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 PATCH "http://localhost:18080/api/v1/support/tickets/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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
/support/tickets/{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/support/tickets/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"
}

Assign service owner to ticket

PATCH
/support/tickets/{id}/assign-owner

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

employeeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/support/tickets/string/assign-owner" \  -H "Content-Type: application/json" \  -d '{    "employeeId": "string"  }'
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Assign solvers to ticket

PATCH
/support/tickets/{id}/assign-solvers

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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 PATCH "http://localhost:18080/api/v1/support/tickets/string/assign-solvers" \  -H "Content-Type: application/json" \  -d '{    "employeeIds": [      "string"    ]  }'
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Add a comment to an entity

POST
/support/tickets/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/support/tickets/string/comment" \  -H "Content-Type: application/json" \  -d '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"
}

Escalate ticket to a person's task list

POST
/support/tickets/{id}/escalate

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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/support/tickets/string/escalate" \  -H "Content-Type: application/json" \  -d '{    "employeeId": "string"  }'
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Add message to ticket

POST
/support/tickets/{id}/messages

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

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/support/tickets/string/messages" \  -F data="{\n  \"content\": \"string\",\n  \"internal\": true\n}"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Change ticket status

PATCH
/support/tickets/{id}/status

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

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 PATCH "http://localhost:18080/api/v1/support/tickets/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "PENDING_VERIFICATION"  }'
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "clientId": "string",
  "clientName": "string",
  "closedAt": "2019-08-24T14:15:22Z",
  "contactEmail": "string",
  "contactName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "elapsedMinutes": 0,
  "escalatedAt": "2019-08-24T14:15:22Z",
  "escalatedToEmployeeId": "string",
  "escalatedToEmployeeName": "string",
  "escalatedToTaskId": "string",
  "firstResponseAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "messageCount": 0,
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "projectId": "string",
  "projectName": "string",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "serviceOwnerId": "string",
  "serviceOwnerName": "string",
  "solution": "string",
  "solutionRecordedAt": "2019-08-24T14:15:22Z",
  "solverIds": [
    "string"
  ],
  "solverNames": [
    "string"
  ],
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string",
  "updated": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Support Settings

Previous Page

Tax Percentages

Next Page