Content only available in english

RecordM - integration endpoint

Integration endpoints for RecordM accept messages with the following format:

PUT: /recordm/recordm/instances/integration
{
  "type": "<Definition Name>",
  "values": {
    "<Field Path>": "<Field Value>", ...
  },
  "waitForSearchAvailability": true|false
}

Data	Description
Definition Name	The name of the target Definition
Field Path	A / separated expression that specifies which field to update. If the expression matches several fields, all matching will be filled.
Field Value	A String representation of the desired field value.

Field Paths

Field Paths are one or more conditions separated by a / character.

Each condition can be constituted by three sections <field name>[<field index>][<value test>] :

• the field name on its own will match all fields that share the same name
• the optional field index is specified as [n] with n beeing the 0 based index
• the optional value test is specified as {==|!=}<value> with == for matching every field with the same value and != for every field with a different value.

Note: field names or values that contain ambiguous characters will need to be escaped. E.g. to match a field named one/other the condition should be one\/other.

If there are multiple conditions they will be matched respecting the structure of the instance. A path field 1/field 2 will only match fields named "field 1" that are descendants of fields named "field 2".

Example Paths

Path	Explanation
Field 1	Matches all fields named "Field 1"
Field 1/Field 2	Matches all fields named "Field 2" that are descendants of fields named "Field 1"
Multiple Field[2]	Matches the third instances of fields named "Multiple Field"
Multiple Field[0]/Field 2	Matches fields named "Field 2" under the first instance of fields named "Multiple Field"

Field Values

All field values must be strings. For text based fields the representation is the visible field value, but for other fields some translation needs to be made:

• $number: represented as a string with . as a decimal separator. No thousands separators.
• $dateand $datetime: number of millisenconds since the epoch.
• $ref: the id of the referenced instance.
• $extRef: the uri of the referenced external instance. Must be a relative URI to be joined with the base URI that is configured on RecordM.