Jump to

• Request
• Response

Create one segment criterion

post

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

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

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CriteriaOperator(required): integer (int32)
  Value that uniquely identifies the criteria operator.
• EntityId: integer (int64)
  Value that uniquely identifies the entity.
• GroupNumber(required): integer (int32)
  Group number for the criteria.
• MeasureId: integer (int64)
  Value that uniquely identifies the measure.
• ObjectVersionNumber: integer (int32)
  Object version number.
• SegmentCriteriaId: integer (int64)
  Value that uniquely identifies the segment criterion.
• SegmentId(required): integer (int64)
  Value that uniquely identifies 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(required): integer
  Value that uniquely identifies the selected dimension.
• TableId: integer (int64)
  Value that uniquely identifies the table.

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

Nested Schema : Segment Plans

Type: array

Title: Segment Plans

Segment plans used for segmentation.

Show Source

• Array of: object schema

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

Nested Schema : Segment Values

Type: array

Title: Segment Values

Segment values used for segmentation.

Show Source

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

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

Nested Schema : schema

Type: object

Show Source

• PlanId: integer (int64)
  Value that uniquely identifies 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":{
        "SegmentCriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SegmentPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• CriteriaValue: string
  Maximum Length: 240

  Value used for the criteria.
• FromDate: string (date)
  From date of the segment value.
• FromValue: number
  From value of the segment value.
• 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":{
        "SegmentCriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ToValue":{
            "type":"number",
            "description":"To value of the segment value.",
            "nullable":true
        },
        "SegmentValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FromDate":{
            "type":"string",
            "description":"From date of the segment value.",
            "format":"date",
            "nullable":true
        },
        "ToDate":{
            "type":"string",
            "description":"To date of the segment value.",
            "format":"date",
            "nullable":true
        },
        "CriteriaValue":{
            "maxLength":240,
            "type":"string",
            "description":"Value used for the criteria.",
            "nullable":true
        },
        "FromValue":{
            "type":"number",
            "description":"From value of the segment value.",
            "nullable":true
        }
    }
}

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

Links

SegmentPlans

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/Segment/{SegmentId}/child/SegmentCriteria/{SegmentCriteriaId}/child/SegmentPlans

Parameters:

• SegmentCriteriaId: $request.path.SegmentCriteriaId
• SegmentGroupId: $request.path.SegmentGroupId
• SegmentId: $request.path.SegmentId

Segment plans used for segmentation.

SegmentValues

Operation: /fscmRestApi/resources/11.13.18.05/planningSegmentGroupsV2/{SegmentGroupId}/child/Segment/{SegmentId}/child/SegmentCriteria/{SegmentCriteriaId}/child/SegmentValues

Parameters:

• SegmentCriteriaId: $request.path.SegmentCriteriaId
• SegmentGroupId: $request.path.SegmentGroupId
• SegmentId: $request.path.SegmentId

Segment values used for segmentation.

Back to Top