Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

pid

The project ID for an existing Codyt project. To find projects use: projects/list

Mandatory, int

name

The name of the flex file to create. The file name must have the .wbflex extension. The name can contain sub folders, see below. Examples:

  • myfile.wbflex
  • folder\folder2\myfile.webflex

Mandatory, string





LANGUAGES
srcThe source locale for the content you will push to the flex file. The locale must exist in the project.

Mandatory, string

trgs

Optional list of target locales into which to translate content.

If not supplied or null then the system simply selects all project languages.

Optional, string[]?





FILTER CONFIGURATION
filterId

Optional. To specify the Flex filter configuration by its ID. 

You can read more on this and see how to enumerate all Flex configurations here: apps/wbflex/settings/filters

Filter configuration can optionally be preset using filterId, or filterName or neither in which case the default configuration will be used. 

Optional, int?
filterName

Optional. To specify the Flex filter configuration by its name. You can list all Flex configurations using: apps/wbflex/settings/filters

Optional, string?





CALLBACK URL / WEBHOOK
callbackurl, callback

Optional Specify a URL which will be called upon success or failure of operation. This makes polling for results (see below) unnecessary.

URL is called as POST request with operation result included in the body, see "RESULTS" chapter below for the JSON format.

Suggestion: Include your own references in the URL, example: http://callmeback.mycompany.com?operationid=22222&mydata=abcde

string?,

operation status unnecessary. See Callbacks (with asynchronous operations)

Optional


RESULTS

If parameters do not validate you receive a regular error JSON result.

...