Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.25 KB

enlistment.md

File metadata and controls

38 lines (29 loc) · 1.25 KB

Enlistment

An Enlistment joins a Project to a source control Code Location.

Once added to the Open Hub database, a Code Location is permanent. However, Enlistments to that Code Location may be added or removed at any time. Many Projects may share a single CodeLocation.

Properties

  • id The unique ID of the Enlistment.
  • project_id The unique ID of the Project.
  • code_location The Code Location record will be included in full here.

URL

To get a single Enlistment

curl GET https://www.openhub.net/p/{project_id}/enlistments/{enlistment_id}.xml

Collection URL

To get a list of all enlistments for a particular project:

curl https://www.openhub.net/p/{project_id}/enlistments.xml

The Enlistment collection method supports the standard collection request parameters with the following details:

  • query If supplied, enlistments with a code_location URL matching the query string will be returned.
  • sort Enlistment collections support the following sort options:
    • module_name
    • project
    • type
    • url (default)