ProjectSight API

picture_as_pdf PDF version

You can use the ProjectSight API to view and update information in your portfolios and projects. To request access, email ProjectSightAPISupport@trimble.com.

After you register your application, you can subscribe it to the API and then acquire a security token. The token is associated with your Trimble account credentials and is valid for the period of time that's defined in the token response.

  1. Sign in to API Cloud with your Trimble account.
  2. On the Discover API page, click ProjectSight or ProjectSight-EU.
  3. Click Subscriptions.
  4. In the Create Subscription section, select your application, and then click Subscribe.
    5. Create subscription
  1. In API Cloud, click ProjectSight or ProjectSight-EU.
  2. Click Get Key.
  3. Copy the following values:
    • Application Name
    • Consumer Key
    • Consumer Secret
    • Package & Usage Plan Key
    Gey Key info
  4. To obtain a security token from Trimble Identity, POST a request to https://id.trimble.com/oauth/token with the following information:
    • Header: Authorization

      • Value: Basic Key

      The key in the Authorization value is a single string that consists of the Consumer Key and the Consumer Secret, separated by a colon (ConstumerKey:ConsumerSecret) and then Base64-encoded.

    • Header: Content-Type

      • Value: application/x-www-form-urlencoded

    • Body:

      • grant_type=client_credentials

      scope=[Application Name]

      Replace [Application Name] with the value copied in the previous step.

      Example:

      POST https://id.trimble.com/oauth/token/
      Authorization: Basic TE9pU...
      Content-Type: application/x-www-form-urlencoded
      Accept: application/json
      Cache-Control: no-cache

      grant_type=client_credentials
      scope=Trimble-ProjectSightApp1

    • If the request is successful, the response contains a Json class with several properties.
      • The access_token property is used to make the API calls.
      • The expires_in property defines how many seconds the token is valid for.
    • If the request fails, the response includes two fields, error and error_description, that describe the problem.
  1. In API Cloud, click ProjectSight or ProjectSight-EU.
  2. For information on how to access the API endpoints, Click How to > Consume API.
    3. How To link
    • To find the URL that you will use to access the API for your application, click API Endpoint.
      • URL to access API
    • To find a specific endpoint, click Documentation.
      • Find endpoint in documentation
  1. Ask Trimble Support to create a new application in API Cloud.
  2. Subscribe to the new application, and use its consumer key and consumer secret for your ProjectSight integrations.
    1. Sign in to API Cloud, and click ProjectSight or ProjectSight-EU.
    2. Click the Subscriptions tab.
    3. In the Create Subscription section, select the new application and then click Subscribe.
      4. Subscribe to API
    4. Click Get Key.
      5. Get key
    5. To view and copy the consumer key and consumer secret for the new application, select the new application from the list.
      6. Copy key and secret
    6. Update your ProjectSight integrations with the new consumer key and consumer secret.

      7. The Package & Usage Plan Key (i.e., x-api-key HTTP header) does not change. Only the Consumer Key and Consumer Secret are unique to each application subscription.

  3. To remove the subscription to the old application, click Revoke Key beside the old application.
    4. Revoke key of old subscription

Supported features

  • ActionItem
  • ApplicationForPayment
  • Budget
  • BudgetCodeStructure
  • BudgetGroup
  • ChangeOrderRequest
  • Checklist
  • Company
  • Contract
  • ContractInvoice
  • DailyReport
  • Drawing
  • DrawingSet
  • FieldWorkDirective
  • File
  • Folder
  • Forecast
  • GeneralInvoice
  • Issue
  • LookupList
  • Notice
  • POCatalog
  • Portfolio
  • PotentialCO
  • PrimeContractCO
  • Project
  • PunchList
  • PurchaseOrder
  • ReportGenerator
  • RFI
  • Role
  • SafetyNotice
  • SubContractCO
  • Submittal
  • SubmittalPackage
  • Transmittal
  • User

For the supported record types, the following API operations are available:

  • Get a record
  • Delete a record
  • Get a collection of records
  • Create or update a record
  • Get a collection of records based on a query request
  • Get workflow states for records
  • Get a list of available reports
  • Get a list of available UDFs

Some record types have different operations. To see the full list, refer to the API documentation for ProjectSight or ProjectSight-EU.