Jump to

• Request
• Response

Get a Product Line Catalog Definition

get

/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}

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

Request

Supported Media Types

• application/json

Path Parameters

• prodFamVarName(required): string
  Variable Name of the Product Family.
• prodLineVarName(required): string
  Variable Name of the Product Line
• varName(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 Lines

Type: object

Title: Product Lines

Show Source

• companyId: integer
  Title: Company Id

  Id Of Company
• 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.
• description: string
  Title: Description

  Description of the Product Line
• id: integer
  Title: Id

  Primary Key of the resource
• label: string
  Title: Product Line Name

  Name of the Product Line
• parentId: integer
  Title: Parent Id

  Id Of Immediate Parent
• segmentId: integer
  Title: Segment Id

  Segment Id of Product Family
• variableName: string
  Title: Variable Name of All Product Families '_allProductFamilies'

  Variable Name of the Product Line

{
    "type":"object",
    "properties":{
        "companyId":{
            "type":"integer",
            "description":"Id Of Company",
            "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"
        },
        "description":{
            "type":"string",
            "description":"Description of the Product Line",
            "title":"Description"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Product Line",
            "title":"Product Line Name"
        },
        "parentId":{
            "type":"integer",
            "description":"Id Of Immediate Parent",
            "title":"Parent Id"
        },
        "segmentId":{
            "type":"integer",
            "description":"Segment Id of Product Family",
            "title":"Segment Id"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Product Line",
            "title":"Variable Name of All Product Families '_allProductFamilies'"
        }
    },
    "title":"Product Lines"
}

Back to Top