Jump to

• Request
• Response

Update one measure context level

patch

/fscmRestApi/resources/11.13.18.05/planningMeasureContextLevels/{planningMeasureContextLevelsUniqID}

Request

Path Parameters

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

• GranularityId: integer (int64)
  Granularity ID of the measure context level.
• MeasureContextLevelsList: string
  Maximum Length: 255

  List of levels used for the measure context.
• ObjectVersionNumber: integer (int32)
  Object version number used for the measure context level.

{
    "type":"object",
    "properties":{
        "GranularityId":{
            "type":"integer",
            "description":"Granularity ID of the measure context level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MeasureContextLevelsList":{
            "maxLength":255,
            "type":"string",
            "description":"List of levels used for the measure context.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number used for the measure context level.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the measure context level.
• GranularityId: integer (int64)
  Granularity ID of the measure context level.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the measure context level.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureContextId: integer (int64)
  Measure context ID used for the measure context level.
• MeasureContextLevelsList: string
  Maximum Length: 255

  List of levels used for the measure context.
• MeasureId: integer (int64)
  Measure ID used for the measure context level.
• ObjectVersionNumber: integer (int32)
  Object version number used for the measure context level.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the measure context level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GranularityId":{
            "type":"integer",
            "description":"Granularity ID of the measure context level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the measure context level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureContextId":{
            "type":"integer",
            "description":"Measure context ID used for the measure context level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeasureContextLevelsList":{
            "maxLength":255,
            "type":"string",
            "description":"List of levels used for the measure context.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureId":{
            "type":"integer",
            "description":"Measure ID used for the measure context level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number used for the measure context level.",
            "format":"int32",
            "nullable":false,
            "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"
            }
        }
    }
}

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