Versions Compared

Key

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

...

id

Specify either a document ID (such as 1000) or a job ID (such as c300).

string, Mandatory
includeCost

If set to true then the result of this method will include the cost of the push. To get this to work, some configuration will be required such as adding pricing information and enabling costing in the Wordbee project workflow.

Read more: Cost summary / Flex

bool, Optional
callbackurl, callback

Optional encoded 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

Info

When setting the callback URL please do not forget to encode it. Example:

.../contents/push?callbackurl=http%3A%2F%2Fcallmeback.mycompany.com%3Foperationid%3D22222%26mydata%3Dabcde

This online tool helps to encode URLs: https://www.urlencoder.org/

string?,

operation status unnecessary. See Callbacks (with asynchronous operations)

Optional


Upload the JSON content with the HTTP request using a multipart request. Set Content-Type header to "multipart/form-data". The JSON content must be UTF-8 encoded.

...