Log_Harvestor_Icon

Login

Sign up

Users

Tickets

Tickets

The Ticket:

Tickets are used to track issues and requests that are submitted by users.

Creating a ticket:

  • Users can submit tickets to Log Harvestor {support} on behalf of themselves, their organization or their project.
  • If a ticket is submitted on behalf of a project or organization, the ticket will be visible to all users that have access to the project or organization.
  • Tickets can be created, updated, and deleted by the user that created the ticket or by a user that has access to the ticket's organization or project.

    • Referencing other Log Harvestor entities:

  • Tickets can reference other entities such as a specific log or forwarder.
  • When referencing another entity, the ticket will be visible to all users that have access to the referenced entity.

    • Service level agreements (SLAs):

  • The time in which Log Harvestor support team is commited to responding to a ticket is determined by the {support} plan that the user's organization is subscribed to.
  • For more information on support plans, see the pricing section.

    • Get all

    Description

    Get all tickets that the user has access to.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    Responses

    Description:

    The [ticket](/docs/api/tickets) objects with populated attributes.

    Type:

    Array of Ticket objects

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    get

    /ticket/

    Request

    1
2
3
4
curl https://logharvestor.com/api/v1/ticket/ \
    -X GET \
    -H 'Authorization: Bearer <token>' \

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Get by id

    Description

    Find the ticket that matches the {id} query parameter.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    The [ticket](/docs/api/tickets) object with populated attributes.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    get

    /ticket/:id

    Request

    1
2
3
4
curl https://logharvestor.com/api/v1/ticket/:id \
    -X GET \
    -H 'Authorization: Bearer <token>' \

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Create

    Description

    Create a new ticket.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    body

    type

    string

    Required

    Description:

    Ticket type

    Options:

    bug | access | billing | feature | other

    Example:

    "bug"

    name

    string

    Required

    Description:

    Ticket name

    Example:

    "Found a bug"

    notes

    string

    Required

    Description:

    Ticket notes

    Example:

    "Log message is formatted correctly in the UI"

    forwarder

    string

    Description:

    Forwarder identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    log

    string

    Description:

    Log identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    project

    string

    Description:

    Project identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    org

    string

    Description:

    Organization identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    The newly created [ticket](/docs/api/tickets) object with populated attributes.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    post

    /ticket/

    Request

    1
2
3
4
5
curl https://logharvestor.com/api/v1/ticket/ \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -H 'Content-Type: application/json' \
	--data-raw '{"type":"\"bug\"","name":"\"Found a bug\"","notes":"\"Log message is formatted correctly in the UI\"","forwarder":"\"0f9c0b0b4f0c6b0017f0e3b1\"","log":"\"0f9c0b0b4f0c6b0017f0e3b1\"","project":"\"0f9c0b0b4f0c6b0017f0e3b1\"","org":"\"0f9c0b0b4f0c6b0017f0e3b1\""}'

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Update

    Description

    Update a ticket.

    Parameters

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    body

    type

    string

    Required

    Description:

    Ticket type

    Options:

    bug | access | billing | feature | other

    Example:

    "bug"

    name

    string

    Required

    Description:

    Ticket name

    Example:

    "Found a bug"

    notes

    string

    Required

    Description:

    Ticket notes

    Example:

    "Log message is formatted correctly in the UI"

    forwarder

    string

    Description:

    Forwarder identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    log

    string

    Description:

    Log identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    project

    string

    Description:

    Project identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    org

    string

    Description:

    Organization identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    The updated [ticket](/docs/api/tickets) object with populated attributes.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    put

    /ticket/:id

    Request

    1
2
3
4
5
curl https://logharvestor.com/api/v1/ticket/:id \
    -X PUT \
     \
    -H 'Content-Type: application/json' \
	--data-raw '{"type":"\"bug\"","name":"\"Found a bug\"","notes":"\"Log message is formatted correctly in the UI\"","forwarder":"\"0f9c0b0b4f0c6b0017f0e3b1\"","log":"\"0f9c0b0b4f0c6b0017f0e3b1\"","project":"\"0f9c0b0b4f0c6b0017f0e3b1\"","org":"\"0f9c0b0b4f0c6b0017f0e3b1\""}'

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Update status

    Description

    Update the status of a ticket.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    body

    status

    string

    Required

    Description:

    Ticket status

    Options:

    open | closed

    Example:

    "open"

    Responses

    Description:

    The [ticket](/docs/api/tickets) object with populated attributes.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    put

    /ticket/:id/status

    Request

    1
2
3
4
5
curl https://logharvestor.com/api/v1/ticket/:id/status \
    -X PUT \
    -H 'Authorization: Bearer <token>' \
    -H 'Content-Type: application/json' \
	--data-raw '{"status":"\"open\""}'

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Delete

    Description

    Delete a ticket.

  • This will permanently a ticket and all associated data.
  • A successful response will return a snapshot of the ticket before it was deleted.
  • If the ticket is already deleted, a 404 will be returned.
  • Associated data that will be deleted includes: Events, Comments, Permissions, and Attachments.
  • Before deleting an ticket - please contact support if you have any questions

    • ⚠️ WARNING ⚠️

  • This action cannot be undone.
  • If you do not want to permanently delete the ticket, consider archiving it instead.

    • Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    A snapshot of the [ticket](/docs/api/tickets) object before deletion.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    delete

    /ticket/:id

    Request

    1
2
3
4
curl https://logharvestor.com/api/v1/ticket/:id \
    -X DELETE \
    -H 'Authorization: Bearer <token>' \

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Archive

    Description

    Archive a ticket.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    The archived [ticket](/docs/api/tickets) object with populated attributes.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    post

    /ticket/:id/archive

    Request

    1
2
3
4
curl https://logharvestor.com/api/v1/ticket/:id/archive \
    -X POST \
    -H 'Authorization: Bearer <token>' \

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Unarchive

    Description

    Unarchive a ticket.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    The unarchived [ticket](/docs/api/tickets) object with populated attributes.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    post

    /ticket/:id/unarchive

    Request

    1
2
3
4
curl https://logharvestor.com/api/v1/ticket/:id/unarchive \
    -X POST \
    -H 'Authorization: Bearer <token>' \

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Add comment

    Description

    Add a {comment} to a ticket.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    body

    message

    string

    Required

    Description:

    Comment message

    Example:

    "User 0f9c0b0b4f0c6b0017f0e3b1 updated forwarder 0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    The updated [ticket](/docs/api/tickets) object with populated attributes.

    Type:

    Ticket object

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    post

    /ticket/:id/comment

    Request

    1
2
3
4
5
curl https://logharvestor.com/api/v1/ticket/:id/comment \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -H 'Content-Type: application/json' \
	--data-raw '{"message":"\"User 0f9c0b0b4f0c6b0017f0e3b1 updated forwarder 0f9c0b0b4f0c6b0017f0e3b1\""}'

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "bug",
    name: "Found a bug",
    notes: "Log message is formatted correctly in the UI",
    status: "open",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    forwarder: "0f9c0b0b4f0c6b0017f0e3b1",
    log: "0f9c0b0b4f0c6b0017f0e3b1",
    project: "0f9c0b0b4f0c6b0017f0e3b1",
    org: "0f9c0b0b4f0c6b0017f0e3b1",
    tot_comments: 1
}

    Get events

    Description

    Get all events for a ticket. This includes things like {status} changes, {comment} additions, etc.

    Parameters

    headers

    Authorization

    string

    Required

    Description:

    Bearer token - JWT

    Example:

    "Bearer <token>"

    params

    id

    string

    Required

    Description:

    Ticket identifier

    Example:

    "0f9c0b0b4f0c6b0017f0e3b1"

    Responses

    Description:

    The {events} for the [ticket](/docs/api/tickets).

    Type:

    Array of Event objects

    Example:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "updated",
    message: "User 0f9c0b0b4f0c6b0017f0e3b1 updated forwarder 0f9c0b0b4f0c6b0017f0e3b1",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    entity: "0f9c0b0b4f0c6b0017f0e3b1",
    entityType: "Forwarder",
    refs: [
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Forwarder"
        },
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Project"
        }
    ]
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

    Type:

    Error object

    Example:

    1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

    get

    /ticket/:id/events

    Request

    1
2
3
4
curl https://logharvestor.com/api/v1/ticket/:id/events \
    -X GET \
    -H 'Authorization: Bearer <token>' \

    Response

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    type: "updated",
    message: "User 0f9c0b0b4f0c6b0017f0e3b1 updated forwarder 0f9c0b0b4f0c6b0017f0e3b1",
    user: "0f9c0b0b4f0c6b0017f0e3b1",
    entity: "0f9c0b0b4f0c6b0017f0e3b1",
    entityType: "Forwarder",
    refs: [
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Forwarder"
        },
        {
            entity: "0f9c0b0b4f0c6b0017f0e3b1",
            entityType: "Project"
        }
    ]
}

    Orgs

    Users

    Log_Harvestor_Icon

    Join our newsletter

    support@logharvestor.com

    Copyright © Log Harvestor 2023 • Terms • Privacy