REST DocumentationTicketsGET Get a ticket subtask

Get a ticket subtask

Returns a single subtask of the given ticket.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/tickets/{id}/subtasks/{subtask_id}
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/tickets/{id}/subtasks/{subtask_id}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

  • Name
    id
    Type
    integer
    Description

    The ticket ID

  • Name
    subtask_id
    Type
    integer
    Description

    The subtask ID

Response

{
  "data": {
    "id": 1,
    "name": "EU",
    "ticket_id": 1234,
    "date": "2024-07-20T00:00:00.000000Z",
    "creator_username": "max.mustermann",
    "processor_username": "frank",
    "subject": "Fehler in der Benutzeroberfläche beheben",
    "status": {
      "id": 1,
      "name": "neu"
    },
    "receipt_date": "2024-11-15",
    "start_date": "2024-01-15T00:00:00.000000Z",
    "deadline": "2024-11-20",
    "processing_date": "2024-02-28 14:09:38",
    "done_date": "2024-02-28 14:11:38",
    "planned_hours": 1.5,
    "prevent_overbooking": 0,
    "history_modified": "2024-03-12 08:23:54",
    "keywords": {},
    "created": "2024-07-20T11:30:00.000000Z",
    "modified": "2024-07-20T12:30:00.000000Z",
    "customer_contact_person_id": 1,
    "history_creator_username": "max.mustermann"
  }
}

Response fields

  • Name
    id
    Type
    integer
    Description

    The subtask’s unique identifier.

  • Name
    name
    Type
    string
    Description

    The subtask’s short name.

  • Name
    ticket_id
    Type
    integer
    Description

    The id of the ticket this subtask belongs to.

  • Name
    date
    Type
    string (date-time), nullable
    Description

    The date the subtask was raised.

  • Name
    creator_username
    Type
    string
    Description

    The username of the employee who created the subtask.

  • Name
    processor_username
    Type
    string, nullable
    Description

    The username of the employee currently processing the subtask.

  • Name
    subject
    Type
    string
    Description

    The subtask’s subject line.

  • Name
    status
    Type
    object
    Description

    The subtask’s lifecycle status (e.g. new, in process, done) — the same states as a ticket.

  • Name
    status.id
    Type
    integer
    Description

    The stored value. Compare against this, not against name.

  • Name
    status.name
    Type
    string
    Description

    The human-readable label, delivered in the tenant’s language. Do not parse it.

    One of: "neu", "in Bearbeitung", "fertig", "abgelehnt", "bewilligt", "billed"

  • Name
    receipt_date
    Type
    string (date-time), nullable
    Description

    The date the underlying request was received.

  • Name
    start_date
    Type
    string (date-time), nullable
    Description

    The date work on the subtask is planned to start.

  • Name
    deadline
    Type
    string (date-time), nullable
    Description

    The date by which the subtask should be completed.

  • Name
    processing_date
    Type
    string (date-time), nullable
    Description

    The date the subtask moved into processing.

  • Name
    done_date
    Type
    string (date-time), nullable
    Description

    The date the subtask was marked done.

  • Name
    planned_hours
    Type
    number, nullable
    Description

    The number of hours planned for this subtask.

  • Name
    prevent_overbooking
    Type
    integer
    Description

    Whether recorded time for this subtask may exceed its planned hours, and for which time types.

    One of: 0, 1, 2, 3, 4

  • Name
    history_modified
    Type
    string (date-time)
    Description

    When the subtask’s most recent activity entry was recorded.

  • Name
    keywords
    Type
    object, nullable
    Description

    Free-text, comma-separated keywords for searching and filtering subtasks.

  • Name
    created
    Type
    string (date-time), nullable
    Description

    When the subtask record was created.

  • Name
    modified
    Type
    string (date-time), nullable
    Description

    When the subtask record was last modified.

  • Name
    customer_contact_person_id
    Type
    integer, nullable
    Description

    The id of the customer contact this subtask was raised by or for.

  • Name
    history_creator_username
    Type
    string, nullable
    Description

    The username of the employee who created the subtask’s first history entry.

Generated from the OpenAPI specification — edit the source code, not this page.