Jump to

• Request
• Response
• Examples

Get List of All Product Families Definitions

get

/rest/v16/allProductFamilySetups

Use this endpoint to retrieve a list of definitions for All Product Families.

Request

Supported Media Types

• application/json

Query Parameters

• expand: string
  Allows expansion of relationships.
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : allProductFamilySetups-collection

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/allProductFamilySetups"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Product
  Title: Product

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

Nested 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 of All Product Families '_allProductFamilies'

  Variable Name of All Product Families '_allProductFamilies'

{
    "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 of All Product Families '_allProductFamilies'",
            "title":"Variable Name of All Product Families '_allProductFamilies'"
        }
    },
    "title":"Product"
}

Back to Top

Examples

The following example shows how to retrieve a list of catalog definitions for All Product Families 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 "Accept: application/json"
https://sitename.oracle.com/rest/v16/allProductFamilySetups

Response Body Sample

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

Back to Top