Jump to

• Request
• Response

Create one measure group

post

/fscmRestApi/resources/11.13.18.05/planningMeasureGroups

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 1000

  Description of the measure group.
• GroupId: integer (int64)
  Value that uniquely identifies the measure group.
• GroupName: string
  Maximum Length: 250

  Name of the measure group.
• IsSeeded: integer (int32)
  Indicator for how a measure group is defined. Value 1 indicates it's a predefined measure group. Value 0 indicates it's a user-defined measure group.
• planningMeasures: array Measure Groups
  Title: Measure Groups

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

{
    "type":"object",
    "properties":{
        "GroupName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure group.",
            "nullable":true
        },
        "IsSeeded":{
            "type":"integer",
            "description":"Indicator for how a measure group is defined. Value 1 indicates it's a predefined measure group. Value 0 indicates it's a user-defined measure group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "planningMeasures":{
            "title":"Measure Groups",
            "type":"array",
            "description":"A listing of all the measures that are part of the measure group.",
            "items":{
                "$ref":"#/components/schemas/planningMeasureGroups-planningMeasures-item-post-request"
            }
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the measure group.",
            "nullable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 schema

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

Nested Schema : schema

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

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

Type: object

Show Source

• Description: string
  Maximum Length: 1000

  Description of the measure group.
• GroupId: integer (int64)
  Value that uniquely identifies the measure group.
• GroupName: string
  Maximum Length: 250

  Name of the measure group.
• IsSeeded: integer (int32)
  Indicator for how a measure group is defined. Value 1 indicates it's a predefined measure group. Value 0 indicates it's a user-defined measure group.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• planningMeasures: array Measure Groups
  Title: Measure Groups

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the measure group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure group.",
            "nullable":true,
            "x-queryable":true
        },
        "planningMeasures":{
            "title":"Measure Groups",
            "type":"array",
            "description":"A listing of all the measures that are part of the measure group.",
            "items":{
                "$ref":"#/components/schemas/planningMeasureGroups-planningMeasures-item-response"
            }
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the measure group.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSeeded":{
            "type":"integer",
            "description":"Indicator for how a measure group is defined. Value 1 indicates it's a predefined measure group. Value 0 indicates it's a user-defined measure group.",
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the measure group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : 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 planningMeasureGroups-planningMeasures-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/planningMeasureGroups-planningMeasures-item-response"
    }
}

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 : planningMeasureGroups-planningMeasures-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"
    }
}

Links

planningMeasures

Operation: /fscmRestApi/resources/11.13.18.05/planningMeasureGroups/{GroupId}/child/planningMeasures

Parameters:

• GroupId: $request.path.GroupId

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

Back to Top