Vocabulary Download - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API returns the list of vocabularies of a given service, and makes it possible to download the associated RDF file of each vocabulary. For more information, see Analytics Vocabularies chapter of the AFS Back Office User Guide.

A "Vocabularies List" API request takes the following form:

http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/vocabulary?

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.

API usage example:

  • $HOST : 10.61.8.175
  • $SERVICE_ID: 1
  • $SERVICE_STATUS: stable.

http://10.61.8.175/bo-ws/service/1/instance/stable/vocabulary?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY

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

The XML result of the previous request is shown below:

<afs:value
xsi:schemaLocation="http://ref.antidot.net/v7/bo/output http://ref.antidot.net/v7.4/bo/output.xsd"
xsi:type="afs:ws.response">
<afs:query xsi:type="afs:ws.response.query">
<afs:locale>fr</afs:locale>
<afs:properties xsi:type="afs:dynamic"/>
</afs:query>
<afs:result xsi:type="afs:ws.filtering.result">
<afs:count>3</afs:count>
<afs:pager>
<afs:pages>
<afs:page current="true" number="1"/>
</afs:pages>
</afs:pager>
<afs:request>
<afs:elementsPerPage>10</afs:elementsPerPage>
<afs:page>1</afs:page>
</afs:request>
<afs:totalCount>3</afs:totalCount>
<afs:values>
<afs:item xsi:type="afs:bows.vocabulary"
reference="/bo-ws/project/1/service/1/instance/stable/vocabulary/Antidot%20Technical%20Publications">
<afs:currentVersion>PUBLISH</afs:currentVersion>
<afs:hasBackupVersion>true</afs:hasBackupVersion>
<afs:hasPublishedVersion>true</afs:hasPublishedVersion>
<afs:tracker>
<afs:lastUpdatedDate xsi:type="afs:date-time"
>2012-02-13T12:34:57+01:00</afs:lastUpdatedDate>
<afs:lastUpdatedUser>
<afs:userName>Root User</afs:userName>
<afs:userReference>/bo-ws/user/36</afs:userReference>
</afs:lastUpdatedUser>
<afs:lastPublishedDate xsi:type="afs:date-time"
>2012-02-10T11:52:50+01:00</afs:lastPublishedDate>
<afs:lastPublishedUser>
<afs:userName>Root User</afs:userName>
<afs:userReference>/bo-ws/user/36</afs:userReference>
</afs:lastPublishedUser>
<afs:lastPreviousPublishedDate xsi:type="afs:date-time"
>2012-02-08T15:56:12+01:00</afs:lastPreviousPublishedDate>
<afs:lastPreviousPublishedUser>
<afs:userName>Root User</afs:userName>
<afs:userReference>/bo-ws/user/36</afs:userReference>
</afs:lastPreviousPublishedUser>
</afs:tracker>
<afs:conceptsMonoScheme>true</afs:conceptsMonoScheme>
<afs:description>Specifics Terms for the Doc</afs:description>
<afs:id>1</afs:id>
<afs:key xsi:type="afs:bows.vocabulary.key">
<afs:name>Antidot Technical Publications</afs:name>
<afs:serviceInstance xsi:type="afs:bows.admin.service.instance" partial="true"
reference="/bo-ws/project/1/service/1/instance/stable">
<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:serviceInstance>
</afs:key>
<afs:languages>
<afs:item xsi:type="afs:bows.model.lang">ENGLISH</afs:item>
</afs:languages>
<afs:mimeType>application/rdf+xml</afs:mimeType>
<afs:nbElements>23</afs:nbElements>
<afs:tags/>
</afs:item>

[...]

</afs:values>
</afs:result>
</afs:value>

There are as many "item" blocks as there are dots returned by the API.

Adding .../$VOCABULARY_NAME/content to the previous request makes it possible to download the RDF file associated to the vocabulary:

http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/vocabulary/$VOCABULARY_NAME/content?

Usage example with the first vocabulary of the previous request:

http://10.61.8.175/bo-ws/service/1/instance/stable/vocabulary/Antidot%20Technical%20Publications/content?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY

The result of this request is the RDF file of the vocabulary, as if downloaded through the Vocabulary application of the Back Office.