Jump to

• Request
• Response

Update a subgroup relationship

patch

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}

Request

Path Parameters

• ProdGroupId(required): integer(int64)
  The unique identifier of the product group.
• ProdGroupRelationshipId(required): integer(int64)
  The unique identifier of the product group relationship.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the related group relationship is active. The default value is true.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  The manually set display order for related groups in a product group.
• EndDate: string (date-time)
  Title: Effective to Date

  The date after which the related group relationship is inactive.
• ProdGroupId: integer (int64)
  The unique identifier of the parent product group.
• ProdGroupRelationshipId: integer (int64)
  The unique identifier of the product group relationship.
• RelProdGroupId: integer (int64)
  Title: Product Group

  The unique identifier of the related child product group.
• StartDate: string (date-time)
  Title: Effective from Date

  The date from which the related group relationship is active.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the parent product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the related group relationship is active.",
            "format":"date-time",
            "nullable":false
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for related groups in a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelProdGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier of the related child product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the related group relationship is inactive.",
            "format":"date-time",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the related group relationship is active. The default value is true.",
            "nullable":false,
            "default":true
        },
        "ProdGroupRelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the product group relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : setupSalesCatalogs-ProductGroupRelationSetup-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the related group relationship is active. The default value is true.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  The manually set display order for related groups in a product group.
• EndDate: string (date-time)
  Title: Effective to Date

  The date after which the related group relationship is inactive.
• InternalName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The internal name of the product group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParPGReferenceNumber: string
  Title: Parent Product Group Reference Number

  Maximum Length: 50

  The par pgreferenceurations of the product.
• PGDetailsReferenceNumber: string
  Title: Reference Number

  Maximum Length: 50

  The pgdetails referenceurations of the product.
• ProdGroupId: integer (int64)
  The unique identifier of the parent product group.
• ProdGroupRelationshipId: integer (int64)
  The unique identifier of the product group relationship.
• RelProdGroupId: integer (int64)
  Title: Product Group

  The unique identifier of the related child product group.
• StartDate: string (date-time)
  Title: Effective from Date

  The date from which the related group relationship is active.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the parent product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the related group relationship is active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for related groups in a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PGDetailsReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The pgdetails referenceurations of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The par pgreferenceurations of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "RelProdGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier of the related child product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the related group relationship is inactive.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the related group relationship is active. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ProdGroupRelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the product group relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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