Jump to

• Request
• Response

Update one segment group

patch

/fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}

Request

Path Parameters

• SegmentGroupId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CatalogId: integer (int64)
  Value that uniquely identifies the catalog.
• CatalogName: string
  Maximum Length: 255

  Name of the catalog.
• Description: string
  Maximum Length: 240

  Description of the segment group.
• Segment: array Segments
  Title: Segments

  All segments within a specific segment group.
• SegmentGroupDimensions: array Segment Group Dimensions
  Title: Segment Group Dimensions

  A set of dimensions used for a segment group.
• SegmentGroupDuplicate: array Segment Group Duplicates
  Title: Segment Group Duplicates

  Segment group used to duplicate a new segment group.
• SegmentGroupExecute: array Segment Group Runs
  Title: Segment Group Runs

  Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.
• SegmentGroupHierarchyCreate: array Creating Hierarchies for Segmentation
  Title: Creating Hierarchies for Segmentation

  Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.
• SegmentGroupHierarchyDelete: array Deleting Hierarchies for Segmentation
  Title: Deleting Hierarchies for Segmentation

  Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.
• SegmentMemberCustomersLOV: array Segment Member Customers List of Values
  Title: Segment Member Customers List of Values

  This list of values includes all customer sites that are associated with the segment group.
• SegmentMemberDemandClassLOV: array Segment Member Demand Classes List of Values
  Title: Segment Member Demand Classes List of Values

  This list of values includes all demand classes that are associated with the segment group.
• SegmentMemberItemsLOV: array Segment Member Items List of Values
  Title: Segment Member Items List of Values

  This list of values includes all items that are associated with the segment group.
• SegmentMemberLocationsLOV: array Segment Member Locations List of Values
  Title: Segment Member Locations List of Values

  This list of values includes all locations that are associated with the segment group.
• SegmentMembers: array Segment Members
  Title: Segment Members

  A set of members like items, locations, demand class, or customer sites that are associated with segments.
• SegmentMemberSegmentsLOV: array Segments List of Values
  Title: Segments List of Values

  This list of values includes all segments that are associated with the segment group.
• SegmentNameLOV: array Segment Names List of Values
  Title: Segment Names List of Values

  This list of values includes all segment names that are associated with the segment group.
• SegmentResults: array Segmentation Results
  Title: Segmentation Results

  Result of the segmentation process.
• SimulationSetId: integer (int64)
  Value that uniquely identifies the simulation set.
• SimulationSetName: string
  Maximum Length: 255

  Name of the simulation set.
• SourceSystemName: string
  Maximum Length: 255

  Name of the source application.

{
    "type":"object",
    "properties":{
        "SegmentMemberDemandClassLOV":{
            "title":"Segment Member Demand Classes List of Values",
            "type":"array",
            "description":"This list of values includes all demand classes that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-patch-request"
            }
        },
        "SegmentMembers":{
            "title":"Segment Members",
            "type":"array",
            "description":"A set of members like items, locations, demand class, or customer sites that are associated with segments.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMembers-item-patch-request"
            }
        },
        "SegmentResults":{
            "title":"Segmentation Results",
            "type":"array",
            "description":"Result of the segmentation process.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentResults-item-patch-request"
            }
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the segment group.",
            "nullable":true
        },
        "SegmentGroupExecute":{
            "title":"Segment Group Runs",
            "type":"array",
            "description":"Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupExecute-item-patch-request"
            }
        },
        "SegmentGroupHierarchyDelete":{
            "title":"Deleting Hierarchies for Segmentation",
            "type":"array",
            "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-patch-request"
            }
        },
        "SourceSystemName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SegmentGroupDuplicate":{
            "title":"Segment Group Duplicates",
            "type":"array",
            "description":"Segment group used to duplicate a new segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDuplicate-item-patch-request"
            }
        },
        "SegmentGroupDimensions":{
            "title":"Segment Group Dimensions",
            "type":"array",
            "description":"A set of dimensions used for a segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDimensions-item-patch-request"
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SegmentNameLOV":{
            "title":"Segment Names List of Values",
            "type":"array",
            "description":"This list of values includes all segment names that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentNameLOV-item-patch-request"
            }
        },
        "Segment":{
            "title":"Segments",
            "type":"array",
            "description":"All segments within a specific segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-item-patch-request"
            }
        },
        "SegmentGroupHierarchyCreate":{
            "title":"Creating Hierarchies for Segmentation",
            "type":"array",
            "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-patch-request"
            }
        },
        "SegmentMemberCustomersLOV":{
            "title":"Segment Member Customers List of Values",
            "type":"array",
            "description":"This list of values includes all customer sites that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-patch-request"
            }
        },
        "SegmentMemberLocationsLOV":{
            "title":"Segment Member Locations List of Values",
            "type":"array",
            "description":"This list of values includes all locations that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-patch-request"
            }
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CatalogName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the catalog.",
            "nullable":true
        },
        "SegmentMemberItemsLOV":{
            "title":"Segment Member Items List of Values",
            "type":"array",
            "description":"This list of values includes all items that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberItemsLOV-item-patch-request"
            }
        },
        "SimulationSetName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the simulation set.",
            "nullable":true
        },
        "SegmentMemberSegmentsLOV":{
            "title":"Segments List of Values",
            "type":"array",
            "description":"This list of values includes all segments that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-patch-request"
            }
        }
    }
}

Nested Schema : Segments

Type: array

Title: Segments

All segments within a specific segment group.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-item-patch-request

{
    "title":"Segments",
    "type":"array",
    "description":"All segments within a specific segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-item-patch-request"
    }
}

Nested Schema : Segment Group Dimensions

Type: array

Title: Segment Group Dimensions

A set of dimensions used for a segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupDimensions-item-patch-request

{
    "title":"Segment Group Dimensions",
    "type":"array",
    "description":"A set of dimensions used for a segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDimensions-item-patch-request"
    }
}

Nested Schema : Segment Group Duplicates

Type: array

Title: Segment Group Duplicates

Segment group used to duplicate a new segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupDuplicate-item-patch-request

{
    "title":"Segment Group Duplicates",
    "type":"array",
    "description":"Segment group used to duplicate a new segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDuplicate-item-patch-request"
    }
}

Nested Schema : Segment Group Runs

Type: array

Title: Segment Group Runs

Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupExecute-item-patch-request

{
    "title":"Segment Group Runs",
    "type":"array",
    "description":"Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupExecute-item-patch-request"
    }
}

Nested Schema : Creating Hierarchies for Segmentation

Type: array

Title: Creating Hierarchies for Segmentation

Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-patch-request

{
    "title":"Creating Hierarchies for Segmentation",
    "type":"array",
    "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-patch-request"
    }
}

Nested Schema : Deleting Hierarchies for Segmentation

Type: array

Title: Deleting Hierarchies for Segmentation

Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-patch-request

{
    "title":"Deleting Hierarchies for Segmentation",
    "type":"array",
    "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-patch-request"
    }
}

Nested Schema : Segment Member Customers List of Values

Type: array

Title: Segment Member Customers List of Values

This list of values includes all customer sites that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-patch-request

{
    "title":"Segment Member Customers List of Values",
    "type":"array",
    "description":"This list of values includes all customer sites that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-patch-request"
    }
}

Nested Schema : Segment Member Demand Classes List of Values

Type: array

Title: Segment Member Demand Classes List of Values

This list of values includes all demand classes that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-patch-request

{
    "title":"Segment Member Demand Classes List of Values",
    "type":"array",
    "description":"This list of values includes all demand classes that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-patch-request"
    }
}

Nested Schema : Segment Member Items List of Values

Type: array

Title: Segment Member Items List of Values

This list of values includes all items that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberItemsLOV-item-patch-request

{
    "title":"Segment Member Items List of Values",
    "type":"array",
    "description":"This list of values includes all items that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberItemsLOV-item-patch-request"
    }
}

Nested Schema : Segment Member Locations List of Values

Type: array

Title: Segment Member Locations List of Values

This list of values includes all locations that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-patch-request

{
    "title":"Segment Member Locations List of Values",
    "type":"array",
    "description":"This list of values includes all locations that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-patch-request"
    }
}

Nested Schema : Segment Members

Type: array

Title: Segment Members

A set of members like items, locations, demand class, or customer sites that are associated with segments.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMembers-item-patch-request

{
    "title":"Segment Members",
    "type":"array",
    "description":"A set of members like items, locations, demand class, or customer sites that are associated with segments.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMembers-item-patch-request"
    }
}

Nested Schema : Segments List of Values

Type: array

Title: Segments List of Values

This list of values includes all segments that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-patch-request

{
    "title":"Segments List of Values",
    "type":"array",
    "description":"This list of values includes all segments that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-patch-request"
    }
}

Nested Schema : Segment Names List of Values

Type: array

Title: Segment Names List of Values

This list of values includes all segment names that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentNameLOV-item-patch-request

{
    "title":"Segment Names List of Values",
    "type":"array",
    "description":"This list of values includes all segment names that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentNameLOV-item-patch-request"
    }
}

Nested Schema : Segmentation Results

Type: array

Title: Segmentation Results

Result of the segmentation process.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentResults-item-patch-request

{
    "title":"Segmentation Results",
    "type":"array",
    "description":"Result of the segmentation process.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentResults-item-patch-request"
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-item-patch-request

Type: object

Show Source

• Description: string
  Maximum Length: 240

  Description of the segment.
• Priority: integer (int32)
  Priority of the segment
• SegmentCriteria: array Segment Criteria
  Title: Segment Criteria

  Segment criteria used for segmentation.
• SegmentDataDelete: array Segment Data
  Title: Segment Data

  Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.
• SegmentDuplicate: array Segment Duplicates
  Title: Segment Duplicates

  Segment used to duplicate a new segment.
• SegmentName: string
  Maximum Length: 120

  Name of the segment.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the segment.",
            "nullable":true
        },
        "SegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":false
        },
        "SegmentCriteria":{
            "title":"Segment Criteria",
            "type":"array",
            "description":"Segment criteria used for segmentation.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-item-patch-request"
            }
        },
        "Priority":{
            "type":"integer",
            "description":"Priority of the segment",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "SegmentDataDelete":{
            "title":"Segment Data",
            "type":"array",
            "description":"Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDataDelete-item-patch-request"
            }
        },
        "SegmentDuplicate":{
            "title":"Segment Duplicates",
            "type":"array",
            "description":"Segment used to duplicate a new segment.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDuplicate-item-patch-request"
            }
        }
    }
}

Nested Schema : Segment Criteria

Type: array

Title: Segment Criteria

Segment criteria used for segmentation.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentCriteria-item-patch-request

{
    "title":"Segment Criteria",
    "type":"array",
    "description":"Segment criteria used for segmentation.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-item-patch-request"
    }
}

Nested Schema : Segment Data

Type: array

Title: Segment Data

Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentDataDelete-item-patch-request

{
    "title":"Segment Data",
    "type":"array",
    "description":"Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDataDelete-item-patch-request"
    }
}

Nested Schema : Segment Duplicates

Type: array

Title: Segment Duplicates

Segment used to duplicate a new segment.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentDuplicate-item-patch-request

{
    "title":"Segment Duplicates",
    "type":"array",
    "description":"Segment used to duplicate a new segment.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDuplicate-item-patch-request"
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-SegmentCriteria-item-patch-request

Type: object

Show Source

• CriteriaOperator: integer (int32)
  Value that uniquely identifies the criteria operator.
• EntityId: integer (int64)
  Value that uniquely identifies the entity.
• GroupNumber: integer (int32)
  Group number for the criteria.
• MeasureId: integer (int64)
  Value that uniquely identifies the measure.
• ObjectVersionNumber: integer (int32)
  Object version number.
• SegmentPlans: array Segment Plans
  Title: Segment Plans

  Segment plans used for segmentation.
• SegmentValues: array Segment Values
  Title: Segment Values

  Segment values used for segmentation.
• SelectedDimension: integer
  Value that uniquely identifies the selected dimension.
• TableId: integer (int64)
  Value that uniquely identifies the table.

{
    "type":"object",
    "properties":{
        "TableId":{
            "type":"integer",
            "description":"Value that uniquely identifies the table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SegmentPlans":{
            "title":"Segment Plans",
            "type":"array",
            "description":"Segment plans used for segmentation.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-patch-request"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "GroupNumber":{
            "type":"integer",
            "description":"Group number for the criteria.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "SelectedDimension":{
            "type":"integer",
            "description":"Value that uniquely identifies the selected dimension.",
            "nullable":false
        },
        "CriteriaOperator":{
            "type":"integer",
            "description":"Value that uniquely identifies the criteria operator.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            }
        },
        "SegmentValues":{
            "title":"Segment Values",
            "type":"array",
            "description":"Segment values used for segmentation.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-patch-request"
            }
        }
    }
}

Nested Schema : Segment Plans

Type: array

Title: Segment Plans

Segment plans used for segmentation.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-patch-request

{
    "title":"Segment Plans",
    "type":"array",
    "description":"Segment plans used for segmentation.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-patch-request"
    }
}

Nested Schema : Segment Values

Type: array

Title: Segment Values

Segment values used for segmentation.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-patch-request

{
    "title":"Segment Values",
    "type":"array",
    "description":"Segment values used for segmentation.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-patch-request"
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-patch-request

Type: object

Show Source

• PlanId: integer (int64)
  Value that uniquely identifies the plan.

{
    "type":"object",
    "properties":{
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-patch-request

Type: object

Show Source

• CriteriaValue: string
  Maximum Length: 240

  Value used for the criteria.
• FromDate: string (date)
  From date of the segment value.
• FromValue: number
  From value of the segment value.
• ToDate: string (date)
  To date of the segment value.
• ToValue: number
  To value of the segment value.

{
    "type":"object",
    "properties":{
        "ToValue":{
            "type":"number",
            "description":"To value of the segment value.",
            "nullable":true
        },
        "FromDate":{
            "type":"string",
            "description":"From date of the segment value.",
            "format":"date",
            "nullable":true
        },
        "ToDate":{
            "type":"string",
            "description":"To date of the segment value.",
            "format":"date",
            "nullable":true
        },
        "CriteriaValue":{
            "maxLength":240,
            "type":"string",
            "description":"Value used for the criteria.",
            "nullable":true
        },
        "FromValue":{
            "type":"number",
            "description":"From value of the segment value.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-SegmentDataDelete-item-patch-request

Type: object

Show Source

• Message: string
  Maximum Length: 255

  Message for segment data deletion.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for segment data deletion.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-SegmentDuplicate-item-patch-request

Type: object

Show Source

• Message: string
  Maximum Length: 255

  Message for the new segment.
• NewSegmentDescription: string
  Maximum Length: 255

  Description of the new segment.
• NewSegmentId: integer
  Value that uniquely identifies the new segment.
• NewSegmentName: string
  Maximum Length: 255

  Name of the new segment.
• NewSegmentPriority: integer
  Priority of the new segment.

{
    "type":"object",
    "properties":{
        "NewSegmentDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the new segment.",
            "nullable":true
        },
        "NewSegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new segment.",
            "nullable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for the new segment.",
            "nullable":true
        },
        "NewSegmentPriority":{
            "type":"integer",
            "description":"Priority of the new segment.",
            "nullable":true
        },
        "NewSegmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the new segment.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentGroupDimensions-item-patch-request

Type: object

Show Source

• DataColumnId: integer (int32)
  Value that uniquely identifies the data column.
• DimensionId: integer (int64)
  Value that uniquely identifies the dimension.
• DimensionName: string
  Maximum Length: 255

  Name of the dimension.
• LevelId: integer (int64)
  Value that uniquely identifies the level.
• LevelName: string
  Maximum Length: 255

  Name of the level.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.

{
    "type":"object",
    "properties":{
        "DataColumnId":{
            "type":"integer",
            "description":"Value that uniquely identifies the data column.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "LevelName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the level.",
            "nullable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DimensionName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the dimension.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentGroupDuplicate-item-patch-request

Type: object

Show Source

• Message: string
  Maximum Length: 255

  Message for the new segment group.
• NewSegmentGroupDescription: string
  Maximum Length: 255

  Description of the new segment group.
• NewSegmentGroupId: integer
  Value that uniquely identifies the new segment group.
• NewSegmentGroupName: string
  Maximum Length: 255

  Name of the new segment group.

{
    "type":"object",
    "properties":{
        "NewSegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new segment group.",
            "nullable":true
        },
        "NewSegmentGroupName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the new segment group.",
            "nullable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for the new segment group.",
            "nullable":true
        },
        "NewSegmentGroupDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the new segment group.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentGroupExecute-item-patch-request

Type: object

Show Source

• ESSProcessId: integer
  Value that uniquely identifies the segmentation process.
• KeepOverrides: integer
  Value that identifies if the segment overrides are to be retained or not.
• KeepPrevious: integer
  Value that identifies if the last segmentation result is to be saved or not.
• Message: string
  Maximum Length: 255

  Message for the segmentation process.

{
    "type":"object",
    "properties":{
        "KeepOverrides":{
            "type":"integer",
            "description":"Value that identifies if the segment overrides are to be retained or not.",
            "nullable":true
        },
        "KeepPrevious":{
            "type":"integer",
            "description":"Value that identifies if the last segmentation result is to be saved or not.",
            "nullable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for the segmentation process.",
            "nullable":true
        },
        "ESSProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segmentation process.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-patch-request

Type: object

Show Source

• Message: string
  Maximum Length: 255

  Message for segment group hierarchy creation.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for segment group hierarchy creation.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-patch-request

Type: object

Show Source

• Message: string
  Maximum Length: 255

  Message for segment group hierarchy deletion.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for segment group hierarchy deletion.",
            "nullable":true
        }
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentMemberItemsLOV-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentMembers-item-patch-request

Type: object

Show Source

• OverrideSegmentId: integer (int64)
  Value that uniquely identifies a segment that's used as a segment override.
• OverrideSegmentName: string
  Maximum Length: 120

  Name of the override segment.

{
    "type":"object",
    "properties":{
        "OverrideSegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the override segment.",
            "nullable":true
        },
        "OverrideSegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies a segment that's used as a segment override.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentNameLOV-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : planningSegmentGroupsV2-SegmentResults-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : planningSegmentGroupsV2-item-response

Type: object

Show Source

• CatalogId: integer (int64)
  Value that uniquely identifies the catalog.
• CatalogName: string
  Maximum Length: 255

  Name of the catalog.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the segment group.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the segment group.
• Description: string
  Maximum Length: 240

  Description of the segment group.
• GroupName: string
  Maximum Length: 120

  Name of the segment group.
• LastRunDate: string (date-time)
  Read Only: true

  Date when the segmentation process was most recently run.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the segment group.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the segment group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Segment: array Segments
  Title: Segments

  All segments within a specific segment group.
• SegmentGroupDimensions: array Segment Group Dimensions
  Title: Segment Group Dimensions

  A set of dimensions used for a segment group.
• SegmentGroupDuplicate: array Segment Group Duplicates
  Title: Segment Group Duplicates

  Segment group used to duplicate a new segment group.
• SegmentGroupExecute: array Segment Group Runs
  Title: Segment Group Runs

  Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.
• SegmentGroupHierarchyCreate: array Creating Hierarchies for Segmentation
  Title: Creating Hierarchies for Segmentation

  Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.
• SegmentGroupHierarchyDelete: array Deleting Hierarchies for Segmentation
  Title: Deleting Hierarchies for Segmentation

  Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.
• SegmentGroupId: integer (int64)
  Value that uniquely identifies the segment group.
• SegmentMemberCustomersLOV: array Segment Member Customers List of Values
  Title: Segment Member Customers List of Values

  This list of values includes all customer sites that are associated with the segment group.
• SegmentMemberDemandClassLOV: array Segment Member Demand Classes List of Values
  Title: Segment Member Demand Classes List of Values

  This list of values includes all demand classes that are associated with the segment group.
• SegmentMemberItemsLOV: array Segment Member Items List of Values
  Title: Segment Member Items List of Values

  This list of values includes all items that are associated with the segment group.
• SegmentMemberLocationsLOV: array Segment Member Locations List of Values
  Title: Segment Member Locations List of Values

  This list of values includes all locations that are associated with the segment group.
• SegmentMembers: array Segment Members
  Title: Segment Members

  A set of members like items, locations, demand class, or customer sites that are associated with segments.
• SegmentMemberSegmentsLOV: array Segments List of Values
  Title: Segments List of Values

  This list of values includes all segments that are associated with the segment group.
• SegmentNameLOV: array Segment Names List of Values
  Title: Segment Names List of Values

  This list of values includes all segment names that are associated with the segment group.
• SegmentResults: array Segmentation Results
  Title: Segmentation Results

  Result of the segmentation process.
• SimulationSetId: integer (int64)
  Value that uniquely identifies the simulation set.
• SimulationSetName: string
  Maximum Length: 255

  Name of the simulation set.
• SourceSystemId: integer (int64)
  Value that uniquely identifies the source application.
• SourceSystemName: string
  Maximum Length: 255

  Name of the source application.
• Status: string
  Read Only: true

  Maximum Length: 255

  Status of the segmentation process.
• StatusCode: integer (int32)
  Read Only: true

  Value that identifies the status of the segmentation process that was run. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.

{
    "type":"object",
    "properties":{
        "GroupName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment group.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentMemberDemandClassLOV":{
            "title":"Segment Member Demand Classes List of Values",
            "type":"array",
            "description":"This list of values includes all demand classes that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-response"
            }
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the segment group.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Value that identifies the status of the segmentation process that was run. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentNameLOV":{
            "title":"Segment Names List of Values",
            "type":"array",
            "description":"This list of values includes all segment names that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentNameLOV-item-response"
            }
        },
        "Segment":{
            "title":"Segments",
            "type":"array",
            "description":"All segments within a specific segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-item-response"
            }
        },
        "LastRunDate":{
            "type":"string",
            "description":"Date when the segmentation process was most recently run.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentGroupHierarchyCreate":{
            "title":"Creating Hierarchies for Segmentation",
            "type":"array",
            "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SimulationSetName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the simulation set.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentMemberSegmentsLOV":{
            "title":"Segments List of Values",
            "type":"array",
            "description":"This list of values includes all segments that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-response"
            }
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the segmentation process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the segment group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentMembers":{
            "title":"Segment Members",
            "type":"array",
            "description":"A set of members like items, locations, demand class, or customer sites that are associated with segments.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMembers-item-response"
            }
        },
        "SegmentResults":{
            "title":"Segmentation Results",
            "type":"array",
            "description":"Result of the segmentation process.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentResults-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the segment group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentGroupExecute":{
            "title":"Segment Group Runs",
            "type":"array",
            "description":"Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupExecute-item-response"
            }
        },
        "SegmentGroupHierarchyDelete":{
            "title":"Deleting Hierarchies for Segmentation",
            "type":"array",
            "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-response"
            }
        },
        "SegmentGroupDuplicate":{
            "title":"Segment Group Duplicates",
            "type":"array",
            "description":"Segment group used to duplicate a new segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDuplicate-item-response"
            }
        },
        "SegmentGroupDimensions":{
            "title":"Segment Group Dimensions",
            "type":"array",
            "description":"A set of dimensions used for a segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDimensions-item-response"
            }
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentMemberCustomersLOV":{
            "title":"Segment Member Customers List of Values",
            "type":"array",
            "description":"This list of values includes all customer sites that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-response"
            }
        },
        "SegmentMemberLocationsLOV":{
            "title":"Segment Member Locations List of Values",
            "type":"array",
            "description":"This list of values includes all locations that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-response"
            }
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CatalogName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentMemberItemsLOV":{
            "title":"Segment Member Items List of Values",
            "type":"array",
            "description":"This list of values includes all items that are associated with the segment group.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberItemsLOV-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Segments

Type: array

Title: Segments

All segments within a specific segment group.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-item-response

{
    "title":"Segments",
    "type":"array",
    "description":"All segments within a specific segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-item-response"
    }
}

Nested Schema : Segment Group Dimensions

Type: array

Title: Segment Group Dimensions

A set of dimensions used for a segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupDimensions-item-response

{
    "title":"Segment Group Dimensions",
    "type":"array",
    "description":"A set of dimensions used for a segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDimensions-item-response"
    }
}

Nested Schema : Segment Group Duplicates

Type: array

Title: Segment Group Duplicates

Segment group used to duplicate a new segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupDuplicate-item-response

{
    "title":"Segment Group Duplicates",
    "type":"array",
    "description":"Segment group used to duplicate a new segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupDuplicate-item-response"
    }
}

Nested Schema : Segment Group Runs

Type: array

Title: Segment Group Runs

Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupExecute-item-response

{
    "title":"Segment Group Runs",
    "type":"array",
    "description":"Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupExecute-item-response"
    }
}

Nested Schema : Creating Hierarchies for Segmentation

Type: array

Title: Creating Hierarchies for Segmentation

Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-response

{
    "title":"Creating Hierarchies for Segmentation",
    "type":"array",
    "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-response"
    }
}

Nested Schema : Deleting Hierarchies for Segmentation

Type: array

Title: Deleting Hierarchies for Segmentation

Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-response

{
    "title":"Deleting Hierarchies for Segmentation",
    "type":"array",
    "description":"Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-response"
    }
}

Nested Schema : Segment Member Customers List of Values

Type: array

Title: Segment Member Customers List of Values

This list of values includes all customer sites that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-response

{
    "title":"Segment Member Customers List of Values",
    "type":"array",
    "description":"This list of values includes all customer sites that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-response"
    }
}

Nested Schema : Segment Member Demand Classes List of Values

Type: array

Title: Segment Member Demand Classes List of Values

This list of values includes all demand classes that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-response

{
    "title":"Segment Member Demand Classes List of Values",
    "type":"array",
    "description":"This list of values includes all demand classes that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-response"
    }
}

Nested Schema : Segment Member Items List of Values

Type: array

Title: Segment Member Items List of Values

This list of values includes all items that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberItemsLOV-item-response

{
    "title":"Segment Member Items List of Values",
    "type":"array",
    "description":"This list of values includes all items that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberItemsLOV-item-response"
    }
}

Nested Schema : Segment Member Locations List of Values

Type: array

Title: Segment Member Locations List of Values

This list of values includes all locations that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-response

{
    "title":"Segment Member Locations List of Values",
    "type":"array",
    "description":"This list of values includes all locations that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-response"
    }
}

Nested Schema : Segment Members

Type: array

Title: Segment Members

A set of members like items, locations, demand class, or customer sites that are associated with segments.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMembers-item-response

{
    "title":"Segment Members",
    "type":"array",
    "description":"A set of members like items, locations, demand class, or customer sites that are associated with segments.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMembers-item-response"
    }
}

Nested Schema : Segments List of Values

Type: array

Title: Segments List of Values

This list of values includes all segments that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-response

{
    "title":"Segments List of Values",
    "type":"array",
    "description":"This list of values includes all segments that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-response"
    }
}

Nested Schema : Segment Names List of Values

Type: array

Title: Segment Names List of Values

This list of values includes all segment names that are associated with the segment group.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentNameLOV-item-response

{
    "title":"Segment Names List of Values",
    "type":"array",
    "description":"This list of values includes all segment names that are associated with the segment group.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentNameLOV-item-response"
    }
}

Nested Schema : Segmentation Results

Type: array

Title: Segmentation Results

Result of the segmentation process.

Show Source

• Array of: object planningSegmentGroupsV2-SegmentResults-item-response

{
    "title":"Segmentation Results",
    "type":"array",
    "description":"Result of the segmentation process.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-SegmentResults-item-response"
    }
}

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."
        }
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the segment.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the segment.
• Description: string
  Maximum Length: 240

  Description of the segment.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the segment.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the segment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Priority: integer (int32)
  Priority of the segment
• SegmentCriteria: array Segment Criteria
  Title: Segment Criteria

  Segment criteria used for segmentation.
• SegmentDataDelete: array Segment Data
  Title: Segment Data

  Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.
• SegmentDuplicate: array Segment Duplicates
  Title: Segment Duplicates

  Segment used to duplicate a new segment.
• SegmentGroupId: integer (int64)
  Value that uniquely identifies the segment group.
• SegmentId: integer (int64)
  Value that uniquely identifies the segment.
• SegmentName: string
  Maximum Length: 120

  Name of the segment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the segment.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":false,
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority of the segment",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "SegmentCriteria":{
            "title":"Segment Criteria",
            "type":"array",
            "description":"Segment criteria used for segmentation.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-item-response"
            }
        },
        "SegmentDuplicate":{
            "title":"Segment Duplicates",
            "type":"array",
            "description":"Segment used to duplicate a new segment.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDuplicate-item-response"
            }
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentDataDelete":{
            "title":"Segment Data",
            "type":"array",
            "description":"Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDataDelete-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Segment Criteria

Type: array

Title: Segment Criteria

Segment criteria used for segmentation.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentCriteria-item-response

{
    "title":"Segment Criteria",
    "type":"array",
    "description":"Segment criteria used for segmentation.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-item-response"
    }
}

Nested Schema : Segment Data

Type: array

Title: Segment Data

Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentDataDelete-item-response

{
    "title":"Segment Data",
    "type":"array",
    "description":"Grouping of item-location combinations on the basis of user-defined, static, or dynamic attributes. Through segmentation, you can better manage the replenishment requirements for many item-location combinations by grouping them into a few segments.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDataDelete-item-response"
    }
}

Nested Schema : Segment Duplicates

Type: array

Title: Segment Duplicates

Segment used to duplicate a new segment.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentDuplicate-item-response

{
    "title":"Segment Duplicates",
    "type":"array",
    "description":"Segment used to duplicate a new segment.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentDuplicate-item-response"
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-SegmentCriteria-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the segment criteria.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the segment criteria.
• CriteriaOperator: integer (int32)
  Value that uniquely identifies the criteria operator.
• CriteriaOperatorName: string
  Read Only: true

  Maximum Length: 255

  Name of the criteria operator.
• EntityId: integer (int64)
  Value that uniquely identifies the entity.
• EntityName: string
  Read Only: true

  Maximum Length: 255

  Name of the entity.
• GroupNumber: integer (int32)
  Group number for the criteria.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the segment criteria.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the segment criteria.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login used for updating the segment criteria.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureId: integer (int64)
  Value that uniquely identifies the measure.
• MeasureName: string
  Read Only: true

  Maximum Length: 255

  Name of the measure.
• ObjectVersionNumber: integer (int32)
  Object version number.
• SegmentCriteriaId: integer (int64)
  Value that uniquely identifies the segment criterion.
• SegmentId: integer (int64)
  Value that uniquely identifies the segment.
• SegmentName: string
  Read Only: true

  Maximum Length: 255

  Name of the segment.
• SegmentPlans: array Segment Plans
  Title: Segment Plans

  Segment plans used for segmentation.
• SegmentValues: array Segment Values
  Title: Segment Values

  Segment values used for segmentation.
• SelectedDimension: integer
  Value that uniquely identifies the selected dimension.
• SelectedDimensionName: string
  Read Only: true

  Maximum Length: 255

  Name of the selected dimension.
• TableId: integer (int64)
  Value that uniquely identifies the table.
• TableName: string
  Read Only: true

  Maximum Length: 255

  Name of the table.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the segment criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TableId":{
            "type":"integer",
            "description":"Value that uniquely identifies the table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment criteria.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentCriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the segment criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SegmentId"
                ]
            },
            "x-queryable":true
        },
        "EntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the entity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EntityId"
                ]
            },
            "x-queryable":true
        },
        "SegmentPlans":{
            "title":"Segment Plans",
            "type":"array",
            "description":"Segment plans used for segmentation.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-response"
            }
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeasureName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the measure.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MeasureId",
                    "TableId",
                    "TableName"
                ]
            },
            "x-queryable":true
        },
        "GroupNumber":{
            "type":"integer",
            "description":"Group number for the criteria.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "SelectedDimensionName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the selected dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentValues":{
            "title":"Segment Values",
            "type":"array",
            "description":"Segment values used for segmentation.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-response"
            }
        },
        "EntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TableName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the table.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TableId"
                ]
            },
            "x-queryable":true
        },
        "MeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SelectedDimension":{
            "type":"integer",
            "description":"Value that uniquely identifies the selected dimension.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CriteriaOperatorName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the criteria operator.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CriteriaOperator"
                ]
            },
            "x-queryable":true
        },
        "CriteriaOperator":{
            "type":"integer",
            "description":"Value that uniquely identifies the criteria operator.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment criteria.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login used for updating the segment criteria.",
            "nullable":true,
            "readOnly":true,
            "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 : Segment Plans

Type: array

Title: Segment Plans

Segment plans used for segmentation.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-response

{
    "title":"Segment Plans",
    "type":"array",
    "description":"Segment plans used for segmentation.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-response"
    }
}

Nested Schema : Segment Values

Type: array

Title: Segment Values

Segment values used for segmentation.

Show Source

• Array of: object planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-response

{
    "title":"Segment Values",
    "type":"array",
    "description":"Segment values used for segmentation.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-response"
    }
}

Nested Schema : planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentPlans-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the segment plan.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the segment plan.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the segment plan.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the segment plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanName: string
  Read Only: true

  Maximum Length: 255

  Name of the plan.
• SegmentCriteriaId: integer (int64)
  Value that uniquely identifies the segment criteria.
• SegmentPlanId: integer (int64)
  Value that uniquely identifies the segment plan.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the segment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentCriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the segment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PlanId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-Segment-SegmentCriteria-SegmentValues-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the segment values.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the segment values.
• CriteriaValue: string
  Maximum Length: 240

  Value used for the criteria.
• CriteriaValueString: string
  Read Only: true

  Maximum Length: 255

  Name of the criteria value.
• FromDate: string (date)
  From date of the segment value.
• FromValue: number
  From value of the segment value.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the segment value.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the segment value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SegmentCriteriaId: integer (int64)
  Value that uniquely identifies the segment criteria.
• SegmentValueId: integer (int64)
  Value that uniquely identifies the segment value.
• ToDate: string (date)
  To date of the segment value.
• ToValue: number
  To value of the segment value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the segment value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment values.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentCriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the segment values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ToValue":{
            "type":"number",
            "description":"To value of the segment value.",
            "nullable":true,
            "x-queryable":true
        },
        "CriteriaValue":{
            "maxLength":240,
            "type":"string",
            "description":"Value used for the criteria.",
            "nullable":true,
            "x-queryable":true
        },
        "CriteriaValueString":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the criteria value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SegmentValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromDate":{
            "type":"string",
            "description":"From date of the segment value.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ToDate":{
            "type":"string",
            "description":"To date of the segment value.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FromValue":{
            "type":"number",
            "description":"From value of the segment value.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-Segment-SegmentDataDelete-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Message for segment data deletion.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for segment data deletion.",
            "nullable":true,
            "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 : planningSegmentGroupsV2-Segment-SegmentDuplicate-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Message for the new segment.
• NewSegmentDescription: string
  Maximum Length: 255

  Description of the new segment.
• NewSegmentId: integer
  Value that uniquely identifies the new segment.
• NewSegmentName: string
  Maximum Length: 255

  Name of the new segment.
• NewSegmentPriority: integer
  Priority of the new segment.

{
    "type":"object",
    "properties":{
        "NewSegmentDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the new segment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NewSegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new segment.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for the new segment.",
            "nullable":true,
            "x-queryable":true
        },
        "NewSegmentPriority":{
            "type":"integer",
            "description":"Priority of the new segment.",
            "nullable":true,
            "x-queryable":true
        },
        "NewSegmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the new segment.",
            "nullable":true,
            "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 : planningSegmentGroupsV2-SegmentGroupDimensions-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the segment group dimension.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the segment group dimension.
• DataColumnId: integer (int32)
  Value that uniquely identifies the data column.
• DimensionId: integer (int64)
  Value that uniquely identifies the dimension.
• DimensionName: string
  Maximum Length: 255

  Name of the dimension.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the segment group level.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the segment .
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated with the user who updated the segment group level.
• LevelId: integer (int64)
  Value that uniquely identifies the level.
• LevelName: string
  Maximum Length: 255

  Name of the level.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• SegmentGroupId: integer (int64)
  Value that uniquely identifies the segment group.
• SegmentGroupName: string
  Read Only: true

  Maximum Length: 255

  Name of the segment group.
• SegmentLevelId: integer (int64)
  Value that uniquely identifies the segment level.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the segment .",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment group dimension.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the segment group dimension.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataColumnId":{
            "type":"integer",
            "description":"Value that uniquely identifies the data column.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "DimensionName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LevelName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the level.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentGroupName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the segment group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment group level.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login associated with the user who updated the segment group level.",
            "nullable":true,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-SegmentGroupDuplicate-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Message for the new segment group.
• NewSegmentGroupDescription: string
  Maximum Length: 255

  Description of the new segment group.
• NewSegmentGroupId: integer
  Value that uniquely identifies the new segment group.
• NewSegmentGroupName: string
  Maximum Length: 255

  Name of the new segment group.

{
    "type":"object",
    "properties":{
        "NewSegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new segment group.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NewSegmentGroupName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the new segment group.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for the new segment group.",
            "nullable":true,
            "x-queryable":true
        },
        "NewSegmentGroupDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the new segment group.",
            "nullable":true,
            "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 : planningSegmentGroupsV2-SegmentGroupExecute-item-response

Type: object

Show Source

• ESSProcessId: integer
  Value that uniquely identifies the segmentation process.
• KeepOverrides: integer
  Value that identifies if the segment overrides are to be retained or not.
• KeepPrevious: integer
  Value that identifies if the last segmentation result is to be saved or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Message for the segmentation process.

{
    "type":"object",
    "properties":{
        "KeepOverrides":{
            "type":"integer",
            "description":"Value that identifies if the segment overrides are to be retained or not.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "KeepPrevious":{
            "type":"integer",
            "description":"Value that identifies if the last segmentation result is to be saved or not.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for the segmentation process.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segmentation process.",
            "nullable":true,
            "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 : planningSegmentGroupsV2-SegmentGroupHierarchyCreate-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Message for segment group hierarchy creation.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for segment group hierarchy creation.",
            "nullable":true,
            "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 : planningSegmentGroupsV2-SegmentGroupHierarchyDelete-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  Message for segment group hierarchy deletion.

{
    "type":"object",
    "properties":{
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message for segment group hierarchy deletion.",
            "nullable":true,
            "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 : planningSegmentGroupsV2-SegmentMemberCustomersLOV-item-response

Type: object

Show Source

• CustomerSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer site.
• CustomerSiteName: string
  Read Only: true

  Maximum Length: 1600

  Name of the customer site.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSiteName":{
            "maxLength":1600,
            "type":"string",
            "description":"Name of the customer site.",
            "nullable":true,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-SegmentMemberDemandClassLOV-item-response

Type: object

Show Source

• DemandClassId: integer (int64)
  Read Only: true

  Value that uniquely identifies the demand class.
• DemandClassName: string
  Read Only: true

  Maximum Length: 80

  Name of the demand class.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DemandClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand class.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandClassName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the demand class.",
            "nullable":true,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-SegmentMemberItemsLOV-item-response

Type: object

Show Source

• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory item.
• ItemName: string
  Read Only: true

  Maximum Length: 300

  Name of the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : planningSegmentGroupsV2-SegmentMemberLocationsLOV-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location.
• LocationName: string
  Read Only: true

  Maximum Length: 29

  Name of the location.

{
    "type":"object",
    "properties":{
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LocationName":{
            "maxLength":29,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-SegmentMembers-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the segment members.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the segment members.
• CustomerSiteId: integer
  Read Only: true

  Value that uniquely identifies the customer site.
• CustomerSiteName: string
  Read Only: true

  Maximum Length: 1600

  Name of the customer site.
• DemandClassId: integer
  Read Only: true

  Value that uniquely identifies the demand class.
• DemandClassName: string
  Read Only: true

  Maximum Length: 80

  Name of the demand class.
• ItemId: integer
  Read Only: true

  Value that uniquely identifies the inventory item.
• ItemName: string
  Read Only: true

  Maximum Length: 300

  Name of the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the segment members.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the segment members.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer
  Read Only: true

  Value that uniquely identifies the location.
• LocationName: string
  Read Only: true

  Maximum Length: 60

  Name of the location.
• OverrideSegmentId: integer (int64)
  Value that uniquely identifies a segment that's used as a segment override.
• OverrideSegmentName: string
  Maximum Length: 120

  Name of the override segment.
• PreviousSegmentId: integer (int64)
  Value that uniquely identifies the previous segment name.
• PreviousSegmentName: string
  Read Only: true

  Maximum Length: 120

  Name of the previous segment.
• SegmentGroupId: integer (int64)
  Value that uniquely identifies the segment group.
• SegmentGroupName: string
  Read Only: true

  Maximum Length: 120

  Name of the segment group.
• SegmentId: integer (int64)
  Value that uniquely identifies the segment.
• SegmentName: string
  Read Only: true

  Maximum Length: 120

  Name of the segment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the segment members.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the segment members.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the segment members.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverrideSegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the override segment.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the demand class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousSegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the previous segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideSegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies a segment that's used as a segment override.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSiteName":{
            "maxLength":1600,
            "type":"string",
            "description":"Name of the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentGroupName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PreviousSegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the previous segment name.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the segment members.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-SegmentMemberSegmentsLOV-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SegmentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the segment.
• SegmentName: string
  Read Only: true

  Maximum Length: 120

  Name of the segment.

{
    "type":"object",
    "properties":{
        "SegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : planningSegmentGroupsV2-SegmentNameLOV-item-response

Type: object

Show Source

• Description: string
  Read Only: true

  Maximum Length: 240

  Description of the segment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SegmentId: integer
  Read Only: true

  Value that uniquely identifies the segment.
• SegmentName: string
  Read Only: true

  Maximum Length: 120

  Name of the segment.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "nullable":true,
            "readOnly":true,
            "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 : planningSegmentGroupsV2-SegmentResults-item-response

Type: object

Show Source

• FinalCount: number
  Read Only: true

  Final count of members in the segment.
• LatestCount: number
  Read Only: true

  Latest count of members in the segment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManuallyAddedCount: number
  Read Only: true

  Count of members with segment overrides in the segment.
• ManuallyRemovedCount: number
  Read Only: true

  Count of members with segment overrides removed in the segment.
• PreviousCount: number
  Read Only: true

  Previous count of members in the segment.
• RecentlyAddedCount: number
  Read Only: true

  Count of recently added members in the segment.
• RecentlyRemovedCount: number
  Read Only: true

  Count of recently removed members from the segment.
• SegmentGroupId: integer
  Read Only: true

  Value that uniquely identifies the segment group.
• SegmentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the segment.
• SegmentName: string
  Read Only: true

  Maximum Length: 120

  Name of the segment.

{
    "type":"object",
    "properties":{
        "ManuallyAddedCount":{
            "type":"number",
            "description":"Count of members with segment overrides in the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecentlyAddedCount":{
            "type":"number",
            "description":"Count of recently added members in the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecentlyRemovedCount":{
            "type":"number",
            "description":"Count of recently removed members from the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousCount":{
            "type":"number",
            "description":"Previous count of members in the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FinalCount":{
            "type":"number",
            "description":"Final count of members in the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestCount":{
            "type":"number",
            "description":"Latest count of members in the segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyRemovedCount":{
            "type":"number",
            "description":"Count of members with segment overrides removed in the segment.",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Links

Segment

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/Segment

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

All segments within a specific segment group.

SegmentGroupDimensions

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentGroupDimensions

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

A set of dimensions used for a segment group.

SegmentGroupDuplicate

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentGroupDuplicate

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

Segment group used to duplicate a new segment group.

SegmentGroupExecute

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentGroupExecute

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

Distinct grouping of item-location combinations based on user-defined static or dynamic attributes. This grouping of similar item-location pairs enables more efficient management of inventory and distribution.

SegmentGroupHierarchyCreate

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentGroupHierarchyCreate

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.

SegmentGroupHierarchyDelete

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentGroupHierarchyDelete

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

Hierarchies used for segmentation, that's a grouping of item-location combinations. The hierarchies are product, organization, customer, and demand class.

SegmentMemberCustomersLOV

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentMemberCustomersLOV

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

This list of values includes all customer sites that are associated with the segment group.

SegmentMemberDemandClassLOV

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentMemberDemandClassLOV

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

This list of values includes all demand classes that are associated with the segment group.

SegmentMemberItemsLOV

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentMemberItemsLOV

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

This list of values includes all items that are associated with the segment group.

SegmentMemberLocationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentMemberLocationsLOV

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

This list of values includes all locations that are associated with the segment group.

SegmentMemberSegmentsLOV

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentMemberSegmentsLOV

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

This list of values includes all segments that are associated with the segment group.

SegmentMembers

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentMembers

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

A set of members like items, locations, demand class, or customer sites that are associated with segments.

SegmentNameLOV

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentNameLOV

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

This list of values includes all segment names that are associated with the segment group.

SegmentResults

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/SegmentResults

Parameters:

• SegmentGroupId: $request.path.SegmentGroupId

Result of the segmentation process.

Back to Top