Loading
Documentation Powered by ReDoc

DFS Ticketing Services API (latest)

Download OpenAPI specification:Download

Contains functionality around tickets.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

TicketManagement

Remove tickets from member watch-list

Removes specified tickets from member watch-list.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json
ticketIds
required
Array of strings <uuid>

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/tickets/watchlist
https://example-host/v1.0/tickets/watchlist

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ticketIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Add tickets to member watch-list

Adds specified tickets to member watch-list. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule).

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json
ticketIds
required
Array of strings <uuid>

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/tickets/watchlist
https://example-host/v1.0/tickets/watchlist

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ticketIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Update a ticket

Updates a ticket. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule). If updated, the assignee must have access to any/all of the associated contacts (depending on the same access rule). All changes are registered in the ticket’s change-log.

Possible ApiError.SubCode values:

AssigneeInsufficientAccess: Assignee does not have sufficient access to associated contact/s.

Authorizations:
Bearer
path Parameters
ticketId
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json
updateProperties
Array of strings Nullable
title
string Nullable
description
string Nullable
dueDate
string <date-time> Nullable
assigneeMemberUid
string <uuid> Nullable
statusUid
string <uuid> Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/tickets/{ticketId}
https://example-host/v1.0/tickets/{ticketId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "updateProperties":
    [
    ],
  • "title": "string",
  • "description": "string",
  • "dueDate": "2024-11-07T14:53:55Z",
  • "assigneeMemberUid": "string",
  • "statusUid": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Update specified comment

Updates specified comment in the specified ticket. Old version of the comment is still accessible via the comment history. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule), and that in order to update a comment, a member needs to be the one who originally added it.

Authorizations:
Bearer
path Parameters
ticketId
required
string <uuid>
commentId
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request data

comment
required
string

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/tickets/{ticketId}/comments/{commentId}
https://example-host/v1.0/tickets/{ticketId}/comments/{commentId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "comment": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Create ticket

Creates a ticket. If specified, the assignee must have access to any/all of the associated contacts (depending on the access rule). Participant association is automatically set (if available in JWT), unless directly specified in request body when called with a bypass token.

Possible ApiError.SubCode values:

AssigneeInsufficientAccess: Assignee does not have sufficient access to associated contact/s.
CreatorInsufficientAccess:  User does not have sufficient access to associated contact/s.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json
title
required
string
description
string Nullable
categoryUid
required
string <uuid>
dueDate
string <date-time> Nullable
assigneeMemberUid
string <uuid> Nullable
contactUids
required
Array of strings <uuid>
referenceUid
string <uuid> Nullable
participantUids
Array of strings <uuid> Nullable

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/tickets
https://example-host/v1.0/tickets

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "title": "New product on-boarding",
  • "description": "Working with new instruments",
  • "categoryUid": "1a2f3ae0-fea3-46d7-acab-465fb43d1ff4",
  • "dueDate": "2024-11-05T14:59:01.0262458+00:00",
  • "assigneeMemberUid": "58000000-0000-0000-0000-000000000000",
  • "contactUids":
    [
    ],
  • "referenceUid": "41288bb6-e840-40c7-9e6e-3ebbc52c261b"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ticketId": "string"
}

Add a comment to a ticket

Adds a comment to a ticket. Note that in order to access a ticket, a member needs to have access to any/all of the associated contacts (depending on the access rule).

Authorizations:
Bearer
path Parameters
ticketId
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request data

comment
required
string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/tickets/{ticketId}/comments
https://example-host/v1.0/tickets/{ticketId}/comments

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "comment": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "commentId": "string"
}