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; number; Finds the collected measure data based on the unique identifier of the decomposition group dimension level.
    • ClgLvlMemberId; number; Finds the collected measure data based on the unique identifier of the decomposition group dimension level member.
    • CtoLvlMemberId; number; Finds the collected measure data based on the unique identifier of the Configure-to-Order dimension level member.
    • CusLvlId; number; Finds the collected measure data based on the unique identifier of the customer dimension level.
    • CusLvlMemberId; number; Finds the collected measure data based on the unique identifier of the customer dimension level member.
    • DcsLvlId; number; Finds the collected measure data based on the unique identifier of the demand class dimension level.
    • DcsLvlMemberId; number; Finds the collected measure data based on the unique identifier of the demand class dimension level member.
    • ExpLvlId; number; Finds the collected measure data based on the unique identifier of the exception dimension level.
    • ExpLvlMemberId; number; Finds the collected measure data based on the unique identifier of the exception dimension level member.
    • FcmLvlId; number; Finds the collected measure data based on the unique identifier of the forecast methods dimension level.
    • FcmLvlMemberId; number; Finds the collected measure data based on the unique identifier of the forecast methods dimension level member.
    • MeasureId; number; Finds collected measure data using the unique identifier of the measure.
    • OrdLvlId; number; Finds the collected measure data based on the unique identifier of the order type dimension level member.
    • OrdLvlMemberId; number; Finds the collected measure data based on the unique identifier of the order type dimension level.
    • OrgLvlId; number; Finds collected measure data using the unique identifier of the organization dimension level.
    • OrgLvlMemberId; number; Finds the collected measure data based on the unique identifier of the organization dimension level member.
    • PlanId; string; Finds collected measure data using the unique identifier of the plan.
    • PrdLvlId; number; Finds collected measure data using the unique identifier of the product dimension level.
    • PrdLvlMemberId; number; Finds collected measure data using the unique identifier of the product dimension level member.
    • ResLvlId; number; Finds the collected measure data based on the unique identifier of the resource dimension level.
    • ResLvlMemberId; number; Finds the collected measure data based on the unique identifier of the resource dimension level member.
    • SorLvlId; number; Finds the collected measure data based on the unique identifier of the sales organization dimension level.
    • SorLvlMemberId; number; Finds the collected measure data based on the unique identifier of the sales organization dimension level member.
    • SrInstanceId; number; Finds collected measure data using the unique identifier of the source instance.
    • SupLvlId; number; Finds the collected measure data based on the unique identifier of the supplier dimension level.
    • SupLvlMemberId; number; Finds the collected measure data based on the unique identifier of the supplier dimension level member.
    • TimLvlId; string; Finds the collected measure data based on the unique identifier of the time dimension level.
    • TimLvlMemberId; number; 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:
  

  • ClgLvlId; number; Unique identifier of the decomposition group dimension level.
  • ClgLvlMemberId; number; Unique identifier of the decomposition group dimension level member.
  • CreationDate; string; Date when the data for the measure was first collected.
  • Cto; string; Name of the Configure-to-Order level member.
  • CtoLvlMemberId; number; Unique identifier of the Configure-to-Order level member.
  • Currency; string; Currency associated with the collected measure data.
  • CusLvlId; number; Unique identifier of the customer dimension level.
  • CusLvlMemberId; number; Unique identifier of the customer dimension level member.
  • Customer; string; Name of the customer dimension level member.
  • CustomerLevel; string; Name of the customer dimension level.
  • DcsLvlId; number; Unique identifier of the demand class dimension level.
  • DcsLvlMemberId; number; Unique identifier of the demand class dimension level member.
  • 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.
  • ExpLvlId; number; Unique identifier of the exception dimension level.
  • ExpLvlMemberId; number; Unique identifier of the exception dimension level member.
  • FcmLvlId; number; Unique identifier of the forecast methods dimension level.
  • FcmLvlMemberId; number; Unique identifier of the forecast methods dimension level member.
  • InstanceCode; string; Code associated with the source instance.
  • LastUpdateDate; string; Date when the measure data was last updated.
  • MeasureId; number; Unique identifier of the measure for which data was collected.
  • MeasureName; string; Name of the measure for which data was collected.
  • MeasureValue; string; Collected value of the measure.
  • OrdLvlId; number; Unique identifier of the order type dimension level.
  • OrdLvlMemberId; number; Unique identifier of the order type dimension level member.
  • Ordertype; string; Name of the order type level member.
  • OrdertypeLevel; string; Name of the order type level.
  • OrgLvlId; number; Unique identifier of the organization dimension level.
  • OrgLvlMemberId; number; Unique identifier of the organization dimension level member.
  • Organization; string; Name of the organization level member.
  • OrganizationLevel; string; Name of the organization level.
  • PlanId; string; Unique identifier of the plan associated with the collected measure data.
  • PlanName; string; Name of the plan associated with the collected measure data.
  • PrdLvlId; number; Unique identifier of the product dimension level.
  • PrdLvlMemberId; number; Unique identifier of the product dimension level member.
  • Product; string; Name of the product dimension level member.
  • ProductLevel; string; Name of the product dimension level.
  • Refreshnumber; number; Unique number associated with the measure data collection process.
  • ResLvlId; number; Unique identifier of the resource dimension level.
  • ResLvlMemberId; number; Unique identifier of the resource dimension level member.
  • 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; number; 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; number; Unique identifier of the sales organization dimension level.
  • SorLvlMemberId; number; Unique identifier of the sales organization dimension level member.
  • SrInstanceId; number; Unique identifier of the source instance.
  • SupLvlId; number; Unique identifier of the supplier dimension level.
  • SupLvlMemberId; number; Unique identifier of the supplier dimension level member.
  • Supplier; string; Name of the supplier dimension level member.
  • SupplierLevel; string; Name of the supplier dimension level.
  • TimLvlId; string; Unique identifier of the time dimension level.
  • TimLvlMemberId; number; Unique identifier of the time dimension level member.
  • 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.
  • ValueDate; string; Date value associated with collected measure data, applicable only to measures with a date data type.
  • ValueNumber; number; Numeric value associated with collected measure data, applicable only to measures with number or percent data types.
  • ValueText; string; Text value associated with collected measure data, applicable only to measures with a text data type.
• 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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/collectedMeasureData-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "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: number
  Read Only: true

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

  Unique identifier of the decomposition group dimension level member.
• CreationDate: string (date-time)
  Read Only: true

  Date when the data for the measure was first collected.
• Cto: string
  Read Only: true

  Maximum Length: 2000

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

  Unique identifier of the Configure-to-Order level member.
• Currency: string
  Read Only: true

  Maximum Length: 5

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

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

  Unique identifier of the customer dimension level member.
• Customer: string
  Read Only: true

  Maximum Length: 360

  Name of the customer dimension level member.
• CustomerLevel: string
  Read Only: true

  Maximum Length: 100

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

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

  Unique identifier of the demand class dimension level member.
• Decomgroup: string
  Read Only: true

  Maximum Length: 100

  Name of the decomposition group dimension level member.
• DecomgroupLevel: string
  Read Only: true

  Maximum Length: 100

  Name of the decomposition group dimension level.
• DemandClass: string
  Read Only: true

  Maximum Length: 100

  Name of the demand class dimension level member.
• DemandClassLevel: string
  Read Only: true

  Maximum Length: 100

  Name of the demand class dimension level.
• Demforecastmet: string
  Read Only: true

  Maximum Length: 100

  Name of the forecast methods dimension level member.
• DemforecastmetLevel: string
  Read Only: true

  Maximum Length: 100

  Name of the forecast methods dimension level.
• Error: string
  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
  Read Only: true

  Maximum Length: 100

  Name of the exception dimension level member.
• ExceptionLevel: string
  Read Only: true

  Maximum Length: 100

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

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

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

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

  Unique identifier of the forecast methods dimension level member.
• InstanceCode: string
  Read Only: true

  Maximum Length: 30

  Code associated with the source instance.
• LastUpdateDate: string (date-time)
  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: number
  Read Only: true

  Unique identifier of the measure for which data was collected.
• MeasureName: string
  Read Only: true

  Maximum Length: 100

  Name of the measure for which data was collected.
• MeasureValue: string
  Read Only: true

  Maximum Length: 100

  Collected value of the measure.
• Ordertype: string
  Read Only: true

  Maximum Length: 100

  Name of the order type level member.
• OrdertypeLevel: string
  Read Only: true

  Maximum Length: 100

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

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

  Unique identifier of the order type dimension level member.
• Organization: string
  Read Only: true

  Maximum Length: 100

  Name of the organization level member.
• OrganizationLevel: string
  Read Only: true

  Maximum Length: 100

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

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

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

  Unique identifier of the plan associated with the collected measure data.
• PlanName: string
  Read Only: true

  Maximum Length: 100

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

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

  Unique identifier of the product dimension level member.
• Product: string
  Read Only: true

  Maximum Length: 300

  Name of the product dimension level member.
• ProductLevel: string
  Read Only: true

  Maximum Length: 100

  Name of the product dimension level.
• Refreshnumber: number
  Read Only: true

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

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

  Unique identifier of the resource dimension level member.
• ResourceLevel: string
  Read Only: true

  Maximum Length: 100

  Name of the resource dimension level.
• Resourcemem: string
  Read Only: true

  Maximum Length: 100

  Name of the resource dimension level member.
• Salesorg: string
  Read Only: true

  Maximum Length: 360

  Name of the sales organization dimension level member.
• SalesorgLevel: string
  Read Only: true

  Maximum Length: 100

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

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

  Unique identifier of the sales organization dimension level member.
• SrInstanceId: number
  Read Only: true

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

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

  Unique identifier of the supplier dimension level member.
• Supplier: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier dimension level member.
• SupplierLevel: string
  Read Only: true

  Maximum Length: 100

  Name of the supplier dimension level.
• Time: string (date)
  Read Only: true

  Date associated with the collected measure data.
• TimeLevel: string
  Read Only: true

  Maximum Length: 100

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

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

  Unique identifier of the time dimension level member.
• Uom: string
  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: number
  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":{
        "ClgLvlId":{
            "type":"number",
            "description":"Unique identifier of the decomposition group dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClgLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the decomposition group dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the data for the measure was first collected.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Cto":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the Configure-to-Order level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CtoLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the Configure-to-Order level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":5,
            "type":"string",
            "description":"Currency associated with the collected measure data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CusLvlId":{
            "type":"number",
            "description":"Unique identifier of the customer dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CusLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the customer dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the customer dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DcsLvlId":{
            "type":"number",
            "description":"Unique identifier of the demand class dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DcsLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the demand class dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Decomgroup":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the decomposition group dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DecomgroupLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the decomposition group dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClass":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the demand class dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the demand class dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Demforecastmet":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the forecast methods dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemforecastmetLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the forecast methods dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "Exception":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the exception dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the exception dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpLvlId":{
            "type":"number",
            "description":"Unique identifier of the exception dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the exception dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FcmLvlId":{
            "type":"number",
            "description":"Unique identifier of the forecast methods dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FcmLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the forecast methods dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstanceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code associated with the source instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the measure data was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureId":{
            "type":"number",
            "description":"Unique identifier of the measure for which data was collected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the measure for which data was collected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureValue":{
            "maxLength":100,
            "type":"string",
            "description":"Collected value of the measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrdLvlId":{
            "type":"number",
            "description":"Unique identifier of the order type dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrdLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the order type dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Ordertype":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the order type level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrdertypeLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the order type level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgLvlId":{
            "type":"number",
            "description":"Unique identifier of the organization dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the organization dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the organization level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the organization level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"string",
            "description":"Unique identifier of the plan associated with the collected measure data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the plan associated with the collected measure data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrdLvlId":{
            "type":"number",
            "description":"Unique identifier of the product dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrdLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the product dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Product":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the product dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the product dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Refreshnumber":{
            "type":"number",
            "description":"Unique number associated with the measure data collection process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResLvlId":{
            "type":"number",
            "description":"Unique identifier of the resource dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the resource dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the resource dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Resourcemem":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the resource dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Salesorg":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the sales organization dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesorgLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the sales organization dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShowErrors":{
            "type":"number",
            "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-queryable":true
        },
        "SorLvlId":{
            "type":"number",
            "description":"Unique identifier of the sales organization dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SorLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the sales organization dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrInstanceId":{
            "type":"number",
            "description":"Unique identifier of the source instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupLvlId":{
            "type":"number",
            "description":"Unique identifier of the supplier dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the supplier dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the supplier dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimLvlId":{
            "type":"string",
            "description":"Unique identifier of the time dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimLvlMemberId":{
            "type":"number",
            "description":"Unique identifier of the time dimension level member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Time":{
            "type":"string",
            "description":"Date associated with the collected measure data.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeLevel":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the time dimension level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Uom":{
            "maxLength":50,
            "type":"string",
            "description":"Unit of Measure associated with the collected measure data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":true
        },
        "ValueNumber":{
            "type":"number",
            "description":"Numeric value associated with collected measure data, applicable only to measures with number or percent data types.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":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