Front Configuration Upload and Publish - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API allows to update the content of a Configuration and publish it. For more information, see Configuration Application chapter of the AFS Back Office User Guide.

A "Configuration upload" API request takes the following form:

curl -H Expect: --form file="@/home/user_name/myconf.xml;type=text/xml" "http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/configuration/content?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY"

Method: POST

The list of parameters 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.

A "Configuration publish" 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/configuration\"}" "http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/publish/configuration?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 ID of the desired service.
  • $SERVICE_STATUS is the status of the desired service.

The Configuration must be discovered and visible within the Configuration application of the Back Office to be uploaded and published through these APIs.

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