Jump to

• Request
• Response

Update one planning level

patch

/fscmRestApi/resources/11.13.18.05/planningLevels/{LevelId}

Request

Path Parameters

• LevelId(required): integer
  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

• LevelAttributes: array Planning Levels Attributes
  Title: Planning Levels Attributes

  Level attributes for the planning.
• MemberIdentifier: string
  Maximum Length: 200

  Member identifier used in the planning level.
• ObjectVersionNumber: integer (int32)
  Version number used in the planning level.
• UserSpecifiedName: string
  Maximum Length: 64

  User-specific field name used in the planning level.

{
    "type":"object",
    "properties":{
        "LevelAttributes":{
            "title":"Planning Levels Attributes",
            "type":"array",
            "description":"Level attributes for the planning.",
            "items":{
                "$ref":"#/components/schemas/planningLevels-LevelAttributes-item-patch-request"
            }
        },
        "MemberIdentifier":{
            "maxLength":200,
            "type":"string",
            "description":"Member identifier used in the planning level.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number used in the planning level.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "UserSpecifiedName":{
            "maxLength":64,
            "type":"string",
            "description":"User-specific field name used in the planning level.",
            "nullable":true
        }
    }
}

Nested Schema : Planning Levels Attributes

Type: array

Title: Planning Levels Attributes

Level attributes for the planning.

Show Source

• Array of: object schema

{
    "title":"Planning Levels Attributes",
    "type":"array",
    "description":"Level attributes for the planning.",
    "items":{
        "$ref":"#/components/schemas/planningLevels-LevelAttributes-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AttributeName: string
  Maximum Length: 200

  Attribute name of the planning level attribute.
• DbDataType: integer (int32)
  Data type of the planning level attribute.
• Label: string
  Maximum Length: 250

  Label of the planning level attribute.

{
    "type":"object",
    "properties":{
        "AttributeName":{
            "maxLength":200,
            "type":"string",
            "description":"Attribute name of the planning level attribute.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "DbDataType":{
            "type":"integer",
            "description":"Data type of the planning level attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "post":"true",
                "precision":9
            }
        },
        "Label":{
            "maxLength":250,
            "type":"string",
            "description":"Label of the planning level attribute.",
            "nullable":true,
            "x-hints":{
                "post":"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 : planningLevels-item-response

Type: object

Show Source

• BucketType: integer (int32)
  Read Only: true

  Bucket type for the planning level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the planning level.
• DimensionId: integer
  Read Only: true

  Dimension ID used in the planning level.
• DimensionName: string
  Read Only: true

  Maximum Length: 64

  Dimension name used in the planning level.
• HierarchyId: number
  Read Only: true

  Hierarchy ID used in the planning level.
• HierarchyName: string
  Read Only: true

  Maximum Length: 240

  Hierarchy name used in the planning level.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when user last updated the planning level.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the planning level.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign in of the user who last updated the planning level.
• LevelAttributes: array Planning Levels Attributes
  Title: Planning Levels Attributes

  Level attributes for the planning.
• LevelId: integer
  Level ID of the planning level.
• LevelName: string
  Read Only: true

  Maximum Length: 64

  Name of the planning level.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberIdentifier: string
  Maximum Length: 200

  Member identifier used in the planning level.
• ObjectVersionNumber: integer (int32)
  Version number used in the planning level.
• OdsColumnName: string
  Read Only: true

  Maximum Length: 30

  Column name used in the planning level.
• TypeCode: integer (int32)
  Read Only: true

  Type code used in the planning level.
• UserSpecifiedName: string
  Maximum Length: 64

  User-specific field name used in the planning level.
• ViewName: string
  Read Only: true

  Maximum Length: 30

  View name used in the planning level.

{
    "type":"object",
    "properties":{
        "BucketType":{
            "type":"integer",
            "description":"Bucket type for the planning level.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the planning level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the planning level.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Dimension ID used in the planning level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionName":{
            "maxLength":64,
            "type":"string",
            "description":"Dimension name used in the planning level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyId":{
            "type":"number",
            "description":"Hierarchy ID used in the planning level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Hierarchy name used in the planning level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when user last updated the planning level.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Sign in of the user who last updated the planning level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the planning level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelAttributes":{
            "title":"Planning Levels Attributes",
            "type":"array",
            "description":"Level attributes for the planning.",
            "items":{
                "$ref":"#/components/schemas/planningLevels-LevelAttributes-item-response"
            }
        },
        "LevelId":{
            "type":"integer",
            "description":"Level ID of the planning level.",
            "nullable":false,
            "x-queryable":true
        },
        "LevelName":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the planning level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberIdentifier":{
            "maxLength":200,
            "type":"string",
            "description":"Member identifier used in the planning level.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number used in the planning level.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OdsColumnName":{
            "maxLength":30,
            "type":"string",
            "description":"Column name used in the planning level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "type":"integer",
            "description":"Type code used in the planning level.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "UserSpecifiedName":{
            "maxLength":64,
            "type":"string",
            "description":"User-specific field name used in the planning level.",
            "nullable":true,
            "x-queryable":true
        },
        "ViewName":{
            "maxLength":30,
            "type":"string",
            "description":"View name used in the planning level.",
            "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"
            }
        }
    }
}

Nested Schema : Planning Levels Attributes

Type: array

Title: Planning Levels Attributes

Level attributes for the planning.

Show Source

• Array of: object planningLevels-LevelAttributes-item-response

{
    "title":"Planning Levels Attributes",
    "type":"array",
    "description":"Level attributes for the planning.",
    "items":{
        "$ref":"#/components/schemas/planningLevels-LevelAttributes-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 : planningLevels-LevelAttributes-item-response

Type: object

Show Source

• AttributeId: integer (int64)
  Read Only: true

  Attribute ID of the planning level.
• AttributeName: string
  Maximum Length: 200

  Attribute name of the planning level attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the planning level attribute.
• DbDataType: integer (int32)
  Data type of the planning level attribute.
• DimensionCode: string
  Read Only: true

  Maximum Length: 3

  Dimension code of the planning level attribute.
• Label: string
  Maximum Length: 250

  Label of the planning level attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user last updated the planning level attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the planning level attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign in of the user who last updated the planning level attribute.
• LevelId: integer (int64)
  Level ID of the planning level attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"integer",
            "description":"Attribute ID of the planning level.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttributeName":{
            "maxLength":200,
            "type":"string",
            "description":"Attribute name of the planning level attribute.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the planning level attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the planning level attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DbDataType":{
            "type":"integer",
            "description":"Data type of the planning level attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "post":"true",
                "precision":9
            },
            "x-queryable":true
        },
        "DimensionCode":{
            "maxLength":3,
            "type":"string",
            "description":"Dimension code of the planning level attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Label":{
            "maxLength":250,
            "type":"string",
            "description":"Label of the planning level attribute.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user last updated the planning level attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Sign in of the user who last updated the planning level attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the planning level attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelId":{
            "type":"integer",
            "description":"Level ID of the planning level attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "post":"true",
                "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."
        }
    }
}

Links

LevelAttributes

Operation: /fscmRestApi/resources/11.13.18.05/planningLevels/{LevelId}/child/LevelAttributes

Parameters:

• LevelId: $request.path.LevelId

Level attributes for the planning.

Back to Top