Jump to

• Request
• Response
• Examples

Get a Product Family Catalog Definition

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}

Use this endpoint to retrieve a catalog definition for the specified Product Family.

Request

Supported Media Types

• application/json

Path Parameters

• allProdFamsVarName(required): string
  Variable Name of All Product Families '_allProductFamilies'
• prodFamVarName(required): string
  Variable Name of the Product Family.

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Product Family

Type: object

Title: Product Family

Show Source

• activeLayoutType: string
  Title: Active Layout Type

  Current Active Layout Type
• companyId: integer
  Title: Company Id

  Company Id
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

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

  Identifier for the resource
• label: string
  Title: Label

  Product Family Label
• lastDeployedDate: string
  Title: Last Deployed Date

  The date of the last successful product family deployment.
• name: string
  Title: Name

  Product Family Name
• segmentId: integer
  Title: Segment Id

  Segment Id
• variableName: string
  Title: Variable Name

  Variable Name

{
    "type":"object",
    "properties":{
        "activeLayoutType":{
            "type":"string",
            "description":"Current Active Layout Type",
            "title":"Active Layout Type"
        },
        "companyId":{
            "type":"integer",
            "description":"Company Id",
            "title":"Company Id"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Identifier for the resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Product Family Label",
            "title":"Label"
        },
        "lastDeployedDate":{
            "type":"string",
            "description":"The date of the last successful product family deployment.",
            "title":"Last Deployed Date"
        },
        "name":{
            "type":"string",
            "description":"Product Family Name",
            "title":"Name"
        },
        "segmentId":{
            "type":"integer",
            "description":"Segment Id",
            "title":"Segment Id"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name",
            "title":"Variable Name"
        }
    },
    "title":"Product Family"
}

Back to Top

Examples

The following example shows how to retrieve a catalog definition for the specified Product Family 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 "Accept: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC

Response Body Sample

{
  "companyId": 4118171,
  "variableName": "unityINC",
  "segmentId": 13,
  "name": "Unity INC",
  "dateModified": "2021-02-03T17:40:33Z",
  "id": 36732579,
  "dateAdded": "2018-11-09T17:24:51Z",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC"
    }, {
      "kind": "",
      "rel": "child",
      "name": "attributes",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/attributes"
    }, {
      "kind": "",
      "rel": "child",
      "name": "productLines",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
    }
  ]
}

Back to Top