Tasks & Notes¶

model.CreateTaskNote(ownerId, aboutPersonId, assigneeId, roleId, isNote, instructions, notes, dueDate, keywordIdList, sendEmails)¶

Parameters:

ownerId (int) – PeopleId of the person who owns the Task. This is a required field.
aboutPersonId (int) – PeopleId of the person the Task is about. This is a required field.
assigneeId (int) – PeopleId of the person the Task is assigned to. This is an optional field.
roleId (int) – RoleId of the Role you want to limit the Task or Note to. This is an optional field.
isNote (str) – Boolean. This will either take a 1 or 0, depending on true or false, or a “True” or “False.” This field is for telling the api how to save this Task or Note.
instructions (str) – String, for a Task or Note.
notes (str) – String, for a Task or Note.
dueDate (date) – Due date for the Task. This is an optional field.
keywordIdList (list) – List of the KeywordIds that you want to assign to the Task or Note. This is an optional field. These are the acceptable formats: [1,2,3,4,5] or (1,2,3,4,5) or {[1],[2],[3],[4],[5]}
sendEmails (bool) – This optional field determines whether a notification email will be sent to the assignee. If omitted, the default is True (an email will be sent).

A Task will be created for the minister (lay or staff person). This person must be a User, i.e. have an account to login with. The Task is a ministerial Task, presumably to contact the person the Task is about.

By default, an email will be sent to the minister with a link to complete the Task with a Note record, but this email can be disabled by setting the sendEmails parameter to False.

model.GetExtraQuestions(taskNoteId)¶

Parameters:: taskNoteId (int) – Required. The Task/Note ID.

Get the extra questions for a given Task/Note.

model.GetExtraQuestionsByKeywords(keywords)¶

Parameters:: keywords (list) – Required. List of keyword IDs.

Get the extra questions for a given list of keywords.

model.GetExtraQuestionsWithAnswers(taskNoteId)¶

Parameters:: taskNoteId (int) – Required. The Task/Note ID.

Get the extra questions with answers for a given Task/Note.

model.GetTaskNote(taskNoteId)¶

Parameters:: taskNoteId (int) – Required. The Task/Note ID.

Get a specific Task/Note by ID.

model.GetTaskNoteKeywordIds(taskNoteId)¶

Parameters:: taskNoteId (int) – Required. The Task/Note ID. To find this, use SQL or, if creating the Task/Note programmatically, retrieve it from the CreateTaskNote function.

Get a list of KeywordIds for a given TaskNote.

model.GetTasksNotes(numOfTaskNotes, notesOnly, orgId, statuses, peopleId, filter)¶

Parameters:

numOfTaskNotes (int) – Optional. The number of Task/Notes to return.
notesOnly (bool) – Optional. If True, only Notes will be returned.
orgId (int) – Optional. Return Task/Notes for a specific Organization.
statuses (list) – Optional. Array of status IDs to filter by.
peopleId (int) – Optional. Return Task/Notes for a specific person.
filter (str) – Optional. Filter string to search for.

Get Task/Notes based on the provided filters.

model.SetTaskNoteKeywordIds(taskNoteId, keywordIds)¶

Parameters:

taskNoteId (int) – Required. The Task/Note ID. To find this, use SQL or, if creating the Task/Note programmatically, retrieve it from the CreateTaskNote function.
keywordIds (int[]) – An array of keyword IDs that the Task/Note should have. Any other Keywords that the Task/Note already has will be removed.

Updates the keywords for a given Task/Note to match the new list. Any other Keywords that the Task/Note already has will be removed. If you use Extra Values connected to these keywords, you may find that this function affects the User’s view of Tasks/Notes in ways you may not want.

model.SetTaskNoteStatus(taskNoteId, status)¶

Parameters:

taskNoteId (int) – Required. The Task/Note ID. To find this, use SQL or, if creating the Task/Note programmatically, retrieve it from the CreateTaskNote function.
status (int|string) – The new status for the Task/Note. Can be ‘Complete’, ‘Pending’, ‘Accepted’, ‘Declined’, ‘Archived’, or ‘Note’. Can also be the corresponding numerical IDs used in the database.

Update the status of a Task. Also can be used to convert a Note to a Task or vice versa. This will NOT validate Extra Values or required content on the Task/Note. This does NOT send emails notifying anyone about the change.

model.TaskNoteAccept(taskNoteId)¶

Parameters:: taskNoteId (int) – Required. The Task/Note ID.

Accept a Task.

model.TaskNoteComplete(taskNoteId, note, extraQuestions)¶

Parameters:

taskNoteId (int) – Required. The Task/Note ID.
note (str) – The note to add to the Task.
extraQuestions (list) – List of extra questions with answers.

Complete a Task.

model.TaskNoteDecline(taskNoteId, reason)¶

Parameters:

taskNoteId (int) – Required. The Task/Note ID.
reason (str) – The reason for declining the Task.

Decline a Task.

model.TaskNoteEdit(viewModel)¶

Parameters:: viewModel (object) – The Task/Note view model with updated values.

Edit a Task/Note.

model.TaskNoteMassAddKeywords(taskNoteIdList, keywordsArray)¶

Parameters:

taskNoteIdList (list) – Required. List of Task/Note IDs.
keywordsArray (list) – Required. List of keyword IDs to add.

Mass add keywords to Tasks/Notes.

model.TaskNoteMassArchive(taskNoteIdList)¶

Parameters:: taskNoteIdList (list) – Required. List of Task/Note IDs.

Mass archive Tasks/Notes.

model.TaskNoteMassAssign(taskNoteIdList, assigneeId)¶

Parameters:

taskNoteIdList (list) – Required. List of Task/Note IDs.
assigneeId (int) – Required. PeopleId of the person to assign the Tasks to.

Mass assign Tasks to a person.

model.TaskNoteMassComplete(taskNoteIdList, completionDate, note)¶

Parameters:

taskNoteIdList (list) – Required. List of Task/Note IDs.
completionDate (date) – Required. The date of completion.
note (str) – Required. The note to add to the Tasks.

Mass complete Tasks.

model.TaskNoteMassDelete(taskNoteIdList)¶

Parameters:: taskNoteIdList (list) – Required. List of Task/Note IDs.

Mass delete Tasks/Notes.

model.TaskNoteMassUnarchive(taskNoteIdList)¶

Parameters:: taskNoteIdList (list) – Required. List of Task/Note IDs.

Mass unarchive Tasks/Notes.

Latest Update

4/25/2025

Hid obselete function documentation.