GET Beef Cut Tree

For a given beef cut, this call will return all the ancestors that are available for the cut, and will return all the descendants of the given cut using deep recursion including all the leaves of the tree until there are no more available. This call returns the media for any cut that is online.

The base URI for Get beef cut tree by ID is:

GET /api/v2/beefcut/{id}/tree

Get Beef Cut Tree By ID Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
id path integer
  A valid beef cut ingredient ID
AuthorizationAppID (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)
AuthorizationAppKey (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)

What it Returns

Requests to the GET beef cut tree by ID will return the following data:

Name & Description Type
  • BeefAPIIngredientTreeListing object
    A container that holds the resulting list of beef cuts.
    • ingredientTree array
      A list of beef cuts that are found as parents, children or cousins of this beef cut. This data structure is used to communicate the hierarchy of relationships of this beef cut.
      • parentIngredientID int
        The parent beef cut ingredient ID of this beef cut tree record.
      • isBeefPrimal boolean
        True if this beef cut tree record is a primal beef cut.
      • isBeefSubprimal boolean
        True if this beef cut tree record is a subprimal beef cut.
      • isBeefSubsection boolean
        True if this beef cut tree record is a subsection beef cut.
      • isBeefFabricatedCut boolean
        True if this beef cut tree record is a fabricated beef cut.
      • isLean boolean
        True if this beef cut tree record is a lean beef cut.
      • isMarinate boolean
        True if this beef cut tree record beef cut is suggested to marinate./span>
      • ingredientID int
        The beef cut ingredient ID of this beef cut tree record.
      • ingredientName string
        Name of the beef cut.
      • ingredientNameSlug string
        URL-friendly slugged name of the beef cut.
      • isOnline boolean
        Marker to denote if this beef cut is available on the Beef API.
      • media array
        A list of media objects containing information about media assigned to this ingredient record. This data will only be present if a beef cut is online.
        • widenURL string
          This is the base part of the URL that is needed to build the embed link.
        • widenUID string
          This is the customer userid part of the URL that is needed to build the embed link.
        • externalID string
          This is the unique identifier of the media item.
        • filename string
          This is the filename of the media item.
        • title string
          This is the title of the media item.
        • caption string
          This is the caption used for the media item.
        • mediaGroup object
          Media will always be returned grouped and sorted. Use this grouping to help manage any groupings that may be suggested from the BeefAPI. Object values found in this array will be an exact match to what can be found in the master list of mediaGroups in the common endpoint (/api/v2/common/lookups).
          • mediaGroupName string
            Name of the media group.
          • mediaGroupNameSlug string
            URL-friendly slugged name of the media group.
          • objectType object
            The type object this media group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups).
            • objectTypeName string
              The name of the object type.
            • objectTypeNameSlug string
              URL-friendly name of the object type.
          • mediaType string
            The type of media returned.
          • sortOrder int
            The suggested sort order to be used for this media item.
          • links array
            A list HATEOAS for this media item that is a link to view the media in its original size.
            • rel string
              The rel attribute specifies the relationship between the current document and the linked document.
            • href string
              URI of the beefapi call to get more information for this links' context.
            • title string
              Title of the link./span>
      • links array
        A list of HATEOAS in relation to this beef cut. Typically if this beef cut is online, you will be provided with a link to the endpoint to get the full beef cut details. You will also be provided a link to get all the recipes that use this beef cut.
        • rel string
          The rel attribute specifies the relationship between the current document and the linked document.
        • href string
          URI of the beefapi call to get more information for this links' context.
        • title string
          Title of the link.