Jump to

• Request
• Response

Get List of Product Family Catalog Definitions

get

/rest/v16/allProductFamilySetups/{varName}/productFamilies

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

Request

Supported Media Types

• application/json

Path Parameters

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

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 : productFamilySetups-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/productFamilySetups"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Product Family
  Title: Product Family

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

Nested Schema : Product Family

Type: object

Title: Product Family

Show Source

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

  Variable Name of All Product Families '_allProductFamilies'

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

Back to Top