Jump to

• Request
• Response
• Examples

Get all planning clusters

get

/fscmRestApi/resources/11.13.18.05/planningClustersV2

Request

Query Parameters

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

  • PrimaryKey Find planning clusters according to cluster identifier.
    Finder Variables
    • ClusterId; integer; Value that uniquely identifies the planning cluster.
• 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:
  

  • ClusterId; integer; Value that uniquely identifies the planning cluster.
  • ClusterLocationsCount; number; Count of cluster locations.
  • ClusterName; string; Name of the planning cluster.
  • CreatedBy; string; User who created the planning cluster.
  • CreationDate; string; Date when the user created the planning cluster.
  • Description; string; Description of the planning cluster.
  • ExcessLeadTimeMultiplier; number; Value that indicates excess lead time multiplier.
  • LastUpdateDate; string; Date when the user most recently updated the planning cluster.
  • LastUpdateLogin; string; Login that the user used when updating the planning cluster.
  • LastUpdatedBy; string; User who most recently updated the planning cluster.
  • LocationHierarchy; string; Value that identifies the location hierarchy. Valid values are Location, Region, and Zone. The default value is Location.
  • LocationHierarchyCode; integer; Abbreviation that identifies the location hierarchy.
  • ObjectVersionNumber; integer; Number of times the object has been updated.
  • OnHandLotExpirationDays; integer; Value that indicates the on hand lot expiration days.
  • ReservedSafetyStockPercentage; integer; Percentage value defined for reserved safety stock.
  • ShortageLeadTimeMultiplier; number; Value that indicates shortage lead time multiplier.
  • SourceSystem; string; Name of the source application.
  • SourceSystemId; integer; Value that uniquely identifies the source application.
  • SweepLocation; string; Name of the location where the excess inventory is moved.
  • SweepLocationId; integer; Value that uniquely identifies the sweep location.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : planningClustersV2

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/planningClustersV2-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object planningClustersV2-item-response

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

Type: object

Show Source

• ClusterId: integer (int64)
  Value that uniquely identifies the planning cluster.
• ClusterLocations: array Cluster Locations
  Title: Cluster Locations

  The Cluster Locations resource manages all locations within the cluster.
• ClusterLocationsCount: number
  Read Only: true

  Count of cluster locations.
• ClusterMembers: array Cluster Members
  Title: Cluster Members

  The cluster members. For example, zones, regions or locations within the cluster.
• ClusterName: string
  Maximum Length: 120

  Name of the planning cluster.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the planning cluster.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the planning cluster.
• Description: string
  Maximum Length: 240

  Description of the planning cluster.
• ExcessLeadTimeMultiplier: number
  Value that indicates excess lead time multiplier.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the planning cluster.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the planning cluster.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the planning cluster.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationHierarchy: string
  Maximum Length: 8

  Value that identifies the location hierarchy. Valid values are Location, Region, and Zone. The default value is Location.
• LocationHierarchyCode: integer
  Abbreviation that identifies the location hierarchy.
• ObjectVersionNumber: integer
  Number of times the object has been updated.
• OnHandLotExpirationDays: integer
  Value that indicates the on hand lot expiration days.
• ReservedSafetyStockPercentage: integer
  Percentage value defined for reserved safety stock.
• ShortageLeadTimeMultiplier: number
  Value that indicates shortage lead time multiplier.
• SourceSystem: string
  Maximum Length: 30

  Name of the source application.
• SourceSystemId: integer (int64)
  Value that uniquely identifies the source application.
• SweepLocation: string
  Maximum Length: 60

  Name of the location where the excess inventory is moved.
• SweepLocationId: integer (int64)
  Value that uniquely identifies the sweep location.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the planning cluster.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the planning cluster.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the planning cluster.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the planning cluster.",
            "nullable":true,
            "x-queryable":true
        },
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShortageLeadTimeMultiplier":{
            "type":"number",
            "description":"Value that indicates shortage lead time multiplier.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationHierarchy":{
            "maxLength":"8",
            "type":"string",
            "description":"Value that identifies the location hierarchy. Valid values are Location, Region, and Zone. The default value is Location.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LocationHierarchyCode"
                ]
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClusterMembers":{
            "title":"Cluster Members",
            "type":"array",
            "description":"The cluster members. For example, zones, regions or locations within the cluster.",
            "items":{
                "$ref":"#/components/schemas/planningClustersV2-ClusterMembers-item-response"
            }
        },
        "LocationHierarchyCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the location hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "nullable":false,
            "x-queryable":true
        },
        "ClusterLocationsCount":{
            "type":"number",
            "description":"Count of cluster locations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SweepLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sweep location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "SourceSystem",
                    "SourceSystemId"
                ]
            },
            "x-queryable":true
        },
        "ReservedSafetyStockPercentage":{
            "type":"integer",
            "description":"Percentage value defined for reserved safety stock.",
            "nullable":true,
            "x-queryable":true
        },
        "ClusterName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the planning cluster.",
            "nullable":false,
            "x-queryable":true
        },
        "OnHandLotExpirationDays":{
            "type":"integer",
            "description":"Value that indicates the on hand lot expiration days.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SweepLocation":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the location where the excess inventory is moved.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceSystem",
                    "SourceSystemId",
                    "SweepLocationId"
                ]
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the source application.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceSystemId"
                ]
            },
            "x-queryable":true
        },
        "ExcessLeadTimeMultiplier":{
            "type":"number",
            "description":"Value that indicates excess lead time multiplier.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the planning cluster.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the planning cluster.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClusterLocations":{
            "title":"Cluster Locations",
            "type":"array",
            "description":"The Cluster Locations resource manages all locations within the cluster.",
            "items":{
                "$ref":"#/components/schemas/planningClustersV2-ClusterLocations-item-response"
            }
        }
    }
}

Nested Schema : Cluster Locations

Type: array

Title: Cluster Locations

The Cluster Locations resource manages all locations within the cluster.

Show Source

• Array of: object planningClustersV2-ClusterLocations-item-response

{
    "title":"Cluster Locations",
    "type":"array",
    "description":"The Cluster Locations resource manages all locations within the cluster.",
    "items":{
        "$ref":"#/components/schemas/planningClustersV2-ClusterLocations-item-response"
    }
}

Nested Schema : Cluster Members

Type: array

Title: Cluster Members

The cluster members. For example, zones, regions or locations within the cluster.

Show Source

• Array of: object planningClustersV2-ClusterMembers-item-response

{
    "title":"Cluster Members",
    "type":"array",
    "description":"The cluster members. For example, zones, regions or locations within the cluster.",
    "items":{
        "$ref":"#/components/schemas/planningClustersV2-ClusterMembers-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 : planningClustersV2-ClusterLocations-item-response

Type: object

Show Source

• ClusterId: integer (int64)
  Value that uniquely identifies the planning cluster.
• ClusterLocationId: integer (int64)
  Value that uniquely identifies the cluster location combination.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the planning cluster locations.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the planning cluster locations.
• Description: string
  Maximum Length: 481

  Description of the planning cluster.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the planning cluster locations.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the planning cluster locations.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the planning cluster locations.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Maximum Length: 60

  Name of the cluster location.
• LocationId: integer (int64)
  Value that uniquely identifies the cluster location.
• LocationPriority: number
  Value that indicates priority of the cluster location.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the planning cluster locations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the planning cluster locations.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the planning cluster locations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"481",
            "type":"string",
            "description":"Description of the planning cluster.",
            "nullable":true,
            "x-queryable":true
        },
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClusterLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location combination.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationPriority":{
            "type":"number",
            "description":"Value that indicates priority of the cluster location.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the planning cluster locations.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the planning cluster locations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the cluster location.",
            "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"
    }
}

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 : planningClustersV2-ClusterMembers-item-response

Type: object

Show Source

• ClusterId: integer (int64)
  Value that uniquely identifies the planning cluster.
• ClusterMemberId: integer (int64)
  Value that uniquely identifies the planning cluster member.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the planning cluster members.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the planning cluster members.
• Description: string
  Read Only: true

  Maximum Length: 281

  Description of the cluster member.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the planning cluster members.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the planning cluster members.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the planning cluster members.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Member: string
  Maximum Length: 3251

  Name of the cluster member.
• MemberId: integer (int64)
  Value that uniquely identifies the cluster member.
• ObjectVersionNumber: integer (int32)
  Number of times the object has been updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the planning cluster members.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the planning cluster members.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the planning cluster members.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"281",
            "type":"string",
            "description":"Description of the cluster member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClusterMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Member":{
            "maxLength":"3251",
            "type":"string",
            "description":"Name of the cluster member.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the planning cluster members.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the planning cluster members.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

This example describes how to get all planning clusters.

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

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
{
            "ClusterId": 300100560744952,
            "ClusterName": "SWP_INSIDE_CLUSTER1",
            "Description": "CLUSTER FOR AUTOMATION - BAT",
            "SourceSystemId": 100010026240309,
            "SourceSystem": "GPR",
            "SweepLocationId": 10001,
            "SweepLocation": "M1",
            "ExcessLeadTimeMultiplier": 1,
            "ShortageLeadTimeMultiplier": 1,
            "ReservedSafetyStockPercentage": 0,
            "LocationHierarchyCode": 1,
            "LocationHierarchy": "Location",
            "OnHandLotExpirationDays": null,
            "CreatedBy": "REPL_USER",
            "CreationDate": "2022-07-11T06:53:58+00:00",
            "LastUpdatedBy": "REPL_USER",
            "LastUpdateDate": "2022-07-11T06:55:24.962+00:00",
            "LastUpdateLogin": "E31BFF727D3040A3E053A46315AC141F",
            "ObjectVersionNumber": 1,
            "ClusterLocationsCount": 4,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560744952",
                    "name": "planningClustersV2",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560744952",
                    "name": "planningClustersV2",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560744952/child/ClusterLocations",
                    "name": "ClusterLocations",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560744952/child/ClusterMembers",
                    "name": "ClusterMembers",
                    "kind": "collection"
                }
            ]
        },
        {
            "ClusterId": 300100560745691,
            "ClusterName": "SWP_OUTSIDE_CLUSTER_AUTO1",
            "Description": "CLUSTER FOR AUTOMATION - BAT",
            "SourceSystemId": 100010026240309,
            "SourceSystem": "GPR",
            "SweepLocationId": 10001,
            "SweepLocation": "M1",
            "ExcessLeadTimeMultiplier": 1,
            "ShortageLeadTimeMultiplier": 1,
            "ReservedSafetyStockPercentage": 10,
            "LocationHierarchyCode": 1,
            "LocationHierarchy": "Location",
            "OnHandLotExpirationDays": null,
            "CreatedBy": "REPL_USER",
            "CreationDate": "2022-07-11T06:54:02+00:00",
            "LastUpdatedBy": "REPL_USER",
            "LastUpdateDate": "2022-07-11T06:55:08.518+00:00",
            "LastUpdateLogin": "E31C06C4060940E3E053A46315AC207D",
            "ObjectVersionNumber": 1,
            "ClusterLocationsCount": 2,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560745691",
                    "name": "planningClustersV2",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560745691",
                    "name": "planningClustersV2",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560745691/child/ClusterLocations",
                    "name": "ClusterLocations",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100560745691/child/ClusterMembers",
                    "name": "ClusterMembers",
                    "kind": "collection"
                }
            ]
        },
        {
            "ClusterId": 300100607280107,
            "ClusterName": "TEST-CLUSTER",
            "Description": "Testing for Cluster REST",
            "SourceSystemId": 100010026240309,
            "SourceSystem": "GPR",
            "SweepLocationId": 10001,
            "SweepLocation": "M1",
            "ExcessLeadTimeMultiplier": 1.57,
            "ShortageLeadTimeMultiplier": 1.19,
            "ReservedSafetyStockPercentage": 95,
            "LocationHierarchyCode": 1,
            "LocationHierarchy": "Location",
            "OnHandLotExpirationDays": null,
            "CreatedBy": "REPL_USER",
            "CreationDate": "2024-08-01T08:29:47+00:00",
            "LastUpdatedBy": "REPL_USER",
            "LastUpdateDate": "2024-08-01T08:29:50.744+00:00",
            "LastUpdateLogin": "1D704E9A7D250A1BE0638D30060A2F4D",
            "ObjectVersionNumber": 1,
            "ClusterLocationsCount": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607280107",
                    "name": "planningClustersV2",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607280107",
                    "name": "planningClustersV2",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607280107/child/ClusterLocations",
                    "name": "ClusterLocations",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607280107/child/ClusterMembers",
                    "name": "ClusterMembers",
                    "kind": "collection"
                }
            ]
        }
 ],
    "count": 20,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/planningClustersV2",
            "name": "planningClustersV2",
            "kind": "collection"
        }
    ]
}

Back to Top