Jump to

• Request
• Response

Get all segments

get

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

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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• 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 a segment according to the primary key.
    Finder Variables
    • SegmentId; integer; Value that uniquely identifies the segment.
  • findBySegmentId Finds segments according to the segment identifier.
    Finder Variables
    • SegmentId; integer; Value that uniquely identifies the segment.
• 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:
  

  • CreatedBy; string; User who created the segment.
  • CreationDate; string; Date when the user created the segment.
  • Description; string; Description of the segment.
  • LastUpdateDate; string; Date when the user most recently updated the segment.
  • LastUpdatedBy; string; User who most recently updated the segment.
  • Priority; integer; Priority of the segment
  • SegmentGroupId; integer; Value that uniquely identifies the segment group.
  • SegmentId; integer; Value that uniquely identifies the segment.
  • SegmentName; string; Name of the segment.
• 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : planningSegmentGroupsV2-Segment

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-Segment-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/planningSegmentGroupsV2-Segment-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-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 : 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-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"
    }
}

Back to Top