Jump to

• Request
• Response
• Examples

Get an All Product Families Catalog Definition

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}

Use this endpoint to retrieve a catalog definition for the specified All Product Families item.

Request

Supported Media Types

• application/json

Path Parameters

• allProdFamsVarName(required): string
  Variable Name of All Product Families '_allProductFamilies'

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Product

Type: object

Title: Product

Show Source

• companyId: integer
  Title: Company Id

  Company Id
• label: string
  Title: Label

  Label
• variableName: string
  Title: Variable Name

  Variable Name

{
    "type":"object",
    "properties":{
        "companyId":{
            "type":"integer",
            "description":"Company Id",
            "title":"Company Id"
        },
        "label":{
            "type":"string",
            "description":"Label",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name",
            "title":"Variable Name"
        }
    },
    "title":"Product"
}

Back to Top

Examples

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

Response Body Sample

{
  "companyId": 4118171,
  "variableName": "_allProductFamilies",
  "label": "All Product Families",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
    }, {
      "kind": "",
      "rel": "child",
      "name": "attributes",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes"
    }, {
      "kind": "",
      "rel": "child",
      "name": "productFamilies",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies"
    }
  ]
}

Back to Top