referenceService

Manager used to create references between different kind of jive objects.

References are use to create a relationship between one kind of jive object to another. For instance a blog may reference a specific thread.

Method	Description
addReference	Creates a reference between the refering object and the references.
deleteAllReferences	Removes all references from the specified referer.
deleteAllReferers	Causes this object to not be referred by any other objects.
deleteReference	Delete the reference between a referer and the refered content.
getReferences	Get all objects that the specfied jiveObject referers too.
getReferers	Get a list of all the objects that refer to this specified object.

addReference

Creates a reference between the refering object and the references.

POST http://domain:port/application_context/rpc/rest/referenceService/references

Arguments

Name	Type	Description
referer	Contents of JiveObject	The object that will refer to references.
reference	Contents of JiveObject

Arguments Template

<addReference> 
    <referer>
        <!-- Contents of JiveObject -->
    <referer>
    <reference>
        <!-- Contents of JiveObject -->
    <reference>
</addReference>

deleteAllReferences

Removes all references from the specified referer.

DELETE http://domain:port/application_context/rpc/rest/referenceService/references/{refererObjectType}/{refererObjectID}

Arguments

Name	Type	Description
refererObjectType	xs:int	The referer's object type.
refererObjectID	xs:long	The id of the referer.

Arguments Template

<deleteAllReferences> 
    <refererObjectType>xs:int</refererObjectType>
    <refererObjectID>xs:long</refererObjectID>
</deleteAllReferences>

deleteAllReferers

Causes this object to not be referred by any other objects.

DELETE http://domain:port/application_context/rpc/rest/referenceService/referers/{referenceObjectType}/{referenceObjectID}

Arguments

Name	Type	Description
referenceObjectType	xs:int	The object Type of the reference.
referenceObjectID	xs:long	The object id of the reference.

Arguments Template

<deleteAllReferers> 
    <referenceObjectType>xs:int</referenceObjectType>
    <referenceObjectID>xs:long</referenceObjectID>
</deleteAllReferers>

deleteReference

Delete the reference between a referer and the refered content.

DELETE http://domain:port/application_context/rpc/rest/referenceService/references/{refererObjectType}/{refererObjectID}/{referenceObjectType}/{referenceObjectID}

Arguments

Name	Type	Description
refererObjectType	xs:int	The referer's object type.
refererObjectID	xs:long	The id of the referer.
referenceObjectType	xs:int	The object Type of the reference.
referenceObjectID	xs:long	The object id of the reference.

Arguments Template

<deleteReference> 
    <refererObjectType>xs:int</refererObjectType>
    <refererObjectID>xs:long</refererObjectID>
    <referenceObjectType>xs:int</referenceObjectType>
    <referenceObjectID>xs:long</referenceObjectID>
</deleteReference>

getReferences

Get all objects that the specfied jiveObject referers too.

GET http://domain:port/application_context/rpc/rest/referenceService/references/{refererObjectType}/{refererObjectID}

Arguments

Name	Type	Description
refererObjectType	xs:int	The referer's object type.
refererObjectID	xs:long	The id of the referer.

Arguments Template

<getReferences> 
    <refererObjectType>xs:int</refererObjectType>
    <refererObjectID>xs:long</refererObjectID>
</getReferences>

Response

Type	Description
List of JiveObject	a list of objects that are refered by jiveObject.

Response Template

<getReferencesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</getReferencesResponse>

getReferers

Get a list of all the objects that refer to this specified object.

GET http://domain:port/application_context/rpc/rest/referenceService/referers/{referenceObjectType}/{referenceObjectID}

Arguments

Name	Type	Description
referenceObjectType	xs:int	The object Type of the reference.
referenceObjectID	xs:long	The object id of the reference.

Arguments Template

<getReferers> 
    <referenceObjectType>xs:int</referenceObjectType>
    <referenceObjectID>xs:long</referenceObjectID>
</getReferers>

Response

Type	Description
List of JiveObject	A list of all object that reference this object.

Response Template

<getReferersResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</getReferersResponse>