Previous Topic

Next Topic

Book Contents

Input parameters—Update

Update takes a list of discrepancies, in which each discrepancy has an associated GUID, revision number, target state, reason, and optional reissue flag.

A request can be made for a single study. A request that contains multiple items is treated as an atomic transaction.

Update

Parameter

Description

authenticationTrialName

The study in which the discrepancies are issued or updated. If username/password authentication is enabled, the username and password that you specify in the SOAP header are authenticated against this study name.

transactionID

A GUID created by the caller.

TransactionID is not case sensitive. It must use one of the formats described in Transaction ID GUID format.

This parameter prevents a transaction from being submitted multiple times. If you specify a value that was previously submitted and resulted in a successful transaction, an error occurs.

transactionUserName

The user name of the InForm user to associate with this transaction. The user must belong to a query group in an InForm trial.

Guid

A GUID that identifies the discrepancy to update.

Revision

The revision number of the discrepancy that is identified by the GUID.

If the specified revision number is less than the current revision number, the operation prohibits the update and notifies the caller that the data is stale.

If no revision number is specified, the transaction takes effect against the latest (most current) revision.

State

The target state.

Values: Candidate, Opened.

Reissue

Values: True, False.

If True, the transaction is treated as a reissuing of the discrepancy.

Can be specified only when specifying Candidate or Opened as the target state.

Reason

The reason for issuing the discrepancy.

ValidateOnly

Values: True, False.

If True, both of the following occur:

  • The request is validated, but no data is committed to the database.
  • The response contains an error list that includes any errors in validation. If all items in the request are validated successfully, the error list is empty.

Send Feedback