Aphex Help
Go to Aphex
  • Welcome
  • Getting Started
    • Joining your Team
      • Getting Around
      • Adding Tasks
      • Linking Tasks
      • Resources
      • Map & Location
      • Readying & Publishing Plans
    • Project Set Up
      • Importing
      • Folders & Structure
      • Users
      • Views
      • Resources & Assets
      • Map
      • Publishing & Routine
  • Guides
    • Imports
      • Importing your Master Schedule (XML)
      • Migrate existing plans to Aphex (CSV)
      • Importing Folders (CSV)
    • Feature Walkthroughs
      • Creating & Sharing Published Versions
      • Understanding Resources in the Plan
      • Exporting Data to a CSV
      • Copying tasks between Projects
      • Blockers
    • Integrations
      • ArcGIS Set Up Guide
      • Getting Started with Power BI Reporting
    • Reporting
      • Power BI Templates
  • Reference Docs
    • Fundamentals
      • Organisations
      • Projects
      • Tasks
      • Task Panel
      • User Preferences and Notifications
    • Scheduling
      • Views
      • Gantt
      • Board
      • List
      • Map and Clashes
      • Status and Progress Updates
    • Project Assets
      • Project Users and Teams
      • Resources and Assets
      • Structure
    • Publish, Print & Share
      • Printing
      • Published Versions and Shared Plans
      • Readying and Reviewing Plans
    • Data
      • Imports and Exports
      • Transferring
  • Frequently Asked
    • FAQs
      • How do I Add & Remove Filters?
      • How do I create & track Milestones?
      • How do I Move Folders?
      • How to login with SSO
      • Where have my Tasks gone?
      • How do I print my Plan?
      • Can I change the sort order of Tasks and Packages?
      • How is PPC calculated in the Power BI dashboard?
      • Why can't I delete a Task?
      • Why are the successors not scheduling?
      • How do I promise Tasks?
      • How do I delete multiple Tasks?
      • Why were some Tasks skipped from updating?
      • Why can't I upload an image for my Location?
      • How do I change the non-working days of a Task?
      • How do I make changes in bulk?
      • How do I transfer my work to another User?
      • How do I add new Users to the Project?
      • What can Lite users do?
      • How do I set a Reviewer?
      • How do I reset my Password?
      • How do I set up MFA?
      • Setting up SAML SSO
      • How can I use Aphex to update P6?
    • Troubleshooting
      • Troubleshooting Aphex
      • Troubleshooting your ArcGIS integrations
    • Coming Soon
      • 2025 Pricing Update
      • Changes to View Controls & Filters
      • Changes to the WBS
      • Changes with Status
  • Policies
    • Terms & Policies
      • Compliance and Certification
      • Terms & Agreements
        • Terms of Service Overview
        • Terms of Service
        • Subprocessors List
        • Service Level Agreement
      • Policies
        • Acceptable Use Policy
        • Privacy Policy
        • Cookie Policy
        • Fair Billing Policy
        • Support Policy
  • DEVELOPER
    • API & Integration
      • Plan APIs
        • Authentication
        • Project Assets
        • Tasks
      • Published Plans (Power BI) API
      • Work Area API
Powered by GitBook
On this page
  • Overview
  • Authentication
  • Data Model
  • Limits and Restrictions

Was this helpful?

  1. DEVELOPER
  2. API & Integration

Work Area API

Last updated 3 months ago

Was this helpful?

This feature is only available on Pro+ or Enterprise plans

Overview

This endpoint provides access to the Work Areas on Published Plans for a project.

Teams generating plans utilising Map Space Locations generate a unique related dataset of real-world work areas and schedule tasks. Teams can use this location data in any of their external GIS or analytics tools with the Work Area API.

The Work Area API has three components.

Authentication

You can access the Work Area API by querying the endpoint URL for your desired project and providing a valid Token.

Finding your API URL

As a Project Administrator, head to your project in the Aphex Planner app. From the Integrations page, the API can be enabled.

This will uncover the API URL specific to that project. The URL structure will be;

https://app.aphex.co/work-areas/v1/<your_api_account_id>

Generating Tokens

From the same location you sourced the API URL, a new Token can be created.

Secret Token

You cannot retrieve the token later, so be sure to save it in a secret manager. If you lose the token, you can generate a new one.

Querying the API

To successfully authenticate your request to the API, set the Token in the Query String of the URL.

The example below can be used by replacing the API account ID and Token using those retrieved in the earlier step

https://app.aphex.co/work-areas/v1/<your_api_account_id>/t/<your_token>

Data Model

Valid requests to the API will return a JSON response consistent with the API data model.

The Work Area API Data Model contains the following objects;

Object
Example

Work Area ID

HEntifOafSu297hg3oj8.2IPGEecKYBdwrpxcwXCX

Location Name

Main Site

Location Type

Map Space

Task ID

2IPGEecKYBdwrpxcwXCX

Task Name

Build Wall

Start

2022-06-13 00:00:00+00:00

End

2022-06-14 00:00:00+00:00

Duration

2

Shift

day

Owner Display Name

Bruce Wayne

Owner Email

[email protected]

Subcontractor

Batman Ltd

WBS Path

12.2.3

WBS Name

Factories

External ID

Aiw9123

Package Code

W-203

Package Name

Internals

Task ID

2IPGEecKYBdwrpxcwXCX

Key Task

False

Status

Planned

Notes

Crane access at 10AM

Limits and Restrictions

The Work Area API has a small number of restrictions and limits to ensure the availability of the system and the security of customer data.

  • Token Management Restrictions: As covered in the Authentication section, requests to the API will only succeed if they follow the correct request structure and include both a valid URL and Token. Tokens are generated individually for a Project, by a user with Project Admin rights.

  • Token Validity Limits: Generated tokens have a maximum lifespan of 3 months to ensure that over time, project data is secure by default. On expiry, or at any time, new tokens can be generated for the project.

  • Publication Limit: To maintain system availability, a Publication Limit exists for the Work Area API. Successful API requests will return up to a maximum of five (5) of the most recent Publications of data.

  • Fair Use Policy: The API endpoint is designed to support periodic (usually weekly) requests from projects. Use of the service outside that threatens the availability of the service for other projects could result in a suspension of the service for the offending project.

Authentication
Data Model
Limits and Restrictions