Versions Compared

Key

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

The API method to submit a post edit request (API - IT - Post Edit Request) may be executed run asynchronously.

In that case it returns an operation ID for this asynchronous operation. The present method then lets you poll the status of the operation.

...

PARAMETERS

Parameters are:

token

The session token obtained when connecting.

trmid

Provide the ID you obtained from API method API - IT - Post Edit Request

 

Note: When polling the system please always sleep for 1 or more seconds in between calls.

RESULTS

The method returns a JSON object:

status

The status of the operation. Any of:

  • Waiting: The operation is queued for processing
  • Executing: The operation is being processed but not complete
  • Finished: The operation is complete
  • Failed: The operation failed

 

string

 

An HTTP status of 200 indicates success. Other HTTP status values indicate an error.

The post edit status in the individual request records (see API - IT - List Requests) indicates when the request for post editing is acknowledged, in progress and ultimately completed.

 

...