Jump to

• Request
• Response
• Examples

Get Product Lines Metadata

get

/rest/v16/productFamilies/{prodFamVarName}/productLines

This endpoint returns definitions for a specific Product Line within a Product Family.

Request

Path Parameters

• prodFamVarName(required): string
  Product family variable name.

Query Parameters

• excludeLinks: string
  Exclude links.
• expand: string
  Allows expansion of relationships.
• showParentAttrs: string
  Allows expansion of parent attributes.

Back to Top

Response

Supported Media Types

• application/json

Default Response

List of product lines.

Body ()

Root Schema : productLine-collection

Type: object

Show Source

• items: array Product Lines
  Title: Product Lines

  List of product lines
• links: object Reference Links
  Title: Reference Links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of product lines",
            "title":"Product Lines",
            "items":{
                "$ref":"#/definitions/productLine"
            }
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Product Lines

Type: array

Title: Product Lines

List of product lines

Show Source

• Array of: object productLine

{
    "type":"array",
    "description":"List of product lines",
    "title":"Product Lines",
    "items":{
        "$ref":"#/definitions/productLine"
    }
}

Nested Schema : Reference Links

Type: object

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: href

  URL to the related object
• rel: string
  Title: Link

  Link relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relationship to the current object",
            "title":"Link"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"href"
        }
    },
    "title":"Reference Links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : productLine

Type: object

Show Source

• _bm_pline_description: string
  Title: Product Line Description

  Product line description.
• _bm_pline_name: string
  Title: Product Line Name

  Product line display name.
• _bm_pline_variable_name: string
  Title: Product Line Variable Name

  Unique variable name to identify the product line.
• customProperties: object Custom Properties
  Title: Custom Properties

  Custom properties of the product line.
• id: integer
  Title: Id

  Primary key of the product line.
• links: object Reference Links
  Title: Reference Links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary key of the product line.",
            "title":"Id"
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the product line.",
            "title":"Custom Properties",
            "properties":{
            }
        },
        "_bm_pline_name":{
            "type":"string",
            "description":"Product line display name.",
            "title":"Product Line Name"
        },
        "_bm_pline_variable_name":{
            "type":"string",
            "description":"Unique variable name to identify the product line.",
            "title":"Product Line Variable Name "
        },
        "_bm_pline_description":{
            "type":"string",
            "description":"Product line description.",
            "title":"Product Line Description"
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Custom Properties

Type: object

Title: Custom Properties

Custom properties of the product line.

Show Source

{
    "type":"object",
    "description":"Custom properties of the product line.",
    "title":"Custom Properties",
    "properties":{
    }
}

Back to Top

Examples

The following example shows how to retrieve the metadata for the specified Configuration item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines

Response Body Sample

{
  "items": [{
      "id": 36637525,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/models"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/attributes"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/arraySets"
        }
      ],
      "customProperties": {},
      "_bm_pline_name": "Servers",
      "_bm_pline_variable_name": "servers",
      "_bm_pline_description": "<img src='$BASE_PATH$/Vision/OLDserver-banner.png' alt='' />"
    }, {
      "id": 36637526,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/models"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/arraySets"
        }
      ],
      "customProperties": {},
      "_bm_pline_name": "Laptops",
      "_bm_pline_variable_name": "laptops",
      "_bm_pline_description": "<img src='$BASE_PATH$/Vision/OLDlaptop-banner.png' alt='' />"
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines"
    }
  ]
}

Back to Top