You are here

Functionality Overview

The tables here list the Core and Field API capabilities.

Core APIs

DirectorySearch Project directory - returns selected details of matching users and groups based on specified search criteria.
Global directory
- returns selected details of matching users based on specified search criteria.
ListUsers in a group - returns details of users in specified group.
ViewOrganization information (from global directory) - returns details of specified organization in the global directory.
User information (from global directory) - returns details of specified user in the global directory.
User information (from project directory) - returns details of specified user in the project directory.
GetOrganization logo - retrieves the logo image for the specified organization.
ProjectsListAvailable projects - returns list of projects that the requesting user has access to, including project details.
Get Project logo - retrieves the project logo image for the specified project.
TasksGetTask count - returns count of tasks.
Task details - returns details of tasks.
Documents - RetrieveList/SearchDocuments - returns list of IDs of documents based on specified search criteria.
ViewDocument schema - returns the schema for the specified project's document register.
Document metadata - returns the detailed metadata for a specified document.
Document event log - returns content of the event log for the specified document.
DownloadDocument attachments - delivers the actual file associated with the specified document.
Document attachments with mark-ups - delivers a TIFF conversion of the file with mark-ups shown.
Documents - CreateRegisterNew document - registers a new document in the register including the backing file.
SupersedeExisting document - supersedes the specified document with another revision (including the backing file).
Mail - RetrieveList/SearchMail - returns list of IDs of mails based on specified search criteria.
ViewMail schema - returns the schema for the specified project's mail register.
Mail detail - returns details of the specified mail ID including all metadata, attributes, mail forms data, a list of file attachments, and the full body/content.
Mail thread - returns the details of the full thread of mails related to the specified mail item.
DownloadMail attachments - delivers the actual file(s) associated with the specified mail.
Mail attachments with mark-ups - delivers a TIFF conversion of the file with mark-ups shown.
Mail - CreateGenerateNew mail - create new project mail item issued to specified recipients (including all metadata, attributes, mail forms data, and attachments).
Reply mail - create a new project mail item in reply to an existing mail (including all metadata, attributes, mail forms data, and attachments).
Forward mail - create a new project mail item as a forward from an existing mail (including all metadata, attributes, mail forms data, and attachments).
RegisterIncoming mail - register an external correspondence in your organization's mail Inbox.

Field APIs

ProjectsListAvailable projects - returns list of projects that the requesting user has access to, including project details.
Search Project - returns project details based on specified search criteria.
AreasListAvailable areas - returns the areas configured for the given project.
List/Search/FilterIssues - returns list of issues with all the details (including photos) based on specified search criteria (issues can be filtered by status, due date, assigned to, etc.).
View an issueIssue details - returns issue details (including photos) for the specified issue ID.
View issues of child areasIssues - returns list of issues with all the issue details for parent and all subsequent child areas.
View issue typesAvailable issue types - returns issue types for a given project.
DownloadPhoto attachments with mark-ups - delivers the file associated with the specified attachment ID.
Checklist TemplatesList/SearchAvailable templates - returns list of checklists templates configured for the given project.
ViewTemplates - view template details based on the specified search criteria.
View by versionTemplates - view template details based on the checklist template's version ID.
ChecklistsListAvailable checklists - returns list of checklists for the given project and area.
ViewChecklist details - returns checklist details for the given checklist ID for a project.
Search/FilterChecklists - returns checklists and additional relevant details based on the specified search criteria (checklists can be filtered by status, modified date, etc.).
View checklists of child areasChecklists - returns list of checklists with all the details for parent and all subsequent child areas.
DownloadPhoto attachments with mark-ups - delivers the file associated with the specified attachment ID.

Was this article helpful?

Thanks. A ticket has been opened with the Support Central team.