PaF Options Upload - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guides
language
English

Method

POST

Path

A "PaF options upload" API request takes the following form:

curl -H Expect: --data "{\"afs:t\":\"bows.paf.option\",\"actived\":true,\"secured\":false,\"warehouse\":false,\"mode\":\"REPLACE\",\"input\":[{\"afs:t\":\"bows.paf.option.input.uri\",\"value\":\"$AFS7/conf/books.xml\",\"disabled\":false},{\"afs:t\":\"bows.paf.option.input.directory\",\"value\":\"val\",\"suffix\":\"suf\",\"disabled\":false}" "http://$BACK_OFFICE_HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME/option?afs:login=login://$USER_LOGIN:$USER_PASSWORD@$AUTHENTICATION_AUTHORITY"

Where

  • $BACK_OFFICE_HOST is the server hosting the Back Office.
  • $SERVICE_ID is the number of the desired service.
  • $SERVICE_STATUS is the status of the desired service.
  • $PAF_NAME is the name of the PaF.
  • $USER_LOGIN is the login of the user.
  • $USER_PASSWORD is the current password of the user.
  • $AUTHENTICATION_AUTHORITY is the user's authentication provider, e.g., LDAP or SAML.

The --data parameter needs a JSON with the following properties:

  • afs:t -> bows.paf.option
  • activated -> "from BO" if true,else "from server"
  • secured -> true to activate secure mode
  • warehouse -> true to activate warehouse mode
  • mode -> REPLACE (for full), INCREMENTAL or DATADRIVEN
  • input -> array of JSON object containing inputs
  • afs:t -> type of input, bows.paf.option.input.uri, bows.paf.option.input.seedfile or bows.paf.option.input.directory
  • value -> input value
  • suffix -> only for directory
  • disabled -> true if input is disabled

CURL is used for these examples. Any other HTTP client can be used.