Jump to

• Request
• Response

Get all collected measure data records

get

/fscmRestApi/resources/11.13.18.05/collectedMeasureData

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds collected measure data based on the primary search criteria.
    Finder Variables
    • ClgLvlId; integer; Finds the collected measure data based on the unique identifier of the decomposition group dimension level.
    • ClgLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the decomposition group dimension level member.
    • CtoLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the Configure-to-Order dimension level member.
    • CusLvlId; integer; Finds the collected measure data based on the unique identifier of the customer dimension level.
    • CusLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the customer dimension level member.
    • DcsLvlId; integer; Finds the collected measure data based on the unique identifier of the demand class dimension level.
    • DcsLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the demand class dimension level member.
    • ExpLvlId; integer; Finds the collected measure data based on the unique identifier of the exception dimension level.
    • ExpLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the exception dimension level member.
    • FcmLvlId; integer; Finds the collected measure data based on the unique identifier of the forecast methods dimension level.
    • FcmLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the forecast methods dimension level member.
    • MeasureId; integer; Finds collected measure data using the unique identifier of the measure.
    • OrdLvlId; integer; Finds the collected measure data based on the unique identifier of the order type dimension level member.
    • OrdLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the order type dimension level.
    • OrgLvlId; integer; Finds collected measure data using the unique identifier of the organization dimension level.
    • OrgLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the organization dimension level member.
    • PlanId; integer; Finds collected measure data using the unique identifier of the plan.
    • PrdLvlId; integer; Finds collected measure data using the unique identifier of the product dimension level.
    • PrdLvlMemberId; integer; Finds collected measure data using the unique identifier of the product dimension level member.
    • ResLvlId; integer; Finds the collected measure data based on the unique identifier of the resource dimension level.
    • ResLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the resource dimension level member.
    • SorLvlId; integer; Finds the collected measure data based on the unique identifier of the sales organization dimension level.
    • SorLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the sales organization dimension level member.
    • SrInstanceId; integer; Finds collected measure data using the unique identifier of the source instance.
    • SupLvlId; integer; Finds the collected measure data based on the unique identifier of the supplier dimension level.
    • SupLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the supplier dimension level member.
    • TimLvlId; integer; Finds the collected measure data based on the unique identifier of the time dimension level.
    • TimLvlMemberId; integer; Finds the collected measure data based on the unique identifier of the time dimension level member.
    • Time; string; Finds the collected measure data based on the date.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreationDate; string; Date when the data for the measure was first collected.
  • Cto; string; Name of the Configure-to-Order level member.
  • Currency; string; Currency associated with the collected measure data.
  • Customer; string; Name of the customer dimension level member.
  • CustomerLevel; string; Name of the customer dimension level.
  • Decomgroup; string; Name of the decomposition group dimension level member.
  • DecomgroupLevel; string; Name of the decomposition group dimension level.
  • DemandClass; string; Name of the demand class dimension level member.
  • DemandClassLevel; string; Name of the demand class dimension level.
  • Demforecastmet; string; Name of the forecast methods dimension level member.
  • DemforecastmetLevel; string; Name of the forecast methods dimension level.
  • Error; string; Error information associated with collected measure data, available only for data that failed validation during the collection process.
  • Exception; string; Name of the exception dimension level member.
  • ExceptionLevel; string; Name of the exception dimension level.
  • InstanceCode; string; Code associated with the source instance.
  • LastUpdateDate; string; Date when the measure data was last updated.
  • MeasureName; string; Name of the measure for which data was collected.
  • MeasureValue; string; Collected value of the measure.
  • Ordertype; string; Name of the order type level member.
  • OrdertypeLevel; string; Name of the order type level.
  • Organization; string; Name of the organization level member.
  • OrganizationLevel; string; Name of the organization level.
  • PlanName; string; Name of the plan associated with the collected measure data.
  • Product; string; Name of the product dimension level member.
  • ProductLevel; string; Name of the product dimension level.
  • Refreshnumber; integer; Unique number associated with the measure data collection process.
  • ResourceLevel; string; Name of the resource dimension level.
  • Resourcemem; string; Name of the resource dimension level member.
  • Salesorg; string; Name of the sales organization dimension level member.
  • SalesorgLevel; string; Name of the sales organization dimension level.
  • ShowErrors; string; 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.
  • Supplier; string; Name of the supplier dimension level member.
  • SupplierLevel; string; Name of the supplier dimension level.
  • Time; string; Date associated with the collected measure data.
  • TimeLevel; string; Name of the time dimension level.
  • Uom; string; Unit of Measure associated with the collected measure data.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : collectedMeasureData

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/collectedMeasureData-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object collectedMeasureData-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/collectedMeasureData-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 : collectedMeasureData-item-response

Type: object

Show Source

• ClgLvlId: integer
  Read Only: true

  Unique identifier of the decomposition group dimension level.
• ClgLvlMemberId: integer
  Read Only: true

  Unique identifier of the decomposition group dimension level member.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the data for the measure was first collected.
• Cto: string
  Title: CTO

  Read Only: true

  Maximum Length: 4000

  Name of the Configure-to-Order level member.
• CtoLvlMemberId: integer
  Read Only: true

  Unique identifier of the Configure-to-Order level member.
• Currency: string
  Title: Currency

  Read Only: true

  Maximum Length: 5

  Currency associated with the collected measure data.
• CusLvlId: integer
  Read Only: true

  Unique identifier of the customer dimension level.
• CusLvlMemberId: integer
  Read Only: true

  Unique identifier of the customer dimension level member.
• Customer: string
  Title: Customer

  Read Only: true

  Maximum Length: 4000

  Name of the customer dimension level member.
• CustomerLevel: string
  Title: Customer Level

  Read Only: true

  Maximum Length: 64

  Name of the customer dimension level.
• DcsLvlId: integer
  Read Only: true

  Unique identifier of the demand class dimension level.
• DcsLvlMemberId: integer
  Read Only: true

  Unique identifier of the demand class dimension level member.
• Decomgroup: string
  Title: Decomposition Group

  Read Only: true

  Maximum Length: 4000

  Name of the decomposition group dimension level member.
• DecomgroupLevel: string
  Title: Decomposition Group Level

  Read Only: true

  Maximum Length: 64

  Name of the decomposition group dimension level.
• DemandClass: string
  Title: Demand Class

  Read Only: true

  Maximum Length: 4000

  Name of the demand class dimension level member.
• DemandClassLevel: string
  Title: Demand Class Level

  Read Only: true

  Maximum Length: 64

  Name of the demand class dimension level.
• Demforecastmet: string
  Title: Demand Forecast Method

  Read Only: true

  Maximum Length: 4000

  Name of the forecast methods dimension level member.
• DemforecastmetLevel: string
  Title: Demand Forecast Method Level

  Read Only: true

  Maximum Length: 64

  Name of the forecast methods dimension level.
• Error: string
  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.
• Exception: string
  Title: Exception Type

  Read Only: true

  Maximum Length: 4000

  Name of the exception dimension level member.
• ExceptionLevel: string
  Title: Exception Type Level

  Read Only: true

  Maximum Length: 64

  Name of the exception dimension level.
• ExpLvlId: integer
  Read Only: true

  Unique identifier of the exception dimension level.
• ExpLvlMemberId: integer
  Read Only: true

  Unique identifier of the exception dimension level member.
• FcmLvlId: integer
  Read Only: true

  Unique identifier of the forecast methods dimension level.
• FcmLvlMemberId: integer
  Read Only: true

  Unique identifier of the forecast methods dimension level member.
• InstanceCode: string
  Title: Source System

  Read Only: true

  Maximum Length: 30

  Code associated with the source instance.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the measure data was last updated.
• links: array Links
  Title: Links

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

  Unique identifier of the measure for which data was collected.
• MeasureName: string
  Title: Measure Name

  Read Only: true

  Maximum Length: 250

  Name of the measure for which data was collected.
• MeasureValue: string
  Title: Measure Value

  Read Only: true

  Maximum Length: 100

  Collected value of the measure.
• Ordertype: string
  Title: Order Type

  Read Only: true

  Maximum Length: 4000

  Name of the order type level member.
• OrdertypeLevel: string
  Title: Order Type Level

  Read Only: true

  Maximum Length: 64

  Name of the order type level.
• OrdLvlId: integer
  Read Only: true

  Unique identifier of the order type dimension level.
• OrdLvlMemberId: integer
  Read Only: true

  Unique identifier of the order type dimension level member.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Name of the organization level member.
• OrganizationLevel: string
  Title: Organization Level

  Read Only: true

  Maximum Length: 64

  Name of the organization level.
• OrgLvlId: integer
  Read Only: true

  Unique identifier of the organization dimension level.
• OrgLvlMemberId: integer
  Read Only: true

  Unique identifier of the organization dimension level member.
• PlanId: integer
  Read Only: true

  Unique identifier of the plan associated with the collected measure data.
• PlanName: string
  Title: Plan Name

  Read Only: true

  Maximum Length: 30

  Name of the plan associated with the collected measure data.
• PrdLvlId: integer
  Read Only: true

  Unique identifier of the product dimension level.
• PrdLvlMemberId: integer
  Read Only: true

  Unique identifier of the product dimension level member.
• Product: string
  Title: Product

  Read Only: true

  Maximum Length: 4000

  Name of the product dimension level member.
• ProductLevel: string
  Title: Product Level

  Read Only: true

  Maximum Length: 64

  Name of the product dimension level.
• Refreshnumber: integer (int64)
  Title: Refresh Number

  Read Only: true

  Unique number associated with the measure data collection process.
• ResLvlId: integer
  Read Only: true

  Unique identifier of the resource dimension level.
• ResLvlMemberId: integer
  Read Only: true

  Unique identifier of the resource dimension level member.
• ResourceLevel: string
  Title: Resource Level

  Read Only: true

  Maximum Length: 64

  Name of the resource dimension level.
• Resourcemem: string
  Title: Resource

  Read Only: true

  Maximum Length: 4000

  Name of the resource dimension level member.
• Salesorg: string
  Title: Sales Organization

  Read Only: true

  Maximum Length: 4000

  Name of the sales organization dimension level member.
• SalesorgLevel: string
  Title: Sales Organization Level

  Read Only: true

  Maximum Length: 64

  Name of the sales organization dimension level.
• ShowErrors: string
  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.
• SorLvlId: integer
  Read Only: true

  Unique identifier of the sales organization dimension level.
• SorLvlMemberId: integer
  Read Only: true

  Unique identifier of the sales organization dimension level member.
• SrInstanceId: integer
  Title: Source System

  Read Only: true

  Unique identifier of the source instance.
• SupLvlId: integer
  Read Only: true

  Unique identifier of the supplier dimension level.
• SupLvlMemberId: integer
  Read Only: true

  Unique identifier of the supplier dimension level member.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 4000

  Name of the supplier dimension level member.
• SupplierLevel: string
  Title: Supplier Level

  Read Only: true

  Maximum Length: 64

  Name of the supplier dimension level.
• Time: string (date)
  Title: Time

  Read Only: true

  Date associated with the collected measure data.
• TimeLevel: string
  Title: Time Level

  Read Only: true

  Maximum Length: 64

  Name of the time dimension level.
• TimLvlId: integer
  Read Only: true

  Unique identifier of the time dimension level.
• TimLvlMemberId: integer
  Read Only: true

  Unique identifier of the time dimension level member.
• Uom: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 50

  Unit of Measure associated with the collected measure data.
• ValueDate: string (date)
  Read Only: true

  Date value associated with collected measure data, applicable only to measures with a date data type.
• ValueNumber: integer
  Read Only: true

  Numeric value associated with collected measure data, applicable only to measures with number or percent data types.
• ValueText: string
  Read Only: true

  Maximum Length: 100

  Text value associated with collected measure data, applicable only to measures with a text data type.

{
    "type":"object",
    "properties":{
        "OrganizationLevel":{
            "title":"Organization Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the organization level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the data for the measure was first collected.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "title":"Customer",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the customer dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceLevel":{
            "title":"Resource Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the resource dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstanceCode":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"Code associated with the source instance.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Product":{
            "title":"Product",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the product dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Demforecastmet":{
            "title":"Demand Forecast Method",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the forecast methods dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FcmLvlId":{
            "type":"integer",
            "description":"Unique identifier of the forecast methods dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CtoLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the Configure-to-Order level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrdLvlId":{
            "type":"integer",
            "description":"Unique identifier of the order type dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ExceptionLevel":{
            "title":"Exception Type Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the exception dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrdLvlId":{
            "type":"integer",
            "description":"Unique identifier of the product dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TimLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the time dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShowErrors":{
            "title":"Errors",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":5,
            "type":"string",
            "description":"Currency associated with the collected measure data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeLevel":{
            "title":"Time Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the time dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Resourcemem":{
            "title":"Resource",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the resource dimension level member.",
            "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"
            }
        },
        "SalesorgLevel":{
            "title":"Sales Organization Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the sales organization dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResLvlId":{
            "type":"integer",
            "description":"Unique identifier of the resource dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MeasureName":{
            "title":"Measure Name",
            "maxLength":250,
            "type":"string",
            "description":"Name of the measure for which data was collected.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SupplierLevel":{
            "title":"Supplier Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the supplier dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Refreshnumber":{
            "title":"Refresh Number",
            "type":"integer",
            "description":"Unique number associated with the measure data collection process.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrgLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the organization dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Salesorg":{
            "title":"Sales Organization",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the sales organization dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassLevel":{
            "title":"Demand Class Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the demand class dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClgLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the decomposition group dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the resource dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MeasureValue":{
            "title":"Measure Value",
            "maxLength":100,
            "type":"string",
            "description":"Collected value of the measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DecomgroupLevel":{
            "title":"Decomposition Group Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the decomposition group dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Ordertype":{
            "title":"Order Type",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the order type level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpLvlId":{
            "type":"integer",
            "description":"Unique identifier of the exception dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Organization":{
            "title":"Organization",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the organization level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductLevel":{
            "title":"Product Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the product dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SorLvlId":{
            "type":"integer",
            "description":"Unique identifier of the sales organization dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ClgLvlId":{
            "type":"integer",
            "description":"Unique identifier of the decomposition group dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Time":{
            "title":"Time",
            "type":"string",
            "description":"Date associated with the collected measure data.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CusLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the customer dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanName":{
            "title":"Plan Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the plan associated with the collected measure data.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the supplier dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ValueText":{
            "maxLength":100,
            "type":"string",
            "description":"Text value associated with collected measure data, applicable only to measures with a text data type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DemforecastmetLevel":{
            "title":"Demand Forecast Method Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the forecast methods dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgLvlId":{
            "type":"integer",
            "description":"Unique identifier of the organization dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SorLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the sales organization dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ValueDate":{
            "type":"string",
            "description":"Date value associated with collected measure data, applicable only to measures with a date data type.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the supplier dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLevel":{
            "title":"Customer Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the customer dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DcsLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the demand class dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the collected measure data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrdLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the order type dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Error":{
            "title":"Error",
            "maxLength":2000,
            "type":"string",
            "description":"Error information associated with collected measure data, available only for data that failed validation during the collection process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrInstanceId":{
            "title":"Source System",
            "type":"integer",
            "description":"Unique identifier of the source instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DemandClass":{
            "title":"Demand Class",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the demand class dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Exception":{
            "title":"Exception Type",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the exception dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupLvlId":{
            "type":"integer",
            "description":"Unique identifier of the supplier dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FcmLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the forecast methods dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure for which data was collected.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TimLvlId":{
            "type":"integer",
            "description":"Unique identifier of the time dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Uom":{
            "title":"Unit of Measure",
            "maxLength":50,
            "type":"string",
            "description":"Unit of Measure associated with the collected measure data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Decomgroup":{
            "title":"Decomposition Group",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the decomposition group dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DcsLvlId":{
            "type":"integer",
            "description":"Unique identifier of the demand class dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CusLvlId":{
            "type":"integer",
            "description":"Unique identifier of the customer dimension level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ExpLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the exception dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ValueNumber":{
            "type":"integer",
            "description":"Numeric value associated with collected measure data, applicable only to measures with number or percent data types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrdLvlMemberId":{
            "type":"integer",
            "description":"Unique identifier of the product dimension level member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrdertypeLevel":{
            "title":"Order Type Level",
            "maxLength":64,
            "type":"string",
            "description":"Name of the order type level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the measure data was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Cto":{
            "title":"CTO",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the Configure-to-Order level member.",
            "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 : 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