Mapping Results Schema

Element Name and Path Description Attributes
root The root of the result document.  
data (root) The root of the data itself.  
objects (root > data) The root element for the objects to update.  
Object
(root > data > objects)
Describes the update operation for a single object and all of its attributes.
  1. Name: name
    Description: Name of the CI type
    Is required?: Required
    Type: String
  2. Name: mode
    Description: The type of update required for the current CI type.
    Is required?: Required
    Type: One of the following strings:
    a. insert – Use this only if the CI does not already exist.
    b. update – Use this only if the CI is known to exist.
    c. update_else_insert – If the CI exists, update it; otherwise, create a new CI.
    d. ignore – Do nothing with this CI type.
  3. Name: operation
    Description: The operation to perform with this CI.
    Is required: Required
    Type: One of the following strings:
    a. add – The CI should be added
    b. update – The CI should be updated
    c. delete – The CI should be deleted
    If no value is set, then the default value of add is used.

  4. Name: mamId
    Description: The ID of the object on the source RTSM.
    Is required?: Required
    Type: String

field
(root > data > objects > Object

-OR-

root > data > links > link)

Describes the value of a single field for an object. The field’s text is the new value in the field, and if the field contains a link, the value is the ID of one of the ends. Each end ID appears as an object (under <objects>).
  1. Name: name
    Description: Name of the field.
    Is required?: Required
    Type: String
  2. Name: key
    Description: Specifies whether this field is a key for the object.
    Is required?: Required
    Type: Boolean
  3. Name: datatype
    Description: The type of the field.
    Is required?: Required
    Type: String
  4. Name: length
    Description: For string/character data types, this is the integer size of the target attribute.
    Is required?: Not Required
    Type: Integer
links (root > data) The root element for the links to update.
  1. Name: targetRelationshipClass
    Description: The name of the relationship (link) in the target system.
    Is required?: Required
    Type: String
  2. Name: targetParent
    Description: The type of first end of the link (parent).
    Is required?: Required
    Type: String
  3. Name: targetChild
    Description: The type of the second end of the link (child).
    Is required?: Required
    Type: String
  4. Name: mode
    Description: The type of update required for the current CI type.
    Is required?: Required
    Type: One of the following strings:
    a. insert – Use this only if the CI does not already exist.
    b. update – Use this only if the CI is known to exist.
    c. update_else_insert – If the CI exists, update it; otherwise, create a new CI.
    d. ignore – Do nothing with this CI type.
  5. Name: operation
    Description: The operation to perform with this CI.
    Is required?: Required
    Type: One of the following strings:
    a. add – The CI should be added
    b. update – The CI should be updated
    c. delete – The CI should be deleted
    If no value is set, then the default value of add is used.
  6. Name: mamId
    Description: The ID of the object on the source RTSM.
    Is required?: Required
    Type: String