Defining REST API expressions

Before you can perform this procedure, you must first upload the API definition. See Importing API registration.
  1. Select BPA Designer > Operations > Expressions.
  2. In the Document field, select the input business document for which to define an expression.
    For accounting framework integration, the list displays transactional document registrations. For a flexible output integration, both the master data and transactional document registrations are shown.
  3. Click Add.
  4. Specify this information:
    Name
    Specify a unique name that identifies the expression. Valid characters are a–z, A–Z, and 0–9. The first character should be an uppercase letter. The maximum length is 15 characters.
    Type
    Select REST API.
    API Registration
    Select the name of the API registration.
  5. Specify the parameter value for each key:
    1. Click the SET hyperlink of the corresponding key.
    2. Select the parameter type. Possible values are:
      • Attribute
      • Fixed Value
    3. Specify the values for the remaining fields. The displayed fields depend on the selected argument type.
      For Attribute argument, you must specify these fields:
      Mapping
      Select the document registration.

      For accounting framework integration, the list shows transactional document registrations. For a flexible output integration, both the master data and transactional document registrations are displayed.

      Attribute
      Select the attribute. This dynamic list shows the attributes associated to the selected document registration.
      For Fixed Value argument, you must specify this field:
      Value
      Specify a numeric or text value.
  6. Click Yes to include the argument in the expression.
  7. Click Save.