Trimble Batch API

openapi: 3.2.0
info:
  title: Org Service Batch API
  description: '# Overview

    The Organizer Service allows managing hierarchical breakdown structures. Each breakdown structure is represented as a tree. Trees are organized in forests, a group of trees. Typically forests would be mapped to projects. Each tree consists of nodes. Nodes are managed as a flat list but clients are expected to organize them into the tree kind of structure based on common name prefixes. Each node has a set of links associated with it. Links are opaque strings that are expected to be interpreted by clients. Documentation for this service is available on the Trimble Developer site. # Getting started

    **You must agree to the Terms of Service to use Connect services.**


    You need to complete the steps in the Getting started guide to be able to call the API. # Concepts

    Please see Common Concepts in the Connect Platform documentation. ## Change notifications

    The Subscribe API allows getting url for creating a WebSocket connection to the service. A standard WebSocket API may be used, no additional library is needed.A webSocket connection

    may be used to receive notification messages of changes on any resource the user has access to. Notifications are delivered at best effort, in some rare cases, notifications can be lost. A periodic full refresh of the local cache is recommended. A Notification WebSocket is opened using the credentials of the subscribing user. Change notifications will be published

    for every change in each resource managed by the service if and only if the user has read access

    (org:GetXXX action) to the changed resource. After opening the WebSocket connection, the client needs to send a subscription message to start receiving change notification messages. Before that, the subscription service will send only keepalive messages. ```json

    {

    "type": "Subscribe"

    }

    ```


    The notification message has type "Data". The Notification message payload has the same syntax as BatchGetRequest, in other words, it contains objects with arrays of resource identifiers. The resource version is always included in the identifier. ```json

    {

    "type": "Data",

    "payload": { "trees":

    [

    {

    "forestId" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

    "treeId" : "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",

    "v" : 2

    }

    ]

    }

    }

    ```

    ```json

    {

    "type": "Data",

    "payload": { "nodes":

    [

    {

    "forestId" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

    "treeId" : "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",

    "nodeId" : "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"

    "v" : 9

    }

    ]

    }

    }

    ```


    The service sends periodic keepalive messages to all connected clients (type "Ka", no payload). No reply from the client is expected. In other words, the client can silently ignore these messages. Also, the client can send keepalive messages. The service will not reply to them. ```json

    {

    "type": "Ka"

    }

    ```


    ## Deprecated Change notifications

    The set of `Subscribe` APIs allows subscribing to the change notifications in different scopes (forest, tree, node). The notifications are delivered with MQTT protocol over HTTP. To consume notifications in browser-based apps you can use https://www.npmjs.com/package/cdm-notify-client as a convenient wrapper for the AWS IoT Device class. The payload of each change notification is a JSON object with a `location` property that identifies the changed resource as a relative URL

    and the `v` property that informs the new version of the changed resource. Note that notification topic names should not be parsed to get the resource identity as they might be scrambled. ## Eventual Read Consistency

    The service internally stores data in several Availability Zones within a Region. Each Availability Zone is isolated from failures in other Availability Zones and provides inexpensive, low-latency network connectivity to other Availability Zones in the same Region. This allows rapid replication of your data among multiple Availability Zones in a Region. When your application writes data to the service and receives an HTTP 200 response (OK), the write has occurred and is durable.'
  version: v1
  contact:
    name: Trimble Connect Support
    url: https://connect.trimble.com
    email: connect-support@trimble.com
  license:
    name: Trimble Connect SDK Internal Use License
    url: https://developer.trimble.com/docs/connect/terms/SDK-IU-license-agreement
  termsOfService: https://developer.trimble.com/docs/connect/terms
servers:
- url: https://org-api.eu-west-1.connect.trimble.com/v1
  description: Production EU (Ireland)
- url: https://org-api.eu-west-2.connect.trimble.com/v1
  description: Production UK (London)
- url: https://org-api.us-east-1.connect.trimble.com/v1
  description: Production US East (N. Virginia)
- url: https://org-api.ap-southeast-1.connect.trimble.com/v1
  description: Production Asia Pacific (Singapore)
- url: https://org-api.ap-southeast-2.connect.trimble.com/v1
  description: Production Asia Pacific (Sydney)
tags:


# --- truncated at 32 KB (50 KB total) ---
# Full source: https://artifacts.apis.io/trimble/openapi/trimble-batch-api-openapi.yml