Function Reference for apiVersion:2

Operator and AccessToken scopes

Accounts, Account Accesses, Short Domains, Domains

.sharedAccount().read();                     // Read all shared accounts
.sharedAccount(id).read();                   // Read a single shared account
.sharedAccount(id).update(AccountDocument);  // Update a shared account

.sharedAccount(id).access().read();                    // Read all account accesses
.sharedAccount(id).access(id).read();                  // Read a single account access
.sharedAccount(id).access(id).update(AccessDocument);  // Update a single account access

.sharedAccount(id).shortDomain().read();  // Read a single account's short domains

.sharedAccount(id).domain().read();  // Read a single account's domains

Operator Accesses

.sharedAccount(id).operatoAccess().read();     // Read all account's operator accesses
.sharedAccount(id).operatoAccess().create(OperatorAccessDocument);  // Create account's operator access
.sharedAccount(id).operatoAccess(id).read();  // Read a single account's operator access
.sharedAccount(id).operatoAccess(id).update(OperatorAccessDocument);  // Update a single account's operator access
.sharedAccount(id).operatoAccess(id).delete();  // Delete a single account's operator access

Access Policy

.accessPolicy().read();     // Read all access policies
.accessPolicy().create(AccessPolicyDocument);  // Create access policy
.accessPolicy(id).read();  // Read a single access policy
.accessPolicy(id).update(AccessPolicyDocument);  // Update a single access policy
.accessPolicy(id).delete();  // Delete a single access policy

Access Token

.accessToken().read();     // Read all access tokens
.accessToken().create(AccessTokenDocument);  // Create access token


.action(type).create(ActionDocument);  // Create an action
.action(type).read();                  // Read all actions of a type

.action(type, id).read();              // Read an action
.action(type, id).delete();            // Delete an action

Action Types

.actionType().create(ActionTypeDocument);      // Create an action type
.actionType().read();                          // Read all action types

.actionType(type).read();                      // Read a single action type
.actionType(type).update(ActionTypeDocument);  // Uppdate an action type
.actionType(type).delete();                    // Delete an action type


.collection().create(CollectionDocument);            // Create a collection
.collection().read();                                // Read all collections

.collection(id).read();                              // Read a collection
.collection(id).update(CollectionDocument);          // Update a collection
.collection(id).delete();                            // Delete a collection

.collection(id).thng().read();                       // Read all Thngs in a collection
.collection(id).thng().update(thngIds);              // Add Thngs to a collection
.collection(id).thng().delete();                     // Remove all Thngs in a collection

.collection(id).thng(id).delete();                   // Remove a Thng from a collection

.collection(id).collection().read();                 // Read all collections in a collection
.collection(id).collection().create(collectionIds);  // Add collections to a collection
.collection(id).collection().delete();               // Remove all collections from a collection


.me().read();     // Read API key access


.place().create(PlaceDocument);    // Create a place
.place().read();                   // Read all places

.place(id).read();                 // Read a place
.place(id).update(PlaceDocument);  // Update a place
.place(id).delete();               // Delete a place

Products, Product Properties, Product Redirections

.product().create(ProductDocument);                  // Create a product
.product().read();                                   // Read all products

.product(id).read();                                 // Read a product
.product(id).update(ProductDocument);                // Update a product
.product(id).delete();                               // Delete a product

.product(id).property().read();                      // Read product properties
.product(id).property().update(PropertiesDocument);  // Update product properties

.product(id).property(key).read();                   // Read product property history
.product(id).property(key).update(value);            // Update a product property
.product(id).property(key).delete();                 // Delete a product property

.product(id).redirection().create(RedirectionDocument);  // Create a product's redirection
.product(id).redirection().read();                       // Read a product's redirection
.product(id).redirection().update(RedirectionDocument);  // Update a product's redirection
.product(id).redirection().delete();                     // Delete a product's redirection

Projects, Applications, Reactor, Application Redirector

.project().create(ProjectDocument);                        // Create a project
.project().read();                                         // Read all projects

.project(id).read();                                       // Read a project
.project(id).update(ProjectDocument);                      // Update a project
.project(id).delete();                                     // Delete a project

.project(id).application().create(ApplicationDocument);    // Create an application
.project(id).application().read();                         // Read all applications in a project

.project(id).application(id).read();                       // Read an application
.project(id).application(id).update(ApplicationDocument);  // Update an application
.project(id).application(id).delete();                     // Delete an application

.project(id).application(id).secretKey().read();  // Read Trusted Application API Key

.project(id).application(id).redirector().read();  // Read an application
.project(id).application(id).redirector()          // Update an application

.project(id).application(id).reactor.log().read();         // Read Reactor logs

.project(id).application(id).reactor.script().read();  // Read the Reactor script
.project(id).application(id).reactor.script()          // Update the Reactor script

.project(id).application(id).reactor.schedule()    // Create a Reactor schedule
.project(id).application(id).reactor.schedule()    // Read all Reactor schedules
.project(id).application(id).reactor.schedule(id)  // Read a Reactor schedule
.project(id).application(id).reactor.schedule(id)  // Update a Reactor schedule
.project(id).application(id).reactor.schedule(id)  // Delete a Reactor schedule

Purchase Orders

.purchaseOrder().create(PurchaseOrderDocument);  // Create a purchase order
.purchaseOrder().read();                         // Read all purchase orders

.purchaseOrder(id).read();                       // Read a purchase order
.purchaseOrder(id).update();                     // Update a purchase order
.purchaseOrder(id).delete();                     // Delete a purchase order

Account Redirector

.redirector().read();                      // Read account Redirector
.redirector().update(RedirectorDocument);  // Update account Redirector

Shipment Notices

.shipmentNotice().create(ShipmentNoticeDocument);  // Create a shipment notice
.shipmentNotice().read();                          // Read all shipment notices

.shipmentNotice(id).read();                        // Read a shipment notice
.shipmentNotice(id).update();                      // Update a shipment notice
.shipmentNotice(id).delete();                      // Delete a shipment notice

Thngs, Thng Properties, Thng Redirections, Thng Commission State

.thng().create(ThngDocument);                     // Create a Thng
.thng().read();                                   // Read all Thngs

.thng(id).read();                                 // Read a Thng
.thng(id).update(ThngDocument);                   // Update a Thng
.thng(id).delete();                               // Delete a Thng

.thng(id).location().read();                      // Read a Thng's location
.thng(id).location().update(LocationDocument);    // Update a Thng's location

.thng(id).property().read();                      // Read Thng properties
.thng(id).property().update(PropertiesDocument);  // Update Thng properties

.thng(id).property(key).read();                   // Read a Thng property's history
.thng(id).property(key).update(value);            // Update a Thng property's history
.thng(id).property(key).delete();                 // Delete a Thng property's history

.thng(id).redirection().create(RedirectionDocument);  // Create a Thng's redirection
.thng(id).redirection().read();                       // Read a Thng's redirection
.thng(id).redirection().update(RedirectionDocument);  // Update a Thng's redirection
.thng(id).redirection().delete();                     // Delete a Thng's redirection

.thng(id).commissionState().read();  // Read Thng commissioning state