|
|
Tasks
Retrieve a Single Task by id
Retrieves information about a specific task (using the "id" parameter).
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| id |
Number |
Yes
|
|
Id of the specific task that you would like to retrieve.
|
Retrieve Tasks
This method retrieves tasks in your workspace based on various filter criteria. The filter parameters for this method work in conjunction on an “AND-basis”. For example, If you pass in the value “true” for filter_by_no_due_date and value “12345” for filter_by_event_Id, you’ll get back all the tasks with no due date for the event that has Id of 12345. Also, you can only pass in one value for each filter parameter; this means that you can’t pass in “12345, 56789” as the value for the filter_by_event_id filter parameter expecting to get back all the tasks for the two events 12345 and 56789.
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| filter_by_event_id |
Number |
No
|
|
Only include tasks from this given event.
|
| filter_by_general_tasks_only |
Number |
No
|
default: false
|
Only include general tasks (tasks on the main task board that do not belong to a particular event). Note: this filter cannot be used in conjunction with the filter_by_event_id filter.
|
| filter_by_incomplete_only |
Boolean |
No
|
default: false
|
If you pass in the value "true" for this parameter, the result will only include tasks that are NOT marked as Completed.
|
| filter_by_completed_only |
Boolean |
No
|
default: false
|
If you pass in the value "true" for this parameter, the result will only include tasks that are marked as Completed.
|
| filter_by_no_due_date |
Boolean |
No
|
default: false
|
If you pass in the value "true" for this parameter, the result will only include tasks that do not have a due date set.
|
| filter_by_due_date_greater_than_or_equal_to |
Date |
No
|
|
Only include tasks that have a due date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD. Note: this filter cannot be used in conjunction with the filter_by_no_due_date filter.
|
| filter_by_due_date_smaller_than_or_equal_to |
Date |
No
|
|
Only include tasks that have a due date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD. Note: this filter cannot be used in conjunction with the filter_by_no_due_date filter.
|
| filter_by_has_assignee |
String |
No
|
default: false
|
Only include tasks that have an assignee. Unassigned tasks will get excluded.
|
| filter_by_assignee_user_id |
String |
No
|
|
Only include tasks that are assigned to this user. You can get a list of UserId's in your workspace from the /v1/references/users_and_resources endpoint. Note: If you want to retrieve the tasks that are unassigned, include this parameter and pass in the word "null" as the value for it.
|
| filter_by_task_name_contains_text |
String |
No
|
|
Only include tasks that have the given text in the task Name. For example: If you want to retrieve all the tasks that have the word “order” in the task Name field, pass in the value “order” for the filter_by_task_name_contains_text parameter. Note: this text search is not case-sensitive.
|
| filter_by_integration_metadata_field_1 |
String |
No
|
max length: 3000
|
Only include tasks that have their integration_metadata_field_1 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField1 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).
|
| filter_by_integration_metadata_field_2 |
String |
No
|
max length: 3000
|
Only include tasks that have their integration_metadata_field_2 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField2 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).
|
| filter_by_integration_metadata_field_3 |
String |
No
|
max length: 3000
|
Only include tasks that have their integration_metadata_field_3 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField3 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).
|
| filter_by_integration_metadata_field_4 |
String |
No
|
max length: 3000
|
Only include tasks that have their integration_metadata_field_4 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField4 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).
|
| filter_by_integration_metadata_field_5 |
String |
No
|
max length: 3000
|
Only include tasks that have their integration_metadata_field_5 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField5 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the "external id" of the task from another system you're integrating with).
|
| hydrate_task_comments |
Boolean |
No
|
default: false
|
Include the comments collection for each task in the result set. Note: hydrating the comments collection for each task in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the list of comments for each task in the result set.
|
Add a Task
The response will contain an object representing the newly added task.
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| name |
String |
Yes
|
max length: 400
|
The name/short description of the task.
|
| event_id |
Number |
No
|
|
The id of the event you would like to add the task under. If this value is not provided, the task will be added as a general (non-event-specific) task in your workspace (under the main Task Board).
|
| task_section_id |
Number |
No
|
|
The id of the event task section that the task should be placed under. Leave this value blank if you don't want to place/categorize the task under a specific event task section. Note: you can get a list of available Task Section Ids for a given event using the /v1/event/info endpoint.
|
| is_completed |
Boolean |
No
|
default: false
|
Boolean representing whether or not the task has been completed.
|
| due_date |
Date |
No
|
|
Task due date (format: YYYY-MM-DD).
|
| assignee_user_id |
String |
No
|
|
The id of the user you would like to assign the task to. If you want the task to be unassigned, leave the value for this parameter blank. To get a list of all the user ids in your workspace, use the /v1/references/users_and_resources API endpoint. Users that can have tasks assigned to them will have their can_have_tasks_assigned property set to true.
|
| details |
String |
No
|
|
The details/description of the task. Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.
|
| integration_metadata_field_1 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_2 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_3 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_4 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_5 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
Delete a Task
Permanently deletes a task. It cannot be undone.
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| id |
Number |
Yes
|
|
The id of the task you would like to delete.
|
Update a Task
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| id |
Number |
Yes
|
|
The Id of the task you would like to update.
|
| name |
String |
No
|
max length: 400
|
The name/short description of the task.
|
| task_section_id |
Number |
No
|
|
The id of the event task section that the task should be placed under. If you don't want to place/categorize the task under a specific event task section, pass in the value
ull" for this parameter. Note: you can get a list of available Task Section Ids for a given event using the /v1/event/info endpoint.
|
| is_completed |
Boolean |
No
|
default: false
|
Boolean representing whether or not the task has been completed.
|
| due_date |
Date |
No
|
|
Task due date (format: YYYY-MM-DD). If you don't want the task to have a due date, pass in the value "null" for this parameter.
|
| assignee_user_id |
String |
No
|
|
The User Id of the user you would like to assign the task to. If you want the task to be unassigned, pass in the value "null" for this parameter. To get a list of all the User Ids in your workspace, use the /v1/references/users_and_resources API endpoint; users who can have tasks assigned to them will have their can_have_tasks_assigned property set to true.
|
| details |
String |
No
|
|
The details/description of the task. Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.
|
| integration_metadata_field_1 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_2 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_3 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_4 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
| integration_metadata_field_5 |
String |
No
|
max length: 3000
|
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the "external id" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.
|
Retrieve Task Comments
This method retrieves task comments in your workspace based on various filter criteria. The filter parameters for this method work in conjunction on an “AND-basis”. For example, If you pass in the value “true” for filter_by_no_due_date and value “12345” for filter_by_event_Id, you’ll get back all the tasks with no due date for the event that has Id of 12345. Also, you can only pass in one value for each filter parameter; this means that you can’t pass in “12345, 56789” as the value for the filter_by_event_id filter parameter expecting to get back all the tasks for the two events 12345 and 56789.
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| filter_by_event_id |
Number |
No
|
|
Only include task comment for tasks from this given event.
|
| filter_by_task_id |
Number |
No
|
default: false
|
Only include task comments for this specific task.
|
| hydrate_task |
Boolean |
No
|
default: false
|
Include the task object for each task comment in the result set. Note: hydrating the task object for each task comment in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the task object each comment in the result set.
|
Retrieve a Single Task Comment by id
Retrieves information about a specific task comment (using the "id" parameter).
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| id |
Number |
Yes
|
|
Id of the specific task comment that you would like to retrieve.
|
Add a Comment to a Task
The response will contain an object representing the newly added task comment.
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| task_id |
Number |
Yes
|
|
The id of the task you would like to add the comment to.
|
| comment |
String |
Yes
|
|
The text of comment you would like to add. Only accepts plain text. Any html tags in the value you pass in will be stripped.
|
Update a Task Comment
Updates the text of a given comment on a task.
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| id |
Number |
Yes
|
|
The Id of the task comment you would like to update.
|
| comment |
String |
Yes
|
|
The text that you would like to replace the existing comment with. Only accepts plain text. Any html tags in the value you pass in will be stripped.
|
Delete a Task Comment
Permanently deletes a task. It cannot be undone.
Parameters
|
Name
|
Type
|
Required?
|
Details
|
Description
|
| api_key |
String |
Yes
|
|
|
| id |
Number |
Yes
|
|
The Id of the task comment you would like to delete.
|
|