Tasks and Task Comments

Detailed mapping of the fields used in POST and GET requests to fetch and create customer tickets. This allows you to bring in tasks, comments, and attachments, providing visibility per group.

Set-up

This information is required when implementing to Tasks or Task Comments via the Ideon API.

  • idresources for each request

  • API access

Endpoints

Here are the available tasks endpoints:

GET:

  • /coverage_periods/{id}/tasks

  • /tasks

  • /tasks/{id}

POST:

  • /coverage_periods/{id}/tasks

PUT:

  • /tasks/{id}/complete

  • /tasks/{id}/reopen

Here are the additional endpoints that allow your team to provide comments on a given Task and work with Ideon's team directly in your UI

Task Comments

POST:

  • /comments/:id/attachments

  • /tasks/{id}/comments

Design Questions

The way you use the Task and Task Comments endpoints depends on the needs of your users. Consider using the questions below to evaluate your implementation and how the design fits your user:

  • What actions must we let the user preform?

    • Are your users trying to create questions or raise issues to the Ideon Team?

    • Are they commenting on Workflow Tasks?

    • Are they monitoring the progress of a connection from intial to production?

  • What training will they have on the Ideon or other systems?

  • What level of security will be required to view the data?

  • What information will be displayed while a user views or interacts with a Task or Task Comment?

  • At what level will the user be viewing this information - member, group, across many groups?

  • What data relationships are important to consider in your system - Examples below:

    • Coverage Periods can have many Tasks, a Task can belong to one coverage period

    • Tasks can have many comments and attachments, comments and attachments can belong to one coverage period

    • Members can belong to one Group, but can have coverages, discrepancies or be related to many Coverage Periods.

Request Mapping

POST:

  • /coverage_periods/{id}/tasks

  • /comments/:id/attachments

  • /tasks/{id}/comments

PUT:

  • /tasks/{id}/complete

  • /tasks/{id}/reopen

For task comments:

Ideon
Usage & Mapping

comment

A stringfield that contains the text of the comment.

created_by

The emailaddress of a user who created this comment.

Required format:

  • text@text.text

Must be an email registered as a userwith Ideon.

For task attachments:

Ideon
Usage & Mapping

file_name

A string field that names the file provided as an attachment

url

This is a multipart HTTP request.

Response Mapping

GET:

  • /coverage_periods/{id}/tasks

  • /tasks

  • /tasks/{id}

/coverage_periods/{id}/tasks is a pagniated endpoint - you can provide the parameters "per_page" and "page" to view all available tasks.

For all GET endpoints, we respond with the taskschema

Ideon
Definition & Mapping

assigned_to

This object holds information on the current assignee of the task or customer ticket.

Provided in the response:

  • id - associated with a user

  • email - email address of the user

  • created_at

  • deactivated_at - provided if the current assignee is presently inactive

  • role_names - user roles associated with the email

Must be an email registered as a userwith Ideon.

created_at

This is the date on which a task was created.

created_by

This object holds information on the user that created the task or customer ticket.

Provided in the response:

  • id - associated with a user

  • email - email address of the user

  • created_at

  • deactivated_at - provided if the current assignee is presently inactive

  • role_names - user roles associated with the email

Must be an email registered as a userwith Ideon.

comments

Each task comment listed in this object will have:

  • attachments

  • comment

  • created_at

  • created_by

  • id

  • task_id

completed_at

This is the timestamp describing when a task was Completed.

This is only present on tasks when the result is completed, skipped or canceled.

completed_by

Returns a user, Provided in the response:

  • id - associated with a user

  • email - email address of the user

  • created_at

  • deactivated_at - provided if the current assignee is presently inactive

  • role_names - user roles associated with the email

Must be an email registered as a userwith Ideon.

coverage_period_id

This is an id (unique "uuid" format) of the given coverage period.

id

This is the id (unique "uuid" format) of this created Task or Customer Ticket.

notes

This is a string field that can display relevant notesprovided by the Ideon team.

result

This is a string field. There are expected values that could be provided:

  • completed

  • skipped

  • unstarted

  • in_progress

  • canceled

severity

This is a string field that describes a given issue's level of severity :

  • normal

  • escalation

  • access_to_care

type

These are the Tasks associated with a given coverage period.

The names of these tasks are listed, currently these are not a fixed enum of values:

  • initial qa

  • final qa

  • request account structure

    • for file-based connections

  • request api access

    • for api connections

  • configuration

  • configuration qa

  • testing qa

    • failures during these QA steps result in a resubmit task

  • send test file

  • review pre-production discrepancies

  • clear for production

  • resubmit

    • This task is assigned externally to a user at the Platform, for resubmission of data to Ideon.

  • customer ticket

  • ideon inquiry

    • customer tickets and inquiries are raised to Ideon using the Dashboard or POST endpoint to create a Task

updated_at

This is a timestamp of when this task was last updated by a user.

See Additional Documentation for links to our current API documentation.

PreviousDiscrepancy Standard MessagesNextFrequently Asked Questions

Last updated

Was this helpful?