Jump to

• Request
• Response

Update one plan dimension filter

patch

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanDimensionFilter/{PlanDimensionFilterUniqID}

Request

Path Parameters

• PlanDimensionFilterUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LevelId, MemberId and PlanId ---for the Plan Dimension Filters resource and used to uniquely identify an instance of Plan Dimension Filters. The client should not generate the hash key value. Instead, the client should query on the Plan Dimension Filters collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Dimension Filters.
  
  For example: PlanDimensionFilter?q=LevelId=<value1>;MemberId=<value2>;PlanId=<value3>
• PlanId(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: string
  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: string
  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

• HierarchyId: integer (int64)
  Specifies the hierarchy at which planning level is selected.
• LevelId: integer (int64)
  Specifies the dimension level at which planning is performed.
• MemberId: integer (int64)
  Identifies the selected member for the planning level.
• MemberName: string
  Maximum Length: 240

  Dimension level members selected for use in a plan.
• PlanId: integer (int64)
  Uniquely identifies the plan.
• SopLevelId: integer (int64)
  Product category level members selected for use in a plan when the planning product level is category.

{
    "type":"object",
    "properties":{
        "HierarchyId":{
            "type":"integer",
            "description":"Specifies the hierarchy at which planning level is selected.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LevelId":{
            "type":"integer",
            "description":"Specifies the dimension level at which planning is performed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MemberId":{
            "type":"integer",
            "description":"Identifies the selected member for the planning level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Dimension level members selected for use in a plan.",
            "nullable":false
        },
        "PlanId":{
            "type":"integer",
            "description":"Uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SopLevelId":{
            "type":"integer",
            "description":"Product category level members selected for use in a plan when the planning product level is category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : planOptions-PlanDimensionFilter-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the plan dimension filter.
• CreationDate: string (date-time)
  Read Only: true

  Date when the plan dimension filter was originally created.
• HierarchyId: integer (int64)
  Specifies the hierarchy at which planning level is selected.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan dimension filter.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update on the plan dimension filter.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last time the user logged into the system.
• LevelId: integer (int64)
  Specifies the dimension level at which planning is performed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberId: integer (int64)
  Identifies the selected member for the planning level.
• MemberName: string
  Maximum Length: 240

  Dimension level members selected for use in a plan.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan dimension version number.
• PlanId: integer (int64)
  Uniquely identifies the plan.
• SopLevelId: integer (int64)
  Product category level members selected for use in a plan when the planning product level is category.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the plan dimension filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan dimension filter was originally created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyId":{
            "type":"integer",
            "description":"Specifies the hierarchy at which planning level is selected.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan dimension filter.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan dimension filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelId":{
            "type":"integer",
            "description":"Specifies the dimension level at which planning is performed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemberId":{
            "type":"integer",
            "description":"Identifies the selected member for the planning level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Dimension level members selected for use in a plan.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan dimension version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SopLevelId":{
            "type":"integer",
            "description":"Product category level members selected for use in a plan when the planning product level is category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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