Get one collected measure data record

get

/fscmRestApi/resources/11.13.18.05/collectedMeasureData/{collectedMeasureDataUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- SrInstanceId, PlanId, MeasureId, PrdLvlId, PrdLvlMemberId, OrgLvlId, OrgLvlMemberId, Time, CusLvlId, CusLvlMemberId, SorLvlId, SorLvlMemberId, DcsLvlId, DcsLvlMemberId, TimLvlId, TimLvlMemberId, SupLvlId, SupLvlMemberId, ResLvlId, ResLvlMemberId, OrdLvlId, OrdLvlMemberId, CtoLvlMemberId, ExpLvlId, ExpLvlMemberId, FcmLvlId, FcmLvlMemberId, ClgLvlId and ClgLvlMemberId ---for the Collected Measure Data resource and used to uniquely identify an instance of Collected Measure Data. The client should not generate the hash key value. Instead, the client should query on the Collected Measure Data collection resource with a filter on the primary key values in order to navigate to a specific instance of Collected Measure Data.

    For example: collectedMeasureData?q=SrInstanceId=<value1>;PlanId=<value2>;MeasureId=<value3>;PrdLvlId=<value4>;PrdLvlMemberId=<value5>;OrgLvlId=<value6>;OrgLvlMemberId=<value7>;Time=<value8>;CusLvlId=<value9>;CusLvlMemberId=<value10>;SorLvlId=<value11>;SorLvlMemberId=<value12>;DcsLvlId=<value13>;DcsLvlMemberId=<value14>;TimLvlId=<value15>;TimLvlMemberId=<value16>;SupLvlId=<value17>;SupLvlMemberId=<value18>;ResLvlId=<value19>;ResLvlMemberId=<value20>;OrdLvlId=<value21>;OrdLvlMemberId=<value22>;CtoLvlMemberId=<value23>;ExpLvlId=<value24>;ExpLvlMemberId=<value25>;FcmLvlId=<value26>;FcmLvlMemberId=<value27>;ClgLvlId=<value28>;ClgLvlMemberId=<value29>
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : collectedMeasureData-item-response
Type: object
Show Source
  • Read Only: true
    Unique identifier of the decomposition group dimension level.
  • Read Only: true
    Unique identifier of the decomposition group dimension level member.
  • Title: Creation Date
    Read Only: true
    Date when the data for the measure was first collected.
  • Title: CTO
    Read Only: true
    Maximum Length: 4000
    Name of the Configure-to-Order level member.
  • Read Only: true
    Unique identifier of the Configure-to-Order level member.
  • Title: Currency
    Read Only: true
    Maximum Length: 5
    Currency associated with the collected measure data.
  • Read Only: true
    Unique identifier of the customer dimension level.
  • Read Only: true
    Unique identifier of the customer dimension level member.
  • Title: Customer
    Read Only: true
    Maximum Length: 4000
    Name of the customer dimension level member.
  • Title: Customer Level
    Read Only: true
    Maximum Length: 64
    Name of the customer dimension level.
  • Read Only: true
    Unique identifier of the demand class dimension level.
  • Read Only: true
    Unique identifier of the demand class dimension level member.
  • Title: Decomposition Group
    Read Only: true
    Maximum Length: 4000
    Name of the decomposition group dimension level member.
  • Title: Decomposition Group Level
    Read Only: true
    Maximum Length: 64
    Name of the decomposition group dimension level.
  • Title: Demand Class
    Read Only: true
    Maximum Length: 4000
    Name of the demand class dimension level member.
  • Title: Demand Class Level
    Read Only: true
    Maximum Length: 64
    Name of the demand class dimension level.
  • Title: Demand Forecast Method
    Read Only: true
    Maximum Length: 4000
    Name of the forecast methods dimension level member.
  • Title: Demand Forecast Method Level
    Read Only: true
    Maximum Length: 64
    Name of the forecast methods dimension level.
  • Title: Error
    Read Only: true
    Maximum Length: 2000
    Error information associated with collected measure data, available only for data that failed validation during the collection process.
  • Title: Exception Type
    Read Only: true
    Maximum Length: 4000
    Name of the exception dimension level member.
  • Title: Exception Type Level
    Read Only: true
    Maximum Length: 64
    Name of the exception dimension level.
  • Read Only: true
    Unique identifier of the exception dimension level.
  • Read Only: true
    Unique identifier of the exception dimension level member.
  • Read Only: true
    Unique identifier of the forecast methods dimension level.
  • Read Only: true
    Unique identifier of the forecast methods dimension level member.
  • Title: Source System
    Read Only: true
    Maximum Length: 30
    Code associated with the source instance.
  • Title: Last Updated Date
    Read Only: true
    Date when the measure data was last updated.
  • Links
  • Read Only: true
    Unique identifier of the measure for which data was collected.
  • Title: Measure Name
    Read Only: true
    Maximum Length: 250
    Name of the measure for which data was collected.
  • Title: Measure Value
    Read Only: true
    Maximum Length: 100
    Collected value of the measure.
  • Title: Order Type
    Read Only: true
    Maximum Length: 4000
    Name of the order type level member.
  • Title: Order Type Level
    Read Only: true
    Maximum Length: 64
    Name of the order type level.
  • Read Only: true
    Unique identifier of the order type dimension level.
  • Read Only: true
    Unique identifier of the order type dimension level member.
  • Title: Organization
    Read Only: true
    Maximum Length: 4000
    Name of the organization level member.
  • Title: Organization Level
    Read Only: true
    Maximum Length: 64
    Name of the organization level.
  • Read Only: true
    Unique identifier of the organization dimension level.
  • Read Only: true
    Unique identifier of the organization dimension level member.
  • Read Only: true
    Unique identifier of the plan associated with the collected measure data.
  • Title: Plan Name
    Read Only: true
    Maximum Length: 30
    Name of the plan associated with the collected measure data.
  • Read Only: true
    Unique identifier of the product dimension level.
  • Read Only: true
    Unique identifier of the product dimension level member.
  • Title: Product
    Read Only: true
    Maximum Length: 4000
    Name of the product dimension level member.
  • Title: Product Level
    Read Only: true
    Maximum Length: 64
    Name of the product dimension level.
  • Title: Refresh Number
    Read Only: true
    Unique number associated with the measure data collection process.
  • Read Only: true
    Unique identifier of the resource dimension level.
  • Read Only: true
    Unique identifier of the resource dimension level member.
  • Title: Resource Level
    Read Only: true
    Maximum Length: 64
    Name of the resource dimension level.
  • Title: Resource
    Read Only: true
    Maximum Length: 4000
    Name of the resource dimension level member.
  • Title: Sales Organization
    Read Only: true
    Maximum Length: 4000
    Name of the sales organization dimension level member.
  • Title: Sales Organization Level
    Read Only: true
    Maximum Length: 64
    Name of the sales organization dimension level.
  • Title: Errors
    Read Only: true
    Option to control the display of collected measure data. Valid values are Display only rows with errors, Display all rows, and Display only rows without errors.
  • Read Only: true
    Unique identifier of the sales organization dimension level.
  • Read Only: true
    Unique identifier of the sales organization dimension level member.
  • Title: Source System
    Read Only: true
    Unique identifier of the source instance.
  • Read Only: true
    Unique identifier of the supplier dimension level.
  • Read Only: true
    Unique identifier of the supplier dimension level member.
  • Title: Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the supplier dimension level member.
  • Title: Supplier Level
    Read Only: true
    Maximum Length: 64
    Name of the supplier dimension level.
  • Title: Time
    Read Only: true
    Date associated with the collected measure data.
  • Title: Time Level
    Read Only: true
    Maximum Length: 64
    Name of the time dimension level.
  • Read Only: true
    Unique identifier of the time dimension level.
  • Read Only: true
    Unique identifier of the time dimension level member.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 50
    Unit of Measure associated with the collected measure data.
  • Read Only: true
    Date value associated with collected measure data, applicable only to measures with a date data type.
  • Read Only: true
    Numeric value associated with collected measure data, applicable only to measures with number or percent data types.
  • Read Only: true
    Maximum Length: 100
    Text value associated with collected measure data, applicable only to measures with a text data type.
Back to Top