Jump to

• Request
• Response

Get all segment groups

get

/fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds segment groups according to the primary key criteria.
    Finder Variables
    • SegmentGroupId; integer; Value that uniquely identifies the segment group.
  • findBySegmentGroupId Finds segment groups according to the segment group identifier.
    Finder Variables
    • SegmentGroupId; integer; Value that uniquely identifies the segment group.
  • findBySegmentGroupName Finds segment groups according to the segment group name.
    Finder Variables
    • GroupName; string; Value that uniquely identifies the segment group.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CatalogId; integer; Value that uniquely identifies the catalog.
  • CatalogName; string; Name of the catalog.
  • CreatedBy; string; User who created the segment group.
  • CreationDate; string; Date when the user created the segment group.
  • Description; string; Description of the segment group.
  • GroupName; string; Name of the segment group.
  • LastRunDate; string; Date when the segmentation process was most recently run.
  • LastUpdateDate; string; Date when the user most recently updated the segment group.
  • LastUpdateLogin; string; Session login associated with the user who updated the segment group.
  • LastUpdatedBy; string; User who most recently updated the segment group.
  • ObjectVersionNumber; integer; Number of times the object has been updated.
  • SegmentGroupId; integer; Value that uniquely identifies the segment group.
  • SimulationSetId; integer; Value that uniquely identifies the simulation set.
  • SimulationSetName; string; Name of the simulation set.
  • SourceSystemId; integer; Value that uniquely identifies the source application.
  • SourceSystemName; string; Name of the source application.
  • Status; string; Status of the segmentation process.
  • StatusCode; integer; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : planningSegmentGroupsV2

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/planningSegmentGroupsV2-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object planningSegmentGroupsV2-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-item-response"
    }
}

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

Type: object

Show Source

• CatalogId: integer (int64)
  Value that uniquely identifies the catalog.
• CatalogName: string
  Read Only: true

  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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated with the user who updated the segment group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.
• SegmentGroupDimensions: array Segment Group Dimensions
  Title: Segment Group Dimensions

  A set of dimensions used for a segment group.
• 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.
• SimulationSetId: integer (int64)
  Value that uniquely identifies the simulation set.
• SimulationSetName: string
  Read Only: true

  Maximum Length: 255

  Name of the simulation set.
• SourceSystemId: integer (int64)
  Value that uniquely identifies the source application.
• SourceSystemName: string
  Read Only: true

  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,
            "readOnly":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"
            }
        },
        "LastRunDate":{
            "type":"string",
            "description":"Date when the segmentation process was most recently run.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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,
            "readOnly":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"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the segment group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the segmentation process.",
            "nullable":true,
            "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"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the segment group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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"
            }
        },
        "CatalogName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login associated with the user who updated the segment group.",
            "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 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 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 : 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-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
  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,
            "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-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
  Value that uniquely identifies the customer site.
• CustomerSiteName: string
  Maximum Length: 255

  Name of the customer site.
• DemandClassId: integer
  Value that uniquely identifies the demand class.
• DemandClassName: string
  Maximum Length: 255

  Name of the demand class.
• ItemId: integer
  Value that uniquely identifies the inventory item.
• ItemName: string
  Maximum Length: 255

  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
  Value that uniquely identifies the location.
• LocationName: string
  Maximum Length: 255

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

  Name of the override segment.
• PreviousSegmentId: integer (int64)
  Value that uniquely identifies the previous segment name.
• PreviousSegmentName: string
  Maximum Length: 255

  Name of the previous segment.
• SegmentGroupId: integer (int64)
  Value that uniquely identifies the segment group.
• SegmentGroupName: string
  Maximum Length: 255

  Name of the segment group.
• SegmentId: integer (int64)
  Value that uniquely identifies the segment.
• SegmentName: string
  Maximum Length: 255

  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":"255",
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SegmentId"
                ]
            },
            "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":"255",
            "type":"string",
            "description":"Name of the override segment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OverrideSegmentId"
                ]
            },
            "x-queryable":true
        },
        "DemandClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand class.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClassName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the demand class.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DemandClassId"
                ]
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":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
        },
        "LocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LocationId"
                ]
            },
            "x-queryable":true
        },
        "PreviousSegmentName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the previous segment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PreviousSegmentId"
                ]
            },
            "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
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer site.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CustomerSiteId"
                ]
            },
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ItemId"
                ]
            },
            "x-queryable":true
        },
        "SegmentGroupName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the segment group.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SegmentGroupId"
                ]
            },
            "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"
    }
}

Back to Top