3.1.5.1.2.1 Request Body

  • Article

The SharedDataBaseInfo (section 2.2.1.12) and UpdateRecord (section 2.2.1.13) objects in Request Body determine the values for the fields of the records to be inserted into the Updatable Source (section 3.1.1). The Updatable Source is specified by the FieldSchema elements in RecordSet (section 2.2.1.9) returned as the Result element in the Response Body of a prior GetData operation (section 3.1.5.1.1.2).

The values to be inserted are specified by the NewValues element of UpdateRecord. These values MUST be formatted according to the FormatInfo element of SharedDataBaseInfo. The SessionId element of SharedDataBaseInfo MUST be the same as the SessionId element of the PagingInfo which is an element of RecordSet (section 2.2.1.9) returned as the Result element in Response Body of the first GetData operation.

 InsertRecordsRequest = dataBaseInfo-member updateRecord-member
 dataBaseInfo-member = json-quotation-mark "dataBaseInfo" json-quotation-mark json-name-separator SharedDataBaseInfo
 updateRecord-member = json-quotation-mark "updateRecord" json-quotation-mark json-name-separator UpdateRecord
 

dataBaseInfo: A SharedDataBaseInfo (section 2.2.1.12) that specifies information about the  Updatable Source (section 3.1.1) into which records are to be inserted.

updateRecord: An UpdateRecord (section 2.2.1.13) that specifies the values for the fields of the records to be inserted.

  • The number of fields in each record MUST be the same for all the records, and MUST match the number and ordering of fields in the FieldNames element of dataBaseInfo.

  • The value of primary key fields in NewValues element MUST be "null".

  • Each field value at an ordinal in a record array from the NewValues element MUST be formatted according to the FormatInfo at the same ordinal in the FormatInfos array of the dataBaseInfo.

  • The OriginalValues element of the UpdateRecord MUST be ignored.

  • The field value at an ordinal in a record array from the NewValues element MUST be "null" if the ReadOnly element of the FieldSchema element at the same ordinal in the Fields array of the RecordSet (section 2.2.1.9), returned in the Result element of the ServiceResult element from a previous call to the GetData operation (section 3.1.5.1.1) is "true".