Jump to

• Request
• Response
• Examples

Get Product Family Metadata

get

/rest/v19/productFamilies/{prodFamVarName}

This endpoint returns definitions for a specific 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

Product family details.

Body ()

Root Schema : productFamily

Type: object

Show Source

• dateModified: string
  Title: Date Last Modified

  System field indicating the date on which the product family was last modified.
• id: integer
  Title: Id

  Primary key of the product family.
• label: string
  Title: Label

  Display name.
• links: array links
• orderNumber: integer
  Title: Order

  Order Number.
• segmentId: integer
  Title: Segment Id

  Segment Identifier.
• variableName: string
  Title: Variable Name

  Product family variable name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary key of the product family.",
            "title":"Id"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the product family was last modified.",
            "title":"Date Last Modified"
        },
        "label":{
            "type":"string",
            "description":"Display name.",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "description":"Product family variable name.",
            "title":"Variable Name"
        },
        "segmentId":{
            "type":"integer",
            "description":"Segment Identifier.",
            "title":"Segment Id"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order Number.",
            "title":"Order"
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

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

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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: URL to the related object

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

  Link Relationship to the current object

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

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 -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/productFamilies/vision

Translations

The following components can be appended to the end of this endpoint to return translation metadata:

• /translations - This returns all language translations for the requested entity.
• /translations/{langCode} - This returns a specific language translation for the requested entity. Example: /translations/es

Response Body Sample

{
  "id": 36637441,
  "dateModified": "2018-10-30T07:29:44.000Z",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/translations"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/arraySets"
    }
  ],
  "label": "Hi-Tech",
  "variableName": "vision",
  "segmentId": 10,
  "orderNumber": 1
}

Back to Top