databaseName

The "databaseName" property specifies the database that contains an object, such as a table or code package. If it is set to null or is omitted, it defaults to the default database of the JSON Action session, see "createSession" and the "defaultDatabaseName" property. 

You specify this property when you want to use a different database instead of the default. 

This property is useful because objects, such as tables and code packages, can have the same name in multiple databases. This feature allows you to create multiple environments in the same server and reuse the same JSON actions in each environment. For example, you can create "dev", "test", "stage", and "prod" databases on the same server and use the "defaultDatabaseName" or "databaseName" properties to specify the desired environment.

It is an error to set "databaseName" to the empty string "".

If no default database is specified during "createSession", the server sets the "defaultDatabaseName" to the "defaultDatabaseName" value specified in the services.json file.

description

Optional with default of "".

"unknown" for Thing API 

0 to 65,500 bytes

1 to 512 bytes for the Thing API 

includeInputConnectorProperties

The "includeInputConnectorProperties" property specifies names of connector properties. When it is included in the request, the response includes an "inputConnectors" list that contains all the connectors related to the request. Each item in the list is an object that contains the specified properties.

For more details, see "includeInputConnectorProperties".

"connectorName"

"connectorId"

"settings"

"serviceName"

"metadata"

includeOutputConnectorProperties

The "includeOutputConnectorProperties" property causes the response to include an "outputConnectors" list that contains all the connectors related to the request. Each item in the list is an object that contains the specified properties.

For more details, see "includeOutputConnectorProperties".

"connectorName"

"connectorId"

"settings"

"serviceName"

"metadata"

includeThingProperties

"id"

"thingName"

"status"

"manufacturer"

"model"

"serialNumber"

"type"

"purpose"

"description"

"location"

"labels"

"hostnames"

"metadata"

"photo"

includeTopicProperties

labels

The "labels" property specifies 1 or more label objects to be assigned to records. It can assign many labels to the same record. Each label may belong to any group. Each specified label must have already been created using the "createLabel" action so that it exists in the label table.

The "labels" property must contain at least one label object. Each label object specifies the label's group name and label name. 

• The "name" property is required and must be set to a string value. If it is omitted or set to null, the action returns an error. 
• The "group" property is optional. If it is omitted or set to null, the action sets it to the empty string "". 

When using tag actions, the optional "labels" property assigns zero or more labels to a tag. It defaults to []. Each label is a string from 1 to 64 bytes. You can use it to do lookups and filtering. You can display a list of existing stages, add new ones, rename them, and deprecate them.

When you use the "alterThing" action, omit the "labels" property to leave existing labels unchanged or specify the complete set of labels. The action does not allow you to change one label at a time.

You can use the "labelsFilter" property to lookup and filter things.

The Tag API implements the "labels" property using the Label API. 

• The API stores and manages labels in the label group, "faircom/labels".
• An API client can retrieve a list of all labels by using the "listLabels" action with "partialGroupFilter": "faircom/labels".
• An API client should use the Thing API's "labels" property to manage the labels assigned to a thing. It should not use the Label API to rename, link, or unlink host names to things.

Required - No default value

Defaults to

[] when using tag actions

1 or more label objects

Values are managed in the Label API with the group of "faircom/edge/label".

metadata

onSyncConflict

ownerName

The "ownerName" property specifies the account that owns an object, such as a table or code package. See "createSession" and the "defaultOwnerName" property for more details. 

You specify this property when you want to use a different account instead of the default. Your session's account must have the appropriate privileges to access the code package. 

This property is useful because objects, such as tables and code packages, can have the same name in the same database as long as different accounts own each object. This feature allows you to create duplicate objects for different users on the same server and reuse the same JSON actions on those objects. For example, an administrator can copy objects from a production environment to her account so she can troubleshoot an issue using the same JSON actions, JavaScript, and SQL code.

It is an error to set "ownerName" to the empty string "".

If no default owner is specified during "createSession", the server sets the "defaultOwnerName" to the "defaultOwnerName" value specified in the services.json file.

purpose

The "purpose" property provides a short description of the specified server's purpose.

In the Thing API, the "purpose" property specifies the thing's purpose, which is a short description of why a thing is in use. A thing may have one purpose. 

The Thing API uses the Label API to manage purposes.

• It uses the label group, "faircom/edge/purpose". 
• An API client can use the "listLabels" action to retrieve the purpose list. 
• An API client can use the "alterLabel" action to rename a purpose label.
• An API client can use the "createLabel" action to create a purpose label.
• An API client can use the "changeLabel" action to delete a purpose label, but the API client must first use the "listThings" action with the "purposeFilter" property to ensure the label is unused.

Optional with default of "". Defaults to

"unknown" in the Thing API 

sourceFieldLength

sourceFieldName

The "sourceFieldName" property links a tag to a field in the tag's integration table. It is the tag's primary field. Transformations can associate a tag with additional fields.

• It must be the name of an existing field in an integration table. 
• It is a case-sensitive string from 1 to 64 bytes in length. 
• It is an optional request property in the "createTag" and "alterTag" actions.
• When a primary field is assigned to a tag, the field's information is returned in the responses to the "createTag", "alterTag", "deleteTag" and "describeTag" actions.

Note: Before using the "sourceFieldName" property with the "createTag" and "alterTag" actions to link a tag to a field, that field must already be defined in the integration table. The integration table defines each field's type, length, and scale. For convenience, tag action responses include this information when a tag is linked to a field.

sourceFieldScale

sourceFieldType

sourcePayloadBinaryFormat

The "sourcePayloadBinaryFormat" property specifies the "binaryFormat" of data embedded in a string property in the source_payload field.

"hex"

"hex"
"base64"
"byteArray"

sourcePayloadDateFormat

"ccyy.mm.dd"
"mm.dd.ccyy"
"mm.dd.yy"
"dd.mm.ccyy"
"dd.mm.yy"
"ccyymmdd"
"iso8601"
"yymmdd"
"utc"

sourcePayloadNumberRounding

"truncate"
"roundup"
"rounddown"

sourcePayloadPath

The "sourcePayloadPath" property is the propertyPath of the tag's value in the source_payload field, such as "sourcePayloadPath": "temperature".

• It must not be an empty string and it may contain up to 2048 bytes.
• It is the primary location of a tag's value.
  • Transforms may make additional copies of the value and store them in other locations in the source_payload field, other JSON fields, user-defined fields, and fields in other tables.
  • It does not have to be the first location of the value as identified in a tag's provenance.

For example, setting "sourcePayloadPath" to "temperature" causes the server to take a value it collects, such as 20.1, and assign it to the "temperature" property in the source_payload field, such as { "temperature": 20.1 }. 

sourcePayloadTimeFormat

sourcePayloadVariantFormat

The "sourcePayloadVariantFormat" property indicates how a variant value is encoded in the "sourcePayloadPath". 

• It applies to the tag's value only when the "tagDataType" property is "variant".
• The default value is "json".
• It can be set to one of the following:
  • "json"
  • "variantObject"
  • "binary"
  • "string"

Examples

• "sourcePayloadVariantFormat":"json" encodes the tag's value in the source_payload field as JSON. If the variant field value is binary, it is encoded in a string and the "sourcePayloadBinaryFormat" property specifies the binary encoding.
• "sourcePayloadVariantFormat":"variantObject" encodes the tag's value in the source_payload field as a variant object.
• "sourcePayloadVariantFormat":"binary" encodes the tag's value in the source_payload field as binary. The "sourcePayloadBinaryFormat" property specifies the binary encoding.
• "sourcePayloadVariantFormat":"string" encodes the tag's value in the source_payload field as a string. If the variant field value is binary, it is encoded in a string and the "sourcePayloadBinaryFormat" property specifies the binary encoding.

For more details, see "variantFormat".

status

The "status" property indicates an items status. When set to "inactive", an item is no longer in active use. Setting an item to "status": "inactive", functions similarly to deleting an item without making the deletion permanent.

When the "status" property is omitted or set to null, API actions set the "status" property to "active". Thus, when you create an item, it defaults to being active. When you list items, the action defaults to returning active items.

To create, alter, and list inactive items, set the "status" property to "inactive".
Use a delete action to permanently delete an item.

"active"

"inactive"

tableName

The "tableName" property contains the unique, user-defined name of a table.

The table name must start with an upper or lowercase letter, must not contain special characters other than underscore "_", and can include a mix of upper-lower case characters, but are treated as case-insensitive.

"params": {
  "tableName": "ctreeTable"
}

tagDataType

The "tagDataType" property specifies the data type of the tag.

• It defines the data type of the tag's value. 
• It must be one of the following values:
  • "string"
  • "number" 
  • "boolean" 
  • "date" 
  • "time" 
  • "timestamp" 
  • "json" 
  • "variant" 
  • "binary" 
• It defines how the server interprets the tag's value, which is located in the source_payload field and its primary table field.

tagName