You can configure the server to run this code in various scenarios, such as a transform or a job. You can write code as a transform method in a transform step as part of the transform process. You can write code as a job that bulk processes data on a schedule or when fired by an event.
Request examples
Minimal
{
"action": "createCodePackage",
"params": {
"databaseName": "faircom",
"ownerName": "admin",
"codeName": "convertTemperature",
"codeLanguage": "javascript",
"codeType": "getRecordsTransform",
"codeStatus": "developing",
"description": "1. Copies the value from the temperature property in source_payload to the temperature_celsius field.\n2. Converts temperature_celsius into Fahrenheit and stores it in the temperature_fahrenheit field.\n3. Stores alerts about temperature in temperature_status field.",
"metadata": {},
"comment": "optional comment about the current version",
"codeFormat": "utf8",
"code": "// The server runs the following JavaScript code, which is registered in the server as a transform method.\nrecord.temperature_celsius = record.source_payload.temperature\nrecord.temperature_fahrenheit = getFahrenheitFromCelsius(record.temperature_celsius)\nrecord.temperature_status = calculateTemperatureStatus(record.temperature_fahrenheit)\n\nfunction getFahrenheitFromCelsius(temperature_celsius){\n return (temperature_celsius * 1.8) + 32;\n}\n\nfunction calculateTemperatureStatus(temperature_fahrenheit){\n switch (true) {\n case (temperature_fahrenheit < 0):\n return \"alert: too cold\";\n case (temperature_fahrenheit < 32):\n return \"cold\";\n case (temperature_fahrenheit > 80):\n return \"hot\";\n case (temperature_fahrenheit > 140):\n return \"alert: too hot\";\n default:\n return \"normal\";\n }\n}"
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Response examples
Minimal
{
"debugInfo": {
"request": {
"api": "admin",
"action": "createCodePackage",
"params": {
"databaseName": "faircom",
"ownerName": "admin",
"codeName": "convertTemperature",
"codeLanguage": "javascript",
"codeType": "getRecordsTransform",
"codeStatus": "developing",
"description": "1. Copies the value from the temperature property in source_payload to the temperature_celsius field.\n2. Converts temperature_celsius into Fahrenheit and stores it in the temperature_fahrenheit field.\n3. Stores alerts about temperature in temperature_status field.",
"metadata": {},
"comment": "optional comment about the current version",
"codeFormat": "utf8",
"code": "// The server runs the following JavaScript code, which is registered in the server as a transform method.\nrecord.temperature_celsius = record.source_payload.temperature\nrecord.temperature_fahrenheit = getFahrenheitFromCelsius(record.temperature_celsius)\nrecord.temperature_status = calculateTemperatureStatus(record.temperature_fahrenheit)\n\nfunction getFahrenheitFromCelsius(temperature_celsius){\n return (temperature_celsius * 1.8) + 32;\n}\n\nfunction calculateTemperatureStatus(temperature_fahrenheit){\n switch (true) {\n case (temperature_fahrenheit < 0):\n return \"alert: too cold\";\n case (temperature_fahrenheit < 32):\n return \"cold\";\n case (temperature_fahrenheit > 80):\n return \"hot\";\n case (temperature_fahrenheit > 140):\n return \"alert: too hot\";\n default:\n return \"normal\";\n }\n}" },
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Properties
Request properties ("params")
| Property | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
code |
The "code" property contains the source code. Before embedding it in a JSON string, encode the source code using the format specified in the "codeFormat" property. |
Optional with default of ""
|
string | 1 to 8,388,096 bytes |
codeFormat |
The "codeFormat" property specifies the encoding of code in the code property. You must encode your code to embed it in a JSON string. "codeFormat" currently only supports the "utf8" encoding, requiring you to use JSON rules to escape problem characters in your code with the \ backslash character, such as \n. |
Optional with default of "utf8"
|
string | "utf8" |
codeLanguage |
The "codeLanguage" property specifies the programming language of the code contained in the "code" property . Any string value is accepted. Currently, "javascript" and "json" are the only types of code the FairCom server can use. |
Required - No default value | string |
|
codeName |
The It is an error to set The package's unique identifier is the combination of |
Required - No default value | string | 1 to 64 bytes |
codeStatus |
The "codeStatus" property specifies a new status for the code. When you create a code package, it defaults to "developing". When you alter a code package, it defaults to the current state. You may set it to one of the following states: "developing", "deleted", "inactive", "deprecated", "testing", or "active". You can use "alterCodePackage" to transition from any state to any other. See "Use "codeStatus" to make a package runnable". |
Optional with default of "developing"
|
string |
|
codeType |
The
|
Required - No default value | string |
|
comment |
The "comment" property explains the code change. |
Optional with default of ""
|
string | 1 to 65,535 bytes |
databaseName |
The You specify this property when you want to use a different database 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 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 It is an error to set If no default database is specified during |
Defaults to the session's "defaultDatabaseName" property |
string | 1 to 64 bytes |
description |
The "description" property describes objects such as code packages, labels, or things. The server indexes this field with a full-text index so that you can search for any word or phrase. You cannot use this property for filtering in the Thing API. |
Optional with default of
|
string |
0 to 65,500 bytes 1 to 512 bytes for the Thing API |
metadata |
The "metadata" property contains user-defined properties that add keywords and tags about the code package. The server indexes this field with a full-text index so you can search for any word or phrase to find code packages. |
Optional with default of {}
|
object | 0 or more key/value pairs |
ownerName |
The 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 If no default owner is specified during |
Optional with default of the session's "defaultOwnerName" property |
string | 1 to 64 bytes |