Get all segment groups

get

/fscmRestApi/resources/11.13.18.05/planningSegmentGroups

Request

Query Parameters
  • 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).
  • 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
  • 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 Find segment groups according to the segment group identifier.
      Finder Variables
      • SegmentGroupId; integer; Value that uniquely identifies the segment group.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 a catalog used in segmentation. The default value is empty.
    • CatalogName; string; Name of the catalog.
    • CreationDate; string; Date when the segment group was created.
    • 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.
    • LastUpdatedBy; string; User who most recently updated the segment group.
    • SegmentGroupId; integer; Value that uniquely identifies a segment group.
    • SimulationSetId; integer; Value that uniquely identifies a simulation set that segmentation uses when the segmentation process was run. A simulation set is a set of adjustments that you make to the input that affects the plan and segmentation. You can use them to test different business scenarios, such as changing the item standard cost.
    • SimulationSetName; string; Name of the simulation set.
    • SourceSystemId; integer; Value that uniquely identifies the source application.
    • SourceSystemName; string; Name of the source application.
    • 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.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : planningSegmentGroups
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planningSegmentGroups-item-response
Type: object
Show Source
Nested Schema : Execute Parts Segmentation
Type: array
Title: Execute Parts Segmentation
The Execute Parts Segmentation resource initiates the parts segmentation process.
Show Source
Nested Schema : Segmentation Results
Type: array
Title: Segmentation Results
The Segmentation Results resource gets the results of the parts segmentation process such as segment information of item and location.
Show Source
Nested Schema : planningSegmentGroups-ExecutePartsSegmentation-item-response
Type: object
Show Source
  • Value that uniquely identifies the process.
  • Value that uniquely identifies the scheduled process.
  • Links
  • Value that indicates whether or not to retain existing policy overrides. Valid values are 0 or 1. If 0, then retain policy overrides. If 1, then don't retain policy overrides. The default value is 0.
  • Value that indicates whether or not to save the last segmentation result. Valid values are 1 or 2. If 1, then save the last result. If 2, then don't save the last result. The default value is 2.
  • Value that uniquely identifies the segment group.
  • 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.
Nested Schema : planningSegmentGroups-SegmentationResults-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all segment groups.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/planningSegmentGroups"

Example Response Body

The following shows an example of the response body in JSON format.

"items": [
{
	"SegmentGroupId": 300100184308748,
	"GroupName": "YM-STK-UOM",
	"Description": null,
	"KeepOverrides": 0,
	"StatusCode": "0",
	"SourceSystemId": 100010026240309,
	"SourceSystemName": "GPR",
	"CatalogId": null,
	"CatalogName": null,
	"SimulationSetId": null,
	"SimulationSetName": null,
	"CreationDate": "2019-11-11T11:29:58+00:00",
	"LastRunDate": "2019-11-12T10:56:47.435+00:00",
	"LastUpdateDate": "2019-11-12T10:56:47.435+00:00",
	"LastUpdatedBy": "rp_user",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100184308748",
		"name": "planningSegmentGroups",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100184308748",
		"name": "planningSegmentGroups",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100184308748/child/ExecutePartsSegmentation",
		"name": "ExecutePartsSegmentation",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100184308748/child/SegmentationResults",
		"name": "SegmentationResults",
		"kind": "collection"
	}
	]
},
{
	"SegmentGroupId": 300100186330527,
	"GroupName": "Cost Segment Group",
	"Description": null,
	"KeepOverrides": 0,
	"StatusCode": "0",
	"SourceSystemId": 300100126663766,
	"SourceSystemName": "EXDMQA",
	"CatalogId": 91401,
	"CatalogName": "DMRP_CATALOG",
	"SimulationSetId": null,
	"SimulationSetName": null,
	"CreationDate": "2019-11-12T09:48:20+00:00",
	"LastRunDate": "2019-11-13T18:56:35.555+00:00",
	"LastUpdateDate": "2019-11-13T18:56:35.555+00:00",
	"LastUpdatedBy": "SCMOPERATIONS",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100186330527",
		"name": "planningSegmentGroups",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100186330527",
		"name": "planningSegmentGroups",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100186330527/child/ExecutePartsSegmentation",
		"name": "ExecutePartsSegmentation",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100186330527/child/SegmentationResults",
		"name": "SegmentationResults",
		"kind": "collection"
	}
	]
}
]
Back to Top