Get all policy assignment sets

get

/fscmRestApi/resources/11.13.18.05/replenishmentPolicyAssignmentSets

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

    • PolicySetIdFinder Finds policy assignment sets according to the policy assignment set identifier.
      Finder Variables
      • PolicySetId; integer; Value that uniquely identifies the policy assignment set.
    • PrimaryKey Finds policy assignment sets according to the policy assignment set identifier.
      Finder Variables
      • PolicySetId; integer; Value that uniquely identifies the policy assignment set.
  • 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:
    • CreatedBy; string; User who created the policy assignment set.
    • CreationDate; string; Date when the user created the policy assignment set.
    • Description; string; Description of the policy assignment set.
    • LastUpdateDate; string; Date when the user most recently updated the policy assignment set.
    • LastUpdateLogin; string; Login that the user used when updating the policy assignment set.
    • LastUpdatedBy; string; User who most recently updated the policy assignment set.
    • ObjectVersionNumber; integer; Number of times the object has been updated.
    • PolicySetId; integer; Value that uniquely identifies the policy assignment set.
    • PolicySetName; string; Name of the policy assignment set.
    • SegmentGroupId; integer; Value that uniquely identifies the segment group.
    • SegmentGroupName; string; Name of the segment group.
  • 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 : replenishmentPolicyAssignmentSets
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : replenishmentPolicyAssignmentSets-item-response
Type: object
Show Source
Nested Schema : Item Location Level Policy Overrides
Type: array
Title: Item Location Level Policy Overrides
The Item Location Level Policy Overrides resource manages policy overrides for the item location combination like minimum quantity, maximum quantity, and so on.
Show Source
Nested Schema : Policy Segment Parameters
Type: array
Title: Policy Segment Parameters
The Policy Segment Parameters resource manages parameters for the segments like policy type, safety stock, minimum quantity, and so on.
Show Source
Nested Schema : Policy Segments
Type: array
Title: Policy Segments
The Policy Segments resource retrieves all segments for the policy assignment set.
Show Source
Nested Schema : replenishmentPolicyAssignmentSets-ItemLocationLevelPolicyOverrides-item-response
Type: object
Show Source
Nested Schema : replenishmentPolicyAssignmentSets-PolicySegmentParameters-item-response
Type: object
Show Source
Nested Schema : replenishmentPolicyAssignmentSets-PolicySegments-item-response
Type: object
Show Source
Nested Schema : Segment Parameters
Type: array
Title: Segment Parameters
The Policy Segment Parameters resource manages parameters for the segments like policy type, safety stock, minimum quantity, and so on.
Show Source
Nested Schema : replenishmentPolicyAssignmentSets-PolicySegments-SegmentParameters-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all policy assignment sets.

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/replenishmentPolicyAssignmentSets"

Example Response Body

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

{
	"items": [
	{
		"PolicySetId": 300100182122087,
		"PolicySetName": "PAS-AUTO",
		"Description": null,
		"SegmentGroupId": 300100182121949,
		"ObjectVersionNumber": 1,
		"SegmentGroupName": "SG-COST-VOL-AUTO",
		"LastUpdateLogin": "915652D58EA850FCE053A15AF00ABFE7",
		"LastUpdatedBy": "REPL_USER",
		"CreatedBy": "REPL_USER",
		"CreationDate": "2019-09-04T07:20:11+00:00",
		"LastUpdateDate": "2019-09-04T07:21:11.868+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087",
			"name": "replenishmentPolicyAssignmentSets",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087",
			"name": "replenishmentPolicyAssignmentSets",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/ItemLocationLevelPolicyOverrides",
			"name": "ItemLocationLevelPolicyOverrides",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182122087/child/PolicySegments",
			"name": "PolicySegments",
			"kind": "collection"
		}
		]
	},
	{
		"PolicySetId": 300100182208291,
		"PolicySetName": "PAS-AUTO23",
		"Description": "Assignment Set for Automation Cases 23",
		"SegmentGroupId": 300100182208248,
		"ObjectVersionNumber": 1,
		"SegmentGroupName": "SG-AUTO23",
		"LastUpdateLogin": "915652D5A51F50FCE053A15AF00ABFE7",
		"LastUpdatedBy": "REPL_USER",
		"CreatedBy": "REPL_USER",
		"CreationDate": "2019-09-06T06:01:45+00:00",
		"LastUpdateDate": "2019-09-06T06:03:25.251+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182208291",
			"name": "replenishmentPolicyAssignmentSets",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182208291",
			"name": "replenishmentPolicyAssignmentSets",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182208291/child/ItemLocationLevelPolicyOverrides",
			"name": "ItemLocationLevelPolicyOverrides",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/replenishmentPolicyAssignmentSets/300100182208291/child/PolicySegments",
			"name": "PolicySegments",
			"kind": "collection"
		}
		]
	}
	
Back to Top