Get Product Family Metadata
get
/rest/v16/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.
Response
Supported Media Types
- application/json
Default Response
Product family details.
Root Schema : productFam
Type:
Show Source
object
-
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:
object Reference Links
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable -
orderNumber:
integer
Title:
Order
Order Number. -
segmentId:
integer
Title:
Segment Id
Segment Identifier. -
VarName:
string
Title:
Variable Name
Product family variable name.
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
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
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/v16/productFamilies/vision" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/arraySets" } ], "label": "Hi-Tech", "variableName": "vision", "segmentId": 10, "orderNumber": 1 }