File Repository - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API allows to create, update, delete or publish configuration files of a PaF. It concerns all PaF configuration files except conf.xml and paf.xml.

A "configuration file creation or upload" API request takes the following form:

curl -H Expect: --form file="@/home/user_name/myconffile" "http://$BACK_OFFICE_HSOT/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME/configuration/file/$FILE_NAME/content?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY"

Method: POST

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

  • $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.
  • $FILE_NAME is the name of the file.

A "configuration file deletion" API request takes the following form:

curl -H Expect: --request DELETE "http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME/configuration/file/$FILE_NAME?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY"

Method: DELETE

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

  • $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.
  • $FILE_NAME is the name of the file to delete.

A "configuration file publishing" API request takes the following form:

curl -H Expect: -H "Content-Type:application/json" --request PUT --data "{\"x:reference\":\"/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME/configuration/file/<file_name>\"}" "http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/publish/paf/$PAF_NAME/configuration/file/<file_name>?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY"

Method: PUT

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

  • $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.
  • $FILE_NAME is the name of the file to publish.

All "configuration files publishing" API request takes the following form:

curl -H Expect: -H "Content-Type:application/json" --request PUT --data "{\"x:reference\":\"/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/paf/$PAF_NAME/configuration/file\"}" "http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/publish/paf/$PAF_NAME/configuration/file?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY"

Method: PUT

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

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