Jump to

• Request
• Response

Get a product group

get

/crmRestApi/resources/11.13.18.05/productGroups/{ProdGrpDetailsId}

Request

Path Parameters

• ProdGrpDetailsId(required): integer(int64)
  The unique identifier of the product group detail.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productGroups-item-response

Type: object

Show Source

• ActiveFlag: string
  Title: Active

  Maximum Length: 1

  Default Value: Y

  Indicates whether the product group is active.
• AllowDuplicateContentFlag: string
  Title: Allow Duplicate Children

  Maximum Length: 1

  Default Value: Y

  Indicates whether a duplicate product or product group can be allowed in the product group hierarchy.
• AllowSelectionFlag: string
  Title: Allow Selection

  Maximum Length: 1

  Indicates whether the product group can be selected.
• EndDate: string (date-time)
  Title: Effective to Date

  The date when the product group becomes inactive.
• HierProdGroupDescTxt: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the product group in the hierarchy.
• HierProdGroupId: integer (int64)
  Read Only: true

  The unique identifier of the product group hier.
• HierProdGroupName: string
  Title: Name

  Read Only: true

  Maximum Length: 250

  The name of the product group hier.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the product group was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModelConfigAttributes: string
  Title: Model Attributes

  Maximum Length: 4000

  The model configurations attribute of the product group.
• ModelFamily: string
  Title: Model Family

  Maximum Length: 1000

  The name of the model family associated with the Product Group.
• ModelLine: string
  Title: Model Line

  Maximum Length: 1000

  The name of the model line associated with the Product Group.
• ModelName: string
  Title: Model

  Maximum Length: 1000

  The name of the product group.
• ProdGrpDetailsId: integer (int64)
  The unique identifier of the product group detail.
• ProductGroupReferenceNumber: string
  Title: Reference Number

  Maximum Length: 50

  The alternate reference number of the product group.
• RevenueCategoryCode: string
  Title: Revenue Category

  Maximum Length: 30

  The revenue category code.
• RevenueRoleCode: string
  Title: Revenue Role

  Maximum Length: 30

  The revenue role code.
• StartDate: string (date-time)
  Title: Effective from Date

  The date from when the product group becomes active.
• UsageRootFlag: string
  Title: Root Catalog

  Maximum Length: 1

  Default Value: N

  Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the product group is active.",
            "nullable":false,
            "default":"Y",
            "x-queryable":false
        },
        "AllowDuplicateContentFlag":{
            "title":"Allow Duplicate Children",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a duplicate product or product group can be allowed in the product group hierarchy.",
            "nullable":false,
            "default":"Y",
            "x-queryable":false
        },
        "AllowSelectionFlag":{
            "title":"Allow Selection",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the product group can be selected.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date when the product group becomes inactive.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "HierProdGroupDescTxt":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the product group in the hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HierProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group hier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HierProdGroupName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group hier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the product group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelConfigAttributes":{
            "title":"Model Attributes",
            "maxLength":4000,
            "type":"string",
            "description":"The model configurations attribute of the product group.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelFamily":{
            "title":"Model Family",
            "maxLength":1000,
            "type":"string",
            "description":"The name of the model family associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelLine":{
            "title":"Model Line",
            "maxLength":1000,
            "type":"string",
            "description":"The name of the model line associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelName":{
            "title":"Model",
            "maxLength":1000,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGrpDetailsId":{
            "type":"integer",
            "description":"The unique identifier of the product group detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate reference number of the product group.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ProdGrpDetailsId"
                ]
            },
            "x-queryable":true
        },
        "RevenueCategoryCode":{
            "title":"Revenue Category",
            "maxLength":30,
            "type":"string",
            "description":"The revenue category code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueRoleCode":{
            "title":"Revenue Role",
            "maxLength":30,
            "type":"string",
            "description":"The revenue role code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from when the product group becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "UsageRootFlag":{
            "title":"Root Catalog",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top