Get a PaF Options - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API allows to get the options of a PaF in a JSON format.

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

curl -H "Accept: application/json" "http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME"

Method: GET

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

  • $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.

Output example

{
"x:type": "ws.response",
"query": {
"x:type": "ws.response.query",
"parameters": {
"x:type": "collection",
"x:values": []
},
"properties": {
"x:type": "x:dynamic"
}
},
"result": {
"x:type": "bows.paf",
"x:reference": "/bo-ws/project/$PROJECT_ID/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME",
"afsVersion": {
"x:type": "Version",
"generation": "7",
"major": "8",
"minor": "0"
},
"configuration": {
"x:type": "bows.paf.configuration",
"changeLog": {
"x:type": "collection",
"x:values": [
{
"x:type": "bows.conf.changelog.element",
"date": {
"x:type": "date-time",
"value": "2017-07-18T10:39:48+02:00"
},
"message": "Configuration item PaF/Filters/initGraceTime update: '3000' replaces '3000'",
"user": {
"x:type": "bows.track.user",
"userName": "conf feature",
"userReference": "/bo-ws/user/10"
}
},
{
"x:type": "bows.conf.changelog.element",
"date": {
"x:type": "date-time",
"value": "2017-07-18T10:39:48+02:00"
},
"message": "Configuration item PaF/Filters/maxProcessingTimeS update: '360000' replaces '360000'",
"user": {
"x:type": "bows.track.user",
"userName": "conf feature",
"userReference": "/bo-ws/user/10"
}
},
...
]
},
"description": "",
"layerDescriptions": {
"x:type": "collection",
"x:values": []
}
},
"configurationVersion": "3.2.13",
"id": 11,
"inCompatibilityMode": false,
"key": {
"x:type": "bows.paf.key",
"name": "FluidTopics",
"serviceInstance": {
"x:type": "bows.admin.service.instance",
"x:reference": "/bo-ws/project/3/service/1/instance/rc",
"x:partial": true,
"clientUrls": {
"x:type": "collection",
"x:values": []
},
"id": 3,
"key": {
"x:type": "bows.admin.service.instance.key",
"x:partial": true,
"status": "RC"
},
"name": "My Fluid Topics website"
}
},
"reportAfsVersion": {
"x:type": "Version",
"generation": "7",
"major": "9",*
"minor": "5"
},
"reportVersion": {
"x:type": "Version",
"generation": "7",
"major": "9",
"minor": "5"
},
"status": "FULL",
"version": {
"x:type": "Version",
"generation": "7",
"major": "8",
"minor": "0"
}
}
}

Where:

  • "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.
  • "x:type": is the object internal type.
  • "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.
    • "name": is the PaF name.