API docs by Redocly

ticket API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the ticket stack.

HistoryService

HistoryService_ListChanges

path Parameters
ticketId
required
string
query Parameters
publicTicketId
string

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

TicketService

TicketService_ChangeStatusBulk

Request Body schema: application/json
required
ids
required
Array of strings
status
required
string (ticketTicketStatus)
Default: "TICKET_STATUS_OPEN"
Enum: "TICKET_STATUS_OPEN" "TICKET_STATUS_IN_PROGRESS" "TICKET_STATUS_DONE" "TICKET_STATUS_CLOSED" "TICKET_STATUS_DRAFT"

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "status": "TICKET_STATUS_OPEN"
}

Response samples

Content type
application/json
{ }

TicketService_CountMyUnreadTickets

query Parameters
userIds
Array of strings

Responses

Response samples

Content type
application/json
{
  • "amount": 0
}

TicketService_CountTickets

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

Create

Request Body schema: application/json
required
required
Array of objects (ticketAdditionalData)
required
object (ticketSetAssignee)
required
Array of objects (ticketChecklistItem)
required
Array of objects (ticketSetCorrespondence)
required
object (ticketticketCosts)
required
Array of objects (ticketticketCosts)
description
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
Array of objects (ticketExternalTicketWatcher)
key
string

Optional

required
Array of objects (ticketTicketLink)
mediaIds
required
Array of strings
required
object (ticketSetOnSiteContact)
required
Array of objects (ticketSetOnSiteContact)
ownerId
required
string <int64>
priority
required
string (ticketTicketPriority)
Default: "DEFAULT"
Enum: "DEFAULT" "LOW" "HIGH"
required
object (ticketRecurrence)
required
Array of objects (ticketTicketReference)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

status
required
string (ticketTicketStatus)
Default: "TICKET_STATUS_OPEN"
Enum: "TICKET_STATUS_OPEN" "TICKET_STATUS_IN_PROGRESS" "TICKET_STATUS_DONE" "TICKET_STATUS_CLOSED" "TICKET_STATUS_DRAFT"
title
required
string
type
required
string (ticketTicketType)
Default: "TICKET_TYPE_UNDEFINED"
Enum: "TICKET_TYPE_UNDEFINED" "TICKET_TYPE_ORDER" "TICKET_TYPE_OFFER" "TICKET_TYPE_ACTIVITY" "TICKET_TYPE_TASK" "TICKET_TYPE_CHECKLIST" "TICKET_TYPE_CLAIM"
required
Array of objects (ticketSetTicketWatcher)

Responses

Request samples

Content type
application/json
{
  • "additionalData": [
    ],
  • "assignee": {
    },
  • "checklist": [
    ],
  • "correspondences": [
    ],
  • "costs": {
    },
  • "costsEntries": [
    ],
  • "description": "string",
  • "dueDate": {
    },
  • "externalTicketWatchers": [
    ],
  • "key": "string",
  • "links": [
    ],
  • "mediaIds": [
    ],
  • "onSiteContact": {
    },
  • "onSiteContacts": [
    ],
  • "ownerId": "string",
  • "priority": "DEFAULT",
  • "recurrence": {
    },
  • "references": [
    ],
  • "startDate": {
    },
  • "status": "TICKET_STATUS_OPEN",
  • "title": "string",
  • "type": "TICKET_TYPE_UNDEFINED",
  • "watchers": [
    ]
}

Response samples

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

Checklist ticket templates

Request Body schema: application/json
required
assigneeUserId
required
string

Ignored if usePropertyAssignee is set to true.

checklistItemTitles
required
Array of strings

Deprecated. Use checklistItems instead.

required
Array of objects (ticketChecklistItemTemplate)
mediaIds
required
Array of strings
name
required
string
ownerId
required
string <int64>
usePropertyAssignee
required
boolean

Responses

Request samples

Content type
application/json
{
  • "assigneeUserId": "string",
  • "checklistItemTitles": [
    ],
  • "checklistItems": [
    ],
  • "mediaIds": [
    ],
  • "name": "string",
  • "ownerId": "string",
  • "usePropertyAssignee": true
}

Response samples

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

TicketService_DeleteChecklistTemplates

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

TicketService_EnableTicketing

Request Body schema: application/json
required
accountId
required
string <int64>
enable
required
boolean

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "enable": true
}

Response samples

Content type
application/json
{ }

TicketService_GetByKey

path Parameters
key
required
string

Responses

Response samples

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

Read

path Parameters
publicId
required
string

Responses

Response samples

Content type
application/json
{
  • "invoiceDocument": {
    },
  • "invoiceMedia": [
    ],
  • "ticket": {
    }
}

TicketService_GetNotificationMailbox

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "mailboxId": "string"
}

Statistics

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "closedTickets": {
    },
  • "countOverall": 0,
  • "doneTickets": {
    },
  • "inProgressTickets": {
    },
  • "openTickets": {
    }
}

Misc

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

TicketService_IsContactInUse

path Parameters
contactId
required
string

Responses

Response samples

Content type
application/json
{
  • "inUse": true
}

TicketService_ListByContactIds

Request Body schema: application/json
required
contactIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tickets": [
    ]
}

TicketService_ListByIds

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "tickets": [
    ]
}

TicketService_ListByQuery

query Parameters
query
string

Responses

Response samples

Content type
application/json
{
  • "tickets": [
    ]
}

TicketService_ListByReferenceIds

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tickets": [
    ]
}

TicketService_ListChecklistTemplates

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

TicketService_ListMyTickets

query Parameters
query
string

Optional filter parameter

page
integer <int32>

Optional. Leave out or set to 0 to disable pagination

itemsPerPage
integer <int32>

Only used when page is set

priorities
Array of strings
Items Enum: "DEFAULT" "LOW" "HIGH"

Optional filter parameter

types
Array of strings
Items Enum: "TICKET_TYPE_UNDEFINED" "TICKET_TYPE_ORDER" "TICKET_TYPE_OFFER" "TICKET_TYPE_ACTIVITY" "TICKET_TYPE_TASK" "TICKET_TYPE_CHECKLIST" "TICKET_TYPE_CLAIM"

Optional filter parameter

statuses
Array of strings
Items Enum: "TICKET_STATUS_OPEN" "TICKET_STATUS_IN_PROGRESS" "TICKET_STATUS_DONE" "TICKET_STATUS_CLOSED" "TICKET_STATUS_DRAFT"

Optional filter parameter

ownerIds
Array of strings <int64> [ items <int64 > ]

Optional filter parameter

creatorUserIds
Array of strings

Optional filter parameter

assigneeUserIds
Array of strings

Optional filter parameter

correspondenceContactIds
Array of strings

Optional filter parameter

involvedContactIds
Array of strings

Optional filter parameter

referenceIds
Array of strings

Optional filter parameter

closedOnly
boolean
overdueOnly
boolean
watchingOnly
boolean
directReferenceIdsOnly
boolean
includeClosed
boolean
unreadByAssigneeOnly
boolean
hasInvoiceOnly
boolean

Optional filter parameter. Only tickets with an invoice document are returned.

Responses

Response samples

Content type
application/json
{
  • "tickets": [
    ],
  • "totalPages": 0,
  • "totalTickets": 0
}

TicketService_ListMyTickets2

Request Body schema: application/json
required
assigneeUserIds
Array of strings

Optional filter parameter

closedOnly
required
boolean
correspondenceContactIds
Array of strings

Optional filter parameter

creatorUserIds
Array of strings

Optional filter parameter

directReferenceIdsOnly
required
boolean
hasInvoiceOnly
boolean

Optional filter parameter. Only tickets with an invoice document are returned.

includeClosed
required
boolean
involvedContactIds
Array of strings

Optional filter parameter

itemsPerPage
required
integer <int32>

Only used when page is set

overdueOnly
required
boolean
ownerIds
Array of strings <int64> [ items <int64 > ]

Optional filter parameter

page
integer <int32>

Optional. Leave out or set to 0 to disable pagination

priorities
Array of strings (ticketTicketPriority)
Items Enum: "DEFAULT" "LOW" "HIGH"

Optional filter parameter

query
string

Optional filter parameter

referenceIds
Array of strings

Optional filter parameter

statuses
Array of strings (ticketTicketStatus)
Items Enum: "TICKET_STATUS_OPEN" "TICKET_STATUS_IN_PROGRESS" "TICKET_STATUS_DONE" "TICKET_STATUS_CLOSED" "TICKET_STATUS_DRAFT"

Optional filter parameter

types
Array of strings (ticketTicketType)
Items Enum: "TICKET_TYPE_UNDEFINED" "TICKET_TYPE_ORDER" "TICKET_TYPE_OFFER" "TICKET_TYPE_ACTIVITY" "TICKET_TYPE_TASK" "TICKET_TYPE_CHECKLIST" "TICKET_TYPE_CLAIM"

Optional filter parameter

unreadByAssigneeOnly
required
boolean
watchingOnly
required
boolean

Responses

Request samples

Content type
application/json
{
  • "assigneeUserIds": [
    ],
  • "closedOnly": true,
  • "correspondenceContactIds": [
    ],
  • "creatorUserIds": [
    ],
  • "directReferenceIdsOnly": true,
  • "hasInvoiceOnly": true,
  • "includeClosed": true,
  • "involvedContactIds": [
    ],
  • "itemsPerPage": 0,
  • "overdueOnly": true,
  • "ownerIds": [
    ],
  • "page": 0,
  • "priorities": [
    ],
  • "query": "string",
  • "referenceIds": [
    ],
  • "statuses": [
    ],
  • "types": [
    ],
  • "unreadByAssigneeOnly": true,
  • "watchingOnly": true
}

Response samples

Content type
application/json
{
  • "tickets": [
    ],
  • "totalPages": 0,
  • "totalTickets": 0
}

TicketService_ListTicketingEnabled

Request Body schema: application/json
required
accountIds
required
Array of strings <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "accountIds": [
    ]
}

Response samples

Content type
application/json
{
  • "enabledAccountIds": [
    ]
}

TicketService_MarkRead2

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

TicketService_MarkUnread2

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

TicketService_RemoveWatcherFromTicketsOfAssignee

Request Body schema: application/json
required
assigneeUserId
required
string

The userId that must be set as assignee on the ticket whose watchers should be modified.

watcherUserId
required
string

The userId that should be removed from watchers list.

Responses

Request samples

Content type
application/json
{
  • "assigneeUserId": "string",
  • "watcherUserId": "string"
}

Response samples

Content type
application/json
{
  • "modifiedTickets": 0
}

TicketService_ReserveKeys

Request Body schema: application/json
required
accountId
required
string <int64>
amount
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Automatic tickets

Request Body schema: application/json
required
required
Array of objects (ticketticketSchedule)

Responses

Request samples

Content type
application/json
{
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{ }

TicketService_ListSchedules

path Parameters
accountId
required
string <int64>
query Parameters
categories
Array of strings

Optional filter parameter

Responses

Response samples

Content type
application/json
{
  • "schedules": [
    ]
}

TicketService_SetNotificationMailbox

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
mailboxId
string

Responses

Request samples

Content type
application/json
{
  • "mailboxId": "string"
}

Response samples

Content type
application/json
{ }

TicketService_UpdateChecklistTemplate

path Parameters
id
required
string
Request Body schema: application/json
required
assigneeUserId
string

Ignored if usePropertyAssignee is set to true.

checklistItemTitles
Array of strings

Deprecated. Use checklistItems instead.

Array of objects (ticketChecklistItemTemplate)
mediaIds
Array of strings
name
string
usePropertyAssignee
boolean

Responses

Request samples

Content type
application/json
{
  • "assigneeUserId": "string",
  • "checklistItemTitles": [
    ],
  • "checklistItems": [
    ],
  • "mediaIds": [
    ],
  • "name": "string",
  • "usePropertyAssignee": true
}

Response samples

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

TicketService_MarkRead

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

TicketService_MarkUnread

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

TicketService_AddInvoice

path Parameters
id
required
string
Request Body schema: application/json
required
mediaId
string

The medium ID (NOT documentId) from the file that should be added to invoice document.

operatorName
string

The name of the operator who added the invoice. Only set if publicId is set.

publicId
string

Optional. Used to authenticate for unregistered upload by craftsman.

Responses

Request samples

Content type
application/json
{
  • "mediaId": "string",
  • "operatorName": "string",
  • "publicId": "string"
}

Response samples

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

TicketService_AddWatcher

path Parameters
id
required
string
Request Body schema: application/json
required
object (ticketSetTicketWatcher)

Responses

Request samples

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

Response samples

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

TicketService_ChangeStatus

path Parameters
id
required
string
Request Body schema: application/json
required
email
string
name
string
status
string (ticketTicketStatus)
Default: "TICKET_STATUS_OPEN"
Enum: "TICKET_STATUS_OPEN" "TICKET_STATUS_IN_PROGRESS" "TICKET_STATUS_DONE" "TICKET_STATUS_CLOSED" "TICKET_STATUS_DRAFT"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "status": "TICKET_STATUS_OPEN"
}

Response samples

Content type
application/json
{ }

Delete

path Parameters
id
required
string
query Parameters
deleteRecurrence
boolean

Responses

Response samples

Content type
application/json
{ }

TicketService_DeleteInvoice

path Parameters
id
required
string
Request Body schema: application/json
required
operatorName
string

The name of the operator who added the invoice. Only set if publicId is set.

publicId
string

Optional. Used to authenticate for unregistered upload by craftsman.

Responses

Request samples

Content type
application/json
{
  • "operatorName": "string",
  • "publicId": "string"
}

Response samples

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

Update

path Parameters
update.id
required
string
Request Body schema: application/json
required
omitCorrespondenceNotification
boolean
object
updateMask
string
updateRecurrenceFields
boolean

Responses

Request samples

Content type
application/json
{
  • "omitCorrespondenceNotification": true,
  • "update": {
    },
  • "updateMask": "string",
  • "updateRecurrenceFields": true
}

Response samples

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