Skip to content

Latest commit

 

History

History
103 lines (92 loc) · 3.95 KB

organization.md

File metadata and controls

103 lines (92 loc) · 3.95 KB

Organization

An organization is an entity which contains a collection of projects and accounts.

Properties

  • name Organization Name
  • url XML API URL for the organization.
  • html_url The URL for the organization page on OpenHub.
  • created_at The time at which the organization was initially added to OpenHub.
  • updated_at The time of most recent modification to the organization record.
  • description The optional description of the organization, currently limited to 800 characters.
  • homepage_url An optional URL for the home page of the organization, e.g Apache Software Foundation (www.apache.org)
  • url_name A short, unique, handle for the organization. e.g for url_name as 'apache' the equivalent web link is www.openhub.net/orgs/apache
  • small_logo_url An url to the organization’s 32×32 pixels logo image.
  • medium_logo_url An url to the organization’s 64×64 pixels logo image.
  • type The type of the organization(Non-profit/Commercial/Government/Educational).
  • inforgraphic_details Details presented in the organization page inforgraphic image
    • outside_committers
    • outside_committers_commits
    • projects_having_outside_commits
    • portfolio_projects
    • affiliators
    • affiliators_committing_to_portfolio_projects
    • affiliator_commits_to_portfolio_projects
    • affiliators_commiting_projects
    • outside_projects
    • outside_projects_commits
    • affiliators_committing_to_outside_projects
  • portfolio_projects First 10 Portfolio Projects for the requested organization
    • project Each project in the list with the following details
      • name
      • activity
      • primary_language
      • i_use_this
      • community_rating
      • twelve_mo_activity_and_year_on_year_change
        • commits
        • change_in_commits
        • percentage_change_in_commits
        • contributors
        • change_in_contributors
        • percentage_change_in_committers
    • detailed_page_url Url for paginated listing of all portfolio projects
  • outside_projects First 10 Outside Projects for the requested organization.
    • project Each project in the list with the following details
      • name
      • activity
      • claimed_by
      • i_use_this
      • community_rating
      • affiliates_contributing
      • commits_by_current_affiliates
    • detailed_page_url Url for paginated listing of all outside projects
  • outside_committers First 10 Outside Committers for the requested organization
    • contributor Each account in the list with the following details
      • name
      • kudos
      • level
      • affiliated_with
      • contributions_to_portfolio_projects
        • projects
        • twelve_mo_commits
    • detailed_page_url Url for paginated listing of all outside committers
  • affiliated_committers First 10 Affiliated Committers for the requested organization
    • affiliator Each account in the list with the following details
      • name
      • kudos
      • level
      • most_commits
        • project
        • commits
      • most_recent_commit
        • project
        • date
    • detailed_page_url Url for paginated listing of all affiliated committers

URL

https://www.openhub.net/orgs/{org_url_name}.xml?api_key={api_key}&view={view_option}

view_option will return the requested organization related data-table(maximum of 10 records)

  • The view option can be one of the following four portfolio_projects, outside_projects, affiliated_committers or outside_committers

Examples

https://www.openhub.net/orgs/mozilla.xml?api_key=some_example_api_key&view=portfolio_projects
https://www.openhub.net/orgs/mozilla.xml?api_key=some_example_api_key&view=outside_projects
https://www.openhub.net/orgs/mozilla.xml?api_key=some_example_api_key&view=affiliated_committers
https://www.openhub.net/orgs/mozilla.xml?api_key=some_example_api_key&view=outside_committers