Jump to

• Request
• Response
• Examples

Create planning clusters

post

/fscmRestApi/resources/11.13.18.05/planningClustersV2

Request

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.
• Upsert-Mode:
  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

• 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.
• ClusterMembers: array Cluster Members
  Title: Cluster Members

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

  Name of the planning cluster.
• Description: string
  Maximum Length: 240

  Description of the planning cluster.
• ExcessLeadTimeMultiplier: number
  Value that indicates excess lead time multiplier.
• LocationHierarchy: string
  Maximum Length: 8

  Value that identifies the location hierarchy. Valid values are Location, Region, and Zone. The default value is Location.
• LocationHierarchyCode(required): 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(required): 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.

{
    "required":[
        "ClusterName",
        "LocationHierarchyCode",
        "SourceSystemId"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the planning cluster.",
            "nullable":true
        },
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShortageLeadTimeMultiplier":{
            "type":"number",
            "description":"Value that indicates shortage lead time multiplier.",
            "nullable":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"
                ]
            }
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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-post-request"
            }
        },
        "LocationHierarchyCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the location hierarchy.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "nullable":false
        },
        "SweepLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sweep location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "SourceSystem",
                    "SourceSystemId"
                ]
            }
        },
        "ReservedSafetyStockPercentage":{
            "type":"integer",
            "description":"Percentage value defined for reserved safety stock.",
            "nullable":true
        },
        "ClusterName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the planning cluster.",
            "nullable":false
        },
        "OnHandLotExpirationDays":{
            "type":"integer",
            "description":"Value that indicates the on hand lot expiration days.",
            "nullable":true
        },
        "SweepLocation":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the location where the excess inventory is moved.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceSystem",
                    "SourceSystemId",
                    "SweepLocationId"
                ]
            }
        },
        "SourceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the source application.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceSystemId"
                ]
            }
        },
        "ExcessLeadTimeMultiplier":{
            "type":"number",
            "description":"Value that indicates excess lead time multiplier.",
            "nullable":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-post-request"
            }
        }
    }
}

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-post-request

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

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 schema

{
    "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-post-request"
    }
}

Nested Schema : planningClustersV2-ClusterLocations-item-post-request

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.
• Description: string
  Maximum Length: 481

  Description of the planning cluster.
• 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":{
        "Description":{
            "maxLength":"481",
            "type":"string",
            "description":"Description of the planning cluster.",
            "nullable":true
        },
        "LocationPriority":{
            "type":"number",
            "description":"Value that indicates priority of the cluster location.",
            "nullable":true
        },
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ClusterLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location combination.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Location":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the cluster location.",
            "nullable":true
        }
    }
}

Nested Schema : schema

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.
• 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":{
        "MemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ClusterMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ClusterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cluster.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the object has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "Member":{
            "maxLength":"3251",
            "type":"string",
            "description":"Name of the cluster member.",
            "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 : 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"
    }
}

Links

ClusterLocations

Operation: /fscmRestApi/resources/11.13.18.05/planningClustersV2/{ClusterId}/child/ClusterLocations

Parameters:

• ClusterId: $request.path.ClusterId

The Cluster Locations resource manages all locations within the cluster.

ClusterMembers

Operation: /fscmRestApi/resources/11.13.18.05/planningClustersV2/{ClusterId}/child/ClusterMembers

Parameters:

• ClusterId: $request.path.ClusterId

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

Back to Top

Examples

This example describes how to create planning clusters.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/planningClustersV2"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "ClusterName": "TEST-CLUSTER",
    "Description": "Testing for Cluster REST",
    "SourceSystem": "GPR",
    "SweepLocation": "M1",
    "ExcessLeadTimeMultiplier": 1.57,
    "ShortageLeadTimeMultiplier": 1.19,
    "ReservedSafetyStockPercentage": 95,
    "LocationHierarchy": "Location"
}

Example 1 Response Body

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

{
    "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"
        }
    ]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
   "parts": [{
   "id": "1",
   "path":"/planningClustersV2",
   "operation": "create",
   "payload": 
{
    "ClusterName": "IR_MULTI_LVL_CLUSTER1-2",
    "Description": "CLUSTER FOR AUTOMATION",
    "SweepLocation": null,
    "ExcessLeadTimeMultiplier": "1",
    "ShortageLeadTimeMultiplier": 0.5,
    "ReservedSafetyStockPercentage": 0,
    "OnHandLotExpirationDays": null,
    "LocationHierarchy": "Zone",
    "SourceSystem": "REPL1"
}},
{
         "id": "2",
         "path":"/planningClustersV2",
   "operation": "create",
   "payload": 
{
    "ClusterName": "RW_REGION_CLUSTER2",
    "SourceSystem": "GPR",
    "LocationHierarchy": "Region"
}},
{
         "id": "3",
         "path":"/planningClustersV2",
   "operation": "create",
   "payload": 
{
    "ClusterName": "RW_LOC_CLUSTER2",
    "Description": "Redwood Location Cluster",
    "SweepLocation": "RPCDC1",
    "ExcessLeadTimeMultiplier": 0.109,
    "ShortageLeadTimeMultiplier": 0.005,
    "ReservedSafetyStockPercentage": 99,
    "LocationHierarchy": "Location",
    "OnHandLotExpirationDays": 1000,
    "SourceSystem": "GPR"
}}
]
}

Example 2 Response Body

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

{
    "parts": [
        {
            "id": "1",
            "path": "https://servername/fscmRestApi/resources/version/planningClustersV2",
            "operation": "create",
            "payload": {
                "ClusterId": 300100607459403,
                "ClusterName": "IR_MULTI_LVL_CLUSTER1-2",
                "Description": "CLUSTER FOR AUTOMATION",
                "SourceSystemId": 300100172783392,
                "SourceSystem": "REPL1",
                "SweepLocationId": null,
                "SweepLocation": null,
                "ExcessLeadTimeMultiplier": 1,
                "ShortageLeadTimeMultiplier": 0.5,
                "ReservedSafetyStockPercentage": 0,
                "LocationHierarchyCode": 3,
                "LocationHierarchy": "Zone",
                "OnHandLotExpirationDays": null,
                "CreatedBy": "REPL_USER",
                "CreationDate": "2024-08-02T05:15:48+00:00",
                "LastUpdatedBy": "REPL_USER",
                "LastUpdateDate": "2024-08-02T05:15:51.246+00:00",
                "LastUpdateLogin": "1D703AB00FAF09B4E0638D30060ADE3D",
                "ObjectVersionNumber": 1,
                "ClusterLocationsCount": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459403",
                        "name": "planningClustersV2",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459403",
                        "name": "planningClustersV2",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459403/child/ClusterLocations",
                        "name": "ClusterLocations",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459403/child/ClusterMembers",
                        "name": "ClusterMembers",
                        "kind": "collection"
                    }
                ]
            }
        },
        {
            "id": "2",
            "path": "https://servername/fscmRestApi/resources/version/planningClustersV2",
            "operation": "create",
            "payload": {
                "ClusterId": 300100607459404,
                "ClusterName": "RW_REGION_CLUSTER2",
                "Description": null,
                "SourceSystemId": 100010026240309,
                "SourceSystem": "GPR",
                "SweepLocationId": null,
                "SweepLocation": null,
                "ExcessLeadTimeMultiplier": 1,
                "ShortageLeadTimeMultiplier": 1,
                "ReservedSafetyStockPercentage": 0,
                "LocationHierarchyCode": 2,
                "LocationHierarchy": "Region",
                "OnHandLotExpirationDays": null,
                "CreatedBy": "REPL_USER",
                "CreationDate": "2024-08-02T05:15:48.176+00:00",
                "LastUpdatedBy": "REPL_USER",
                "LastUpdateDate": "2024-08-02T05:15:51.263+00:00",
                "LastUpdateLogin": "1D703AB00FAF09B4E0638D30060ADE3D",
                "ObjectVersionNumber": 1,
                "ClusterLocationsCount": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404",
                        "name": "planningClustersV2",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404",
                        "name": "planningClustersV2",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterLocations",
                        "name": "ClusterLocations",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459404/child/ClusterMembers",
                        "name": "ClusterMembers",
                        "kind": "collection"
                    }
                ]
            }
        },
        {
            "id": "3",
            "path": "https://servername/fscmRestApi/resources/version/planningClustersV2",
            "operation": "create",
            "payload": {
                "ClusterId": 300100607459405,
                "ClusterName": "RW_LOC_CLUSTER2",
                "Description": "Redwood Location Cluster",
                "SourceSystemId": 100010026240309,
                "SourceSystem": "GPR",
                "SweepLocationId": 31634,
                "SweepLocation": "RPCDC1",
                "ExcessLeadTimeMultiplier": 0.11,
                "ShortageLeadTimeMultiplier": 0.01,
                "ReservedSafetyStockPercentage": 99,
                "LocationHierarchyCode": 1,
                "LocationHierarchy": "Location",
                "OnHandLotExpirationDays": 1000,
                "CreatedBy": "REPL_USER",
                "CreationDate": "2024-08-02T05:15:48.190+00:00",
                "LastUpdatedBy": "REPL_USER",
                "LastUpdateDate": "2024-08-02T05:15:51.270+00:00",
                "LastUpdateLogin": "1D703AB00FAF09B4E0638D30060ADE3D",
                "ObjectVersionNumber": 1,
                "ClusterLocationsCount": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459405",
                        "name": "planningClustersV2",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459405",
                        "name": "planningClustersV2",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459405/child/ClusterLocations",
                        "name": "ClusterLocations",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/planningClustersV2/300100607459405/child/ClusterMembers",
                        "name": "ClusterMembers",
                        "kind": "collection"
                    }
                ]
            }
        }
    ]
}

Back to Top