Root element and attributes

The root element of an XML message is based on an object structure and an operation specified for the channel or service used for the communication. The root element can contain one or more attributes.

The following table shows the attributes that can apply to root elements. Attribute names and values are case-sensitive. All attributes are optional.

Attribute Description Type Applicable to
baselanguage

The base language in which the content values are supplied.

string

All input and output operations

creationDateTime

Date and time when the content is generated.

dateTime

All input and output operations

maximoVersion

The major version, minor version, build, and database build that is generated for all published XML.

MaximoVersionType

All input and output operations

messageID

Unique identifier generated for all messages.

string

All input and output operations

transLanguage

The language in which the values for multilanguage-enabled fields are supplied.

string

All input and output operations

event

The origin of an outbound XML message. Valid values are:

  • 0 (false), indicates that the message is generated by the data export feature.
  • 1 (true), indicates that the message is generated by an outbound integration event listener (that is, data entry in an application).

eventType

All output operations

uniqueResult

Specifies whether a query expects one record or multiple records in a response. If the value is 0, or the attribute is not specified, the query can return multiple records. If the value is 1, the query can return a single record only and, otherwise, an error occurs.

Boolean

Queries (input)

maxItems

If a query can return multiple records, this attribute limits the number of records to be returned at one time. If this attribute is not specified, the response contains the entire result set.

positiveInteger

Queries (input)

rsStart

Specifies the first record to return in the response. If not specified, the response starts with the first record in the result set. If the number of results in the result set is lower than the rsStart value, the response returns no records.

If a maxItems value is specified, the response returns the specified number of records, starting with rsStart value, if one is set.

For example, if maxItems=10 and rsStart is not specified, the response returns results 1 through 10. To receive results 11 through 20, resend the query with rsStart=11.

integer

Queries (input)

rsStart

This value matches the rsStart value in the corresponding query.

If the query contains a maxItems value, the rsStart value in requests for additional records is rsStart + rsCount + 1.

If this attribute is not specified, the response starts with the first record in the result set and includes the number of records specified by the rsCount attribute.

integer

Responses (output)

rsCount

The number of records returned in a message. If the original query specifies a maxItems value, the rsStart value for the subsequent request for additional records is rsStart + rsCount + 1.

integer

Responses (output)

rsTotal

The total number of records in the result set. If the query does not specify a maxItems value, the rsTotal value is the same as the rsCount value.

integer

Responses (output)