Documentation Powered by ReDoc

Pingum Events API (v0.1.0)

Download OpenAPI specification:Download

Pingum Support: support@pingum.io URL: https://pingum.io/about/ License: Apache License Version 2.0

Rest APIs for Pingum Events - Retrieve and Interact with Events, Status, Tags, and much more!

Comments

Comment Controller

Delete Comment

path Parameters
commentId
required
integer <int32>

commentId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided comment does not exist

409

The tenant for this data does not match the header tenant

delete /api/v1/comments/{commentId}
https://event-api.pingum.io/api/v1/comments/{commentId}

Update Comment

path Parameters
commentId
required
integer <int32>

commentId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

comment
string

Comment text

commentHeader
string

Header or title describing this comment

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided comment does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/comments/{commentId}
https://event-api.pingum.io/api/v1/comments/{commentId}

Request samples

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

Dashboards

Dashboard Controller

Get All Dashboards

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/dashboards
https://event-api.pingum.io/api/v1/dashboards

Create Dashboard

Create a dashboard with preset filters for returning events

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

auditLog
string
dashboardData
object (SearchEvents)
defaultView
string
Enum: "list" "grid" "kanban" "analytics"

Default view for the dashboard. 'list' is default selection

description
string

Description of the dashobard

directLinkName
required
string

Direct link name for accessing the dashboard

name
required
string

Name of the dashboard

organizationExposed
required
boolean

Is this dashboard available for all organization members?

selectedColumns
Array of objects (Map«string,string»)

What columns are shown for this dashboard, and in what order

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

409

The tenant for this data does not match the header tenant

post /api/v1/dashboards
https://event-api.pingum.io/api/v1/dashboards

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "auditLog": "string",
  • "dashboardData":
    {
    },
  • "defaultView": "list",
  • "description": "string",
  • "directLinkName": "string",
  • "name": "string",
  • "organizationExposed": false,
  • "selectedColumns":
    [
    ]
}

Delete Dashboard

Once deleting a dashoard, it cannot be retreived again

path Parameters
dashboardId
required
integer <int32>

dashboardId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided dashboard does not exist

409

The tenant for this data does not match the header tenant

delete /api/v1/dashboards/{dashboardId}
https://event-api.pingum.io/api/v1/dashboards/{dashboardId}

Update Dashboard

Update and existing dashboard with new data

path Parameters
dashboardId
required
integer <int32>

dashboardId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

auditLog
string
dashboardData
object (SearchEvents)
defaultView
string
Enum: "list" "grid" "kanban" "analytics"

Default view for the dashboard. 'list' is default selection

description
string

Description of the dashobard

directLinkName
string

Direct link name for accessing the dashboard

name
string

Name of the dashboard

organizationExposed
required
boolean

Is this dashboard available for all organization members?

selectedColumns
Array of objects (Map«string,string»)

What columns are shown for this dashboard, and in what order

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided dashbaord does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/dashboards/{dashboardId}
https://event-api.pingum.io/api/v1/dashboards/{dashboardId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "auditLog": "string",
  • "dashboardData":
    {
    },
  • "defaultView": "list",
  • "description": "string",
  • "directLinkName": "string",
  • "name": "string",
  • "organizationExposed": false,
  • "selectedColumns":
    [
    ]
}

Get All Subscriptions to Dashboard

path Parameters
dashboardId
required
integer <int32>

dashboardId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/dashboards/{dashboardId}/subscriptions
https://event-api.pingum.io/api/v1/dashboards/{dashboardId}/subscriptions

Event Data

Event Data Controller

Get All Event Data

query Parameters
includeArchived
boolean
Default: false

includeArchived

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/eventData
https://event-api.pingum.io/api/v1/eventData

Create Event Data

Create a data field that can be used as additional data input when creating events

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

Name is used to display the field. Type is used to determine the input type (value must be one of: (Text, Number)

auditLog
string
name
required
string

Field Name of the event data field

required
boolean

Is the Event Data required?

type
required
string
Enum: "Text" "Number" "Date" "Datetime" "User" "Address" "Email" "Phone"

Data type for the field

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

409

The tenant for this data does not match the header tenant

post /api/v1/eventData
https://event-api.pingum.io/api/v1/eventData

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "auditLog": "string",
  • "name": "string",
  • "required": false,
  • "type": "Text"
}

Update Event Data

path Parameters
eventDataId
required
integer <int32>

eventDataId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

Name is used to display the field. Type is used to determine the input type (value must be one of: (Text, Number)

archived
boolean

Is the Event Data archived?

auditLog
string
name
string

Field Name of the event data field

required
boolean

Is the Event Data required?

type
string
Enum: "Text" "Number" "Date" "Datetime" "User" "Address" "Email" "Phone"

Data type for the field

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event data does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/eventData/{eventDataId}
https://event-api.pingum.io/api/v1/eventData/{eventDataId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "archived": false,
  • "auditLog": "string",
  • "name": "string",
  • "required": false,
  • "type": "Text"
}

Event Status

Event Status Controller

Delete EventStatus

path Parameters
eventStatusId
required
integer <int32>

eventStatusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event status does not exist

409

The tenant for this data does not match the header tenant

delete /api/v1/eventStatus/{eventStatusId}
https://event-api.pingum.io/api/v1/eventStatus/{eventStatusId}

Update EventStatus

path Parameters
eventStatusId
required
integer <int32>

eventStatusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

statusComment
string

Comment for event status

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event status does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/eventStatus/{eventStatusId}
https://event-api.pingum.io/api/v1/eventStatus/{eventStatusId}

Request samples

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

Delete EventStatus

path Parameters
eventStatusId
required
integer <int32>

eventStatusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event status does not exist

409

The tenant for this data does not match the header tenant

delete /api/v1/eventStatuses/{eventStatusId}
https://event-api.pingum.io/api/v1/eventStatuses/{eventStatusId}

Update EventStatus

path Parameters
eventStatusId
required
integer <int32>

eventStatusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

statusComment
string

Comment for event status

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event status does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/eventStatuses/{eventStatusId}
https://event-api.pingum.io/api/v1/eventStatuses/{eventStatusId}

Request samples

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

Event Templates

Event Template Controller

Get Event Templates

query Parameters
includeArchived
boolean
Default: false

includeArchived

search
string

search

page
ref

Results page you want to retrieve (0..N)

size
ref

Number of records per page.

sort
Array of strings

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/eventTemplates
https://event-api.pingum.io/api/v1/eventTemplates

Create New Event Template

Create an event template by providing the all required data

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

allowActiveDuplicates
boolean

Allow multiple active events created from the event template

configurableName
boolean

Allow the name of the event being created or updated from the template to have a different name?

configurableTags
boolean

Allow different tags to be provided when creating events from this event template?

defaultStartStatusId
required
integer <int32>

ID of the status events created from this event template will start in

description
string

Description of the event template - also used as the description of events created from this event template

eventData
Array of integers <int32>

JSON Map of event data fields that will be available when creating events from this event template

name
required
string

Name of the event template - also used as the name of events created from this event template

tags
required
Array of integers <int32>

List of tag IDs to be assigned to the events created from this event template

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided status or tag does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/eventTemplates
https://event-api.pingum.io/api/v1/eventTemplates

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "allowActiveDuplicates": false,
  • "configurableName": false,
  • "configurableTags": false,
  • "defaultStartStatusId": 0,
  • "description": "string",
  • "eventData":
    [
    ],
  • "name": "string",
  • "tags":
    [
    ]
}

Search For Event Templates

query Parameters
includeArchived
boolean
Default: false

includeArchived

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

search
string
statusIds
Array of integers <int32>
tagConditions
Array of Array of integers

The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Event Templates which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ]

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post /api/v1/eventTemplates/search
https://event-api.pingum.io/api/v1/eventTemplates/search

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "search": "string",
  • "statusIds":
    [
    ],
  • "tagConditions":
    [
    ]
}

Delete An Event Template

Deleting an event template will remove it completely and cannot be retrieved

path Parameters
eventTemplateId
required
integer <int32>

eventTemplateId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event template does not exist

409

The tenant for this data does not match the header tenant

delete /api/v1/eventTemplates/{eventTemplateId}
https://event-api.pingum.io/api/v1/eventTemplates/{eventTemplateId}

Update An Event Template

Update event template fields

path Parameters
eventTemplateId
required
integer <int32>

eventTemplateId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

allowActiveDuplicates
boolean

Allow multiple active events created from the event template

archived
boolean

Is the event template archived

configurableName
boolean

Allow the name of the event being created or updated from the template to have a different name?

configurableTags
boolean

Allow different tags to be provided when creating events from this event template?

defaultStartStatusId
integer <int32>

ID of the status events created from this event template will start in

description
string

Description of the event template - also used as the description of events created from this event template

eventData
Array of integers <int32>

JSON Map of event data fields that will be available when creating events from this event template

name
string

Name of the event template - also used as the name of events created from this event template

tags
Array of integers <int32>

List of tag IDs to be assigned to the events created from this event template

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event template, status, or tag does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/eventTemplates/{eventTemplateId}
https://event-api.pingum.io/api/v1/eventTemplates/{eventTemplateId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "allowActiveDuplicates": false,
  • "archived": false,
  • "configurableName": false,
  • "configurableTags": false,
  • "defaultStartStatusId": 0,
  • "description": "string",
  • "eventData":
    [
    ],
  • "name": "string",
  • "tags":
    [
    ]
}

Create Event From Event Template

Quickly create and event by providing an event templates pre defined data

path Parameters
eventTemplateId
required
integer <int32>

eventTemplateId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

description
string

Description of the event

eventData
object

JSON Map of event data fields and label values for the event

name
string

Name of event - override name on event template - only allowed on templates that have configurable name set to true

startingStatusComment
string

Comment for the initial status of the event

tags
Array of integers <int32>

List of tag IDs to be assigned to the event. Only provide this field if you want to override the tags already defined for the Event Template

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event template or tag does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/eventTemplates/{eventTemplateId}/events
https://event-api.pingum.io/api/v1/eventTemplates/{eventTemplateId}/events

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "eventData":
    {
    },
  • "name": "string",
  • "startingStatusComment": "string",
  • "tags":
    [
    ]
}

Get All Subscriptions to Event Template

path Parameters
eventTemplateId
required
integer <int32>

eventTemplateId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/eventTemplates/{eventTemplateId}/subscriptions
https://event-api.pingum.io/api/v1/eventTemplates/{eventTemplateId}/subscriptions

Event Uploads

Event Upload Controller

Update Event Upload

Update and existing event upload with a new file.

path Parameters
eventUploadId
required
integer <int32>

eventUploadId

query Parameters
displayName
string

displayName

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event upload does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/eventUploads/{eventUploadId}
https://event-api.pingum.io/api/v1/eventUploads/{eventUploadId}

Delete Upload for Event Upload

Remove an event upload. This action cannot be undone and the file will not able to be retrieved again.

path Parameters
eventUploadId
required
integer <int32>

eventUploadId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event upload does not exist

409

The tenant for this data does not match the header tenant

delete /api/v1/eventUploads/{eventUploadId}
https://event-api.pingum.io/api/v1/eventUploads/{eventUploadId}

Download Event Upload

path Parameters
eventUploadId
required
integer <int32>

eventUploadId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

The provided event upload does not exist

409

The tenant for this data does not match the header tenant

get /api/v1/eventUploads/{eventUploadId}/download
https://event-api.pingum.io/api/v1/eventUploads/{eventUploadId}/download

Events

Event Controller

Create Event

Create an event by providing the all required data to do so.

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

description
string

Description of the event

eventData
object

JSON Map of event data fields and label values for the event

name
required
string

Name of the event

startingStatusComment
string

Comment for the initial status of the event

startingStatusId
required
integer <int32>

ID of the status this event will start in

tags
required
Array of integers <int32>

List of tag IDs to be assigned to the event

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided status or tag does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/events
https://event-api.pingum.io/api/v1/events

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "description": "string",
  • "eventData":
    {
    },
  • "name": "string",
  • "startingStatusComment": "string",
  • "startingStatusId": 0,
  • "tags":
    [
    ]
}

Get Analytics Data for Events

Get Analytics for events by providing filters and search criteria

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

completedLookBackTimeMillis
integer <int64>

(If including completed events) Number of milliseconds to look back for completed events when searching events

endDate
string <date-time>

Return all event starting before this date - null means no end date filter - dateFilter value must be null for this field to be used

includeArchived
boolean

Include archived events?

includeComplete
boolean

Include completed events?

presetDateFilter
string
Enum: "Today" "ThisWeek" "ThisMonth"

Filter events in time range - null means no time range fitler

searchText
string

Filter result with provided text searching the following fields: Event name/description, Tag name/description, Status name, Comments, and Event Data Fields

sortStartDateDesc
boolean

Sort result by start date descending or ascending

startDate
string <date-time>

Return all event starting after this date - null means no start date filter - dateFilter value must be null for this field to be used

statusIds
Array of integers <int32>

Filter result with events in the provided statuses

tagConditions
Array of Array of integers

The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Events which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ]

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

post /api/v1/events/analytics
https://event-api.pingum.io/api/v1/events/analytics

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "completedLookBackTimeMillis": 0,
  • "endDate": "2020-01-26T18:23:25Z",
  • "includeArchived": false,
  • "includeComplete": false,
  • "presetDateFilter": "Today",
  • "searchText": "string",
  • "sortStartDateDesc": false,
  • "startDate": "2020-01-26T18:23:25Z",
  • "statusIds":
    [
    ],
  • "tagConditions":
    [
    ]
}

Export Events

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

completedLookBackTimeMillis
integer <int64>

(If including completed events) Number of milliseconds to look back for completed events when searching events

endDate
string <date-time>

Return all event starting before this date - null means no end date filter - dateFilter value must be null for this field to be used

includeArchived
boolean

Include archived events?

includeComplete
boolean

Include completed events?

presetDateFilter
string
Enum: "Today" "ThisWeek" "ThisMonth"

Filter events in time range - null means no time range fitler

searchText
string

Filter result with provided text searching the following fields: Event name/description, Tag name/description, Status name, Comments, and Event Data Fields

sortStartDateDesc
boolean

Sort result by start date descending or ascending

startDate
string <date-time>

Return all event starting after this date - null means no start date filter - dateFilter value must be null for this field to be used

statusIds
Array of integers <int32>

Filter result with events in the provided statuses

tagConditions
Array of Array of integers

The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Events which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ]

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

post /api/v1/events/export
https://event-api.pingum.io/api/v1/events/export

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "completedLookBackTimeMillis": 0,
  • "endDate": "2020-01-26T18:23:25Z",
  • "includeArchived": false,
  • "includeComplete": false,
  • "presetDateFilter": "Today",
  • "searchText": "string",
  • "sortStartDateDesc": false,
  • "startDate": "2020-01-26T18:23:25Z",
  • "statusIds":
    [
    ],
  • "tagConditions":
    [
    ]
}

Get server sent events for new and updated events

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/events/notifications
https://event-api.pingum.io/api/v1/events/notifications

Search Events

Search for events by providing filters and search criteria

query Parameters
page
ref

Results page you want to retrieve (0..N)

size
ref

Number of records per page.

updatedAfter
string <date>

Only include events created or updated after this date: ISO format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

completedLookBackTimeMillis
integer <int64>

(If including completed events) Number of milliseconds to look back for completed events when searching events

endDate
string <date-time>

Return all event starting before this date - null means no end date filter - dateFilter value must be null for this field to be used

includeArchived
boolean

Include archived events?

includeComplete
boolean

Include completed events?

presetDateFilter
string
Enum: "Today" "ThisWeek" "ThisMonth"

Filter events in time range - null means no time range fitler

searchText
string

Filter result with provided text searching the following fields: Event name/description, Tag name/description, Status name, Comments, and Event Data Fields

sortStartDateDesc
boolean

Sort result by start date descending or ascending

startDate
string <date-time>

Return all event starting after this date - null means no start date filter - dateFilter value must be null for this field to be used

statusIds
Array of integers <int32>

Filter result with events in the provided statuses

tagConditions
Array of Array of integers

The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Events which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ]

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

post /api/v1/events/search
https://event-api.pingum.io/api/v1/events/search

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "completedLookBackTimeMillis": 0,
  • "endDate": "2020-01-26T18:23:25Z",
  • "includeArchived": false,
  • "includeComplete": false,
  • "presetDateFilter": "Today",
  • "searchText": "string",
  • "sortStartDateDesc": false,
  • "startDate": "2020-01-26T18:23:25Z",
  • "statusIds":
    [
    ],
  • "tagConditions":
    [
    ]
}

Get Event By Id

path Parameters
eventId
required
integer <int32>

eventId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

The provided event does not exist

409

The tenant for this data does not match the header tenant

get /api/v1/events/{eventId}
https://event-api.pingum.io/api/v1/events/{eventId}

Update Event

Update and existing event with new data.

path Parameters
eventId
required
integer <int32>

eventId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

archived
boolean

Is the event archived?

completeEvent
boolean

Is the event complete?

description
string

Description of the event

eventData
object

JSON Map of event data fields and label values for the event

name
string

Name of the event

tags
Array of integers <int32>

List of tag IDs to be assigned to the event

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event or tag does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/events/{eventId}
https://event-api.pingum.io/api/v1/events/{eventId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "archived": false,
  • "completeEvent": false,
  • "description": "string",
  • "eventData":
    {
    },
  • "name": "string",
  • "tags":
    [
    ]
}

Get Comments for Event

path Parameters
eventId
required
integer <int32>

eventId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

The provided event does not exist

409

The tenant for this data does not match the header tenant

get /api/v1/events/{eventId}/comments
https://event-api.pingum.io/api/v1/events/{eventId}/comments

Add Comment to Event

path Parameters
eventId
required
integer <int32>

eventId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

comment
string

Comment text

commentHeader
string

Header or title describing this comment

parentCommentId
integer <int32>

ID of parent or in reply to comment

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/events/{eventId}/comments
https://event-api.pingum.io/api/v1/events/{eventId}/comments

Request samples

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

Add/Change Status for Event

Move event to the provided status

path Parameters
eventId
required
integer <int32>

eventId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

completeEvent
required
boolean

Is this completing the event?

statusComment
string

Comment for new status of event

statusId
required
integer <int32>

ID of the status

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event or status does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/events/{eventId}/eventStatus
https://event-api.pingum.io/api/v1/events/{eventId}/eventStatus

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "completeEvent": false,
  • "statusComment": "string",
  • "statusId": 0
}

Add/Change Status for Event

Move event to the provided status

path Parameters
eventId
required
integer <int32>

eventId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: application/json

request

completeEvent
required
boolean

Is this completing the event?

statusComment
string

Comment for new status of event

statusId
required
integer <int32>

ID of the status

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event or status does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/events/{eventId}/eventStatuses
https://event-api.pingum.io/api/v1/events/{eventId}/eventStatuses

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "completeEvent": false,
  • "statusComment": "string",
  • "statusId": 0
}

Get Event Uploads by Event ID

Return all file uploads for the event

path Parameters
eventId
required
integer <int32>

eventId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

The provided event does not exist

409

The tenant for this data does not match the header tenant

get /api/v1/events/{eventId}/eventUploads
https://event-api.pingum.io/api/v1/events/{eventId}/eventUploads

Add Event Upload to Event

Upload a file to the event

path Parameters
eventId
required
integer <int32>

eventId

query Parameters
displayName
string

displayName

sendNotifications
boolean

sendNotifications

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

X-Timezone
string

X-Timezone

Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/events/{eventId}/eventUploads
https://event-api.pingum.io/api/v1/events/{eventId}/eventUploads

Forms

Form Controller

Create Events From Form

Create events for the given form and templates.

path Parameters
formId
required
string

formId

header Parameters
X-Timezone
string

X-Timezone

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

createEventFromTemplates
object

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

post /api/v1/forms/{formId}/events
https://event-api.pingum.io/api/v1/forms/{formId}/events

Request samples

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

Logs

Log Controller

Get Logs Related to Event Settings

query Parameters
actions
required
Array of strings

actions

startTime
required
string <date-time>

startTime

endTime
string <date-time>

endTime

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/auditLogs
https://event-api.pingum.io/api/v1/auditLogs

Statuses

Status Controller

Get All Statuses

query Parameters
includeArchived
boolean
Default: false

includeArchived

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/status
https://event-api.pingum.io/api/v1/status

Create Status

Creates a new status that events can be placed into. Status order is used for ordering all statuses.

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

auditLog
string
endingStatus
boolean

Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed.

icon
string

Icon for the status. This is a text name of any material icon: https://material.io/tools/icons

iconColor
string

Color for the status icon. Must be 7 characters in length representing hex color.

name
required
string

Name of the status

statusOrder
required
integer <int32>

Order of the status in relation to other status. Must be greater than 0.

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

409

The tenant for this data does not match the header tenant

post /api/v1/status
https://event-api.pingum.io/api/v1/status

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "auditLog": "string",
  • "endingStatus": false,
  • "icon": "credit_card",
  • "iconColor": "#1111111",
  • "name": "string",
  • "statusOrder": 0
}

Get Status By Id

path Parameters
statusId
required
integer <int32>

statusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

The provided status does not exist

409

The tenant for this data does not match the header tenant

get /api/v1/status/{statusId}
https://event-api.pingum.io/api/v1/status/{statusId}

Update Status

path Parameters
statusId
required
integer <int32>

statusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

archived
boolean

Is the status archived?

auditLog
string
endingStatus
boolean

Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed.

icon
string

Icon for the status. This is a text name of any material icon: https://material.io/tools/icons

iconColor
string

Color for the status icon. Must be 7 characters in length representing hex color.

name
string

Name of the status

statusOrder
integer <int32>

Order of the status in relation to other status. Must be greater than 0.

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided status does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/status/{statusId}
https://event-api.pingum.io/api/v1/status/{statusId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "archived": false,
  • "auditLog": "string",
  • "endingStatus": false,
  • "icon": "credit_card",
  • "iconColor": "#1111111",
  • "name": "string",
  • "statusOrder": 0
}

Get All Statuses

query Parameters
includeArchived
boolean
Default: false

includeArchived

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/statuses
https://event-api.pingum.io/api/v1/statuses

Create Status

Creates a new status that events can be placed into. Status order is used for ordering all statuses.

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

auditLog
string
endingStatus
boolean

Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed.

icon
string

Icon for the status. This is a text name of any material icon: https://material.io/tools/icons

iconColor
string

Color for the status icon. Must be 7 characters in length representing hex color.

name
required
string

Name of the status

statusOrder
required
integer <int32>

Order of the status in relation to other status. Must be greater than 0.

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

409

The tenant for this data does not match the header tenant

post /api/v1/statuses
https://event-api.pingum.io/api/v1/statuses

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "auditLog": "string",
  • "endingStatus": false,
  • "icon": "credit_card",
  • "iconColor": "#1111111",
  • "name": "string",
  • "statusOrder": 0
}

Get Status By Id

path Parameters
statusId
required
integer <int32>

statusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

The provided status does not exist

409

The tenant for this data does not match the header tenant

get /api/v1/statuses/{statusId}
https://event-api.pingum.io/api/v1/statuses/{statusId}

Update Status

path Parameters
statusId
required
integer <int32>

statusId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

archived
boolean

Is the status archived?

auditLog
string
endingStatus
boolean

Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed.

icon
string

Icon for the status. This is a text name of any material icon: https://material.io/tools/icons

iconColor
string

Color for the status icon. Must be 7 characters in length representing hex color.

name
string

Name of the status

statusOrder
integer <int32>

Order of the status in relation to other status. Must be greater than 0.

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided status does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/statuses/{statusId}
https://event-api.pingum.io/api/v1/statuses/{statusId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "archived": false,
  • "auditLog": "string",
  • "endingStatus": false,
  • "icon": "credit_card",
  • "iconColor": "#1111111",
  • "name": "string",
  • "statusOrder": 0
}

Tag Types

Tag Type Controller

Get All Tag Types

Returns all tag types for tenant.

query Parameters
includeArchived
boolean
Default: false

includeArchived

includeTags
boolean
Default: false

includeTags

buildHierarchicalList
boolean
Default: true

buildHierarchicalList

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/tagTypes
https://event-api.pingum.io/api/v1/tagTypes

Create Tag Type

Create new tag type with provided data.

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

auditLog
string
description
string

Description of the tag type

icon
string

Icon for the tag type. This is a text name of any material icon: https://material.io/tools/icons

iconColor
string

Color for the tag type icon. Must be 7 characters in length representing hex color.

name
required
string

Name of the tag type

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

409

The tenant for this data does not match the header tenant

post /api/v1/tagTypes
https://event-api.pingum.io/api/v1/tagTypes

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "auditLog": "string",
  • "description": "string",
  • "icon": "credit_card",
  • "iconColor": "#1111111",
  • "name": "string"
}

Update Tag Type

Update existing tag type with provided data.

path Parameters
tagTypeId
required
integer <int32>

tagTypeId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

archived
boolean

Is the tag type archived?

auditLog
string
description
string

Description of the tag type

icon
string

Icon for the tag type. This is a text name of any material icon: https://material.io/tools/icons

iconColor
string

Color for the tag type icon. Must be 7 characters in length representing hex color.

name
string

Name of the tag type

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided tag type does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/tagTypes/{tagTypeId}
https://event-api.pingum.io/api/v1/tagTypes/{tagTypeId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "archived": false,
  • "auditLog": "string",
  • "description": "string",
  • "icon": "credit_card",
  • "iconColor": "#1111111",
  • "name": "string"
}

Get Tags For Tag Type

Returns all tags for tag type. Result can be returned in flat list or in the parent child hierarchy.

path Parameters
tagTypeId
required
integer <int32>

tagTypeId

query Parameters
includeArchived
boolean
Default: false

includeArchived

buildHierarchicalList
boolean
Default: false

buildHierarchicalList

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

The provided tag type does not exist

409

The tenant for this data does not match the header tenant

get /api/v1/tagTypes/{tagTypeId}/tags
https://event-api.pingum.io/api/v1/tagTypes/{tagTypeId}/tags

Create Tag For Tag Type

Creates new tag tied to tag type with provided data.

path Parameters
tagTypeId
required
integer <int32>

tagTypeId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

name
required
string

Name of the tag

parentTagId
integer <int32>

ID of parent tag - leave null if there is no parent

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided tag type or tag does not exist

409

The tenant for this data does not match the header tenant

post /api/v1/tagTypes/{tagTypeId}/tags
https://event-api.pingum.io/api/v1/tagTypes/{tagTypeId}/tags

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "parentTagId": 0
}

Tags

Tag Controller

Get All Tags

Returns all tags for tenant. Result can be returned in flat list or in the parent child hierarchy.

query Parameters
includeArchived
boolean
Default: false

includeArchived

buildHierarchicalList
boolean
Default: false

buildHierarchicalList

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/tags
https://event-api.pingum.io/api/v1/tags

Bulk Update Tags

Update a list of existing tags with new data.

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

Array
archived
boolean

Is the tag archived?

customActions
object (PatchTagCustomActions)
name
string

Name of the tag

parentTagId
integer <int32>

ID of parent tag - leave null if there is no parent

tagId
required
integer <int32>

ID of the Tag being updated

tagTypeId
integer <int32>

ID of the tag type associated with this tag

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event or tag or tag type does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/tags
https://event-api.pingum.io/api/v1/tags

Request samples

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

Update Tag

Update and existing tag with new data.

path Parameters
tagId
required
integer <int32>

tagId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

archived
boolean

Is the tag archived?

customActions
object (PatchTagCustomActions)
name
string

Name of the tag

parentTagId
integer <int32>

ID of parent tag - leave null if there is no parent

tagTypeId
integer <int32>

ID of the tag type associated with this tag

Responses

200

OK

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

The provided event or tag or tag type does not exist

409

The tenant for this data does not match the header tenant

patch /api/v1/tags/{tagId}
https://event-api.pingum.io/api/v1/tags/{tagId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "archived": false,
  • "customActions":
    {
    },
  • "name": "string",
  • "parentTagId": 0,
  • "tagTypeId": 0
}

Users

User Controller

Search Subscriptions

query Parameters
eventTemplateId
integer <int32>

eventTemplateId

statusId
integer <int32>

statusId

tagIds
Array of integers <int32>

tagIds

searchFields
Array of strings

searchFields

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/users/subscription/search
https://event-api.pingum.io/api/v1/users/subscription/search

Get Subscriptions for User

path Parameters
auth0UserId
required
string

auth0UserId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /api/v1/users/{auth0UserId}/subscriptions
https://event-api.pingum.io/api/v1/users/{auth0UserId}/subscriptions

Delete Subscriptions for User

path Parameters
auth0UserId
required
string

auth0UserId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

delete /api/v1/users/{auth0UserId}/subscriptions
https://event-api.pingum.io/api/v1/users/{auth0UserId}/subscriptions

Update Subscriptions for User

path Parameters
auth0UserId
required
string

auth0UserId

header Parameters
Authorization
required
string

Authorization

X-Tenant
required
string

X-Tenant

Request Body schema: application/json

request

dashboards
object (PatchSubscriptionEntity)
eventTemplates
object (PatchSubscriptionEntity)

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

patch /api/v1/users/{auth0UserId}/subscriptions
https://event-api.pingum.io/api/v1/users/{auth0UserId}/subscriptions

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "dashboards":
    {
    },
  • "eventTemplates":
    {
    }
}