Jump to

• Request
• Response

Update one plan optional dimension

patch

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanOptionalDimensions/{PlanOptionalDimensionsUniqID}

Request

Path Parameters

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

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

• DimensionId: integer (int64)
  Unique identifier of the dimension.
• Enabled: integer (int32)
  Indicates whether the dimension is enabled or disabled.
• LevelId: integer (int64)
  Indicates the last level ID for the dimension.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.

{
    "type":"object",
    "properties":{
        "Enabled":{
            "type":"integer",
            "description":"Indicates whether the dimension is enabled or disabled.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "DimensionId":{
            "type":"integer",
            "description":"Unique identifier of the dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LevelId":{
            "type":"integer",
            "description":"Indicates the last level ID for the dimension.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "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-PlanOptionalDimensions-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the plan dimension filter was originally created.
• DimensionId: integer (int64)
  Unique identifier of the dimension.
• DimensionName: string
  Read Only: true

  Maximum Length: 255

  Name of the dimension to be created for a planning attribute. This is used in attribute-based planning.
• Enabled: integer (int32)
  Indicates whether the dimension is enabled or disabled.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  Last time the user logged into the system.
• LevelId: integer (int64)
  Indicates the last level ID for the dimension.
• LevelName: string
  Read Only: true

  Maximum Length: 255

  Hierarchy level name selected for the dimension.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan version number.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the plan dimension filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Enabled":{
            "type":"integer",
            "description":"Indicates whether the dimension is enabled or disabled.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "DimensionName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the dimension to be created for a planning attribute. This is used in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LevelName":{
            "maxLength":255,
            "type":"string",
            "description":"Hierarchy level name selected for the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DimensionId":{
            "type":"integer",
            "description":"Unique identifier of the dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LevelId":{
            "type":"integer",
            "description":"Indicates the last level ID for the dimension.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "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
        }
    }
}

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