<< Back to GForge REST API

Entity: Association

GET

getAssociation

Returns all associations for the specified source object.

Parameters (2)

Name Type Description
section string Section of the source object (e.g. trackeritem, wiki). Required.
refId int Id of the source object. Required.

Return: array

Associations grouped by target section type.

POST

postAssociation

Creates an association between two items.

Parameters (5)

Name Type Description
section string Section of the source object. Required.
refId int Id of the source object. Required.
toSection string Section of the target object. Required.
toRefId int Id of the target object. Required.
comment string Optional comment.

Return: \gforge\core\models\api\AssociationBasic

Name Type Description
section string Type of the source object
refId int Id of source object
toSection string Type of the referenced object
toRefId int Id of referenced object
comment string comment

PUT

DELETE

deleteAssociation

Deletes an association between two items.

Parameters (4)

Name Type Description
section string Section of the source object. Required.
refId int Id of the source object. Required.
toSection string Section of the target object. Required.
toRefId int Id of the target object. Required.

Return: void