Service Instances List Download - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API returns the list of services instances available for a given user. For more information, see AFS Back Office User Guide.

A "Service List Download" API request takes the following form:

http://$HOST/bo-ws/service/instance?

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

  • $HOST is the server hosting the Back Office.

API usage example:

  • $HOST: 10.61.8.175

http://10.61.8.175/bo-ws/service/instance?

API responses are returned in the format indicated by the "Accept" header.

The XML result of the previous request is shown below:

<afs:value xmlns:afs="http://ref.antidot.net/v7/bo/output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ref.antidot.net/v7/bo/output http://ref.antidot.net/v7.4/bo/output.xsd" xsi:type="afs:ws.response">
[...]
<afs:result xsi:type="afs:ws.filtering.result">
[...]
<afs:values>
<afs:item xsi:type="afs:bows.admin.service.instance" partial="true" reference="/bo-ws/project/1/service/1/instance/stable"> <!-- This is the reference of the Service instance -->
<afs:clientUrls/>
<afs:id>1</afs:id>
<afs:key xsi:type="afs:bows.admin.service.instance.key" partial="true">
<afs:status>STABLE</afs:status>
</afs:key>
<afs:name>Technical Publications (1) STABLE</afs:name>
<afs:url>http://packaging-doc/</afs:url>
</afs:item>
[...] <!-- There are as many afs:item nodes as there are available Service Instances -->
</afs:values>
</afs:result>
</afs:value>

To find the ID associated to a project:

API usage example:

  • $HOST: 10.61.8.175
  • $PROJECT_NAME: Technical Publications

http://10.61.8.175/bo-ws/project?afs:filter=name=%22Technical%20Publications%22&afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY