ARSetEntry

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Updates the form entry with the indicated ID on the specified server.

If you perform a set operation on an overlay and you provide values for an inherited grain, the values are ignored. Only values for extended or overwritten grains of the overlay are set.

Privileges

The system updates data based on the access privileges of the user that you specify for the control parameter. User permissions are verified for each specified field. The system generates an error if the user does not have write permission for a field or a field does not exist.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARSetEntry(
  ARControlStruct *control,
  ARNameType schema,
  AREntryIdList *entryId,
  ARFieldValueList *fieldList,
  ARTimestamp getTime,
  unsigned int option,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

schema

The name of the form containing the entry to update.

entryId

The ID of the entry to update.

Note

The system identifies entries in join forms by concatenating the entry IDs from the member forms. As a result, an entry ID can consist of one or more values of type AREntryIdType and, therefore, is represented by the AREntryIdList structure.

fieldList

A list of one or more field/value pairs (specified in any order) that identifies the new data for the entry. Values must be of the data type defined for the field or have a data type of 0 (AR_DATA_TYPE_NULL). NULL values can be specified only for optional fields. An error is generated if a field does not exist or the user specified by the control parameter does not have write permission for a field.

getTime

A time stamp that specifies when the entry was last retrieved. The system compares this value with the value in the Modified Date core field to determine whether the entry has been changed since the last retrieval. The system updates the entry if the value that you specify is greater than Modified Date. If not, the system returns an error. You can either retrieve the entry again and determine whether to apply your changes or specify 0 for this parameter to bypass the time stamp comparison.

option

A value that indicates whether users can update fields specified in the join qualification (only applicable to join forms).The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Return values

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.