Jump to

• Request
• Response

Create measures

post

/fscmRestApi/resources/11.13.18.05/planningMeasures

Request

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

• AggrMethodOther: string
  Maximum Length: 20

  Other aggregation method used in measure definition.
• AggrMethodTime: string
  Maximum Length: 20

  Time aggregation method used in measure definition.
• AggrOrder: integer (int32)
  Value that indicates the aggregation order in measure definition. Valid values are 1:calculate then aggregate,2: aggregate then calculate. The default value is 1.
• BaseCurrencyCode: string
  Maximum Length: 60

  Base currency code used in measure definition.
• BaseUOMCode: string
  Maximum Length: 12

  Base unit of measure code used in measure definition.
• changeHistory: array Measure Change Histories
  Title: Measure Change Histories

  An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.
• DataTypeId: string
  Maximum Length: 9

  Value that indicates the data type in measure definition. Valid values are 1:Number, 2:Currency, 3:Percent, 4:Date or 5:Text. The default value is 1.
• DecimalPlaces: integer (int32)
  Indicates decimal places in measure definition.
• Description: string
  Maximum Length: 1000

  Description of the measure.
• DisaggrBasisOther: integer
  Indicates other disaggregation basis used in measure definition.
• DisaggrBasisTime: integer
  Indicates disaggregation basis time used in measure definition.
• DisaggrMethodOther: string
  Maximum Length: 20

  Indicates other disaggregation method used in measure definition.
• DisaggrMethodTime: string
  Maximum Length: 20

  Indicates disaggregation basis time used in measure definition.
• EditLockExpr: string
  Maximum Length: 2000

  Edit lock expression used in measure definition.
• EditRange: integer (int32)
  Value that indicates the edit range in measure definition. Valid values are 1:History, 2: Future or 3:History and future.
• GranularityId: integer
  Value that uniquely identifies the granularity of the measure.
• IsDisable: integer (int32)
  Indicates whether the measure is disabled. Valid values are 1:Yes or 2:No.
• isMeasureEditable: integer (int32)
  Title: Allow editing

  Default Value: 2

  Indicates whether the measure is editable. Valid values are 1:Yes or 2:No.
• IsSeeded: integer
  Default Value: 0

  Indicates whether the measure is predefined. Valid values are 1:Yes or 2:No.
• isShared: integer (int32)
  Indicates whether the measure is shared. Valid values are 1:Yes or 2:No.
• measureAssociations: array Measure Associations
  Title: Measure Associations

  The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.
• MeasureCode: string
  Maximum Length: 100

  Value that uniquely identifies the code of the measure.
• measureGroupAssignment: array Measure Groups
  Title: Measure Groups

  A listing of all the measures that are part of the measure group.
• MeasureId: integer
  Value that uniquely identifies the measure.
• measureReferenceTypesLOV: array Measure Reference Types List of Values
  Title: Measure Reference Types List of Values

  List of object types such as a table or graph that are linked to the measure.
• Name(required): string
  Title: Measure

  Maximum Length: 250

  Name of the measure.
• ObjectVersionNumber: integer (int32)
  Implements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried.
• Owner: integer (int32)
  Name of the user who owns the measure.
• SecBasis: integer (int64)
  Indicates secondary disaggregation basis for the measure.
• SeededExpression: string
  Maximum Length: 2000

  Indicates the predefined measure expression.
• StoreResult: integer (int32)
  Indicates whether the measure is enabled for store result. Valid values are 1:Yes or 2:No.
• WeightedBy: integer
  Indicates weight by aggregation for the measure.

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "MeasureCode":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the code of the measure.",
            "nullable":true
        },
        "Owner":{
            "type":"integer",
            "description":"Name of the user who owns the measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the measure.",
            "nullable":true
        },
        "measureGroupAssignment":{
            "title":"Measure Groups",
            "type":"array",
            "description":"A listing of all the measures that are part of the measure group.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-measureGroupAssignment-item-post-request"
            }
        },
        "DisaggrBasisOther":{
            "type":"integer",
            "description":"Indicates other disaggregation basis used in measure definition.",
            "nullable":true
        },
        "measureAssociations":{
            "title":"Measure Associations",
            "type":"array",
            "description":"The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-measureAssociations-item-post-request"
            }
        },
        "EditRange":{
            "type":"integer",
            "description":"Value that indicates the edit range in measure definition. Valid values are 1:History, 2: Future or 3:History and future.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "AggrMethodTime":{
            "maxLength":20,
            "type":"string",
            "description":"Time aggregation method used in measure definition.",
            "nullable":true
        },
        "Name":{
            "title":"Measure",
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure.",
            "nullable":false
        },
        "measureReferenceTypesLOV":{
            "title":"Measure Reference Types List of Values",
            "type":"array",
            "description":"List of object types such as a table or graph that are linked to the measure.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-measureReferenceTypesLOV-item-post-request"
            }
        },
        "WeightedBy":{
            "type":"integer",
            "description":"Indicates weight by aggregation for the measure.",
            "nullable":true
        },
        "BaseUOMCode":{
            "maxLength":12,
            "type":"string",
            "description":"Base unit of measure code used in measure definition.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Implements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "GranularityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the granularity of the measure.",
            "nullable":true
        },
        "StoreResult":{
            "type":"integer",
            "description":"Indicates whether the measure is enabled for store result. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "SecBasis":{
            "type":"integer",
            "description":"Indicates secondary disaggregation basis for the measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DisaggrMethodOther":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates other disaggregation method used in measure definition.",
            "nullable":true
        },
        "changeHistory":{
            "title":"Measure Change Histories",
            "type":"array",
            "description":"An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-changeHistory-item-post-request"
            }
        },
        "DisaggrMethodTime":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates disaggregation basis time used in measure definition.",
            "nullable":true
        },
        "isMeasureEditable":{
            "title":"Allow editing",
            "type":"integer",
            "description":"Indicates whether the measure is editable. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "default":2,
            "x-hints":{
                "precision":9
            }
        },
        "SeededExpression":{
            "maxLength":2000,
            "type":"string",
            "description":"Indicates the predefined measure expression.",
            "nullable":true
        },
        "DisaggrBasisTime":{
            "type":"integer",
            "description":"Indicates disaggregation basis time used in measure definition.",
            "nullable":true
        },
        "AggrOrder":{
            "type":"integer",
            "description":"Value that indicates the aggregation order in measure definition. Valid values are 1:calculate then aggregate,2: aggregate then calculate. The default value is 1.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "BaseCurrencyCode":{
            "maxLength":60,
            "type":"string",
            "description":"Base currency code used in measure definition.",
            "nullable":true
        },
        "DecimalPlaces":{
            "type":"integer",
            "description":"Indicates decimal places in measure definition.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "EditLockExpr":{
            "maxLength":2000,
            "type":"string",
            "description":"Edit lock expression used in measure definition.",
            "nullable":true
        },
        "MeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure.",
            "nullable":false
        },
        "AggrMethodOther":{
            "maxLength":20,
            "type":"string",
            "description":"Other aggregation method used in measure definition.",
            "nullable":true
        },
        "DataTypeId":{
            "maxLength":9,
            "type":"string",
            "description":"Value that indicates the data type in measure definition. Valid values are 1:Number, 2:Currency, 3:Percent, 4:Date or 5:Text. The default value is 1.",
            "nullable":true
        },
        "IsSeeded":{
            "type":"integer",
            "description":"Indicates whether the measure is predefined. Valid values are 1:Yes or 2:No.",
            "nullable":true,
            "default":0
        },
        "isShared":{
            "type":"integer",
            "description":"Indicates whether the measure is shared. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "IsDisable":{
            "type":"integer",
            "description":"Indicates whether the measure is disabled. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        }
    }
}

Nested Schema : Measure Change Histories

Type: array

Title: Measure Change Histories

An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.

Show Source

• Array of: object planningMeasures-changeHistory-item-post-request

{
    "title":"Measure Change Histories",
    "type":"array",
    "description":"An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-changeHistory-item-post-request"
    }
}

Nested Schema : Measure Associations

Type: array

Title: Measure Associations

The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.

Show Source

• Array of: object planningMeasures-measureAssociations-item-post-request

{
    "title":"Measure Associations",
    "type":"array",
    "description":"The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-measureAssociations-item-post-request"
    }
}

Nested Schema : Measure Groups

Type: array

Title: Measure Groups

A listing of all the measures that are part of the measure group.

Show Source

• Array of: object planningMeasures-measureGroupAssignment-item-post-request

{
    "title":"Measure Groups",
    "type":"array",
    "description":"A listing of all the measures that are part of the measure group.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-measureGroupAssignment-item-post-request"
    }
}

Nested Schema : Measure Reference Types List of Values

Type: array

Title: Measure Reference Types List of Values

List of object types such as a table or graph that are linked to the measure.

Show Source

• Array of: object planningMeasures-measureReferenceTypesLOV-item-post-request

{
    "title":"Measure Reference Types List of Values",
    "type":"array",
    "description":"List of object types such as a table or graph that are linked to the measure.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-measureReferenceTypesLOV-item-post-request"
    }
}

Nested Schema : planningMeasures-changeHistory-item-post-request

Type: object

Show Source

• MeasureName: string
  Title: Measure

  Name of the measure that has change history.
• PreviousValue: string
  Title: Previous Value

  Previous value of the measure property.
• Property: string
  Specific attribute of a measure such as the expression, allow editing, or description.
• UpdatedValue: string
  Title: New Value

  New value of the measure property.

{
    "type":"object",
    "properties":{
        "UpdatedValue":{
            "title":"New Value",
            "type":"string",
            "description":"New value of the measure property.",
            "nullable":true
        },
        "PreviousValue":{
            "title":"Previous Value",
            "type":"string",
            "description":"Previous value of the measure property.",
            "nullable":true
        },
        "Property":{
            "type":"string",
            "description":"Specific attribute of a measure such as the expression, allow editing, or description.",
            "nullable":true
        },
        "MeasureName":{
            "title":"Measure",
            "type":"string",
            "description":"Name of the measure that has change history.",
            "nullable":true
        }
    }
}

Nested Schema : planningMeasures-measureAssociations-item-post-request

Type: object

Show Source

• DeletionType: string
  Maximum Length: 255

  Deletion types linked to the measure. Valid values are Automatic and Manual.
• Type: string
  Maximum Length: 255

  Type of the associated object such as pivot table, graph, measure catalog, or measure group that are linked to the measure.

{
    "type":"object",
    "properties":{
        "DeletionType":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion types linked to the measure. Valid values are Automatic and Manual.",
            "nullable":true
        },
        "Type":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the associated object such as pivot table, graph, measure catalog, or measure group that are linked to the measure.",
            "nullable":true
        }
    }
}

Nested Schema : planningMeasures-measureGroupAssignment-item-post-request

Type: object

Show Source

• GroupId: integer (int64)
  Title: Measure Groups

  Value that uniquely identifies the measure group.
• MeasureId: integer (int64)
  Title: Measure

  Value that uniquely identifies the measure in a measure group.
• MeasureName: string
  Name of the measure.

{
    "type":"object",
    "properties":{
        "MeasureId":{
            "title":"Measure",
            "type":"integer",
            "description":"Value that uniquely identifies the measure in a measure group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "GroupId":{
            "title":"Measure Groups",
            "type":"integer",
            "description":"Value that uniquely identifies the measure group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MeasureName":{
            "type":"string",
            "description":"Name of the measure.",
            "nullable":true
        }
    }
}

Nested Schema : planningMeasures-measureReferenceTypesLOV-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : planningMeasures-item-response

Type: object

Show Source

• AggrMethodOther: string
  Maximum Length: 20

  Other aggregation method used in measure definition.
• AggrMethodTime: string
  Maximum Length: 20

  Time aggregation method used in measure definition.
• AggrOrder: integer (int32)
  Value that indicates the aggregation order in measure definition. Valid values are 1:calculate then aggregate,2: aggregate then calculate. The default value is 1.
• BaseCurrencyCode: string
  Maximum Length: 60

  Base currency code used in measure definition.
• BaseUOMCode: string
  Maximum Length: 12

  Base unit of measure code used in measure definition.
• changeHistory: array Measure Change Histories
  Title: Measure Change Histories

  An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.
• DataTypeId: string
  Maximum Length: 9

  Value that indicates the data type in measure definition. Valid values are 1:Number, 2:Currency, 3:Percent, 4:Date or 5:Text. The default value is 1.
• DecimalPlaces: integer (int32)
  Indicates decimal places in measure definition.
• Description: string
  Maximum Length: 1000

  Description of the measure.
• DisaggrBasisOther: integer
  Indicates other disaggregation basis used in measure definition.
• DisaggrBasisTime: integer
  Indicates disaggregation basis time used in measure definition.
• DisaggrMethodOther: string
  Maximum Length: 20

  Indicates other disaggregation method used in measure definition.
• DisaggrMethodTime: string
  Maximum Length: 20

  Indicates disaggregation basis time used in measure definition.
• EditLockExpr: string
  Maximum Length: 2000

  Edit lock expression used in measure definition.
• EditRange: integer (int32)
  Value that indicates the edit range in measure definition. Valid values are 1:History, 2: Future or 3:History and future.
• Expression: string
  Read Only: true

  Maximum Length: 2000

  Expression used in measure definition.
• GranularityId: integer
  Value that uniquely identifies the granularity of the measure.
• IsDisable: integer (int32)
  Indicates whether the measure is disabled. Valid values are 1:Yes or 2:No.
• isMeasureEditable: integer (int32)
  Title: Allow editing

  Default Value: 2

  Indicates whether the measure is editable. Valid values are 1:Yes or 2:No.
• IsSeeded: integer
  Default Value: 0

  Indicates whether the measure is predefined. Valid values are 1:Yes or 2:No.
• isShared: integer (int32)
  Indicates whether the measure is shared. Valid values are 1:Yes or 2:No.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measureAssociations: array Measure Associations
  Title: Measure Associations

  The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.
• MeasureCode: string
  Maximum Length: 100

  Value that uniquely identifies the code of the measure.
• measureGroupAssignment: array Measure Groups
  Title: Measure Groups

  A listing of all the measures that are part of the measure group.
• MeasureId: integer
  Value that uniquely identifies the measure.
• measureReferenceTypesLOV: array Measure Reference Types List of Values
  Title: Measure Reference Types List of Values

  List of object types such as a table or graph that are linked to the measure.
• Name: string
  Title: Measure

  Maximum Length: 250

  Name of the measure.
• ObjectVersionNumber: integer (int32)
  Implements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried.
• Owner: integer (int32)
  Name of the user who owns the measure.
• SecBasis: integer (int64)
  Indicates secondary disaggregation basis for the measure.
• SeededExpression: string
  Maximum Length: 2000

  Indicates the predefined measure expression.
• StoreResult: integer (int32)
  Indicates whether the measure is enabled for store result. Valid values are 1:Yes or 2:No.
• WeightedBy: integer
  Indicates weight by aggregation for the measure.

{
    "type":"object",
    "properties":{
        "MeasureCode":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the code of the measure.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "type":"integer",
            "description":"Name of the user who owns the measure.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the measure.",
            "nullable":true,
            "x-queryable":true
        },
        "measureGroupAssignment":{
            "title":"Measure Groups",
            "type":"array",
            "description":"A listing of all the measures that are part of the measure group.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-measureGroupAssignment-item-response"
            }
        },
        "DisaggrBasisOther":{
            "type":"integer",
            "description":"Indicates other disaggregation basis used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "measureAssociations":{
            "title":"Measure Associations",
            "type":"array",
            "description":"The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-measureAssociations-item-response"
            }
        },
        "EditRange":{
            "type":"integer",
            "description":"Value that indicates the edit range in measure definition. Valid values are 1:History, 2: Future or 3:History and future.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AggrMethodTime":{
            "maxLength":20,
            "type":"string",
            "description":"Time aggregation method used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Measure",
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure.",
            "nullable":false,
            "x-queryable":true
        },
        "measureReferenceTypesLOV":{
            "title":"Measure Reference Types List of Values",
            "type":"array",
            "description":"List of object types such as a table or graph that are linked to the measure.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-measureReferenceTypesLOV-item-response"
            }
        },
        "WeightedBy":{
            "type":"integer",
            "description":"Indicates weight by aggregation for the measure.",
            "nullable":true,
            "x-queryable":true
        },
        "BaseUOMCode":{
            "maxLength":12,
            "type":"string",
            "description":"Base unit of measure code used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Implements optimistic locking by incrementing this number each time the row is updated. At the start and end of a transaction, the number is compared to detect if another session has updated the row since it was last queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "GranularityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the granularity of the measure.",
            "nullable":true,
            "x-queryable":true
        },
        "StoreResult":{
            "type":"integer",
            "description":"Indicates whether the measure is enabled for store result. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "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"
            }
        },
        "SecBasis":{
            "type":"integer",
            "description":"Indicates secondary disaggregation basis for the measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisaggrMethodOther":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates other disaggregation method used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "changeHistory":{
            "title":"Measure Change Histories",
            "type":"array",
            "description":"An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.",
            "items":{
                "$ref":"#/components/schemas/planningMeasures-changeHistory-item-response"
            }
        },
        "DisaggrMethodTime":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates disaggregation basis time used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "isMeasureEditable":{
            "title":"Allow editing",
            "type":"integer",
            "description":"Indicates whether the measure is editable. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "default":2,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SeededExpression":{
            "maxLength":2000,
            "type":"string",
            "description":"Indicates the predefined measure expression.",
            "nullable":true,
            "x-queryable":true
        },
        "DisaggrBasisTime":{
            "type":"integer",
            "description":"Indicates disaggregation basis time used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "AggrOrder":{
            "type":"integer",
            "description":"Value that indicates the aggregation order in measure definition. Valid values are 1:calculate then aggregate,2: aggregate then calculate. The default value is 1.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BaseCurrencyCode":{
            "maxLength":60,
            "type":"string",
            "description":"Base currency code used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "DecimalPlaces":{
            "type":"integer",
            "description":"Indicates decimal places in measure definition.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EditLockExpr":{
            "maxLength":2000,
            "type":"string",
            "description":"Edit lock expression used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure.",
            "nullable":false,
            "x-queryable":true
        },
        "AggrMethodOther":{
            "maxLength":20,
            "type":"string",
            "description":"Other aggregation method used in measure definition.",
            "nullable":true,
            "x-queryable":true
        },
        "Expression":{
            "maxLength":2000,
            "type":"string",
            "description":"Expression used in measure definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataTypeId":{
            "maxLength":9,
            "type":"string",
            "description":"Value that indicates the data type in measure definition. Valid values are 1:Number, 2:Currency, 3:Percent, 4:Date or 5:Text. The default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSeeded":{
            "type":"integer",
            "description":"Indicates whether the measure is predefined. Valid values are 1:Yes or 2:No.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "isShared":{
            "type":"integer",
            "description":"Indicates whether the measure is shared. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the measure.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsDisable":{
            "type":"integer",
            "description":"Indicates whether the measure is disabled. Valid values are 1:Yes or 2:No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Measure Change Histories

Type: array

Title: Measure Change Histories

An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.

Show Source

• Array of: object planningMeasures-changeHistory-item-response

{
    "title":"Measure Change Histories",
    "type":"array",
    "description":"An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-changeHistory-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 : Measure Associations

Type: array

Title: Measure Associations

The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.

Show Source

• Array of: object planningMeasures-measureAssociations-item-response

{
    "title":"Measure Associations",
    "type":"array",
    "description":"The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-measureAssociations-item-response"
    }
}

Nested Schema : Measure Groups

Type: array

Title: Measure Groups

A listing of all the measures that are part of the measure group.

Show Source

• Array of: object planningMeasures-measureGroupAssignment-item-response

{
    "title":"Measure Groups",
    "type":"array",
    "description":"A listing of all the measures that are part of the measure group.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-measureGroupAssignment-item-response"
    }
}

Nested Schema : Measure Reference Types List of Values

Type: array

Title: Measure Reference Types List of Values

List of object types such as a table or graph that are linked to the measure.

Show Source

• Array of: object planningMeasures-measureReferenceTypesLOV-item-response

{
    "title":"Measure Reference Types List of Values",
    "type":"array",
    "description":"List of object types such as a table or graph that are linked to the measure.",
    "items":{
        "$ref":"#/components/schemas/planningMeasures-measureReferenceTypesLOV-item-response"
    }
}

Nested Schema : planningMeasures-changeHistory-item-response

Type: object

Show Source

• ChangeDate: string (date-time)
  Title: Change Date

  Read Only: true

  Date when the user updated the property of the measure.
• ChangedBy: string
  Title: Changed By

  Read Only: true

  Maximum Length: 64

  User who updated the property of the measure.
• Id: integer
  Read Only: true

  Value that uniquely identifies the change history of the measure
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureName: string
  Title: Measure

  Name of the measure that has change history.
• PreviousValue: string
  Title: Previous Value

  Previous value of the measure property.
• Property: string
  Specific attribute of a measure such as the expression, allow editing, or description.
• UpdatedValue: string
  Title: New Value

  New value of the measure property.

{
    "type":"object",
    "properties":{
        "UpdatedValue":{
            "title":"New Value",
            "type":"string",
            "description":"New value of the measure property.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangedBy":{
            "title":"Changed By",
            "maxLength":64,
            "type":"string",
            "description":"User who updated the property of the measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureName":{
            "title":"Measure",
            "type":"string",
            "description":"Name of the measure that has change history.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeDate":{
            "title":"Change Date",
            "type":"string",
            "description":"Date when the user updated the property of the measure.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the change history of the measure",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousValue":{
            "title":"Previous Value",
            "type":"string",
            "description":"Previous value of the measure property.",
            "nullable":true,
            "x-queryable":true
        },
        "Property":{
            "type":"string",
            "description":"Specific attribute of a measure such as the expression, allow editing, or description.",
            "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 : planningMeasures-measureAssociations-item-response

Type: object

Show Source

• DeletionType: string
  Maximum Length: 255

  Deletion types linked to the measure. Valid values are Automatic and Manual.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureId: integer
  Read Only: true

  Value that identifies the measure.
• Name: string
  Read Only: true

  Maximum Length: 250

  Name of the associated object.
• ReferenceEntityId: integer (int64)
  Read Only: true

  Value that uniquely identifies the associated object.
• RefType: integer
  Read Only: true

  Unique identifier of a measure reference type.
• Type: string
  Maximum Length: 255

  Type of the associated object such as pivot table, graph, measure catalog, or measure group that are linked to the measure.

{
    "type":"object",
    "properties":{
        "RefType":{
            "type":"integer",
            "description":"Unique identifier of a measure reference type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureId":{
            "type":"integer",
            "description":"Value that identifies the measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the associated object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Type":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the associated object such as pivot table, graph, measure catalog, or measure group that are linked to the measure.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletionType":{
            "maxLength":255,
            "type":"string",
            "description":"Deletion types linked to the measure. Valid values are Automatic and Manual.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Name":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the associated object.",
            "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 : planningMeasures-measureGroupAssignment-item-response

Type: object

Show Source

• Description: string
  Read Only: true

  Description of the measure.
• GroupId: integer (int64)
  Title: Measure Groups

  Value that uniquely identifies the measure group.
• GroupName: string
  Read Only: true

  Name of the measure group.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user added the measure to the measure group.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently added the measure to the measure group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureId: integer (int64)
  Title: Measure

  Value that uniquely identifies the measure in a measure group.
• MeasureName: string
  Name of the measure.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently added the measure to the measure group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupName":{
            "type":"string",
            "description":"Name of the measure group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MeasureId":{
            "title":"Measure",
            "type":"integer",
            "description":"Value that uniquely identifies the measure in a measure group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "type":"string",
            "description":"Description of the measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MeasureName":{
            "type":"string",
            "description":"Name of the measure.",
            "nullable":true,
            "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 added the measure to the measure group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupId":{
            "title":"Measure Groups",
            "type":"integer",
            "description":"Value that uniquely identifies the measure group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : planningMeasures-measureReferenceTypesLOV-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReferenceType: string
  Read Only: true

  Maximum Length: 255

  Type of object associated with the measure.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReferenceType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of object associated with the measure.",
            "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

changeHistory

Operation: /fscmRestApi/resources/11.13.18.05/planningMeasures/{MeasureId}/child/changeHistory

Parameters:

• MeasureId: $request.path.MeasureId

An audit history of changes to planning measure properties such as details about what was changed, when it was changed, and who made the changes.

measureAssociations

Operation: /fscmRestApi/resources/11.13.18.05/planningMeasures/{MeasureId}/child/measureAssociations

Parameters:

• MeasureId: $request.path.MeasureId

The association of a planning measure with other planning objects such as a pivot table, graph, measure group, measure catalog, or forecast profile.

measureGroupAssignment

Operation: /fscmRestApi/resources/11.13.18.05/planningMeasures/{MeasureId}/child/measureGroupAssignment

Parameters:

• MeasureId: $request.path.MeasureId

A listing of all the measures that are part of the measure group.

measureReferenceTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/planningMeasures/{MeasureId}/child/measureReferenceTypesLOV

Parameters:

• MeasureId: $request.path.MeasureId

List of object types such as a table or graph that are linked to the measure.

Back to Top