Modify a PaF Options - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API allows to change the options of a PaF.

A "Modify a PaF Options" API request takes the following form:

curl -XPUT -H Expect: --data '{"version": {"minor": "0", "generation": "7", "major": "8", "x:type": "Version"}, "x:type": "bows.paf", "configurationVersion": "3.2.13", "key": {"x:type": "bows.paf.key", "name": "$PAF_NAME"}}' "http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME"

Method: PUT

The list of parameters in their order of appearance and their possible values are enumerated below.

  • "version": is the AFS version of the PaF, e.g., 7.8.0 corresponds to "generation"="7", "major"="8", "minor"="0").
    • "x:type": is the object internal type. Must be set to "Version".
  • "x:type": is the object internal type. Must be set to "bows.paf".
  • "configurationVersion" is the product version, e.g., the Fluid Topics or AFS@Store version.
  • "key": is the PaF name.
    • "x:type": is the object internal type. Must be set to "bows.paf".
    • "name": is the PaF name.
  • $HOST is the server hosting the Back Office.
  • $SERVICE_ID is the ID of the desired service.
  • $SERVICE_STATUS is the status of the desired service.

To retrieve all necessary information to form your request, use the Get a PaF Options web service.