PaF Export - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API is used to download the content of an archive containing the PaF configuration in the form of a ZIP file.

Method

GET

Path

A "PaF export" API request takes the following form:

curl "http://$BACK_OFFICE_HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME/archive?afs:login=login://$USER_LOGIN:$USER_PASSWORD@$AUTHENTICATION_AUTHORITY" > <$ZIP_FILE

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.
  • $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.
  • $PAF_NAME is the name of the PaF.
  • $ZIP_FILE is the name of downloaded archive.

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