Jump to

• Request
• Response

Update locations for one cluster

patch

/fscmRestApi/resources/11.13.18.05/planningClustersV2/{ClusterId}/child/ClusterLocations/{ClusterLocationId}

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  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.

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.
• 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
        }
    }
}

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

Back to Top